RCRTCClient | RTCLib

RTC 业务客户端

Hierarchy

RCMediaStreamCapture
- RCRTCClient

Methods

createMicrophoneAudioTrack

createMicrophoneAudioTrack(tag?: string, options?: IMicphoneAudioProfile): Promise<{ code: RCRTCCode; track?: RCMicphoneAudioTrack }>

Inherited from RCMediaStreamCapture.createMicrophoneAudioTrack
- Defined in src/core/RCMediaStreamCapture.ts:100
从麦克风中捕获音轨数据

Parameters
- tag: string = 'RongCloudRTC'
- Optional options: IMicphoneAudioProfile
Returns Promise<{ code: RCRTCCode; track?: RCMicphoneAudioTrack }>

createCameraVideoTrack

createCameraVideoTrack(tag?: string, options?: ICameraVideoProfile): Promise<{ code: RCRTCCode; track?: RCCameraVideoTrack }>

Inherited from RCMediaStreamCapture.createCameraVideoTrack
- Defined in src/core/RCMediaStreamCapture.ts:157
由摄像头捕获视轨数据

Parameters
- tag: string = 'RongCloudRTC'
- Optional options: ICameraVideoProfile
Returns Promise<{ code: RCRTCCode; track?: RCCameraVideoTrack }>

createMicrophoneAndCameraTracks

createMicrophoneAndCameraTracks(tag?: string, options?: { audio?: IMicphoneAudioProfile; video?: ICameraVideoProfile }): Promise<{ code: RCRTCCode; tracks: RCLocalTrack[] }>

Inherited from RCMediaStreamCapture.createMicrophoneAndCameraTracks
- Defined in src/core/RCMediaStreamCapture.ts:216
通过摄像头与麦克风采集音视频轨道数据

Parameters
- tag: string = 'RongCloudRTC'
- Optional options: { audio?: IMicphoneAudioProfile; video?: ICameraVideoProfile }
  - Optional audio?: IMicphoneAudioProfile
  - Optional video?: ICameraVideoProfile
Returns Promise<{ code: RCRTCCode; tracks: RCLocalTrack[] }>

createScreenVideoTrack

createScreenVideoTrack(tag?: string, options?: IScreenVideoProfile): Promise<{ code: RCRTCCode; track?: RCScreenVideoTrack }>

Inherited from RCMediaStreamCapture.createScreenVideoTrack
- Defined in src/core/RCMediaStreamCapture.ts:296
创建屏幕共享视频流，默认分辨率 1280 * 720，帧率 15

description
支持 Electron 平台下通过制定 chromeMediaSourceId 的方式获取屏幕共享视频。参考：https://www.electronjs.org/docs/api/desktop-capturer

Parameters
- tag: string = 'screenshare'
  
  屏幕共享视轨数据标识
- Optional options: IScreenVideoProfile
Returns Promise<{ code: RCRTCCode; track?: RCScreenVideoTrack }>

createScreenWithAudioTracks

createScreenWithAudioTracks(tag?: string, options?: IScreenVideoProfile): Promise<{ code: RCRTCCode; tracks?: (RCScreenVideoTrack | RCScreenAudioTrack)[] }>

Inherited from RCMediaStreamCapture.createScreenWithAudioTracks
- Defined in src/core/RCMediaStreamCapture.ts:311
创建带音频的屏幕共享资源

description
electron 中 mac 系统暂不支持屏幕共享采集声音

Parameters
- tag: string = 'screenshare'
  
  屏幕共享视轨数据标识
- Optional options: IScreenVideoProfile
Returns Promise<{ code: RCRTCCode; tracks?: (RCScreenVideoTrack | RCScreenAudioTrack)[] }>
在可以取到音频的情况下，tracks 中包含音轨和视轨；取不到音视频时 tracks 仅返回视轨

createLocalAudioTrack

createLocalAudioTrack(tag: string, track: MediaStreamTrack): Promise<{ code: RCRTCCode; track?: RCLocalAudioTrack }>

Inherited from RCMediaStreamCapture.createLocalAudioTrack
- Defined in src/core/RCMediaStreamCapture.ts:471
创建 RCLocalAudioTrack 实例

Parameters
- tag: string
- track: MediaStreamTrack
Returns Promise<{ code: RCRTCCode; track?: RCLocalAudioTrack }>

createLocalVideoTrack

createLocalVideoTrack(tag: string, track: MediaStreamTrack): Promise<{ code: RCRTCCode; track?: RCLocalVideoTrack }>

Inherited from RCMediaStreamCapture.createLocalVideoTrack
- Defined in src/core/RCMediaStreamCapture.ts:518
创建 RCLocalVideoTrack 实例

Parameters
- tag: string
  
  视轨数据标识
- track: MediaStreamTrack
  
  MediaStreamTrack 实例
Returns Promise<{ code: RCRTCCode; track?: RCLocalVideoTrack }>

createLocalFileTracks

createLocalFileTracks(tag: string, file: string | File, options?: ICreateLocalTrackOptions): Promise<{ code: RCRTCCode; tracks: RCLocalFileTrack[] }>

Inherited from RCMediaStreamCapture.createLocalFileTracks
- Defined in src/core/RCMediaStreamCapture.ts:614
根据本地或网络媒体文件资源创建 RCLocalFileTrack 实例

Parameters
- tag: string
  
  资源标识
- file: string | File
  
  网络文件地址，或通过获取到的 File 实例
- Optional options: ICreateLocalTrackOptions
  
  可用于指定 withoutVideo 与 withoutAudio 以剔除视轨与音轨
Returns Promise<{ code: RCRTCCode; tracks: RCLocalFileTrack[] }>

createLocalTracks

createLocalTracks(tag: string, stream: MediaStream, options?: ICreateLocalTrackOptions): Promise<{ code: RCRTCCode; tracks: RCLocalTrack[] }>

Inherited from RCMediaStreamCapture.createLocalTracks
- Defined in src/core/RCMediaStreamCapture.ts:680
根据 MediaStream 实例对象创建 RCLocalTrack 实例

Parameters
- tag: string
  
  轨道标识
- stream: MediaStream
  
  MediaStream 实例
- Optional options: ICreateLocalTrackOptions
  
  可用于指定 withoutVideo 与 withoutAudio 以剔除视轨与音轨
Returns Promise<{ code: RCRTCCode; tracks: RCLocalTrack[] }>

getCurrentId

getCurrentId(): string

- Defined in src/core/RCRTCClient.ts:133
获取当前用户 Id，若 IM 未连接，这返回 ''

Returns string

joinCrossRTCRoom

joinCrossRTCRoom(roomId: string, joinType?: RTCJoinType, userData?: IRTCUserData, _?: boolean, __?: RTCMode): Promise<{ room?: RCRTCRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[] }>

- Defined in src/core/RCRTCClient.ts:148
加入跨 AppKey 音视频房间

deprecated
@since 5.7.0; 请使用 joinRTCRoomWithOptions 方法替代

Parameters
- roomId: string
- Optional joinType: RTCJoinType
  
  多端处理方式
- Optional userData: IRTCUserData
  
  设置用户属性
- _: boolean = false
  
  参数已废弃
- __: RTCMode = RTCMode.CROSS_MUTI
  
  参数已废弃
Returns Promise<{ room?: RCRTCRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[] }>

joinRTCRoom

joinRTCRoom(roomId: string, joinType?: RTCJoinType, userData?: IRTCUserData, _?: boolean, roomType?: RTC | SIP | CALL): Promise<{ room?: RCRTCRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[] }>

- Defined in src/core/RCRTCClient.ts:166
加入普通音视频房间，加入成功后返回 room 实例、code、userIds、tracks

deprecated
@since 5.7.0; 请使用 joinRTCRoomWithOptions 方法替代

Parameters
- roomId: string
  
  房间号
- Optional joinType: RTCJoinType
- Optional userData: IRTCUserData
- _: boolean = false
- roomType: RTC | SIP | CALL = RTCMode.RTC
  
  房间类型，请谨慎修改，默认为 RTCMode.RTC
Returns Promise<{ room?: RCRTCRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[] }>

joinRTCRoomWithOptions

joinRTCRoomWithOptions(roomId: string, options?: IJoinRTCRoomOptions): Promise<{ room?: RCRTCRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[] }>

- Defined in src/core/RCRTCClient.ts:187
加入普通音视频房间

since
5.7.0

Parameters
- roomId: string
  
  房间 ID
- Optional options: IJoinRTCRoomOptions
Returns Promise<{ room?: RCRTCRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[] }>

joinLivingRoom

joinLivingRoom(roomId: string, livingType: RCLivingType, joinType?: RTCJoinType, outerUserDatas?: IRTCUserData, _?: boolean): Promise<{ room?: RCLivingRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[]; CDNEnable?: boolean }>

- Defined in src/core/RCRTCClient.ts:229
主播加入直播房间或观众上麦场景调用，观众上麦之前需先取消已订阅的直播间资源

Parameters
- roomId: string
  
  房间 Id
- livingType: RCLivingType
  
  直播间类型，RCLivingType.AUDIO 为音频直播，RCLivingType.VIDEO 为音视频直播
- Optional joinType: RTCJoinType
  
  多端处理方式，公有云暂不支持该字段
- Optional outerUserDatas: IRTCUserData
  
  业务层设置人员属性
- _: boolean = false
  
  参数已废弃
Returns Promise<{ room?: RCLivingRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[]; CDNEnable?: boolean }>

getAudienceClient

getAudienceClient(_?: boolean): RCAudienceClient

- Defined in src/core/RCRTCClient.ts:276
获取直播观众客户端

Parameters
- Optional _: boolean
  
  参数已废弃
Returns RCAudienceClient

leaveRoom

leaveRoom(room: RCAbstractRoom): Promise<{ code: RCRTCCode }>

- Defined in src/core/RCRTCClient.ts:344
退出并销毁当前房间实例，退出后该房间的所有方法将不可用

Parameters
- room: RCAbstractRoom
Returns Promise<{ code: RCRTCCode }>

joinLivingRoomAsAudience

joinLivingRoomAsAudience(roomId: string, livingType: RCLivingType, _?: boolean): Promise<{ room?: RCAudienceLivingRoom; code: RCRTCCode; userIds?: string[]; RTCTracks?: RCRemoteTrack[]; MCUTracks?: RCRemoteTrack[]; CDNUris?: IJoinResCDNInfo }>

- Defined in src/core/RCRTCClient.ts:380
观众加入直播房间

Parameters
- roomId: string
  
  房间 ID
- livingType: RCLivingType
  
  直播类型（音频直播 or 音视频直播）
- Optional _: boolean
  
  废弃参数
Returns Promise<{ room?: RCAudienceLivingRoom; code: RCRTCCode; userIds?: string[]; RTCTracks?: RCRemoteTrack[]; MCUTracks?: RCRemoteTrack[]; CDNUris?: IJoinResCDNInfo }>

leaveLivingRoomAsAudience

leaveLivingRoomAsAudience(room: RCAudienceLivingRoom): Promise<{ code: RCRTCCode }>

- Defined in src/core/RCRTCClient.ts:469
观众退出并销毁当前房间实例，退出后该房间的所有方法将不可用

Parameters
- room: RCAudienceLivingRoom
Returns Promise<{ code: RCRTCCode }>

upgradeToAnchorRoom

upgradeToAnchorRoom(room: RCAudienceLivingRoom): Promise<{ room?: RCLivingRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[]; CDNEnable?: boolean }>

- Defined in src/core/RCRTCClient.ts:509
升级为主播房间

Parameters
- room: RCAudienceLivingRoom
  
  观众房间实例
Returns Promise<{ room?: RCLivingRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[]; CDNEnable?: boolean }>

downgradeToAudienceRoom

downgradeToAudienceRoom(room: RCLivingRoom): Promise<{ room?: RCAudienceLivingRoom; code: RCRTCCode; userIds?: string[]; RTCTracks?: RCRemoteTrack[]; MCUTracks?: RCRemoteTrack[]; CDNUris?: IJoinResCDNInfo }>

- Defined in src/core/RCRTCClient.ts:570
降级为观众房间

Parameters
- room: RCLivingRoom
  
  主播房间实例
Returns Promise<{ room?: RCAudienceLivingRoom; code: RCRTCCode; userIds?: string[]; RTCTracks?: RCRemoteTrack[]; MCUTracks?: RCRemoteTrack[]; CDNUris?: IJoinResCDNInfo }>

getJoinedRoomInfo

getJoinedRoomInfo(): Promise<{ code: RCRTCCode | ErrorCode; data?: IRTCJoinedInfo[] }>

- Defined in src/core/RCRTCClient.ts:650
验证本用户是否存在于某个 RTC 房间内

since
version 5.2.1

Returns Promise<{ code: RCRTCCode | ErrorCode; data?: IRTCJoinedInfo[] }>

Constructors

constructor

new RCRTCClient(_context: RTCContext, _runtime: IRuntime, _options: IRCRTCInitOptions): RCRTCClient

Overrides RCMediaStreamCapture.constructor
- Defined in src/core/RCRTCClient.ts:56
Parameters
- _context: RTCContext
- _runtime: IRuntime
- _options: IRCRTCInitOptions
Returns RCRTCClient

Hierarchy

Index

Methods

Constructors

Methods

createMicrophoneAudioTrack

Parameters

tag: string = 'RongCloudRTC'

Optional options: IMicphoneAudioProfile

Returns Promise<{ code: RCRTCCode; track?: RCMicphoneAudioTrack }>

createCameraVideoTrack

Parameters

tag: string = 'RongCloudRTC'

Optional options: ICameraVideoProfile

Returns Promise<{ code: RCRTCCode; track?: RCCameraVideoTrack }>

createMicrophoneAndCameraTracks

Parameters

tag: string = 'RongCloudRTC'

Optional options: { audio?: IMicphoneAudioProfile; video?: ICameraVideoProfile }

Optional audio?: IMicphoneAudioProfile

Optional video?: ICameraVideoProfile

Returns Promise<{ code: RCRTCCode; tracks: RCLocalTrack[] }>

createScreenVideoTrack

Parameters

tag: string = 'screenshare'

Optional options: IScreenVideoProfile

Returns Promise<{ code: RCRTCCode; track?: RCScreenVideoTrack }>

createScreenWithAudioTracks

Parameters

tag: string = 'screenshare'

Optional options: IScreenVideoProfile

Returns Promise<{ code: RCRTCCode; tracks?: (RCScreenVideoTrack | RCScreenAudioTrack)[] }>

createLocalAudioTrack

Parameters

tag: string

track: MediaStreamTrack

Returns Promise<{ code: RCRTCCode; track?: RCLocalAudioTrack }>

createLocalVideoTrack

Parameters

tag: string

track: MediaStreamTrack

Returns Promise<{ code: RCRTCCode; track?: RCLocalVideoTrack }>

createLocalFileTracks

Parameters

tag: string

file: string | File

Optional options: ICreateLocalTrackOptions

Returns Promise<{ code: RCRTCCode; tracks: RCLocalFileTrack[] }>

createLocalTracks

Parameters

tag: string

stream: MediaStream

Optional options: ICreateLocalTrackOptions

Returns Promise<{ code: RCRTCCode; tracks: RCLocalTrack[] }>

getCurrentId

Returns string

joinCrossRTCRoom

Parameters

roomId: string

Optional joinType: RTCJoinType

Optional userData: IRTCUserData

_: boolean = false

__: RTCMode = RTCMode.CROSS_MUTI

Returns Promise<{ room?: RCRTCRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[] }>

joinRTCRoom

Parameters

roomId: string

Optional joinType: RTCJoinType

Optional userData: IRTCUserData

_: boolean = false

roomType: RTC | SIP | CALL = RTCMode.RTC

Returns Promise<{ room?: RCRTCRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[] }>

joinRTCRoomWithOptions

Parameters

roomId: string

Optional options: IJoinRTCRoomOptions

Returns Promise<{ room?: RCRTCRoom; code: RCRTCCode; userIds?: string[]; tracks?: RCRemoteTrack[] }>

joinLivingRoom

Parameters

roomId: string