Class default

Hierarchy

default

Implements

Index

Constructors

constructor

Methods

Constructors

constructor

new default(): default

Returns default

Methods

Private _getFullEventName

_getFullEventName(event: string): string

- Defined in RCRTCEngine.ts:418
Parameters
- event: string
Returns string

Private _invokeMethod

_invokeMethod(name: string, params?: object): any

- Defined in RCRTCEngine.ts:433
Parameters
- name: string
- Optional params: object
Returns any

Private _setListener

_setListener(event: string, callback?: (result: any) => void): void

- Defined in RCRTCEngine.ts:442
Parameters
- event: string
- Optional callback: (result: any) => void
  - - (result: any): void
    - Parameters
      - result: any
      Returns void
Returns void

addLiveCdn

addLiveCdn(url: string): number

Implementation of RCRTCEngineInterface.addLiveCdn
- Defined in RCRTCEngine.ts:241
设置 CDN 直播推流地址, 仅供直播主播用户使用

Parameters
- url: string
Returns number
{number} 错误码

adjustAllAudioEffectsVolume

adjustAllAudioEffectsVolume(volume: number): number

Implementation of RCRTCEngineInterface.adjustAllAudioEffectsVolume
- Defined in RCRTCEngine.ts:307
设置全局音效文件播放音量, 仅供会议用户或直播主播用户使用

Parameters
- volume: number
Returns number
{number} 错误码

adjustAudioEffectVolume

adjustAudioEffectVolume(effectId: number, volume: number): number

Implementation of RCRTCEngineInterface.adjustAudioEffectVolume
- Defined in RCRTCEngine.ts:301
设置音效文件播放音量, 仅供会议用户或直播主播用户使用

Parameters
- effectId: number
- volume: number
Returns number
{number} 错误码

adjustAudioMixingPlaybackVolume

adjustAudioMixingPlaybackVolume(volume: number): number

Implementation of RCRTCEngineInterface.adjustAudioMixingPlaybackVolume
- Defined in RCRTCEngine.ts:325
设置混音本地播放音量, 仅供会议用户或直播主播用户使用

Parameters
- volume: number
Returns number
{number} 错误码

adjustAudioMixingPublishVolume

adjustAudioMixingPublishVolume(volume: number): number

Implementation of RCRTCEngineInterface.adjustAudioMixingPublishVolume
- Defined in RCRTCEngine.ts:331
设置混音发送音量, 仅供会议用户或直播主播用户使用

Parameters
- volume: number
Returns number
{number}

adjustAudioMixingVolume

adjustAudioMixingVolume(volume: number): number

Implementation of RCRTCEngineInterface.adjustAudioMixingVolume
- Defined in RCRTCEngine.ts:322
设置混音输入音量, 包含本地播放和发送音量, 仅供会议用户或直播主播用户使用

Parameters
- volume: number
Returns number
{number}

adjustLocalVolume

adjustLocalVolume(volume: number): number

Implementation of RCRTCEngineInterface.adjustLocalVolume
- Defined in RCRTCEngine.ts:187
设置麦克风的音量

Parameters
- volume: number
Returns number
{number} 错误码

cancelJoinSubRoomRequest

cancelJoinSubRoomRequest(roomId: string, userId: string, extra?: string): number

Implementation of RCRTCEngineInterface.cancelJoinSubRoomRequest
- Defined in RCRTCEngine.ts:388
取消正在进行中的跨房间连麦请求

Parameters
- roomId: string
- userId: string
- Optional extra: string
Returns number
{number} 错误码

createAudioEffect

createAudioEffect(path: string, effectId: number): number

Implementation of RCRTCEngineInterface.createAudioEffect
- Defined in RCRTCEngine.ts:274
创建音效文件缓存, 仅供会议用户或直播主播用户使用

Parameters
- path: string
- effectId: number
Returns number
{number}

createCustomStreamFromFile

createCustomStreamFromFile(path: string, tag: string, replace: boolean, playback: boolean): number

Implementation of RCRTCEngineInterface.createCustomStreamFromFile
- Defined in RCRTCEngine.ts:349
从视频文件创建自定义流, 仅供会议用户或直播主播用户使用

Parameters
- path: string
- tag: string
- replace: boolean
- playback: boolean
Returns number
{number} 错误码

destroy

destroy(): number

Implementation of RCRTCEngineInterface.destroy
- Defined in RCRTCEngine.ts:137
销毁实例

Returns number
{number} 错误码

enableCamera

enableCamera(enable: boolean, camera?: RCRTCCamera): number

Implementation of RCRTCEngineInterface.enableCamera
- Defined in RCRTCEngine.ts:190
打开/关闭摄像头

Parameters
- enable: boolean
- camera: RCRTCCamera = RCRTCCamera.Front
Returns number
{number} 错误码

enableLiveMixInnerCdnStream

enableLiveMixInnerCdnStream(enable: boolean): number

- Defined in RCRTCEngine.ts:736
开启直播内置 cdn 功能

Parameters
- enable: boolean
Returns number
0: 成功, 非0: 失败

enableMicrophone

enableMicrophone(enable: boolean): number

Implementation of RCRTCEngineInterface.enableMicrophone
- Defined in RCRTCEngine.ts:181
打开/关闭麦克风

Parameters
- enable: boolean
Returns number
{number} 错误码

enableSei

enableSei(enable: boolean): number

- Defined in RCRTCEngine.ts:830
开启 SEI 功能，观众身份调用无效

Parameters
- enable: boolean
  
  是否开启
Returns number
接口调用状态码 0: 成功, 非0: 失败

enableSpeaker

enableSpeaker(enable: boolean): number

Implementation of RCRTCEngineInterface.enableSpeaker
- Defined in RCRTCEngine.ts:184
打开/关闭外放

Parameters
- enable: boolean
Returns number
{number} 错误码

getAudioEffectVolume

getAudioEffectVolume(effectId: number): number

Implementation of RCRTCEngineInterface.getAudioEffectVolume
- Defined in RCRTCEngine.ts:304
获取音效文件播放音量, 仅供会议用户或直播主播用户使用

Parameters
- effectId: number
Returns number
{number} 音量，如果小于 0，则是错误码，错误码对应 number

getAudioMixingDuration

getAudioMixingDuration(): number

Implementation of RCRTCEngineInterface.getAudioMixingDuration
- Defined in RCRTCEngine.ts:343
获取音频文件时长, 单位:秒, 仅供会议用户或直播主播用户使用

Returns number
{number} 音频文件时长, 如果小于 0，则是错误码，错误码对应 number

getAudioMixingPlaybackVolume

getAudioMixingPlaybackVolume(): number

Implementation of RCRTCEngineInterface.getAudioMixingPlaybackVolume
- Defined in RCRTCEngine.ts:328
获取混音本地播放音量, 仅供会议用户或直播主播用户使用

Returns number
{number} 音量，如果小于 0，则是错误码，错误码对应 number

getAudioMixingPosition

getAudioMixingPosition(): number

Implementation of RCRTCEngineInterface.getAudioMixingPosition
- Defined in RCRTCEngine.ts:340
获取音频文件合流进度, 仅供会议用户或直播主播用户使用

Returns number
{number} 合流进度 0~1

getAudioMixingPublishVolume

getAudioMixingPublishVolume(): number

Implementation of RCRTCEngineInterface.getAudioMixingPublishVolume
- Defined in RCRTCEngine.ts:334
获取混音发送音量, 仅供会议用户或直播主播用户使用

Returns number
{number} 音量，如果小于 0，则是错误码，错误码对应 number

getSessionId

getSessionId(): string

Implementation of RCRTCEngineInterface.getSessionId
- Defined in RCRTCEngine.ts:346
获取当前房间的 SessionId, 仅在加入房间成功后可获取每次加入房间所得到的 SessionId 均不同

Returns string
{string} 获取到的 sessionId

isCameraExposurePositionSupported

isCameraExposurePositionSupported(): boolean

Implementation of RCRTCEngineInterface.isCameraExposurePositionSupported
- Defined in RCRTCEngine.ts:202
获取摄像头是否支持区域测光

Returns boolean
{boolean} true: 支持 false: 不支持

isCameraFocusSupported

isCameraFocusSupported(): boolean

Implementation of RCRTCEngineInterface.isCameraFocusSupported
- Defined in RCRTCEngine.ts:199
获取摄像头是否支持区域对焦

Returns boolean
{boolean} true: 支持 false: 不支持

joinRoom

joinRoom(roomId: string, setup: RCRTCRoomSetup): number

Implementation of RCRTCEngineInterface.joinRoom
- Defined in RCRTCEngine.ts:145
加入房间

Parameters
- roomId: string
- setup: RCRTCRoomSetup
Returns number
{number} 错误码

joinSubRoom

joinSubRoom(roomId: string): number

Implementation of RCRTCEngineInterface.joinSubRoom
- Defined in RCRTCEngine.ts:400
连麦邀请后加入副房间

Parameters
- roomId: string
Returns number
{number} 错误码

leaveRoom

leaveRoom(): number

Implementation of RCRTCEngineInterface.leaveRoom
- Defined in RCRTCEngine.ts:148
离开房间

Returns number
{number} 错误码

leaveSubRoom

leaveSubRoom(roomId: string, disband: boolean): number

Implementation of RCRTCEngineInterface.leaveSubRoom
- Defined in RCRTCEngine.ts:403
离开副房间，此方法仅供连麦离开副房间使用

Parameters
- roomId: string
- disband: boolean
Returns number
{number} 错误码

muteAllRemoteAudioStreams

muteAllRemoteAudioStreams(mute: boolean): number

- Defined in RCRTCEngine.ts:719
停止所有远端音频数据渲染

Parameters
- mute: boolean
  
  true: 不渲染 false: 渲染
Returns number
0: 成功, 非0: 失败

muteLiveMixInnerCdnStream

muteLiveMixInnerCdnStream(mute: boolean): number

- Defined in RCRTCEngine.ts:788
观众端禁用或启用融云内置 CDN 流

Parameters
- mute: boolean
  
  true: 停止资源渲染，false: 恢复资源渲染
Returns number
接口调用状态码 0: 成功, 非0: 失败

muteLiveMixStream

muteLiveMixStream(type: RCRTCMediaType, mute: boolean): number

- Defined in RCRTCEngine.ts:238
Parameters
- type: RCRTCMediaType
- mute: boolean
Returns number

muteLocalCustomStream

muteLocalCustomStream(tag: string, mute: boolean): number

Implementation of RCRTCEngineInterface.muteLocalCustomStream
- Defined in RCRTCEngine.ts:355
停止自定义流发送, 仅供会议用户或直播主播用户使用

Parameters
- tag: string
- mute: boolean
Returns number
{number} 错误码

muteLocalStream

muteLocalStream(type: RCRTCMediaType, mute: boolean): number

Implementation of RCRTCEngineInterface.muteLocalStream
- Defined in RCRTCEngine.ts:232
停止本地音视频数据发送

Parameters
- type: RCRTCMediaType
- mute: boolean
Returns number
{number} 错误码

muteRemoteCustomStream

muteRemoteCustomStream(userId: string, tag: string, type: RCRTCMediaType, mute: boolean): number

Implementation of RCRTCEngineInterface.muteRemoteCustomStream
- Defined in RCRTCEngine.ts:370
停止远端用户自定义流数据的接收

Parameters
- userId: string
- tag: string
- type: RCRTCMediaType
- mute: boolean
Returns number
{number} 错误码

muteRemoteStream

muteRemoteStream(userId: string, type: RCRTCMediaType, mute: boolean): number

Implementation of RCRTCEngineInterface.muteRemoteStream
- Defined in RCRTCEngine.ts:235
停止远端用户音视频数据的接收

Parameters
- userId: string
- type: RCRTCMediaType
- mute: boolean
Returns number
{number} 错误码

pauseAllAudioEffects

pauseAllAudioEffects(): number

Implementation of RCRTCEngineInterface.pauseAllAudioEffects
- Defined in RCRTCEngine.ts:286
暂停全部音效文件播放, 仅供会议用户或直播主播用户使用

Returns number
{number} 错误码

pauseAudioEffect

pauseAudioEffect(effectId: number): number

Implementation of RCRTCEngineInterface.pauseAudioEffect
- Defined in RCRTCEngine.ts:283
暂停音效文件播放, 仅供会议用户或直播主播用户使用

Parameters
- effectId: number
Returns number
{number} 错误码

pauseAudioMixing

pauseAudioMixing(): number

Implementation of RCRTCEngineInterface.pauseAudioMixing
- Defined in RCRTCEngine.ts:316
暂停混音, 仅供会议用户或直播主播用户使用

Returns number
{number} 错误码

playAudioEffect

playAudioEffect(effectId: number, volume: number, loop?: number): number

Implementation of RCRTCEngineInterface.playAudioEffect
- Defined in RCRTCEngine.ts:280
播放音效文件, 仅供会议用户或直播主播用户使用

Parameters
- effectId: number
- volume: number
- loop: number = 1
Returns number
{number}

preconnectToMediaServer

preconnectToMediaServer(): number

- Defined in RCRTCEngine.ts:847
预链接到媒体服务器

Returns number
接口调用状态码 0: 成功, 非0: 失败

publish

publish(type: RCRTCMediaType): number

Implementation of RCRTCEngineInterface.publish
- Defined in RCRTCEngine.ts:151
加入房间后, 发布本地资源

Parameters
- type: RCRTCMediaType
Returns number
{number} 错误码

publishCustomStream

publishCustomStream(tag: string): number

Implementation of RCRTCEngineInterface.publishCustomStream
- Defined in RCRTCEngine.ts:364
发布自定义流, 仅供会议用户或直播主播用户使用

Parameters
- tag: string
Returns number
{number} 错误码

releaseAudioEffect

releaseAudioEffect(effectId: number): number

Implementation of RCRTCEngineInterface.releaseAudioEffect
- Defined in RCRTCEngine.ts:277
释放音效文件缓存, 仅供会议用户或直播主播用户使用

Parameters
- effectId: number
Returns number
{number}

removeLiveCdn

removeLiveCdn(url: string): number

Implementation of RCRTCEngineInterface.removeLiveCdn
- Defined in RCRTCEngine.ts:244
移除 CDN 直播推流地址, 仅供直播主播用户使用

Parameters
- url: string
Returns number
{number} 错误码

removeLiveMixInnerCdnStreamView

removeLiveMixInnerCdnStreamView(): number

- Defined in RCRTCEngine.ts:760
移除直播内置 cdn 流预览窗口

Returns number
0: 成功, 非0: 失败

removeLiveMixView

removeLiveMixView(callback: (code: number) => {}): void

Implementation of RCRTCEngineInterface.removeLiveMixView
- Defined in RCRTCEngine.ts:229
移除合流视频窗口

Parameters
- callback: (code: number) => {}
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

removeLocalCustomStreamView

removeLocalCustomStreamView(tag: string, callback: (code: number) => {}): void

Implementation of RCRTCEngineInterface.removeLocalCustomStreamView
- Defined in RCRTCEngine.ts:361
移除自定义流预览窗口, 仅供会议用户或直播主播用户使用

Parameters
- tag: string
- callback: (code: number) => {}
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

removeLocalView

removeLocalView(callback: (code: number) => {}): void

Implementation of RCRTCEngineInterface.removeLocalView
- Defined in RCRTCEngine.ts:217
移除本地视频渲染窗口

Parameters
- callback: (code: number) => {}
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

removeRemoteCustomStreamView

removeRemoteCustomStreamView(userId: string, tag: string, callback: (code: number) => {}): void

Implementation of RCRTCEngineInterface.removeRemoteCustomStreamView
- Defined in RCRTCEngine.ts:376
移除远端自定义流View

Parameters
- userId: string
- tag: string
- callback: (code: number) => {}
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

removeRemoteView

removeRemoteView(userId: string, callback: (code: number) => {}): void

Implementation of RCRTCEngineInterface.removeRemoteView
- Defined in RCRTCEngine.ts:223
移除远端视频窗口

Parameters
- userId: string
- callback: (code: number) => {}
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

removeWatermark

removeWatermark(): number

- Defined in RCRTCEngine.ts:796
移除水印

Returns number
接口调用状态码 0: 成功, 非0: 失败

requestJoinSubRoom

requestJoinSubRoom(roomId: string, userId: string, autoLayout: boolean, extra?: string): number

Implementation of RCRTCEngineInterface.requestJoinSubRoom
- Defined in RCRTCEngine.ts:385
向指定用户发送跨房间连麦请求

Parameters
- roomId: string
- userId: string
- autoLayout: boolean
- Optional extra: string
Returns number
{number} 错误码

responseJoinSubRoomRequest

responseJoinSubRoomRequest(roomId: string, userId: string, agree: boolean, autoLayout: boolean, extra?: string): number

Implementation of RCRTCEngineInterface.responseJoinSubRoomRequest
- Defined in RCRTCEngine.ts:391
响应跨房间连麦请求

Parameters
- roomId: string
- userId: string
- agree: boolean
- autoLayout: boolean
- Optional extra: string
Returns number
{number} 错误码

resumeAllAudioEffects

resumeAllAudioEffects(): number

Implementation of RCRTCEngineInterface.resumeAllAudioEffects
- Defined in RCRTCEngine.ts:292
恢复全部音效文件播放, 仅供会议用户或直播主播用户使用

Returns number
{number} 错误码

resumeAudioEffect

resumeAudioEffect(effectId: number): number

Implementation of RCRTCEngineInterface.resumeAudioEffect
- Defined in RCRTCEngine.ts:289
恢复音效文件播放, 仅供会议用户或直播主播用户使用

Parameters
- effectId: number
Returns number
{number} 错误码

resumeAudioMixing

resumeAudioMixing(): number

Implementation of RCRTCEngineInterface.resumeAudioMixing
- Defined in RCRTCEngine.ts:319
恢复混音, 仅供会议用户或直播主播用户使用

Returns number
{number} 错误码

sendSei

sendSei(sei: string): number

- Defined in RCRTCEngine.ts:839
发送 SEI 信息，需开启 SEI 功能之后调用

Parameters
- sei: string
  
  SEI 信息
Returns number
接口调用状态码 0: 成功, 非0: 失败

setAudioConfig

setAudioConfig(config: RCRTCAudioConfig): number

Implementation of RCRTCEngineInterface.setAudioConfig
- Defined in RCRTCEngine.ts:175
设置默认音频参数, 仅供会议用户或直播主播用户使用

Parameters
- config: RCRTCAudioConfig
Returns number
{number} 错误码

setAudioMixingPosition

setAudioMixingPosition(position: number): number

Implementation of RCRTCEngineInterface.setAudioMixingPosition
- Defined in RCRTCEngine.ts:337
设置混音文件合流进度, 仅供会议用户或直播主播用户使用

Parameters
- position: number
Returns number
{number}

setCameraCaptureOrientation

setCameraCaptureOrientation(orientation: RCRTCCameraCaptureOrientation): number

Implementation of RCRTCEngineInterface.setCameraCaptureOrientation
- Defined in RCRTCEngine.ts:211
设置摄像头采集方向

Parameters
- orientation: RCRTCCameraCaptureOrientation
Returns number
{number}

setCameraExposurePositionInPreview

setCameraExposurePositionInPreview(x: number, y: number): number

Implementation of RCRTCEngineInterface.setCameraExposurePositionInPreview
- Defined in RCRTCEngine.ts:208
设置在指定点区域测光

Parameters
- x: number
- y: number
Returns number
{number}

setCameraFocusPositionInPreview

setCameraFocusPositionInPreview(x: number, y: number): number

Implementation of RCRTCEngineInterface.setCameraFocusPositionInPreview
- Defined in RCRTCEngine.ts:205
设置在指定点区域对焦

Parameters
- x: number
- y: number
Returns number
{number}

setCustomStreamVideoConfig

setCustomStreamVideoConfig(tag: string, config: RCRTCVideoConfig): number

Implementation of RCRTCEngineInterface.setCustomStreamVideoConfig
- Defined in RCRTCEngine.ts:352
设置自定义流参数, 仅供会议用户或直播主播用户使用

Parameters
- tag: string
- config: RCRTCVideoConfig
Returns number
{number} 错误码

setLiveMixAudioBitrate

setLiveMixAudioBitrate(bitrate: number): number

Implementation of RCRTCEngineInterface.setLiveMixAudioBitrate
- Defined in RCRTCEngine.ts:262
设置直播合流音频码率, 仅供直播主播用户使用

Parameters
- bitrate: number
Returns number
{number}

setLiveMixBackgroundColor

setLiveMixBackgroundColor(red: number, green: number, blue: number): number

Implementation of RCRTCEngineInterface.setLiveMixBackgroundColor
- Defined in RCRTCEngine.ts:253
设置直播合流布局背景颜色仅供直播主播用户使用

Parameters
- red: number
- green: number
- blue: number
Returns number
{number} 错误码

setLiveMixCustomAudios

setLiveMixCustomAudios(userIds: string[]): number

Implementation of RCRTCEngineInterface.setLiveMixCustomAudios
- Defined in RCRTCEngine.ts:259
设置直播自定义音频流列表, 仅供直播主播用户使用

Parameters
- userIds: string[]
Returns number
{number} 错误码

setLiveMixCustomLayouts

setLiveMixCustomLayouts(layouts: RCRTCCustomLayout[]): number

Implementation of RCRTCEngineInterface.setLiveMixCustomLayouts
- Defined in RCRTCEngine.ts:256
设置直播混流布局配置, 仅供直播主播用户使用

Parameters
- layouts: RCRTCCustomLayout[]
Returns number
{number}

setLiveMixInnerCdnStreamView

setLiveMixInnerCdnStreamView(ref: string, callback: (code: number) => {}): void

Implementation of RCRTCEngineInterface.setLiveMixInnerCdnStreamView
- Defined in RCRTCEngine.ts:406
设置直播内置 cdn 流预览窗口

Parameters
- ref: string
- callback: (code: number) => {}
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void
0: 成功, 非0: 失败

setLiveMixLayoutMode

setLiveMixLayoutMode(mode: RCRTCLiveMixLayoutMode): number

Implementation of RCRTCEngineInterface.setLiveMixLayoutMode
- Defined in RCRTCEngine.ts:247
设置直播合流布局类型, 仅供直播主播用户使用

Parameters
- mode: RCRTCLiveMixLayoutMode
Returns number
{number} 错误码

setLiveMixRenderMode

setLiveMixRenderMode(mode: RCRTCLiveMixRenderMode): number

Implementation of RCRTCEngineInterface.setLiveMixRenderMode
- Defined in RCRTCEngine.ts:250
设置直播合流布局填充类型, 仅供直播主播用户使用

Parameters
- mode: RCRTCLiveMixRenderMode
Returns number
{number} 错误码

setLiveMixVideoBitrate

setLiveMixVideoBitrate(bitrate: number, tiny?: boolean): number

Implementation of RCRTCEngineInterface.setLiveMixVideoBitrate
- Defined in RCRTCEngine.ts:265
设置直播合流视频码率, 仅供直播主播用户使用

Parameters
- bitrate: number
- tiny: boolean = false
Returns number
{number}

setLiveMixVideoFps

setLiveMixVideoFps(fps: RCRTCVideoFps, tiny?: boolean): number

Implementation of RCRTCEngineInterface.setLiveMixVideoFps
- Defined in RCRTCEngine.ts:271
设置直播合流视频帧率, 仅供直播主播用户使用

Parameters
- fps: RCRTCVideoFps
- tiny: boolean = false
Returns number
{number}

setLiveMixVideoResolution

setLiveMixVideoResolution(width: number, height: number, tiny?: boolean): number

Implementation of RCRTCEngineInterface.setLiveMixVideoResolution
- Defined in RCRTCEngine.ts:268
设置直播合流视频分辨率, 仅供直播主播用户使用

Parameters
- width: number
- height: number
- tiny: boolean = false
Returns number
{number}

setLiveMixView

setLiveMixView(ref: string, callback: (code: number) => {}): void

Implementation of RCRTCEngineInterface.setLiveMixView
- Defined in RCRTCEngine.ts:226
设置合流视频窗口

Parameters
- ref: string
- callback: (code: number) => {}
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

setLocalCustomStreamView

setLocalCustomStreamView(tag: string, ref: string, callback: (code: number) => {}): void

Implementation of RCRTCEngineInterface.setLocalCustomStreamView
- Defined in RCRTCEngine.ts:358
设置自定义流预览窗口, 仅供会议用户或直播主播用户使用

Parameters
- tag: string
- ref: string
- callback: (code: number) => {}
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

setLocalLiveMixInnerCdnVideoFps

setLocalLiveMixInnerCdnVideoFps(fps: RCRTCVideoFps): number

- Defined in RCRTCEngine.ts:779
观众端设置订阅 cdn 流的帧率

Parameters
- fps: RCRTCVideoFps
  
  帧率
Returns number
接口调用状态码 0: 成功, 非0: 失败

setLocalLiveMixInnerCdnVideoResolution

setLocalLiveMixInnerCdnVideoResolution(width: number, height: number): number

- Defined in RCRTCEngine.ts:770
观众端设置订阅 cdn 流的分辨率

Parameters
- width: number
  
  分辨率宽
- height: number
  
  高
Returns number
接口调用状态码 0: 成功, 非0: 失败

setLocalView

setLocalView(ref: string, callback: (code: number) => {}): void

Implementation of RCRTCEngineInterface.setLocalView
- Defined in RCRTCEngine.ts:214
设置本地视频渲染窗口

Parameters
- ref: string
- callback: (code: number) => {}
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

setOnAudioEffectCreatedListener

setOnAudioEffectCreatedListener(callback?: (result: OnAudioEffectCreatedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnAudioEffectCreatedListener
- Defined in RCRTCEngine.ts:524
创建音效操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnAudioEffectCreatedResult) => void
  - - (result: OnAudioEffectCreatedResult): void
    - Parameters
      - result: OnAudioEffectCreatedResult
      Returns void
Returns void

setOnAudioEffectFinishedListener

setOnAudioEffectFinishedListener(callback?: (result: OnAudioEffectFinishedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnAudioEffectFinishedListener
- Defined in RCRTCEngine.ts:527
播放音效结束, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnAudioEffectFinishedResult) => void
  - - (result: OnAudioEffectFinishedResult): void
    - Parameters
      - result: OnAudioEffectFinishedResult
      Returns void
Returns void

setOnAudioMixingFinishedListener

setOnAudioMixingFinishedListener(callback?: (result: void) => void): void

Implementation of RCRTCEngineEventsInterface.setOnAudioMixingFinishedListener
- Defined in RCRTCEngine.ts:539
结束本地音频文件数据合流操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: void) => void
  - - (result: void): void
    - Parameters
      - result: void
      Returns void
Returns void

setOnAudioMixingPausedListener

setOnAudioMixingPausedListener(callback?: (result: void) => void): void

Implementation of RCRTCEngineEventsInterface.setOnAudioMixingPausedListener
- Defined in RCRTCEngine.ts:533
暂停本地音频数据合流操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: void) => void
  - - (result: void): void
    - Parameters
      - result: void
      Returns void
Returns void

setOnAudioMixingStartedListener

setOnAudioMixingStartedListener(callback?: (result: void) => void): void

Implementation of RCRTCEngineEventsInterface.setOnAudioMixingStartedListener
- Defined in RCRTCEngine.ts:530
开始本地音频数据合流操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: void) => void
  - - (result: void): void
    - Parameters
      - result: void
      Returns void
Returns void

setOnAudioMixingStoppedListener

setOnAudioMixingStoppedListener(callback?: (result: void) => void): void

Implementation of RCRTCEngineEventsInterface.setOnAudioMixingStoppedListener
- Defined in RCRTCEngine.ts:536
停止本地音频文件数据合流操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: void) => void
  - - (result: void): void
    - Parameters
      - result: void
      Returns void
Returns void

setOnCameraEnabledListener

setOnCameraEnabledListener(callback?: (result: OnCameraEnabledResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnCameraEnabledListener
- Defined in RCRTCEngine.ts:485
本地用户开关摄像头操作回调

Parameters
- Optional callback: (result: OnCameraEnabledResult) => void
  - - (result: OnCameraEnabledResult): void
    - Parameters
      - result: OnCameraEnabledResult
      Returns void
Returns void

setOnCameraSwitchedListener

setOnCameraSwitchedListener(callback?: (result: OnCameraSwitchedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnCameraSwitchedListener
- Defined in RCRTCEngine.ts:488
本地用户切换前后置摄像头操作回调

Parameters
- Optional callback: (result: OnCameraSwitchedResult) => void
  - - (result: OnCameraSwitchedResult): void
    - Parameters
      - result: OnCameraSwitchedResult
      Returns void
Returns void

setOnCancelJoinSubRoomRequestReceivedListener

setOnCancelJoinSubRoomRequestReceivedListener(callback?: (result: OnCancelJoinSubRoomRequestReceivedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnCancelJoinSubRoomRequestReceivedListener
- Defined in RCRTCEngine.ts:615
收到取消加入请求回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnCancelJoinSubRoomRequestReceivedResult) => void
  - - (result: OnCancelJoinSubRoomRequestReceivedResult): void
    - Parameters
      - result: OnCancelJoinSubRoomRequestReceivedResult
      Returns void
Returns void

setOnCustomStreamPublishFinishedListener

setOnCustomStreamPublishFinishedListener(callback?: (result: OnCustomStreamPublishFinishedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnCustomStreamPublishFinishedListener
- Defined in RCRTCEngine.ts:578
本地自定义流发布结束回调

Parameters
- Optional callback: (result: OnCustomStreamPublishFinishedResult) => void
  - - (result: OnCustomStreamPublishFinishedResult): void
    - Parameters
      - result: OnCustomStreamPublishFinishedResult
      Returns void
Returns void

setOnCustomStreamPublishedListener

setOnCustomStreamPublishedListener(callback?: (result: OnCustomStreamPublishedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnCustomStreamPublishedListener
- Defined in RCRTCEngine.ts:572
本地用户发布本地自定义流操作回调

Parameters
- Optional callback: (result: OnCustomStreamPublishedResult) => void
  - - (result: OnCustomStreamPublishedResult): void
    - Parameters
      - result: OnCustomStreamPublishedResult
      Returns void
Returns void

setOnCustomStreamSubscribedListener

setOnCustomStreamSubscribedListener(callback?: (result: OnCustomStreamSubscribedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnCustomStreamSubscribedListener
- Defined in RCRTCEngine.ts:597
订阅远端用户发布的自定义流操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnCustomStreamSubscribedResult) => void
  - - (result: OnCustomStreamSubscribedResult): void
    - Parameters
      - result: OnCustomStreamSubscribedResult
      Returns void
Returns void

setOnCustomStreamUnpublishedListener

setOnCustomStreamUnpublishedListener(callback?: (result: OnCustomStreamUnpublishedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnCustomStreamUnpublishedListener
- Defined in RCRTCEngine.ts:575
本地用户取消发布本地自定义流操作回调

Parameters
- Optional callback: (result: OnCustomStreamUnpublishedResult) => void
  - - (result: OnCustomStreamUnpublishedResult): void
    - Parameters
      - result: OnCustomStreamUnpublishedResult
      Returns void
Returns void

setOnCustomStreamUnsubscribedListener

setOnCustomStreamUnsubscribedListener(callback?: (result: OnCustomStreamUnsubscribedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnCustomStreamUnsubscribedListener
- Defined in RCRTCEngine.ts:600
取消订阅远端用户发布的自定义流操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnCustomStreamUnsubscribedResult) => void
  - - (result: OnCustomStreamUnsubscribedResult): void
    - Parameters
      - result: OnCustomStreamUnsubscribedResult
      Returns void
Returns void

setOnErrorListener

setOnErrorListener(callback?: (result: OnErrorResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnErrorListener
- Defined in RCRTCEngine.ts:455
本地用户操作错误回调

Parameters
- Optional callback: (result: OnErrorResult) => void
  - - (result: OnErrorResult): void
    - Parameters
      - result: OnErrorResult
      Returns void
Returns void

setOnJoinSubRoomRequestCanceledListener

setOnJoinSubRoomRequestCanceledListener(callback?: (result: OnJoinSubRoomRequestCanceledResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnJoinSubRoomRequestCanceledListener
- Defined in RCRTCEngine.ts:606
取消请求加入子房间回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnJoinSubRoomRequestCanceledResult) => void
  - - (result: OnJoinSubRoomRequestCanceledResult): void
    - Parameters
      - result: OnJoinSubRoomRequestCanceledResult
      Returns void
Returns void

setOnJoinSubRoomRequestReceivedListener

setOnJoinSubRoomRequestReceivedListener(callback?: (result: OnJoinSubRoomRequestReceivedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnJoinSubRoomRequestReceivedListener
- Defined in RCRTCEngine.ts:612
收到加入请求回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnJoinSubRoomRequestReceivedResult) => void
  - - (result: OnJoinSubRoomRequestReceivedResult): void
    - Parameters
      - result: OnJoinSubRoomRequestReceivedResult
      Returns void
Returns void

setOnJoinSubRoomRequestRespondedListener

setOnJoinSubRoomRequestRespondedListener(callback?: (result: OnJoinSubRoomRequestRespondedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnJoinSubRoomRequestRespondedListener
- Defined in RCRTCEngine.ts:609
响应请求加入子房间回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnJoinSubRoomRequestRespondedResult) => void
  - - (result: OnJoinSubRoomRequestRespondedResult): void
    - Parameters
      - result: OnJoinSubRoomRequestRespondedResult
      Returns void
Returns void

setOnJoinSubRoomRequestResponseReceivedListener

setOnJoinSubRoomRequestResponseReceivedListener(callback?: (result: OnJoinSubRoomRequestResponseReceivedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnJoinSubRoomRequestResponseReceivedListener
- Defined in RCRTCEngine.ts:620
收到加入请求响应回调仅供直播主播用户使用

Parameters
- Optional callback: (result: OnJoinSubRoomRequestResponseReceivedResult) => void
  - - (result: OnJoinSubRoomRequestResponseReceivedResult): void
    - Parameters
      - result: OnJoinSubRoomRequestResponseReceivedResult
      Returns void
Returns void

setOnJoinSubRoomRequestedListener

setOnJoinSubRoomRequestedListener(callback?: (result: OnJoinSubRoomRequestedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnJoinSubRoomRequestedListener
- Defined in RCRTCEngine.ts:603
请求加入子房间回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnJoinSubRoomRequestedResult) => void
  - - (result: OnJoinSubRoomRequestedResult): void
    - Parameters
      - result: OnJoinSubRoomRequestedResult
      Returns void
Returns void

setOnKickedListener

setOnKickedListener(callback?: (result: OnKickedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnKickedListener
- Defined in RCRTCEngine.ts:458
本地用户被踢出房间回调

Parameters
- Optional callback: (result: OnKickedResult) => void
  - - (result: OnKickedResult): void
    - Parameters
      - result: OnKickedResult
      Returns void
Returns void

setOnLiveCdnAddedListener

setOnLiveCdnAddedListener(callback?: (result: OnLiveCdnAddedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnLiveCdnAddedListener
- Defined in RCRTCEngine.ts:491
添加旁路推流URL操作回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnLiveCdnAddedResult) => void
  - - (result: OnLiveCdnAddedResult): void
    - Parameters
      - result: OnLiveCdnAddedResult
      Returns void
Returns void

setOnLiveCdnRemovedListener

setOnLiveCdnRemovedListener(callback?: (result: OnLiveCdnRemovedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnLiveCdnRemovedListener
- Defined in RCRTCEngine.ts:494
移除旁路推流URL操作回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnLiveCdnRemovedResult) => void
  - - (result: OnLiveCdnRemovedResult): void
    - Parameters
      - result: OnLiveCdnRemovedResult
      Returns void
Returns void

setOnLiveMixAudioBitrateSetListener

setOnLiveMixAudioBitrateSetListener(callback?: (result: OnLiveMixAudioBitrateSetResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnLiveMixAudioBitrateSetListener
- Defined in RCRTCEngine.ts:512
设置合流音频码率操作回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnLiveMixAudioBitrateSetResult) => void
  - - (result: OnLiveMixAudioBitrateSetResult): void
    - Parameters
      - result: OnLiveMixAudioBitrateSetResult
      Returns void
Returns void

setOnLiveMixAudioStatsListener

setOnLiveMixAudioStatsListener(callback?: (result: RCRTCRemoteAudioStats) => void): void

Implementation of RCRTCStatsEventsInterface.setOnLiveMixAudioStatsListener
- Defined in RCRTCEngine.ts:655
上报远端合流音频统计信息

Parameters
- Optional callback: (result: RCRTCRemoteAudioStats) => void
  - - (result: RCRTCRemoteAudioStats): void
    - Parameters
      - result: RCRTCRemoteAudioStats
      Returns void
Returns void

setOnLiveMixBackgroundColorSetListener

setOnLiveMixBackgroundColorSetListener(callback?: BaseCallback<OnLiveMixBackgroundColorSetResult>): void

Implementation of RCRTCEngineEventsInterface.setOnLiveMixBackgroundColorSetListener
- Defined in RCRTCEngine.ts:503
设置合流布局背景颜色操作回调, 仅供直播主播用户使用

Parameters
- Optional callback: BaseCallback<OnLiveMixBackgroundColorSetResult>
Returns void

setOnLiveMixCustomAudiosSetListener

setOnLiveMixCustomAudiosSetListener(callback?: (result: OnLiveMixCustomAudiosSetResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnLiveMixCustomAudiosSetListener
- Defined in RCRTCEngine.ts:506
设置需要合流音频操作回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnLiveMixCustomAudiosSetResult) => void
  - - (result: OnLiveMixCustomAudiosSetResult): void
    - Parameters
      - result: OnLiveMixCustomAudiosSetResult
      Returns void
Returns void

setOnLiveMixCustomLayoutsSetListener

setOnLiveMixCustomLayoutsSetListener(callback?: (result: OnLiveMixCustomLayoutsSetResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnLiveMixCustomLayoutsSetListener
- Defined in RCRTCEngine.ts:509
设置合流自定义布局操作回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnLiveMixCustomLayoutsSetResult) => void
  - - (result: OnLiveMixCustomLayoutsSetResult): void
    - Parameters
      - result: OnLiveMixCustomLayoutsSetResult
      Returns void
Returns void

setOnLiveMixInnerCdnStreamEnabledListener

setOnLiveMixInnerCdnStreamEnabledListener(callback?: (res: OnLiveMixInnerCdnStreamEnabledResult) => void): void

- Defined in RCRTCEngine.ts:854
开启直播内置 cdn 结果回调

Parameters
- Optional callback: (res: OnLiveMixInnerCdnStreamEnabledResult) => void
  - - (res: OnLiveMixInnerCdnStreamEnabledResult): void
    - Parameters
      - res: OnLiveMixInnerCdnStreamEnabledResult
      Returns void
Returns void

setOnLiveMixInnerCdnStreamSubscribedListener

setOnLiveMixInnerCdnStreamSubscribedListener(callback?: (res: OnLiveMixInnerCdnStreamSubscribedResult) => void): void

- Defined in RCRTCEngine.ts:886
订阅直播内置 cdn 资源回调

Parameters
- Optional callback: (res: OnLiveMixInnerCdnStreamSubscribedResult) => void
  - - (res: OnLiveMixInnerCdnStreamSubscribedResult): void
    - Parameters
      - res: OnLiveMixInnerCdnStreamSubscribedResult
      Returns void
Returns void

setOnLiveMixInnerCdnStreamUnsubscribedListener

setOnLiveMixInnerCdnStreamUnsubscribedListener(callback?: (res: OnLiveMixInnerCdnStreamUnsubscribedResult) => void): void

- Defined in RCRTCEngine.ts:896
取消订阅直播内置 cdn 资源回调

Parameters
- Optional callback: (res: OnLiveMixInnerCdnStreamUnsubscribedResult) => void
  - - (res: OnLiveMixInnerCdnStreamUnsubscribedResult): void
    - Parameters
      - res: OnLiveMixInnerCdnStreamUnsubscribedResult
      Returns void
Returns void

setOnLiveMixLayoutModeSetListener

setOnLiveMixLayoutModeSetListener(callback?: (result: OnLiveMixLayoutModeSetResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnLiveMixLayoutModeSetListener
- Defined in RCRTCEngine.ts:497
设置合流布局类型操作回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnLiveMixLayoutModeSetResult) => void
  - - (result: OnLiveMixLayoutModeSetResult): void
    - Parameters
      - result: OnLiveMixLayoutModeSetResult
      Returns void
Returns void

setOnLiveMixMemberAudioStatsListener

setOnLiveMixMemberAudioStatsListener(callback?: (result: OnLiveMixMemberAudioStatsResult) => void): void

Implementation of RCRTCStatsEventsInterface.setOnLiveMixMemberAudioStatsListener
- Defined in RCRTCEngine.ts:661
上报远端分流音频统计信息

Parameters
- Optional callback: (result: OnLiveMixMemberAudioStatsResult) => void
  - - (result: OnLiveMixMemberAudioStatsResult): void
    - Parameters
      - result: OnLiveMixMemberAudioStatsResult
      Returns void
Returns void

setOnLiveMixMemberCustomAudioStatsListener

setOnLiveMixMemberCustomAudioStatsListener(callback?: (result: OnLiveMixMemberCustomAudioStatsResult) => void): void

Implementation of RCRTCStatsEventsInterface.setOnLiveMixMemberCustomAudioStatsListener
- Defined in RCRTCEngine.ts:664
上报远端分流自定义音频统计信息

Parameters
- Optional callback: (result: OnLiveMixMemberCustomAudioStatsResult) => void
  - - (result: OnLiveMixMemberCustomAudioStatsResult): void
    - Parameters
      - result: OnLiveMixMemberCustomAudioStatsResult
      Returns void
Returns void

setOnLiveMixRenderModeSetListener

setOnLiveMixRenderModeSetListener(callback?: (result: OnLiveMixRenderModeSetResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnLiveMixRenderModeSetListener
- Defined in RCRTCEngine.ts:500
设置合流布局填充类型操作回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnLiveMixRenderModeSetResult) => void
  - - (result: OnLiveMixRenderModeSetResult): void
    - Parameters
      - result: OnLiveMixRenderModeSetResult
      Returns void
Returns void

setOnLiveMixSeiReceivedListener

setOnLiveMixSeiReceivedListener(callback?: (res: OnLiveMixSeiReceivedResult) => void): void

- Defined in RCRTCEngine.ts:974
观众收到合流 SEI 信息回调

Parameters
- Optional callback: (res: OnLiveMixSeiReceivedResult) => void
  - - (res: OnLiveMixSeiReceivedResult): void
    - Parameters
      - res: OnLiveMixSeiReceivedResult
      Returns void
Returns void

setOnLiveMixSubscribedListener

setOnLiveMixSubscribedListener(callback?: (result: OnLiveMixSubscribedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnLiveMixSubscribedListener
- Defined in RCRTCEngine.ts:479
订阅合流资源操作回调, 仅供直播观众用户使用

Parameters
- Optional callback: (result: OnLiveMixSubscribedResult) => void
  - - (result: OnLiveMixSubscribedResult): void
    - Parameters
      - result: OnLiveMixSubscribedResult
      Returns void
Returns void

setOnLiveMixUnsubscribedListener

setOnLiveMixUnsubscribedListener(callback?: (result: OnLiveMixUnsubscribedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnLiveMixUnsubscribedListener
- Defined in RCRTCEngine.ts:482
取消订阅合流资源操作回调, 仅供直播观众用户使用

Parameters
- Optional callback: (result: OnLiveMixUnsubscribedResult) => void
  - - (result: OnLiveMixUnsubscribedResult): void
    - Parameters
      - result: OnLiveMixUnsubscribedResult
      Returns void
Returns void

setOnLiveMixVideoBitrateSetListener

setOnLiveMixVideoBitrateSetListener(callback?: (result: OnLiveMixVideoBitrateSetResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnLiveMixVideoBitrateSetListener
- Defined in RCRTCEngine.ts:515
设置默认视频合流码率操作回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnLiveMixVideoBitrateSetResult) => void
  - - (result: OnLiveMixVideoBitrateSetResult): void
    - Parameters
      - result: OnLiveMixVideoBitrateSetResult
      Returns void
Returns void

setOnLiveMixVideoFpsSetListener

setOnLiveMixVideoFpsSetListener(callback?: (result: OnLiveMixVideoFpsSetResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnLiveMixVideoFpsSetListener
- Defined in RCRTCEngine.ts:521
设置默认视频帧率操作回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnLiveMixVideoFpsSetResult) => void
  - - (result: OnLiveMixVideoFpsSetResult): void
    - Parameters
      - result: OnLiveMixVideoFpsSetResult
      Returns void
Returns void

setOnLiveMixVideoResolutionSetListener

setOnLiveMixVideoResolutionSetListener(callback?: (result: OnLiveMixVideoResolutionSetResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnLiveMixVideoResolutionSetListener
- Defined in RCRTCEngine.ts:518
设置默认视频分辨率操作回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnLiveMixVideoResolutionSetResult) => void
  - - (result: OnLiveMixVideoResolutionSetResult): void
    - Parameters
      - result: OnLiveMixVideoResolutionSetResult
      Returns void
Returns void

setOnLiveMixVideoStatsListener

setOnLiveMixVideoStatsListener(callback?: (result: RCRTCRemoteVideoStats) => void): void

Implementation of RCRTCStatsEventsInterface.setOnLiveMixVideoStatsListener
- Defined in RCRTCEngine.ts:658
上报远端合流视频统计信息

Parameters
- Optional callback: (result: RCRTCRemoteVideoStats) => void
  - - (result: RCRTCRemoteVideoStats): void
    - Parameters
      - result: RCRTCRemoteVideoStats
      Returns void
Returns void

setOnLiveRoleSwitchedListener

setOnLiveRoleSwitchedListener(callback?: (res: OnLiveRoleSwitchedResult) => void): void

- Defined in RCRTCEngine.ts:701
角色切换回调

Parameters
- Optional callback: (res: OnLiveRoleSwitchedResult) => void
  - - (res: OnLiveRoleSwitchedResult): void
    - Parameters
      - res: OnLiveRoleSwitchedResult
      Returns void
Returns void

setOnLocalAudioStatsListener

setOnLocalAudioStatsListener(callback?: (result: RCRTCLocalAudioStats) => void): void

Implementation of RCRTCStatsEventsInterface.setOnLocalAudioStatsListener
- Defined in RCRTCEngine.ts:643
上报本地音频统计信息

Parameters
- Optional callback: (result: RCRTCLocalAudioStats) => void
  - - (result: RCRTCLocalAudioStats): void
    - Parameters
      - result: RCRTCLocalAudioStats
      Returns void
Returns void

setOnLocalCustomAudioStatsListener

setOnLocalCustomAudioStatsListener(callback?: (result: OnLocalCustomAudioStatsResult) => void): void

Implementation of RCRTCStatsEventsInterface.setOnLocalCustomAudioStatsListener
- Defined in RCRTCEngine.ts:669
上报本地自定义音频统计信息

Parameters
- Optional callback: (result: OnLocalCustomAudioStatsResult) => void
  - - (result: OnLocalCustomAudioStatsResult): void
    - Parameters
      - result: OnLocalCustomAudioStatsResult
      Returns void
Returns void

setOnLocalCustomVideoStatsListener

setOnLocalCustomVideoStatsListener(callback?: (result: OnLocalCustomVideoStatsResult) => void): void

Implementation of RCRTCStatsEventsInterface.setOnLocalCustomVideoStatsListener
- Defined in RCRTCEngine.ts:672
上报本地自定义视频统计信息

Parameters
- Optional callback: (result: OnLocalCustomVideoStatsResult) => void
  - - (result: OnLocalCustomVideoStatsResult): void
    - Parameters
      - result: OnLocalCustomVideoStatsResult
      Returns void
Returns void

setOnLocalLiveMixInnerCdnVideoFpsSetListener

setOnLocalLiveMixInnerCdnVideoFpsSetListener(callback?: (res: OnLocalLiveMixInnerCdnVideoFpsSetResult) => void): void

- Defined in RCRTCEngine.ts:916
观众端设置订阅 cdn 流的帧率的回调

Parameters
- Optional callback: (res: OnLocalLiveMixInnerCdnVideoFpsSetResult) => void
  - - (res: OnLocalLiveMixInnerCdnVideoFpsSetResult): void
    - Parameters
      - res: OnLocalLiveMixInnerCdnVideoFpsSetResult
      Returns void
Returns void

setOnLocalLiveMixInnerCdnVideoResolutionSetListener

setOnLocalLiveMixInnerCdnVideoResolutionSetListener(callback?: (res: OnLocalLiveMixInnerCdnVideoResolutionSetResult) => void): void

- Defined in RCRTCEngine.ts:906
观众端设置订阅 cdn 流的分辨率的回调

Parameters
- Optional callback: (res: OnLocalLiveMixInnerCdnVideoResolutionSetResult) => void
  - - (res: OnLocalLiveMixInnerCdnVideoResolutionSetResult): void
    - Parameters
      - res: OnLocalLiveMixInnerCdnVideoResolutionSetResult
      Returns void
Returns void

setOnLocalVideoStatsListener

setOnLocalVideoStatsListener(callback?: (result: RCRTCLocalVideoStats) => void): void

Implementation of RCRTCStatsEventsInterface.setOnLocalVideoStatsListener
- Defined in RCRTCEngine.ts:646
上报本地视频统计信息

Parameters
- Optional callback: (result: RCRTCLocalVideoStats) => void
  - - (result: RCRTCLocalVideoStats): void
    - Parameters
      - result: RCRTCLocalVideoStats
      Returns void
Returns void

setOnNetworkProbeDownLinkStatsListener

setOnNetworkProbeDownLinkStatsListener(callback?: (res: OnNetworkProbeDownLinkStatsResult) => void): void

- Defined in RCRTCEngine.ts:693
网络检测下行回调

Parameters
- Optional callback: (res: OnNetworkProbeDownLinkStatsResult) => void
  - - (res: OnNetworkProbeDownLinkStatsResult): void
    - Parameters
      - res: OnNetworkProbeDownLinkStatsResult
      Returns void
Returns void

setOnNetworkProbeFinishedListener

setOnNetworkProbeFinishedListener(callback?: (res: OnNetworkProbeFinishedResult) => void): void

- Defined in RCRTCEngine.ts:979
Parameters
- Optional callback: (res: OnNetworkProbeFinishedResult) => void
  - - (res: OnNetworkProbeFinishedResult): void
    - Parameters
      - res: OnNetworkProbeFinishedResult
      Returns void
Returns void

setOnNetworkProbeStartedListener

setOnNetworkProbeStartedListener(callback?: (res: OnNetworkProbeStartedResult) => void): void

- Defined in RCRTCEngine.ts:942
开启网络探测结果回调

Parameters
- Optional callback: (res: OnNetworkProbeStartedResult) => void
  - - (res: OnNetworkProbeStartedResult): void
    - Parameters
      - res: OnNetworkProbeStartedResult
      Returns void
Returns void

setOnNetworkProbeStoppedListener

setOnNetworkProbeStoppedListener(callback?: (res: OnNetworkProbeStoppedResult) => void): void

- Defined in RCRTCEngine.ts:950
关闭网络探测结果回调

Parameters
- Optional callback: (res: OnNetworkProbeStoppedResult) => void
  - - (res: OnNetworkProbeStoppedResult): void
    - Parameters
      - res: OnNetworkProbeStoppedResult
      Returns void
Returns void

setOnNetworkProbeUpLinkStatsListener

setOnNetworkProbeUpLinkStatsListener(callback?: (res: OnNetworkProbeUpLinkStatsResult) => void): void

- Defined in RCRTCEngine.ts:685
网络检测上行回调

Parameters
- Optional callback: (res: OnNetworkProbeUpLinkStatsResult) => void
  - - (res: OnNetworkProbeUpLinkStatsResult): void
    - Parameters
      - res: OnNetworkProbeUpLinkStatsResult
      Returns void
Returns void

setOnNetworkStatsListener

setOnNetworkStatsListener(callback?: (result: RCRTCNetworkStats) => void): void

Implementation of RCRTCStatsEventsInterface.setOnNetworkStatsListener
- Defined in RCRTCEngine.ts:640
上报网络状态统计信息

Parameters
- Optional callback: (result: RCRTCNetworkStats) => void
  - - (result: RCRTCNetworkStats): void
    - Parameters
      - result: RCRTCNetworkStats
      Returns void
Returns void

setOnPublishedListener

setOnPublishedListener(callback?: (result: OnPublishedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnPublishedListener
- Defined in RCRTCEngine.ts:467
本地用户发布资源回调

Parameters
- Optional callback: (result: OnPublishedResult) => void
  - - (result: OnPublishedResult): void
    - Parameters
      - result: OnPublishedResult
      Returns void
Returns void

setOnRemoteAudioStatsListener

setOnRemoteAudioStatsListener(callback?: (result: OnRemoteAudioStatsResult) => void): void

Implementation of RCRTCStatsEventsInterface.setOnRemoteAudioStatsListener
- Defined in RCRTCEngine.ts:649
上报远端音频统计信息

Parameters
- Optional callback: (result: OnRemoteAudioStatsResult) => void
  - - (result: OnRemoteAudioStatsResult): void
    - Parameters
      - result: OnRemoteAudioStatsResult
      Returns void
Returns void

setOnRemoteCustomAudioStatsListener

setOnRemoteCustomAudioStatsListener(callback?: (result: OnRemoteCustomAudioStatsResult) => void): void

Implementation of RCRTCStatsEventsInterface.setOnRemoteCustomAudioStatsListener
- Defined in RCRTCEngine.ts:675
上报远端自定义音频统计信息

Parameters
- Optional callback: (result: OnRemoteCustomAudioStatsResult) => void
  - - (result: OnRemoteCustomAudioStatsResult): void
    - Parameters
      - result: OnRemoteCustomAudioStatsResult
      Returns void
Returns void

setOnRemoteCustomStreamFirstFrameListener

setOnRemoteCustomStreamFirstFrameListener(callback?: (result: OnRemoteCustomStreamFirstFrameResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRemoteCustomStreamFirstFrameListener
- Defined in RCRTCEngine.ts:594
收到远端用户自定义流第一个关键帧回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnRemoteCustomStreamFirstFrameResult) => void
  - - (result: OnRemoteCustomStreamFirstFrameResult): void
    - Parameters
      - result: OnRemoteCustomStreamFirstFrameResult
      Returns void
Returns void

setOnRemoteCustomStreamPublishedListener

setOnRemoteCustomStreamPublishedListener(callback?: (result: OnRemoteCustomStreamPublishedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRemoteCustomStreamPublishedListener
- Defined in RCRTCEngine.ts:581
远端用户发布自定义流操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnRemoteCustomStreamPublishedResult) => void
  - - (result: OnRemoteCustomStreamPublishedResult): void
    - Parameters
      - result: OnRemoteCustomStreamPublishedResult
      Returns void
Returns void

setOnRemoteCustomStreamStateChangedListener

setOnRemoteCustomStreamStateChangedListener(callback?: (result: OnRemoteCustomStreamStateChangedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRemoteCustomStreamStateChangedListener
- Defined in RCRTCEngine.ts:589
远端用户开关自定义流操作回调

Parameters
- Optional callback: (result: OnRemoteCustomStreamStateChangedResult) => void
  - - (result: OnRemoteCustomStreamStateChangedResult): void
    - Parameters
      - result: OnRemoteCustomStreamStateChangedResult
      Returns void
Returns void

setOnRemoteCustomStreamUnpublishedListener

setOnRemoteCustomStreamUnpublishedListener(callback?: (result: OnRemoteCustomStreamUnpublishedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRemoteCustomStreamUnpublishedListener
- Defined in RCRTCEngine.ts:584
远端用户取消发布自定义流操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnRemoteCustomStreamUnpublishedResult) => void
  - - (result: OnRemoteCustomStreamUnpublishedResult): void
    - Parameters
      - result: OnRemoteCustomStreamUnpublishedResult
      Returns void
Returns void

setOnRemoteCustomVideoStatsListener

setOnRemoteCustomVideoStatsListener(callback?: (result: OnRemoteCustomVideoStatsResult) => void): void

Implementation of RCRTCStatsEventsInterface.setOnRemoteCustomVideoStatsListener
- Defined in RCRTCEngine.ts:678
上报远端自定义视频统计信息

Parameters
- Optional callback: (result: OnRemoteCustomVideoStatsResult) => void
  - - (result: OnRemoteCustomVideoStatsResult): void
    - Parameters
      - result: OnRemoteCustomVideoStatsResult
      Returns void
Returns void

setOnRemoteFirstFrameListener

setOnRemoteFirstFrameListener(callback?: (result: OnRemoteFirstFrameResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRemoteFirstFrameListener
- Defined in RCRTCEngine.ts:566
收到远端用户第一个音频或视频关键帧回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnRemoteFirstFrameResult) => void
  - - (result: OnRemoteFirstFrameResult): void
    - Parameters
      - result: OnRemoteFirstFrameResult
      Returns void
Returns void

setOnRemoteLiveMixFirstFrameListener

setOnRemoteLiveMixFirstFrameListener(callback?: (result: OnRemoteLiveMixFirstFrameResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRemoteLiveMixFirstFrameListener
- Defined in RCRTCEngine.ts:569
收到远端用户第一个音频或视频关键帧回调, 仅供直播观众用户使用

Parameters
- Optional callback: (result: OnRemoteLiveMixFirstFrameResult) => void
  - - (result: OnRemoteLiveMixFirstFrameResult): void
    - Parameters
      - result: OnRemoteLiveMixFirstFrameResult
      Returns void
Returns void

setOnRemoteLiveMixInnerCdnStreamPublishedListener

setOnRemoteLiveMixInnerCdnStreamPublishedListener(callback?: (res: OnRemoteLiveMixInnerCdnStreamPublishedResult) => void): void

- Defined in RCRTCEngine.ts:864
直播内置 cdn 资源发布回调

Parameters
- Optional callback: (res: OnRemoteLiveMixInnerCdnStreamPublishedResult) => void
  - - (res: OnRemoteLiveMixInnerCdnStreamPublishedResult): void
    - Parameters
      - res: OnRemoteLiveMixInnerCdnStreamPublishedResult
      Returns void
Returns void

setOnRemoteLiveMixInnerCdnStreamUnpublishedListener

setOnRemoteLiveMixInnerCdnStreamUnpublishedListener(callback?: (res: OnRemoteLiveMixInnerCdnStreamUnpublishedResult) => void): void

- Defined in RCRTCEngine.ts:876
直播内置 cdn 资源取消发布回调

Parameters
- Optional callback: (res: OnRemoteLiveMixInnerCdnStreamUnpublishedResult) => void
  - - (res: OnRemoteLiveMixInnerCdnStreamUnpublishedResult): void
    - Parameters
      - res: OnRemoteLiveMixInnerCdnStreamUnpublishedResult
      Returns void
Returns void

setOnRemoteLiveMixPublishedListener

setOnRemoteLiveMixPublishedListener(callback?: (result: OnRemoteLiveMixPublishedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRemoteLiveMixPublishedListener
- Defined in RCRTCEngine.ts:557
远端用户发布直播资源操作回调, 仅供直播观众用户使用

Parameters
- Optional callback: (result: OnRemoteLiveMixPublishedResult) => void
  - - (result: OnRemoteLiveMixPublishedResult): void
    - Parameters
      - result: OnRemoteLiveMixPublishedResult
      Returns void
Returns void

setOnRemoteLiveMixUnpublishedListener

setOnRemoteLiveMixUnpublishedListener(callback?: (result: OnRemoteLiveMixUnpublishedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRemoteLiveMixUnpublishedListener
- Defined in RCRTCEngine.ts:560
远端用户取消发布直播资源操作回调, 仅供直播观众用户使用

Parameters
- Optional callback: (result: OnRemoteLiveMixUnpublishedResult) => void
  - - (result: OnRemoteLiveMixUnpublishedResult): void
    - Parameters
      - result: OnRemoteLiveMixUnpublishedResult
      Returns void
Returns void

setOnRemoteLiveRoleSwitchedListener

setOnRemoteLiveRoleSwitchedListener(callback?: (res: OnRemoteLiveRoleSwitchedResult) => void): void

- Defined in RCRTCEngine.ts:709
远端角色切换回调

Parameters
- Optional callback: (res: OnRemoteLiveRoleSwitchedResult) => void
  - - (res: OnRemoteLiveRoleSwitchedResult): void
    - Parameters
      - res: OnRemoteLiveRoleSwitchedResult
      Returns void
Returns void

setOnRemotePublishedListener

setOnRemotePublishedListener(callback?: (result: OnRemotePublishedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRemotePublishedListener
- Defined in RCRTCEngine.ts:551
远端用户发布资源操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnRemotePublishedResult) => void
  - - (result: OnRemotePublishedResult): void
    - Parameters
      - result: OnRemotePublishedResult
      Returns void
Returns void

setOnRemoteStateChangedListener

setOnRemoteStateChangedListener(callback?: (result: OnRemoteStateChangedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRemoteStateChangedListener
- Defined in RCRTCEngine.ts:563
远端用户开关麦克风或摄像头操作回调

Parameters
- Optional callback: (result: OnRemoteStateChangedResult) => void
  - - (result: OnRemoteStateChangedResult): void
    - Parameters
      - result: OnRemoteStateChangedResult
      Returns void
Returns void

setOnRemoteUnpublishedListener

setOnRemoteUnpublishedListener(callback?: (result: OnRemoteUnpublishedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRemoteUnpublishedListener
- Defined in RCRTCEngine.ts:554
远端用户取消发布资源操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnRemoteUnpublishedResult) => void
  - - (result: OnRemoteUnpublishedResult): void
    - Parameters
      - result: OnRemoteUnpublishedResult
      Returns void
Returns void

setOnRemoteVideoStatsListener

setOnRemoteVideoStatsListener(callback?: (result: OnRemoteVideoStatsResult) => void): void

Implementation of RCRTCStatsEventsInterface.setOnRemoteVideoStatsListener
- Defined in RCRTCEngine.ts:652
上报远端视频统计信息

Parameters
- Optional callback: (result: OnRemoteVideoStatsResult) => void
  - - (result: OnRemoteVideoStatsResult): void
    - Parameters
      - result: OnRemoteVideoStatsResult
      Returns void
Returns void

setOnRoomJoinedListener

setOnRoomJoinedListener(callback?: (result: OnRoomJoinedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRoomJoinedListener
- Defined in RCRTCEngine.ts:461
本地用户加入房间回调

Parameters
- Optional callback: (result: OnRoomJoinedResult) => void
  - - (result: OnRoomJoinedResult): void
    - Parameters
      - result: OnRoomJoinedResult
      Returns void
Returns void

setOnRoomLeftListener

setOnRoomLeftListener(callback?: (result: OnRoomLeftResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnRoomLeftListener
- Defined in RCRTCEngine.ts:464
本地用户离开房间回调

Parameters
- Optional callback: (result: OnRoomLeftResult) => void
  - - (result: OnRoomLeftResult): void
    - Parameters
      - result: OnRoomLeftResult
      Returns void
Returns void

setOnSeiEnabledListener

setOnSeiEnabledListener(callback?: (res: OnSeiEnabledResult) => void): void

- Defined in RCRTCEngine.ts:958
开启 SEI 功能结果回调

Parameters
- Optional callback: (res: OnSeiEnabledResult) => void
  - - (res: OnSeiEnabledResult): void
    - Parameters
      - res: OnSeiEnabledResult
      Returns void
Returns void

setOnSeiReceivedListener

setOnSeiReceivedListener(callback?: (res: OnSeiReceivedResult) => void): void

- Defined in RCRTCEngine.ts:966
收到 SEI 信息回调

Parameters
- Optional callback: (res: OnSeiReceivedResult) => void
  - - (res: OnSeiReceivedResult): void
    - Parameters
      - res: OnSeiReceivedResult
      Returns void
Returns void

setOnSubRoomBandedListener

setOnSubRoomBandedListener(callback?: (result: OnSubRoomBandedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnSubRoomBandedListener
- Defined in RCRTCEngine.ts:631
连麦中的子房间回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnSubRoomBandedResult) => void
  - - (result: OnSubRoomBandedResult): void
    - Parameters
      - result: OnSubRoomBandedResult
      Returns void
Returns void

setOnSubRoomDisbandListener

setOnSubRoomDisbandListener(callback?: (result: OnSubRoomDisbandResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnSubRoomDisbandListener
- Defined in RCRTCEngine.ts:634
子房间结束连麦回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnSubRoomDisbandResult) => void
  - - (result: OnSubRoomDisbandResult): void
    - Parameters
      - result: OnSubRoomDisbandResult
      Returns void
Returns void

setOnSubRoomJoinedListener

setOnSubRoomJoinedListener(callback?: (result: OnSubRoomJoinedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnSubRoomJoinedListener
- Defined in RCRTCEngine.ts:625
加入子房间回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnSubRoomJoinedResult) => void
  - - (result: OnSubRoomJoinedResult): void
    - Parameters
      - result: OnSubRoomJoinedResult
      Returns void
Returns void

setOnSubRoomLeftListener

setOnSubRoomLeftListener(callback?: (result: OnSubRoomLeftResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnSubRoomLeftListener
- Defined in RCRTCEngine.ts:628
离开子房间回调, 仅供直播主播用户使用

Parameters
- Optional callback: (result: OnSubRoomLeftResult) => void
  - - (result: OnSubRoomLeftResult): void
    - Parameters
      - result: OnSubRoomLeftResult
      Returns void
Returns void

setOnSubscribedListener

setOnSubscribedListener(callback?: (result: OnSubscribedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnSubscribedListener
- Defined in RCRTCEngine.ts:473
订阅远端用户发布的资源操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnSubscribedResult) => void
  - - (result: OnSubscribedResult): void
    - Parameters
      - result: OnSubscribedResult
      Returns void
Returns void

setOnUnpublishedListener

setOnUnpublishedListener(callback?: (result: OnUnpublishedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnUnpublishedListener
- Defined in RCRTCEngine.ts:470
本地用户取消发布资源回调

Parameters
- Optional callback: (result: OnUnpublishedResult) => void
  - - (result: OnUnpublishedResult): void
    - Parameters
      - result: OnUnpublishedResult
      Returns void
Returns void

setOnUnsubscribedListener

setOnUnsubscribedListener(callback?: (result: OnUnsubscribedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnUnsubscribedListener
- Defined in RCRTCEngine.ts:476
取消订阅远端用户发布的资源, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnUnsubscribedResult) => void
  - - (result: OnUnsubscribedResult): void
    - Parameters
      - result: OnUnsubscribedResult
      Returns void
Returns void

setOnUserJoinedListener

setOnUserJoinedListener(callback?: (result: OnUserJoinedResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnUserJoinedListener
- Defined in RCRTCEngine.ts:542
远端用户加入房间操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnUserJoinedResult) => void
  - - (result: OnUserJoinedResult): void
    - Parameters
      - result: OnUserJoinedResult
      Returns void
Returns void

setOnUserLeftListener

setOnUserLeftListener(callback?: (result: OnUserLeftResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnUserLeftListener
- Defined in RCRTCEngine.ts:548
远端用户离开房间操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnUserLeftResult) => void
  - - (result: OnUserLeftResult): void
    - Parameters
      - result: OnUserLeftResult
      Returns void
Returns void

setOnUserOfflineListener

setOnUserOfflineListener(callback?: (result: OnUserOfflineResult) => void): void

Implementation of RCRTCEngineEventsInterface.setOnUserOfflineListener
- Defined in RCRTCEngine.ts:545
远端用户因离线离开房间操作回调, 仅供会议用户或直播主播用户使用

Parameters
- Optional callback: (result: OnUserOfflineResult) => void
  - - (result: OnUserOfflineResult): void
    - Parameters
      - result: OnUserOfflineResult
      Returns void
Returns void

setOnWatermarkRemovedListener

setOnWatermarkRemovedListener(callback?: (res: OnWatermarkRemovedResult) => void): void

- Defined in RCRTCEngine.ts:934
移除水印的回调

Parameters
- Optional callback: (res: OnWatermarkRemovedResult) => void
  - - (res: OnWatermarkRemovedResult): void
    - Parameters
      - res: OnWatermarkRemovedResult
      Returns void
Returns void

setOnWatermarkSetListener

setOnWatermarkSetListener(callback?: (res: OnWatermarkSetResult) => void): void

- Defined in RCRTCEngine.ts:926
设置水印的回调

Parameters
- Optional callback: (res: OnWatermarkSetResult) => void
  - - (res: OnWatermarkSetResult): void
    - Parameters
      - res: OnWatermarkSetResult
      Returns void
Returns void

setRemoteCustomStreamView

setRemoteCustomStreamView(userId: string, tag: string, ref: string, callback: (code: number) => {}): void

Implementation of RCRTCEngineInterface.setRemoteCustomStreamView
- Defined in RCRTCEngine.ts:373
设置远端自定义流View

Parameters
- userId: string
- tag: string
- ref: string
- callback: (code: number) => {}
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

setRemoteView

setRemoteView(userId: string, ref: string, callback: (code: number) => {}): void

Implementation of RCRTCEngineInterface.setRemoteView
- Defined in RCRTCEngine.ts:220
设置远端视频窗口

Parameters
- userId: string
- ref: string
- callback: (code: number) => {}
  - - (code: number): {}
    - Parameters
      - code: number
      Returns {}
Returns void

setVideoConfig

setVideoConfig(config: RCRTCVideoConfig, tiny?: boolean): number

Implementation of RCRTCEngineInterface.setVideoConfig
- Defined in RCRTCEngine.ts:178
设置默认视频参数, 仅供会议用户或直播主播用户使用

Parameters
- config: RCRTCVideoConfig
- tiny: boolean = false
Returns number
{number} 错误码

setWatermark

setWatermark(path: string, positionX: number, positionY: number, zoom: number): number

Implementation of RCRTCEngineInterface.setWatermark
- Defined in RCRTCEngine.ts:409
设置水印

Parameters
- path: string
- positionX: number
- positionY: number
- zoom: number
Returns number
接口调用状态码 0: 成功, 非0: 失败

startAudioMixing

startAudioMixing(path: string, mode: RCRTCAudioMixingMode, playback?: boolean, loop?: number): number

Implementation of RCRTCEngineInterface.startAudioMixing
- Defined in RCRTCEngine.ts:310
开始混音, 仅支持混合本地音频文件数据, 仅供会议用户或直播主播用户使用

Parameters
- path: string
- mode: RCRTCAudioMixingMode
- playback: boolean = true
- loop: number = 1
Returns number
{number} 错误码

startEchoTest

startEchoTest(timeInterval: number): number

- Defined in RCRTCEngine.ts:813
开始麦克风&扬声器检测

Parameters
- timeInterval: number
  
  麦克风录制时间
Returns number
接口调用状态码 0: 成功, 非0: 失败

startNetworkProbe

startNetworkProbe(): number

Implementation of RCRTCEngineInterface.startNetworkProbe
- Defined in RCRTCEngine.ts:412
开始网络探测

Returns number
接口调用状态码 0: 成功, 非0: 失败

stopAllAudioEffects

stopAllAudioEffects(): number

Implementation of RCRTCEngineInterface.stopAllAudioEffects
- Defined in RCRTCEngine.ts:298
停止全部音效文件播放, 仅供会议用户或直播主播用户使用

Returns number
{number} 错误码

stopAudioEffect

stopAudioEffect(effectId: number): number

Implementation of RCRTCEngineInterface.stopAudioEffect
- Defined in RCRTCEngine.ts:295
停止音效文件播放, 仅供会议用户或直播主播用户使用

Parameters
- effectId: number
Returns number
{number} 错误码

stopAudioMixing

stopAudioMixing(): number

Implementation of RCRTCEngineInterface.stopAudioMixing
- Defined in RCRTCEngine.ts:313
停止混音, 仅供会议用户或直播主播用户使用

Returns number
{number} 错误码

stopEchoTest

stopEchoTest(): number

- Defined in RCRTCEngine.ts:821
停止麦克风&扬声器检测，结束检测后必须手动调用停止方法

Returns number
接口调用状态码 0: 成功, 非0: 失败

stopNetworkProbe

stopNetworkProbe(): number

- Defined in RCRTCEngine.ts:804
停止网络探测

Returns number
接口调用状态码 0: 成功, 非0: 失败

subscribe

subscribe(userId: string, type: RCRTCMediaType, tiny?: boolean): number

Implementation of RCRTCEngineInterface.subscribe
- Defined in RCRTCEngine.ts:157
Parameters
- userId: string
- type: RCRTCMediaType
- tiny: boolean = true
Returns number
number 错误码

subscribeCustomStream

subscribeCustomStream(userId: string, tag: string, type: RCRTCMediaType, tiny: boolean): number

Implementation of RCRTCEngineInterface.subscribeCustomStream
- Defined in RCRTCEngine.ts:379
加入房间后, 订阅远端用户发布的自定义流

Parameters
- userId: string
- tag: string
- type: RCRTCMediaType
- tiny: boolean
Returns number
{number} 错误码

subscribeLiveMix

subscribeLiveMix(type: RCRTCMediaType, tiny?: boolean): number

Implementation of RCRTCEngineInterface.subscribeLiveMix
- Defined in RCRTCEngine.ts:169
订阅主播合流资源, 仅供直播观众用户使用

Parameters
- type: RCRTCMediaType
- tiny: boolean = true
Returns number
{number} 错误码

subscribeLiveMixInnerCdnStream

subscribeLiveMixInnerCdnStream(): number

- Defined in RCRTCEngine.ts:744
订阅直播内置 cdn 流

Returns number
0: 成功, 非0: 失败

subscribes

subscribes(userIds: string[], type: RCRTCMediaType, tiny?: boolean): number

Implementation of RCRTCEngineInterface.subscribes
- Defined in RCRTCEngine.ts:160
加入房间后, 订阅远端多个用户发布的资源

Parameters
- userIds: string[]
- type: RCRTCMediaType
- tiny: boolean = true
Returns number
{number} 错误码

switchCamera

switchCamera(): number

Implementation of RCRTCEngineInterface.switchCamera
- Defined in RCRTCEngine.ts:193
切换前后摄像头

Returns number
{number} 错误码

switchLiveRole

switchLiveRole(role: RCRTCRole): number

- Defined in RCRTCEngine.ts:727
切换直播角色

Parameters
- role: RCRTCRole
Returns number
0: 成功, 非0: 失败

unpublish

unpublish(type: RCRTCMediaType): number

Implementation of RCRTCEngineInterface.unpublish
- Defined in RCRTCEngine.ts:154
加入房间后, 取消发布已经发布的本地资源

Parameters
- type: RCRTCMediaType
Returns number
{number} 错误码

unpublishCustomStream

unpublishCustomStream(tag: string): number

Implementation of RCRTCEngineInterface.unpublishCustomStream
- Defined in RCRTCEngine.ts:367
取消发布自定义流, 仅供会议用户或直播主播用户使用

Parameters
- tag: string
Returns number
{number} 错误码

unsubscribe

unsubscribe(userId: string, type: RCRTCMediaType): number

Implementation of RCRTCEngineInterface.unsubscribe
- Defined in RCRTCEngine.ts:163
加入房间后, 取消订阅远端单个用户发布的资源

Parameters
- userId: string
- type: RCRTCMediaType
Returns number
{number} 错误码

unsubscribeCustomStream

unsubscribeCustomStream(userId: string, tag: string, type: RCRTCMediaType): number

Implementation of RCRTCEngineInterface.unsubscribeCustomStream
- Defined in RCRTCEngine.ts:382
加入房间后, 取消订阅远端用户发布的自定义流

Parameters
- userId: string
- tag: string
- type: RCRTCMediaType
Returns number
{number} 错误码

unsubscribeLiveMix

unsubscribeLiveMix(type: RCRTCMediaType): number

Implementation of RCRTCEngineInterface.unsubscribeLiveMix
- Defined in RCRTCEngine.ts:172
取消订阅主播合流资源, 仅供直播观众用户使用

Parameters
- type: RCRTCMediaType
Returns number
{number} 错误码

unsubscribeLiveMixInnerCdnStream

unsubscribeLiveMixInnerCdnStream(): number

- Defined in RCRTCEngine.ts:752
取消订阅直播内置 cdn 流

Returns number
0: 成功, 非0: 失败

unsubscribes

unsubscribes(userIds: string[], type: RCRTCMediaType): number

Implementation of RCRTCEngineInterface.unsubscribes
- Defined in RCRTCEngine.ts:166
加入房间后, 取消订阅远端多个用户发布的资源

Parameters
- userIds: string[]
- type: RCRTCMediaType
Returns number
{number} 错误码

whichCamera

whichCamera(): RCRTCCamera

Implementation of RCRTCEngineInterface.whichCamera
- Defined in RCRTCEngine.ts:196
获取当前使用摄像头位置

Returns RCRTCCamera
{RCRTCCamera} 摄像头类型

Static create

create(setup: RCRTCEngineSetup): null | default

- Defined in RCRTCEngine.ts:127
初始化

memberof
RCRTCEngineInterface

Parameters
- setup: RCRTCEngineSetup
  
  配置项
Returns null | default

Generated using TypeDoc