Class default

addLiveCdn

• addLiveCdn(url: string): number

• 设置 CDN 直播推流地址, 仅供直播主播用户使用

  Parameters

  • url: string

  Returns number

  {number} 错误码

adjustAllAudioEffectsVolume

• adjustAllAudioEffectsVolume(volume: number): number

• 设置全局音效文件播放音量, 仅供会议用户或直播主播用户使用

  Parameters

  • volume: number

  Returns number

  {number} 错误码

adjustAudioEffectVolume

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

• 设置音效文件播放音量, 仅供会议用户或直播主播用户使用

  Parameters

  • effectId: number

  • volume: number

  Returns number

  {number} 错误码

adjustAudioMixingPlaybackVolume

• adjustAudioMixingPlaybackVolume(volume: number): number

• 设置混音本地播放音量, 仅供会议用户或直播主播用户使用

  Parameters

  • volume: number

  Returns number

  {number} 错误码

adjustAudioMixingPublishVolume

• adjustAudioMixingPublishVolume(volume: number): number

• 设置混音发送音量, 仅供会议用户或直播主播用户使用

  Parameters

  • volume: number

  Returns number

  {number}

adjustAudioMixingVolume

• adjustAudioMixingVolume(volume: number): number

• 设置混音输入音量, 包含本地播放和发送音量, 仅供会议用户或直播主播用户使用

  Parameters

  • volume: number

  Returns number

  {number}

adjustLocalVolume

• adjustLocalVolume(volume: number): number

• 设置麦克风的音量

  Parameters

  • volume: number

  Returns number

  {number} 错误码

cancelJoinSubRoomRequest

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

• 取消正在进行中的跨房间连麦请求

  Parameters

  • roomId: string

  • userId: string

  • Optional extra: string

  Returns number

  {number} 错误码

createAudioEffect

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

• 创建音效文件缓存, 仅供会议用户或直播主播用户使用

  Parameters

  • path: string

  • effectId: number

  Returns number

  {number}

createCustomStreamFromFile

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

• 从视频文件创建自定义流, 仅供会议用户或直播主播用户使用

  Parameters

  • path: string

  • tag: string

  • replace: boolean

  • playback: boolean

  Returns number

  {number} 错误码

destroy

• destroy(): number

• 销毁实例

  Returns number

  {number} 错误码

enableCamera

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

• 打开/关闭摄像头

  Parameters

  • enable: boolean

  • camera: RCRTCCamera = RCRTCCamera.Front

  Returns number

  {number} 错误码

enableLiveMixInnerCdnStream

• enableLiveMixInnerCdnStream(enable: boolean): number

• 开启直播内置 cdn 功能

  Parameters

  • enable: boolean

  Returns number

  0: 成功, 非0: 失败

enableMicrophone

• enableMicrophone(enable: boolean): number

• 打开/关闭麦克风

  Parameters

  • enable: boolean

  Returns number

  {number} 错误码

enableSei

• enableSei(enable: boolean): number

• 开启 SEI 功能，观众身份调用无效

  Parameters

  • enable: boolean

    是否开启

  Returns number

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

enableSpeaker

• enableSpeaker(enable: boolean): number

• 打开/关闭外放

  Parameters

  • enable: boolean

  Returns number

  {number} 错误码

getAudioEffectVolume

• getAudioEffectVolume(effectId: number): number

• 获取音效文件播放音量, 仅供会议用户或直播主播用户使用

  Parameters

  • effectId: number

  Returns number

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

getAudioMixingDuration

• getAudioMixingDuration(): number

• 获取音频文件时长, 单位:秒, 仅供会议用户或直播主播用户使用

  Returns number

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

getAudioMixingPlaybackVolume

• getAudioMixingPlaybackVolume(): number

• 获取混音本地播放音量, 仅供会议用户或直播主播用户使用

  Returns number

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

getAudioMixingPosition

• getAudioMixingPosition(): number

• 获取音频文件合流进度, 仅供会议用户或直播主播用户使用

  Returns number

  {number} 合流进度 0~1

getAudioMixingPublishVolume

• getAudioMixingPublishVolume(): number

• 获取混音发送音量, 仅供会议用户或直播主播用户使用

  Returns number

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

getSessionId

• getSessionId(): string

• 获取当前房间的 SessionId, 仅在加入房间成功后可获取 每次加入房间所得到的 SessionId 均不同

  Returns string

  {string} 获取到的 sessionId

isCameraExposurePositionSupported

• isCameraExposurePositionSupported(): boolean

• 获取摄像头是否支持区域测光

  Returns boolean

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

isCameraFocusSupported

• isCameraFocusSupported(): boolean

• 获取摄像头是否支持区域对焦

  Returns boolean

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

joinRoom

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

• 加入房间

  Parameters

  • roomId: string

  • setup: RCRTCRoomSetup

  Returns number

  {number} 错误码

joinSubRoom

• joinSubRoom(roomId: string): number

• 连麦邀请后加入副房间

  Parameters

  • roomId: string

  Returns number

  {number} 错误码

leaveRoom

• leaveRoom(): number

• 离开房间

  Returns number

  {number} 错误码

leaveSubRoom

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

• 离开副房间，此方法仅供连麦离开副房间使用

  Parameters

  • roomId: string

  • disband: boolean

  Returns number

  {number} 错误码

muteAllRemoteAudioStreams

• muteAllRemoteAudioStreams(mute: boolean): number

• 停止所有远端音频数据渲染

  Parameters

  • mute: boolean

    true: 不渲染 false: 渲染

  Returns number

  0: 成功, 非0: 失败

muteLiveMixInnerCdnStream

• muteLiveMixInnerCdnStream(mute: boolean): number

• 观众端禁用或启用融云内置 CDN 流

  Parameters

  • mute: boolean

    true: 停止资源渲染，false: 恢复资源渲染

  Returns number

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

muteLiveMixStream

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

• Parameters

  • type: RCRTCMediaType

  • mute: boolean

  Returns number

muteLocalCustomStream

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

• 停止自定义流发送, 仅供会议用户或直播主播用户使用

  Parameters

  • tag: string

  • mute: boolean

  Returns number

  {number} 错误码

muteLocalStream

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

• 停止本地音视频数据发送

  Parameters

  • type: RCRTCMediaType

  • mute: boolean

  Returns number

  {number} 错误码

muteRemoteCustomStream

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

• 停止远端用户自定义流数据的接收

  Parameters

  • userId: string

  • tag: string

  • type: RCRTCMediaType

  • mute: boolean

  Returns number

  {number} 错误码

muteRemoteStream

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

• 停止远端用户音视频数据的接收

  Parameters

  • userId: string

  • type: RCRTCMediaType

  • mute: boolean

  Returns number

  {number} 错误码

pauseAllAudioEffects

• pauseAllAudioEffects(): number

• 暂停全部音效文件播放, 仅供会议用户或直播主播用户使用

  Returns number

  {number} 错误码

pauseAudioEffect

• pauseAudioEffect(effectId: number): number

• 暂停音效文件播放, 仅供会议用户或直播主播用户使用

  Parameters

  • effectId: number

  Returns number

  {number} 错误码

pauseAudioMixing

• pauseAudioMixing(): number

• 暂停混音, 仅供会议用户或直播主播用户使用

  Returns number

  {number} 错误码

playAudioEffect

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

• 播放音效文件, 仅供会议用户或直播主播用户使用

  Parameters

  • effectId: number

  • volume: number

  • loop: number = 1

  Returns number

  {number}

preconnectToMediaServer

• preconnectToMediaServer(): number

• 预链接到媒体服务器

  Returns number

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

publish

• publish(type: RCRTCMediaType): number

• 加入房间后, 发布本地资源

  Parameters

  • type: RCRTCMediaType

  Returns number

  {number} 错误码

publishCustomStream

• publishCustomStream(tag: string): number

• 发布自定义流, 仅供会议用户或直播主播用户使用

  Parameters

  • tag: string

  Returns number

  {number} 错误码

releaseAudioEffect

• releaseAudioEffect(effectId: number): number

• 释放音效文件缓存, 仅供会议用户或直播主播用户使用

  Parameters

  • effectId: number

  Returns number

  {number}

removeLiveCdn

• removeLiveCdn(url: string): number

• 移除 CDN 直播推流地址, 仅供直播主播用户使用

  Parameters

  • url: string

  Returns number

  {number} 错误码

removeLiveMixInnerCdnStreamView

• removeLiveMixInnerCdnStreamView(): number

• 移除直播内置 cdn 流预览窗口

  Returns number

  0: 成功, 非0: 失败

removeLiveMixView

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

• 移除合流视频窗口

  Parameters

  • callback: ((code: number) => {})

    • • (code: number): {}

      • Parameters

        • code: number

        Returns {}

  Returns void

removeLocalCustomStreamView

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

• 移除自定义流预览窗口, 仅供会议用户或直播主播用户使用

  Parameters

  • tag: string

  • callback: ((code: number) => {})

    • • (code: number): {}

      • Parameters

        • code: number

        Returns {}

  Returns void

removeLocalView

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

• 移除本地视频渲染窗口

  Parameters

  • callback: ((code: number) => {})

    • • (code: number): {}

      • Parameters

        • code: number

        Returns {}

  Returns void

removeRemoteCustomStreamView

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

• 移除远端自定义流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

• 移除远端视频窗口

  Parameters

  • userId: string

  • callback: ((code: number) => {})

    • • (code: number): {}

      • Parameters

        • code: number

        Returns {}

  Returns void

removeWatermark

• removeWatermark(): number

• 移除水印

  Returns number

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

requestJoinSubRoom

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

• 向指定用户发送跨房间连麦请求

  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

• 响应跨房间连麦请求

  Parameters

  • roomId: string

  • userId: string

  • agree: boolean

  • autoLayout: boolean

  • Optional extra: string

  Returns number

  {number} 错误码

resumeAllAudioEffects

• resumeAllAudioEffects(): number

• 恢复全部音效文件播放, 仅供会议用户或直播主播用户使用

  Returns number

  {number} 错误码

resumeAudioEffect

• resumeAudioEffect(effectId: number): number

• 恢复音效文件播放, 仅供会议用户或直播主播用户使用

  Parameters

  • effectId: number

  Returns number

  {number} 错误码

resumeAudioMixing

• resumeAudioMixing(): number

• 恢复混音, 仅供会议用户或直播主播用户使用

  Returns number

  {number} 错误码

sendSei

• sendSei(sei: string): number

• 发送 SEI 信息，需开启 SEI 功能之后调用

  Parameters

  • sei: string

    SEI 信息

  Returns number

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

setAudioConfig

• setAudioConfig(config: RCRTCAudioConfig): number

• 设置默认音频参数, 仅供会议用户或直播主播用户使用

  Parameters

  • config: RCRTCAudioConfig

  Returns number

  {number} 错误码

setAudioMixingPosition

• setAudioMixingPosition(position: number): number

• 设置混音文件合流进度, 仅供会议用户或直播主播用户使用

  Parameters

  • position: number

  Returns number

  {number}

setCameraCaptureOrientation

• setCameraCaptureOrientation(orientation: RCRTCCameraCaptureOrientation): number

• 设置摄像头采集方向

  Parameters

  • orientation: RCRTCCameraCaptureOrientation

  Returns number

  {number}

setCameraExposurePositionInPreview

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

• 设置在指定点区域测光

  Parameters

  • x: number

  • y: number

  Returns number

  {number}

setCameraFocusPositionInPreview

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

• 设置在指定点区域对焦

  Parameters

  • x: number

  • y: number

  Returns number

  {number}

setCustomStreamVideoConfig

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

• 设置自定义流参数, 仅供会议用户或直播主播用户使用

  Parameters

  • tag: string

  • config: RCRTCVideoConfig

  Returns number

  {number} 错误码

setLiveMixAudioBitrate

• setLiveMixAudioBitrate(bitrate: number): number

• 设置直播合流音频码率, 仅供直播主播用户使用

  Parameters

  • bitrate: number

  Returns number

  {number}

setLiveMixBackgroundColor

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

• 设置直播合流布局背景颜色 仅供直播主播用户使用

  Parameters

  • red: number

  • green: number

  • blue: number

  Returns number

  {number} 错误码

setLiveMixCustomAudios

• setLiveMixCustomAudios(userIds: string[]): number

• 设置直播自定义音频流列表, 仅供直播主播用户使用

  Parameters

  • userIds: string[]

  Returns number

  {number} 错误码

setLiveMixCustomLayouts

• setLiveMixCustomLayouts(layouts: RCRTCCustomLayout[]): number

• 设置直播混流布局配置, 仅供直播主播用户使用

  Parameters

  • layouts: RCRTCCustomLayout[]

  Returns number

  {number}

setLiveMixInnerCdnStreamView

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

• 设置直播内置 cdn 流预览窗口

  Parameters

  • ref: string

  • callback: ((code: number) => {})

    • • (code: number): {}

      • Parameters

        • code: number

        Returns {}

  Returns void

  0: 成功, 非0: 失败

setLiveMixLayoutMode

• setLiveMixLayoutMode(mode: RCRTCLiveMixLayoutMode): number

• 设置直播合流布局类型, 仅供直播主播用户使用

  Parameters

  • mode: RCRTCLiveMixLayoutMode

  Returns number

  {number} 错误码

setLiveMixRenderMode

• setLiveMixRenderMode(mode: RCRTCLiveMixRenderMode): number

• 设置直播合流布局填充类型, 仅供直播主播用户使用

  Parameters

  • mode: RCRTCLiveMixRenderMode

  Returns number

  {number} 错误码

setLiveMixVideoBitrate

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

• 设置直播合流视频码率, 仅供直播主播用户使用

  Parameters

  • bitrate: number

  • tiny: boolean = false

  Returns number

  {number}

setLiveMixVideoFps

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

• 设置直播合流视频帧率, 仅供直播主播用户使用

  Parameters

  • fps: RCRTCVideoFps

  • tiny: boolean = false

  Returns number

  {number}

setLiveMixVideoResolution

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

• 设置直播合流视频分辨率, 仅供直播主播用户使用

  Parameters

  • width: number

  • height: number

  • tiny: boolean = false

  Returns number

  {number}

setLiveMixView

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

• 设置合流视频窗口

  Parameters

  • ref: string

  • callback: ((code: number) => {})

    • • (code: number): {}

      • Parameters

        • code: number

        Returns {}

  Returns void

setLocalCustomStreamView

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

• 设置自定义流预览窗口, 仅供会议用户或直播主播用户使用

  Parameters

  • tag: string

  • ref: string

  • callback: ((code: number) => {})

    • • (code: number): {}

      • Parameters

        • code: number

        Returns {}

  Returns void

setLocalLiveMixInnerCdnVideoFps

• setLocalLiveMixInnerCdnVideoFps(fps: RCRTCVideoFps): number

• 观众端设置订阅 cdn 流的帧率

  Parameters

  • fps: RCRTCVideoFps

    帧率

  Returns number

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

setLocalLiveMixInnerCdnVideoResolution

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

• 观众端 设置订阅 cdn 流的分辨率

  Parameters

  • width: number

    分辨率宽

  • height: number

    高

  Returns number

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

setLocalView

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

• 设置本地视频渲染窗口

  Parameters

  • ref: string

  • callback: ((code: number) => {})

    • • (code: number): {}

      • Parameters

        • code: number

        Returns {}

  Returns void

setOnAudioEffectCreatedListener

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

• 创建音效操作回调, 仅供会议用户或直播主播用户使用

  Parameters

  • Optional callback: ((result: OnAudioEffectCreatedResult) => void)

    • • (result: OnAudioEffectCreatedResult): void

      • Parameters

        • result: OnAudioEffectCreatedResult

        Returns void

  Returns void

setOnAudioEffectFinishedListener

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

• 播放音效结束, 仅供会议用户或直播主播用户使用

  Parameters

  • Optional callback: ((result: OnAudioEffectFinishedResult) => void)

    • • (result: OnAudioEffectFinishedResult): void

      • Parameters

        • result: OnAudioEffectFinishedResult

        Returns void

  Returns void

setOnAudioMixingFinishedListener

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

• 结束本地音频文件数据合流操作回调, 仅供会议用户或直播主播用户使用

  Parameters

  • Optional callback: ((result: void) => void)

    • • (result: void): void

      • Parameters

        • result: void

        Returns void

  Returns void

setOnAudioMixingPausedListener

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

• 暂停本地音频数据合流操作回调, 仅供会议用户或直播主播用户使用

  Parameters

  • Optional callback: ((result: void) => void)

    • • (result: void): void

      • Parameters

        • result: void

        Returns void

  Returns void

setOnAudioMixingStartedListener

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

• 开始本地音频数据合流操作回调, 仅供会议用户或直播主播用户使用

  Parameters

  • Optional callback: ((result: void) => void)

    • • (result: void): void

      • Parameters

        • result: void

        Returns void

  Returns void

setOnAudioMixingStoppedListener

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

• 停止本地音频文件数据合流操作回调, 仅供会议用户或直播主播用户使用

  Parameters

  • Optional callback: ((result: void) => void)

    • • (result: void): void

      • Parameters

        • result: void

        Returns void

  Returns void

setOnCameraEnabledListener

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

• 本地用户开关摄像头操作回调

  Parameters

  • Optional callback: ((result: OnCameraEnabledResult) => void)

    • • (result: OnCameraEnabledResult): void

      • Parameters

        • result: OnCameraEnabledResult

        Returns void

  Returns void

setOnCameraSwitchedListener

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

• 本地用户切换前后置摄像头操作回调

  Parameters

  • Optional callback: ((result: OnCameraSwitchedResult) => void)

    • • (result: OnCameraSwitchedResult): void

      • Parameters

        • result: OnCameraSwitchedResult

        Returns void

  Returns void

setOnCancelJoinSubRoomRequestReceivedListener

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

• 收到取消加入请求回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnCancelJoinSubRoomRequestReceivedResult) => void)

    • • (result: OnCancelJoinSubRoomRequestReceivedResult): void

      • Parameters

        • result: OnCancelJoinSubRoomRequestReceivedResult

        Returns void

  Returns void

setOnCustomStreamPublishFinishedListener

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

• 本地自定义流发布结束回调

  Parameters

  • Optional callback: ((result: OnCustomStreamPublishFinishedResult) => void)

    • • (result: OnCustomStreamPublishFinishedResult): void

      • Parameters

        • result: OnCustomStreamPublishFinishedResult

        Returns void

  Returns void

setOnCustomStreamPublishedListener

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

• 本地用户发布本地自定义流操作回调

  Parameters

  • Optional callback: ((result: OnCustomStreamPublishedResult) => void)

    • • (result: OnCustomStreamPublishedResult): void

      • Parameters

        • result: OnCustomStreamPublishedResult

        Returns void

  Returns void

setOnCustomStreamSubscribedListener

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

• 订阅远端用户发布的自定义流操作回调, 仅供会议用户或直播主播用户使用

  Parameters

  • Optional callback: ((result: OnCustomStreamSubscribedResult) => void)

    • • (result: OnCustomStreamSubscribedResult): void

      • Parameters

        • result: OnCustomStreamSubscribedResult

        Returns void

  Returns void

setOnCustomStreamUnpublishedListener

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

• 本地用户取消发布本地自定义流操作回调

  Parameters

  • Optional callback: ((result: OnCustomStreamUnpublishedResult) => void)

    • • (result: OnCustomStreamUnpublishedResult): void

      • Parameters

        • result: OnCustomStreamUnpublishedResult

        Returns void

  Returns void

setOnCustomStreamUnsubscribedListener

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

• 取消订阅远端用户发布的自定义流操作回调, 仅供会议用户或直播主播用户使用

  Parameters

  • Optional callback: ((result: OnCustomStreamUnsubscribedResult) => void)

    • • (result: OnCustomStreamUnsubscribedResult): void

      • Parameters

        • result: OnCustomStreamUnsubscribedResult

        Returns void

  Returns void

setOnErrorListener

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

• 本地用户操作错误回调

  Parameters

  • Optional callback: ((result: OnErrorResult) => void)

    • • (result: OnErrorResult): void

      • Parameters

        • result: OnErrorResult

        Returns void

  Returns void

setOnJoinSubRoomRequestCanceledListener

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

• 取消请求加入子房间回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnJoinSubRoomRequestCanceledResult) => void)

    • • (result: OnJoinSubRoomRequestCanceledResult): void

      • Parameters

        • result: OnJoinSubRoomRequestCanceledResult

        Returns void

  Returns void

setOnJoinSubRoomRequestReceivedListener

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

• 收到加入请求回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnJoinSubRoomRequestReceivedResult) => void)

    • • (result: OnJoinSubRoomRequestReceivedResult): void

      • Parameters

        • result: OnJoinSubRoomRequestReceivedResult

        Returns void

  Returns void

setOnJoinSubRoomRequestRespondedListener

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

• 响应请求加入子房间回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnJoinSubRoomRequestRespondedResult) => void)

    • • (result: OnJoinSubRoomRequestRespondedResult): void

      • Parameters

        • result: OnJoinSubRoomRequestRespondedResult

        Returns void

  Returns void

setOnJoinSubRoomRequestResponseReceivedListener

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

• 收到加入请求响应回调 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnJoinSubRoomRequestResponseReceivedResult) => void)

    • • (result: OnJoinSubRoomRequestResponseReceivedResult): void

      • Parameters

        • result: OnJoinSubRoomRequestResponseReceivedResult

        Returns void

  Returns void

setOnJoinSubRoomRequestedListener

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

• 请求加入子房间回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnJoinSubRoomRequestedResult) => void)

    • • (result: OnJoinSubRoomRequestedResult): void

      • Parameters

        • result: OnJoinSubRoomRequestedResult

        Returns void

  Returns void

setOnKickedListener

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

• 本地用户被踢出房间回调

  Parameters

  • Optional callback: ((result: OnKickedResult) => void)

    • • (result: OnKickedResult): void

      • Parameters

        • result: OnKickedResult

        Returns void

  Returns void

setOnLiveCdnAddedListener

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

• 添加旁路推流URL操作回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnLiveCdnAddedResult) => void)

    • • (result: OnLiveCdnAddedResult): void

      • Parameters

        • result: OnLiveCdnAddedResult

        Returns void

  Returns void

setOnLiveCdnRemovedListener

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

• 移除旁路推流URL操作回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnLiveCdnRemovedResult) => void)

    • • (result: OnLiveCdnRemovedResult): void

      • Parameters

        • result: OnLiveCdnRemovedResult

        Returns void

  Returns void

setOnLiveMixAudioBitrateSetListener

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

• 设置合流音频码率操作回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnLiveMixAudioBitrateSetResult) => void)

    • • (result: OnLiveMixAudioBitrateSetResult): void

      • Parameters

        • result: OnLiveMixAudioBitrateSetResult

        Returns void

  Returns void

setOnLiveMixAudioStatsListener

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

• 上报远端合流音频统计信息

  Parameters

  • Optional callback: ((result: RCRTCRemoteAudioStats) => void)

    • • (result: RCRTCRemoteAudioStats): void

      • Parameters

        • result: RCRTCRemoteAudioStats

        Returns void

  Returns void

setOnLiveMixBackgroundColorSetListener

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

• 设置合流布局背景颜色操作回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: BaseCallback<OnLiveMixBackgroundColorSetResult>

  Returns void

setOnLiveMixCustomAudiosSetListener

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

• 设置需要合流音频操作回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnLiveMixCustomAudiosSetResult) => void)

    • • (result: OnLiveMixCustomAudiosSetResult): void

      • Parameters

        • result: OnLiveMixCustomAudiosSetResult

        Returns void

  Returns void

setOnLiveMixCustomLayoutsSetListener

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

• 设置合流自定义布局操作回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnLiveMixCustomLayoutsSetResult) => void)

    • • (result: OnLiveMixCustomLayoutsSetResult): void

      • Parameters

        • result: OnLiveMixCustomLayoutsSetResult

        Returns void

  Returns void

setOnLiveMixInnerCdnStreamEnabledListener

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

• 开启直播内置 cdn 结果回调

  Parameters

  • Optional callback: ((res: OnLiveMixInnerCdnStreamEnabledResult) => void)

    • • (res: OnLiveMixInnerCdnStreamEnabledResult): void

      • Parameters

        • res: OnLiveMixInnerCdnStreamEnabledResult

        Returns void

  Returns void

setOnLiveMixInnerCdnStreamSubscribedListener

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

• 订阅直播内置 cdn 资源回调

  Parameters

  • Optional callback: ((res: OnLiveMixInnerCdnStreamSubscribedResult) => void)

    • • (res: OnLiveMixInnerCdnStreamSubscribedResult): void

      • Parameters

        • res: OnLiveMixInnerCdnStreamSubscribedResult

        Returns void

  Returns void

setOnLiveMixInnerCdnStreamUnsubscribedListener

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

• 取消订阅直播内置 cdn 资源回调

  Parameters

  • Optional callback: ((res: OnLiveMixInnerCdnStreamUnsubscribedResult) => void)

    • • (res: OnLiveMixInnerCdnStreamUnsubscribedResult): void

      • Parameters

        • res: OnLiveMixInnerCdnStreamUnsubscribedResult

        Returns void

  Returns void

setOnLiveMixLayoutModeSetListener

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

• 设置合流布局类型操作回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnLiveMixLayoutModeSetResult) => void)

    • • (result: OnLiveMixLayoutModeSetResult): void

      • Parameters

        • result: OnLiveMixLayoutModeSetResult

        Returns void

  Returns void

setOnLiveMixMemberAudioStatsListener

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

• 上报远端分流音频统计信息

  Parameters

  • Optional callback: ((result: OnLiveMixMemberAudioStatsResult) => void)

    • • (result: OnLiveMixMemberAudioStatsResult): void

      • Parameters

        • result: OnLiveMixMemberAudioStatsResult

        Returns void

  Returns void

setOnLiveMixMemberCustomAudioStatsListener

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

• 上报远端分流自定义音频统计信息

  Parameters

  • Optional callback: ((result: OnLiveMixMemberCustomAudioStatsResult) => void)

    • • (result: OnLiveMixMemberCustomAudioStatsResult): void

      • Parameters

        • result: OnLiveMixMemberCustomAudioStatsResult

        Returns void

  Returns void

setOnLiveMixRenderModeSetListener

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

• 设置合流布局填充类型操作回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnLiveMixRenderModeSetResult) => void)

    • • (result: OnLiveMixRenderModeSetResult): void

      • Parameters

        • result: OnLiveMixRenderModeSetResult

        Returns void

  Returns void

setOnLiveMixSeiReceivedListener

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

• 观众收到合流 SEI 信息回调

  Parameters

  • Optional callback: ((res: OnLiveMixSeiReceivedResult) => void)

    • • (res: OnLiveMixSeiReceivedResult): void

      • Parameters

        • res: OnLiveMixSeiReceivedResult

        Returns void

  Returns void

setOnLiveMixSubscribedListener

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

• 订阅合流资源操作回调, 仅供直播观众用户使用

  Parameters

  • Optional callback: ((result: OnLiveMixSubscribedResult) => void)

    • • (result: OnLiveMixSubscribedResult): void

      • Parameters

        • result: OnLiveMixSubscribedResult

        Returns void

  Returns void

setOnLiveMixUnsubscribedListener

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

• 取消订阅合流资源操作回调, 仅供直播观众用户使用

  Parameters

  • Optional callback: ((result: OnLiveMixUnsubscribedResult) => void)

    • • (result: OnLiveMixUnsubscribedResult): void

      • Parameters

        • result: OnLiveMixUnsubscribedResult

        Returns void

  Returns void

setOnLiveMixVideoBitrateSetListener

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

• 设置默认视频合流码率操作回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnLiveMixVideoBitrateSetResult) => void)

    • • (result: OnLiveMixVideoBitrateSetResult): void

      • Parameters

        • result: OnLiveMixVideoBitrateSetResult

        Returns void

  Returns void

setOnLiveMixVideoFpsSetListener

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

• 设置默认视频帧率操作回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnLiveMixVideoFpsSetResult) => void)

    • • (result: OnLiveMixVideoFpsSetResult): void

      • Parameters

        • result: OnLiveMixVideoFpsSetResult

        Returns void

  Returns void

setOnLiveMixVideoResolutionSetListener

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

• 设置默认视频分辨率操作回调, 仅供直播主播用户使用

  Parameters

  • Optional callback: ((result: OnLiveMixVideoResolutionSetResult) => void)

    • • (result: OnLiveMixVideoResolutionSetResult): void

      • Parameters

        • result: OnLiveMixVideoResolutionSetResult

        Returns void

  Returns void

setOnLiveMixVideoStatsListener

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

• 上报远端合流视频统计信息

  Parameters

  • Optional callback: ((result: RCRTCRemoteVideoStats) => void)

    • • (result: RCRTCRemoteVideoStats): void

      • Parameters

        • result: RCRTCRemoteVideoStats

        Returns void

  Returns void

setOnLiveRoleSwitchedListener

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

• 角色切换回调

  Parameters

  • Optional callback: ((res: OnLiveRoleSwitchedResult) => void)

    • • (res: OnLiveRoleSwitchedResult): void

      • Parameters

        • res: OnLiveRoleSwitchedResult

        Returns void

  Returns void

setOnLocalAudioStatsListener

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

• 上报本地音频统计信息

  Parameters

  • Optional callback: ((result: RCRTCLocalAudioStats) => void)

    • • (result: RCRTCLocalAudioStats): void

      • Parameters

        • result: RCRTCLocalAudioStats

        Returns void

  Returns void

setOnLocalCustomAudioStatsListener

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

• 上报本地自定义音频统计信息

  Parameters

  • Optional callback: ((result: OnLocalCustomAudioStatsResult) => void)

    • • (result: OnLocalCustomAudioStatsResult): void

      • Parameters

        • result: OnLocalCustomAudioStatsResult

        Returns void

  Returns void

setOnLocalCustomVideoStatsListener

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