Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • default

Index

Constructors

Properties

Methods Other

Methods 混音

Constructors

constructor

Properties

Static _instance

_instance: null | default

Other Methods

addLiveCdn

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

    memberof

    RCRTCEngineInterface

    Parameters

    • url: string

      推流地址

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

adjustAllAudioEffectsVolume

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

    memberof

    RCRTCEngineInterface

    Parameters

    • volume: number

      音量 0~100, 默认 100

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

adjustAudioEffectVolume

  • adjustAudioEffectVolume(effectId: number, volume: number): Promise<RCRTCErrorCode>

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

    memberof

    RCRTCEngineInterface

    Parameters

    • effectId: number

      自定义全局唯一音效Id

    • volume: number

      音量 0~100, 默认 100

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

adjustAudioMixingPlaybackVolume

  • adjustAudioMixingPlaybackVolume(volume: number): Promise<RCRTCErrorCode>

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

    memberof

    RCRTCEngineInterface

    Parameters

    • volume: number

      音量 0~100, 默认 100

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

adjustAudioMixingPublishVolume

  • adjustAudioMixingPublishVolume(volume: number): Promise<RCRTCErrorCode>

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

    memberof

    RCRTCEngineInterface

    Parameters

    • volume: number

      音量 0~100, 默认 100

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

adjustAudioMixingVolume

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

    memberof

    RCRTCEngineInterface

    Parameters

    • volume: number

      音量 0~100, 默认 100

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

adjustLocalVolume

  • 设置麦克风的音量

    memberof

    RCRTCEngineInterface

    Parameters

    • volume: number

      0 ~ 100, 默认值: 100

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

cancelJoinSubRoomRequest

  • cancelJoinSubRoomRequest(roomId: string, userId: string, extra: string): Promise<RCRTCErrorCode>

  • 取消正在进行中的加入子房间（跨房间连麦）请求

    memberof

    RCRTCEngineInterface

    Parameters

    • roomId: string

      正在请求的目标房间id

    • userId: string

      正在请求的目标主播id

    • extra: string

      附加信息，默认为空

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

createAudioEffect

  • createAudioEffect(path: string, effectId: number): Promise<RCRTCErrorCode>

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

    memberof

    RCRTCEngineInterface

    Parameters

    • path: string

      本地文件地址

    • effectId: number

      自定义全局唯一音效Id

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

createCustomStreamFromFile

  • createCustomStreamFromFile(path: string, tag: string, replace: boolean, playback: boolean): Promise<RCRTCErrorCode>

  • 创建基于文件的自定义流

    memberof

    RCRTCEngineInterface

    Parameters

    • path: string

      本地文件地址

    • tag: string

      自定义流全局唯一标签

    • replace: boolean

      是否替换音频流

    • playback: boolean

      是否本地回放音频流

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

destroy

  • destroy(): void

  • 销毁引擎

    memberof

    RCRTCEngineInterface

    Returns void

enableCamera

  • 打开/关闭摄像头

    memberof

    RCRTCEngineInterface

    Parameters

    • enable: boolean

      true：打开， false：关闭

    • camera: RCRTCCamera

      摄像头类型

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

enableLiveMixInnerCdnStream

  • enableLiveMixInnerCdnStream(enable: boolean): Promise<number>

  • 开启直播内置 cdn 功能

    Parameters

    • enable: boolean

    Returns Promise<number>

    0: 成功, 非0: 失败

enableMicrophone

  • 打开/关闭麦克风

    memberof

    RCRTCEngineInterface

    Parameters

    • enable: boolean

      true 打开, false 关闭

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

enableSei

  • enableSei(enable: boolean): Promise<number>

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

    Parameters

    • enable: boolean

      是否开启

    Returns Promise<number>

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

enableSpeaker

  • 打开/关闭外放

    memberof

    RCRTCEngineInterface

    Parameters

    • enable: boolean

      true 打开, false 关闭

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

getAudioEffectVolume

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

    memberof

    RCRTCEngineInterface

    Parameters

    • effectId: number

      自定义全局唯一音效Id

    Returns Promise<RCRTCErrorCode>

    大于或等于0: 调用成功, 小于0: 调用失败

getAudioMixingDuration

  • getAudioMixingDuration(): Promise<number>

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

    memberof

    RCRTCEngineInterface

    Returns Promise<number>

    大于或等于0: 调用成功, 小于0: 调用失败

getAudioMixingPlaybackVolume

  • getAudioMixingPlaybackVolume(): Promise<number>

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

    memberof

    RCRTCEngineInterface

    Returns Promise<number>

    大于或等于0: 调用成功, 小于0: 调用失败

getAudioMixingPosition

  • getAudioMixingPosition(): Promise<number>

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

    memberof

    RCRTCEngineInterface

    Returns Promise<number>

    合流进度 0~1

getAudioMixingPublishVolume

  • getAudioMixingPublishVolume(): Promise<number>

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

    memberof

    RCRTCEngineInterface

    Returns Promise<number>

    大于或等于0: 调用成功, 小于0: 调用失败

getSessionId

  • getSessionId(): Promise<string>

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

    memberof

    RCRTCEngineInterface

    Returns Promise<string>

    {string} 获取到的 sessionId

isCameraExposurePositionSupported

  • isCameraExposurePositionSupported(): Promise<boolean>

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

    memberof

    RCRTCEngineInterface

    Returns Promise<boolean>

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

isCameraFocusSupported

  • isCameraFocusSupported(): Promise<boolean>

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

    memberof

    RCRTCEngineInterface

    Returns Promise<boolean>

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

joinRoom

  • 加入房间

    memberof

    RCRTCEngineInterface 错误码

    Parameters

    Returns Promise<null>

    {void}

joinSubRoom

  • 加入子房间 前提必须已经 通过 joinRoom 加入了主房间 未建立连麦时，需先调用 requestJoinSubRoom 发起加入请求

    memberof

    RCRTCEngineInterface

    Parameters

    • roomId: string

      目标房间id

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

leaveRoom

  • 离开房间

    memberof

    RCRTCEngineInterface 错误码

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

leaveSubRoom

  • leaveSubRoom(roomId: string, disband: boolean): Promise<RCRTCErrorCode>

  • 离开子房间

    memberof

    RCRTCEngineInterface

    Parameters

    • roomId: string

      子房间id

    • disband: boolean

      是否解散，解散后再次加入需先调用 requestJoinSubRoom 发起加入请求

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

muteAllRemoteAudioStreams

  • muteAllRemoteAudioStreams(mute: boolean): Promise<number>

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

    Parameters

    • mute: boolean

      true: 不渲染 false: 渲染

    Returns Promise<number>

    0: 成功, 非0: 失败

muteLiveMixInnerCdnStream

  • muteLiveMixInnerCdnStream(mute: boolean): Promise<number>

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

    Parameters

    • mute: boolean

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

    Returns Promise<number>

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

muteLiveMixStream

  • muteLiveMixStream(type: RCRTCMediaType, mute: boolean): Promise<number>

  • 停止合流数据渲染

    memberof

    RCRTCEngineInterface

    Parameters

    • type: RCRTCMediaType

      媒体类型

    • mute: boolean

      true: 不发送 false: 发送

    Returns Promise<number>

    0: 成功, 非0: 失败

muteLocalCustomStream

  • muteLocalCustomStream(tag: string, mute: boolean): Promise<RCRTCErrorCode>

  • 停止本地数据渲染

    memberof

    RCRTCEngineInterface

    Parameters

    • tag: string
    • mute: boolean

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

muteLocalStream

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

    memberof

    RCRTCEngineInterface

    Parameters

    • type: RCRTCMediaType

      媒体类型

    • mute: boolean

      true: 不发送 false: 发送

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

muteRemoteCustomStream

  • muteRemoteCustomStream(userId: string, tag: string, type: number, mute: boolean): Promise<RCRTCErrorCode>

  • 停止远端数据渲染

    memberof

    RCRTCEngineInterface

    Parameters

    • userId: string
    • tag: string
    • type: number
    • mute: boolean

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

muteRemoteStream

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

    memberof

    RCRTCEngineInterface

    Parameters

    • userId: string

      远端用户Id

    • type: RCRTCMediaType

      媒体类型

    • mute: boolean

      true: 不发送 false: 发送

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

pauseAllAudioEffects

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

    memberof

    RCRTCEngineInterface

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

pauseAudioEffect

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

    memberof

    RCRTCEngineInterface

    Parameters

    • effectId: number

      自定义全局唯一音效Id

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

playAudioEffect

  • playAudioEffect(effectId: number, volume: number, loop?: number): Promise<RCRTCErrorCode>

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

    memberof

    RCRTCEngineInterface

    Parameters

    • effectId: number

      自定义全局唯一音效Id

    • volume: number

      音效文件播放音量

    • loop: number = 1

      循环播放次数 默认：1次

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

preconnectToMediaServer

  • preconnectToMediaServer(): Promise<number>

  • 预链接到媒体服务器

    Returns Promise<number>

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

publish

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

    memberof

    RCRTCEngineInterface 错误码

    Parameters

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

publishCustomStream

  • 发布自定义视频

    memberof

    RCRTCEngineInterface

    Parameters

    • tag: string

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

releaseAudioEffect

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

    memberof

    RCRTCEngineInterface

    Parameters

    • effectId: number

      自定义全局唯一音效Id

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

removeLiveCdn

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

    memberof

    RCRTCEngineInterface

    Parameters

    • url: string

      推流地址

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

removeLiveMixInnerCdnStreamView

  • removeLiveMixInnerCdnStreamView(): Promise<number>

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

    Returns Promise<number>

    0: 成功, 非0: 失败

removeLiveMixView

  • 移除合流视频窗口

    memberof

    RCRTCEngineInterface

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

removeLocalCustomStreamView

  • 移除本地自定义视频预览窗口

    memberof

    RCRTCEngineInterface

    Parameters

    • tag: string

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

removeLocalView

  • 移除本地视频渲染窗口

    memberof

    RCRTCEngineInterface

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

removeRemoteCustomStreamView

  • removeRemoteCustomStreamView(userId: string, tag: string): Promise<RCRTCErrorCode>

  • 移除远端自定义视频预览窗口

    memberof

    RCRTCEngineInterface

    Parameters

    • userId: string
    • tag: string

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

removeRemoteView

  • 移除远端视频窗口

    memberof

    RCRTCEngineInterface

    Parameters

    • userId: string

      远端用户Id

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

removeWatermark

  • removeWatermark(): Promise<number>

  • 移除水印

    Returns Promise<number>

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

requestJoinSubRoom

  • requestJoinSubRoom(roomId: string, userId: string, autoLayout: boolean, extra: string): Promise<RCRTCErrorCode>

  • 请求加入子房间（跨房间连麦）

    memberof

    RCRTCEngineInterface

    Parameters

    • roomId: string

      目标房间id

    • userId: string

      目标主播id

    • autoLayout: boolean

      是否自动布局

                    开启自动布局
                    如果被邀请方在加入邀请方房间之前发布了资源，当被邀请方加入邀请者房间成功后，服务器会把被邀请方流资源合并到邀请方视图（默认仅悬浮布局合流）上。
                    如果被邀请方在加入邀请方房间之前没有发布过资源，将会在被邀请方发布资源成功后，服务器会把被邀请方流资源合并到邀请方视图（默认仅悬浮布局合流）上。
                    双方可以主动设置合流布局。一旦主动设置过合流布局，后续音视频直播过程中设置的自动合流参数将失效。
    • extra: string

      附加信息，默认为空

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

responseJoinSubRoomRequest

  • responseJoinSubRoomRequest(roomId: string, userId: string, agree: boolean, autoLayout: boolean, extra: string): Promise<RCRTCErrorCode>

  • 响应加入子房间（跨房间连麦）请求

    memberof

    RCRTCEngineInterface

    Parameters

    • roomId: string

      发起请求的目标房间id

    • userId: string

      发起请求的主播id

    • agree: boolean

      是否同意（跨房间连麦）

    • autoLayout: boolean

      是否自动布局

                    开启自动布局
                    如果被邀请方在加入邀请方房间之前发布了资源，当被邀请方加入邀请者房间成功后，服务器会把被邀请方流资源合并到邀请方视图（默认仅悬浮布局合流）上。
                    如果被邀请方在加入邀请方房间之前没有发布过资源，将会在被邀请方发布资源成功后，服务器会把被邀请方流资源合并到邀请方视图（默认仅悬浮布局合流）上。
                    双方可以主动设置合流布局。一旦主动设置过合流布局，后续音视频直播过程中设置的自动合流参数将失效。
    • extra: string

      附加信息，默认为空

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

resumeAllAudioEffects

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

    memberof

    RCRTCEngineInterface

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

resumeAudioEffect

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

    memberof

    RCRTCEngineInterface

    Parameters

    • effectId: number

      自定义全局唯一音效Id

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

resumeAudioMixing

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

    memberof

    RCRTCEngineInterface

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

sendSei

  • sendSei(sei: string): Promise<number>

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

    Parameters

    • sei: string

      SEI 信息

    Returns Promise<number>

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

setAudioConfig

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

    memberof

    RCRTCEngineInterface

    Parameters

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setAudioMixingPosition

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

    memberof

    RCRTCEngineInterface

    Parameters

    • position: number

      进度 0~1

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setCameraCaptureOrientation

  • 设置摄像头采集方向

    memberof

    RCRTCEngineInterface

    Parameters

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setCameraExposurePositionInPreview

  • setCameraExposurePositionInPreview(x: number, y: number): Promise<RCRTCErrorCode>

  • 设置在指定点区域测光

    memberof

    RCRTCEngineInterface

    Parameters

    • x: number

      曝光点，视图上的 x 轴坐标

    • y: number

      曝光点，视图上的 y 轴坐标

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setCameraFocusPositionInPreview

  • setCameraFocusPositionInPreview(x: number, y: number): Promise<RCRTCErrorCode>

  • 设置在指定点区域对焦

    memberof

    RCRTCEngineInterface

    Parameters

    • x: number

      对焦点，视图上的 x 轴坐标

    • y: number

      对焦点，视图上的 y 轴坐标

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setCustomStreamVideoConfig

  • 设置自定义流的视频配置

    memberof

    RCRTCEngineInterface

    Parameters

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setLiveMixAudioBitrate

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

    memberof

    RCRTCEngineInterface

    Parameters

    • bitrate: number

      音频码率 单位：kbps

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setLiveMixBackgroundColor

  • setLiveMixBackgroundColor(color: number): Promise<number>

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

    memberof

    RCRTCEngineInterface

    Parameters

    • color: number

      用于旁路直播的输出视频的背景色，格式为 RGB 定义下的 Hex 值，不要带 # 号，如 0xFFB6C1 表示浅粉色。默认0x000000，黑色。取值范围 [0x000000, 0xFFFFFF]

    Returns Promise<number>

    0: 成功, 非0: 失败

setLiveMixBackgroundColorRgb

  • setLiveMixBackgroundColorRgb(red: number, green: number, blue: number): Promise<number>

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

    memberof

    RCRTCEngineInterface

    Parameters

    • red: number

      红色 取值范围: 0 ~ 255

    • green: number

      绿色 取值范围: 0 ~ 255

    • blue: number

      蓝色 取值范围: 0 ~ 255

    Returns Promise<number>

    0: 成功, 非0: 失败

setLiveMixCustomAudios

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

    memberof

    RCRTCEngineInterface

    Parameters

    • userIds: string[]

      音频流列表

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setLiveMixCustomLayouts

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

    memberof

    RCRTCEngineInterface

    Parameters

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setLiveMixInnerCdnStreamView

  • 设置 CDN 合流视图

    memberof

    RCRTCEngineInterface

    Parameters

    • tag: number

      窗口的 tag

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setLiveMixLayoutMode

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

    memberof

    RCRTCEngineInterface

    Parameters

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setLiveMixRenderMode

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

    memberof

    RCRTCEngineInterface

    Parameters

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setLiveMixVideoBitrate

  • setLiveMixVideoBitrate(bitrate: number, tiny?: boolean): Promise<RCRTCErrorCode>

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

    memberof

    RCRTCEngineInterface

    Parameters

    • bitrate: number

      音频码率 单位：kbps

    • tiny: boolean = false

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setLiveMixVideoFps

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

    memberof

    RCRTCEngineInterface

    Parameters

    • fps: RCRTCVideoFps

      帧率

    • tiny: boolean = false

      是否小流 true:视频小流 false:视频大流，默认值 false

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setLiveMixVideoResolution

  • setLiveMixVideoResolution(width: number, height: number, tiny?: boolean): Promise<RCRTCErrorCode>

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

    memberof

    RCRTCEngineInterface

    Parameters

    • width: number

      视频宽度

    • height: number

      视频高度

    • tiny: boolean = false

      是否小流 true:视频小流 false:视频大流，默认值 false

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setLiveMixView

  • 设置合流视频窗口

    memberof

    RCRTCEngineInterface

    Parameters

    • tag: number

      窗口 tag

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setLocalCustomStreamView

  • setLocalCustomStreamView(tag: string, view: number): Promise<RCRTCErrorCode>

  • 设置本地自定义视频预览窗口

    memberof

    RCRTCEngineInterface

    Parameters

    • tag: string
    • view: number

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setLocalLiveMixInnerCdnVideoFps

  • setLocalLiveMixInnerCdnVideoFps(fps: RCRTCVideoFps): Promise<number>

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

    Parameters

    Returns Promise<number>

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

setLocalLiveMixInnerCdnVideoResolution

  • setLocalLiveMixInnerCdnVideoResolution(width: number, height: number): Promise<number>

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

    Parameters

    • width: number

      分辨率宽

    • height: number

      高

    Returns Promise<number>

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

setLocalView

  • 设置本地视频渲染窗口

    memberof

    RCRTCEngineInterface

    Parameters

    • tag: number

      窗口的 tag

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setOnAudioEffectCreatedListener

  • setOnAudioEffectCreatedListener(listener?: (id: string, code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (id: string, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (id: string, code: number, message: string): void

        • Parameters

          • id: string
          • code: number
          • message: string

          Returns void

    Returns void

setOnAudioEffectFinishedListener

  • setOnAudioEffectFinishedListener(listener?: (id: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (id: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (id: string): void

        • Parameters

          • id: string

          Returns void

    Returns void

setOnAudioMixingFinishedListener

  • setOnAudioMixingFinishedListener(listener?: () => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: () => void

      回调函数，不传值表示移除当前事件的所有监听。

        • (): void

        • Returns void

    Returns void

setOnAudioMixingPausedListener

  • setOnAudioMixingPausedListener(listener?: () => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: () => void

      回调函数，不传值表示移除当前事件的所有监听。

        • (): void

        • Returns void

    Returns void

setOnAudioMixingStartedListener

  • setOnAudioMixingStartedListener(listener?: () => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: () => void

      回调函数，不传值表示移除当前事件的所有监听。

        • (): void

        • Returns void

    Returns void

setOnAudioMixingStoppedListener

  • setOnAudioMixingStoppedListener(listener?: () => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: () => void

      回调函数，不传值表示移除当前事件的所有监听。

        • (): void

        • Returns void

    Returns void

setOnCancelJoinSubRoomRequestReceivedListener

  • setOnCancelJoinSubRoomRequestReceivedListener(listener?: (roomId: string, userId: string, extra: string) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, extra: string) => void
        • (roomId: string, userId: string, extra: string): void

        • Parameters

          • roomId: string
          • userId: string
          • extra: string

          Returns void

    Returns void

setOnCustomStreamPublishFinishedListener

  • setOnCustomStreamPublishFinishedListener(listener?: (tag: string) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (tag: string) => void
        • (tag: string): void

        • Parameters

          • tag: string

          Returns void

    Returns void

setOnCustomStreamPublishedListener

  • setOnCustomStreamPublishedListener(listener?: (tag: string, code: number, message: string) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (tag: string, code: number, message: string) => void
        • (tag: string, code: number, message: string): void

        • Parameters

          • tag: string
          • code: number
          • message: string

          Returns void

    Returns void

setOnCustomStreamSubscribedListener

  • setOnCustomStreamSubscribedListener(listener?: (userId: string, tag: string, type: RCRTCMediaType, code: number, message: string) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (userId: string, tag: string, type: RCRTCMediaType, code: number, message: string) => void
        • (userId: string, tag: string, type: RCRTCMediaType, code: number, message: string): void

        • Parameters

          • userId: string
          • tag: string
          • type: RCRTCMediaType
          • code: number
          • message: string

          Returns void

    Returns void

setOnCustomStreamUnpublishedListener

  • setOnCustomStreamUnpublishedListener(listener?: (tag: string, code: number, message: string) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (tag: string, code: number, message: string) => void
        • (tag: string, code: number, message: string): void

        • Parameters

          • tag: string
          • code: number
          • message: string

          Returns void

    Returns void

setOnCustomStreamUnsubscribedListener

  • setOnCustomStreamUnsubscribedListener(listener?: (userId: string, tag: string, type: RCRTCMediaType, code: number, message: string) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (userId: string, tag: string, type: RCRTCMediaType, code: number, message: string) => void
        • (userId: string, tag: string, type: RCRTCMediaType, code: number, message: string): void

        • Parameters

          • userId: string
          • tag: string
          • type: RCRTCMediaType
          • code: number
          • message: string

          Returns void

    Returns void

setOnEnableCameraListener

  • setOnEnableCameraListener(listener?: (enable: boolean, code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (enable: boolean, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (enable: boolean, code: number, message: string): void

        • Parameters

          • enable: boolean
          • code: number
          • message: string

          Returns void

    Returns void

setOnErrorListener

  • setOnErrorListener(listener?: (code: number, message: string) => void): void

  • 本地用户操作错误回调

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (code: number, message: string) => void
        • (code: number, message: string): void

        • Parameters

          • code: number
          • message: string

          Returns void

    Returns void

setOnJoinSubRoomRequestCanceledListener

  • setOnJoinSubRoomRequestCanceledListener(listener?: (roomId: string, userId: string, code: number, message: string) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, code: number, message: string) => void
        • (roomId: string, userId: string, code: number, message: string): void

        • Parameters

          • roomId: string
          • userId: string
          • code: number
          • message: string

          Returns void

    Returns void

setOnJoinSubRoomRequestReceivedListener

  • setOnJoinSubRoomRequestReceivedListener(listener?: (roomId: string, userId: string, extra: string) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, extra: string) => void
        • (roomId: string, userId: string, extra: string): void

        • Parameters

          • roomId: string
          • userId: string
          • extra: string

          Returns void

    Returns void

setOnJoinSubRoomRequestRespondedListener

  • setOnJoinSubRoomRequestRespondedListener(listener?: (roomId: string, userId: string, agree: boolean, code: number, message: string) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, agree: boolean, code: number, message: string) => void
        • (roomId: string, userId: string, agree: boolean, code: number, message: string): void

        • Parameters

          • roomId: string
          • userId: string
          • agree: boolean
          • code: number
          • message: string

          Returns void

    Returns void

setOnJoinSubRoomRequestResponseReceivedListener

  • setOnJoinSubRoomRequestResponseReceivedListener(listener?: (roomId: string, userId: string, agree: boolean, extra: string) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, agree: boolean, extra: string) => void
        • (roomId: string, userId: string, agree: boolean, extra: string): void

        • Parameters

          • roomId: string
          • userId: string
          • agree: boolean
          • extra: string

          Returns void

    Returns void

setOnJoinSubRoomRequestedListener

  • setOnJoinSubRoomRequestedListener(listener?: (roomId: string, userId: string, code: number, message: string) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, code: number, message: string) => void
        • (roomId: string, userId: string, code: number, message: string): void

        • Parameters

          • roomId: string
          • userId: string
          • code: number
          • message: string

          Returns void

    Returns void

setOnKickedListener

  • setOnKickedListener(listener?: (id: string, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (id: string, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (id: string, message: string): void

        • Parameters

          • id: string
          • message: string

          Returns void

    Returns void

setOnLiveCdnAddedListener

  • setOnLiveCdnAddedListener(listener?: (url: string, code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (url: string, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (url: string, code: number, message: string): void

        • Parameters

          • url: string
          • code: number
          • message: string

          Returns void

    Returns void

setOnLiveCdnRemovedListener

  • setOnLiveCdnRemovedListener(listener?: (url: string, code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (url: string, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (url: string, code: number, message: string): void

        • Parameters

          • url: string
          • code: number
          • message: string

          Returns void

    Returns void

setOnLiveMixAudioBitrateSetListener

  • setOnLiveMixAudioBitrateSetListener(listener?: (code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (code: number, message: string): void

        • Parameters

          • code: number
          • message: string

          Returns void

    Returns void

setOnLiveMixAudioStatsListener

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

    memberof

    RCRTCStatsEventsInterface

    Parameters

    Returns void

setOnLiveMixBackgroundColorSetListener

  • setOnLiveMixBackgroundColorSetListener(listener?: (code: number, message: string) => void): void

  • 设置合流布局背景颜色操作回调

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (code: number, message: string) => void
        • (code: number, message: string): void

        • Parameters

          • code: number
          • message: string

          Returns void

    Returns void

setOnLiveMixCustomAudiosSetListener

  • setOnLiveMixCustomAudiosSetListener(listener?: (code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (code: number, message: string): void

        • Parameters

          • code: number
          • message: string

          Returns void

    Returns void

setOnLiveMixCustomLayoutsSetListener

  • setOnLiveMixCustomLayoutsSetListener(listener?: (code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (code: number, message: string): void

        • Parameters

          • code: number
          • message: string

          Returns void

    Returns void

setOnLiveMixInnerCdnStreamEnabledListener

  • setOnLiveMixInnerCdnStreamEnabledListener(listener?: (enable: boolean, code: number, errMsg: string) => void): void

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

    Parameters

    • Optional listener: (enable: boolean, code: number, errMsg: string) => void
        • (enable: boolean, code: number, errMsg: string): void

        • Parameters

          • enable: boolean
          • code: number
          • errMsg: string

          Returns void

    Returns void

setOnLiveMixInnerCdnStreamSubscribedListener

  • setOnLiveMixInnerCdnStreamSubscribedListener(listener?: (code: number, errMsg: string) => void): void

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

    Parameters

    • Optional listener: (code: number, errMsg: string) => void
        • (code: number, errMsg: string): void

        • Parameters

          • code: number
          • errMsg: string

          Returns void

    Returns void

setOnLiveMixInnerCdnStreamUnsubscribedListener

  • setOnLiveMixInnerCdnStreamUnsubscribedListener(listener?: (code: number, errMsg: string) => void): void

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

    Parameters

    • Optional listener: (code: number, errMsg: string) => void
        • (code: number, errMsg: string): void

        • Parameters

          • code: number
          • errMsg: string

          Returns void

    Returns void

setOnLiveMixLayoutModeSetListener

  • setOnLiveMixLayoutModeSetListener(listener?: (code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (code: number, message: string): void

        • Parameters

          • code: number
          • message: string

          Returns void

    Returns void

setOnLiveMixMemberAudioStatsListener

  • setOnLiveMixMemberAudioStatsListener(listener?: (userId: string, volume: number) => void): void

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

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (userId: string, volume: number) => void

      回调函数，不传值表示移除当前事件的所有监听。

        • (userId: string, volume: number): void

        • Parameters

          • userId: string
          • volume: number

          Returns void

    Returns void

setOnLiveMixMemberCustomAudioStatsListener

  • setOnLiveMixMemberCustomAudioStatsListener(listener?: (userId: string, tag: string, volume: number) => void): void

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

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (userId: string, tag: string, volume: number) => void

      回调函数，不传值表示移除当前事件的所有监听。

        • (userId: string, tag: string, volume: number): void

        • Parameters

          • userId: string
          • tag: string
          • volume: number

          Returns void

    Returns void

setOnLiveMixRenderModeSetListener

  • setOnLiveMixRenderModeSetListener(listener?: (code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (code: number, message: string): void

        • Parameters

          • code: number
          • message: string

          Returns void

    Returns void

setOnLiveMixSeiReceivedListener

  • setOnLiveMixSeiReceivedListener(listener?: (sei: string) => void): void

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

    Parameters

    • Optional listener: (sei: string) => void
        • (sei: string): void

        • Parameters

          • sei: string

          Returns void

    Returns void

setOnLiveMixSubscribedListener

  • setOnLiveMixSubscribedListener(listener?: (type: RCRTCMediaType, code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (type: RCRTCMediaType, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

    Returns void

setOnLiveMixUnsubscribedListener

  • setOnLiveMixUnsubscribedListener(listener?: (type: RCRTCMediaType, code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (type: RCRTCMediaType, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

    Returns void

setOnLiveMixVideoBitrateSetListener

  • setOnLiveMixVideoBitrateSetListener(listener?: (tiny: boolean, code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (tiny: boolean, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (tiny: boolean, code: number, message: string): void

        • Parameters

          • tiny: boolean
          • code: number
          • message: string

          Returns void

    Returns void

setOnLiveMixVideoFpsSetListener

  • setOnLiveMixVideoFpsSetListener(listener?: (tiny: boolean, code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (tiny: boolean, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (tiny: boolean, code: number, message: string): void

        • Parameters

          • tiny: boolean
          • code: number
          • message: string

          Returns void

    Returns void

setOnLiveMixVideoResolutionSetListener

  • setOnLiveMixVideoResolutionSetListener(listener?: (tiny: boolean, code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (tiny: boolean, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (tiny: boolean, code: number, message: string): void

        • Parameters

          • tiny: boolean
          • code: number
          • message: string

          Returns void

    Returns void

setOnLiveMixVideoStatsListener

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

    memberof

    RCRTCStatsEventsInterface

    Parameters

    Returns void

setOnLiveRoleSwitchedListener

  • setOnLiveRoleSwitchedListener(listener?: (current: RCRTCRole, code: number, message: string) => void): void

  • 切换直播角色回调

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (current: RCRTCRole, code: number, message: string) => void
        • (current: RCRTCRole, code: number, message: string): void

        • Parameters

          • current: RCRTCRole
          • code: number
          • message: string

          Returns void

    Returns void

setOnLocalAudioStatsListener

  • 上报本地音频统计信息

    memberof

    RCRTCEngineEventsInterface

    Parameters

    Returns void

setOnLocalCustomAudioStatsListener

  • setOnLocalCustomAudioStatsListener(listener?: (tag: string, stats: RCRTCLocalAudioStats) => void): void

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

    memberof

    RCRTCStatsEventsInterface

    Parameters

    Returns void

setOnLocalCustomVideoStatsListener

  • setOnLocalCustomVideoStatsListener(listener?: (tag: string, stats: RCRTCLocalVideoStats) => void): void

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

    memberof

    RCRTCStatsEventsInterface

    Parameters

    Returns void

setOnLocalLiveMixInnerCdnVideoFpsSetListener

  • setOnLocalLiveMixInnerCdnVideoFpsSetListener(listener?: (code: number, errMsg: string) => void): void

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

    Parameters

    • Optional listener: (code: number, errMsg: string) => void
        • (code: number, errMsg: string): void

        • Parameters

          • code: number
          • errMsg: string

          Returns void

    Returns void

setOnLocalLiveMixInnerCdnVideoResolutionSetListener

  • setOnLocalLiveMixInnerCdnVideoResolutionSetListener(listener?: (code: number, errMsg: string) => void): void

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

    Parameters

    • Optional listener: (code: number, errMsg: string) => void
        • (code: number, errMsg: string): void

        • Parameters

          • code: number
          • errMsg: string

          Returns void

    Returns void

setOnLocalVideoStatsListener

  • 上报本地视频统计信息

    memberof

    RCRTCEngineEventsInterface

    Parameters

    Returns void

setOnNetworkProbeDownLinkStatsListener

setOnNetworkProbeFinishedListener

  • setOnNetworkProbeFinishedListener(listener?: (code: number, errMsg: string) => void): void

  • 网络探测完成

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (code: number, errMsg: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

        • (code: number, errMsg: string): void

        • Parameters

          • code: number
          • errMsg: string

          Returns void

    Returns void

setOnNetworkProbeStartedListener

  • setOnNetworkProbeStartedListener(listener?: (code: number, errMsg: string) => void): void

  • 开启网络探测结果回调

    Parameters

    • Optional listener: (code: number, errMsg: string) => void
        • (code: number, errMsg: string): void

        • Parameters

          • code: number
          • errMsg: string

          Returns void

    Returns void

setOnNetworkProbeStoppedListener

  • setOnNetworkProbeStoppedListener(listener?: (code: number, errMsg: string) => void): void

  • 关闭网络探测结果回调

    Parameters

    • Optional listener: (code: number, errMsg: string) => void
        • (code: number, errMsg: string): void

        • Parameters

          • code: number
          • errMsg: string

          Returns void

    Returns void

setOnNetworkProbeUpLinkStatsListener

setOnNetworkStatsListener

  • 上报网络状态统计信息

    memberof

    RCRTCEngineEventsInterface

    Parameters

    Returns void

setOnPublishedListener

  • setOnPublishedListener(listener?: (type: RCRTCMediaType, code: number, message: string) => void): void

  • 本地用户发布资源回调

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (type: RCRTCMediaType, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

    Returns void

setOnRemoteAudioStatsListener

  • setOnRemoteAudioStatsListener(listener?: (roomId: string, userId: string, stats: RCRTCRemoteAudioStats) => void): void

  • 上报远端音频统计信息

    memberof

    RCRTCEngineEventsInterface

    Parameters

    Returns void

setOnRemoteCustomAudioStatsListener

  • setOnRemoteCustomAudioStatsListener(listener?: (roomId: string, userId: string, tag: string, stats: RCRTCRemoteAudioStats) => void): void

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

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, tag: string, stats: RCRTCRemoteAudioStats) => void

      回调函数，不传值表示移除当前事件的所有监听。

    Returns void

setOnRemoteCustomStreamFirstFrameListener

  • setOnRemoteCustomStreamFirstFrameListener(listener?: (roomId: string, userId: string, tag: string, type: RCRTCMediaType) => void): void

  • 收到远端用户自定义流第一个关键帧回调, 仅供会议用户或直播主播用户使用

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, tag: string, type: RCRTCMediaType) => void
        • (roomId: string, userId: string, tag: string, type: RCRTCMediaType): void

        • Parameters

          Returns void

    Returns void

setOnRemoteCustomStreamPublishedListener

  • setOnRemoteCustomStreamPublishedListener(listener?: (roomId: string, userId: string, tag: string, type: RCRTCMediaType) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, tag: string, type: RCRTCMediaType) => void
        • (roomId: string, userId: string, tag: string, type: RCRTCMediaType): void

        • Parameters

          Returns void

    Returns void

setOnRemoteCustomStreamStateChangedListener

  • setOnRemoteCustomStreamStateChangedListener(listener?: (roomId: string, userId: string, tag: string, type: RCRTCMediaType, disabled: boolean) => void): void

  • 远端用户开关自定义流操作回调

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, tag: string, type: RCRTCMediaType, disabled: boolean) => void
        • (roomId: string, userId: string, tag: string, type: RCRTCMediaType, disabled: boolean): void

        • Parameters

          • roomId: string
          • userId: string
          • tag: string
          • type: RCRTCMediaType
          • disabled: boolean

          Returns void

    Returns void

setOnRemoteCustomStreamUnpublishedListener

  • setOnRemoteCustomStreamUnpublishedListener(listener?: (roomId: string, userId: string, tag: string, type: RCRTCMediaType) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, tag: string, type: RCRTCMediaType) => void
        • (roomId: string, userId: string, tag: string, type: RCRTCMediaType): void

        • Parameters

          Returns void

    Returns void

setOnRemoteCustomVideoStatsListener

  • setOnRemoteCustomVideoStatsListener(listener?: (roomId: string, userId: string, tag: string, stats: RCRTCRemoteVideoStats) => void): void

  • 上报远端自定义视频统计信息

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, tag: string, stats: RCRTCRemoteVideoStats) => void

      回调函数，不传值表示移除当前事件的所有监听。

    Returns void

setOnRemoteFirstFrameListener

  • setOnRemoteFirstFrameListener(listener?: (roomId: string, userId: string, type: RCRTCMediaType) => void): void

  • 收到远端用户第一个音频或视频关键帧回调, 仅供会议用户或直播主播用户使用

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, type: RCRTCMediaType) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

    Returns void

setOnRemoteLiveMixFirstFrameListener

  • setOnRemoteLiveMixFirstFrameListener(listener?: (type: RCRTCMediaType) => void): void

  • 收到远端用户第一个音频或视频关键帧回调, 仅供直播观众用户使用

    memberof

    RCRTCEngineEventsInterface

    Parameters

    Returns void

setOnRemoteLiveMixInnerCdnStreamPublishedListener

  • setOnRemoteLiveMixInnerCdnStreamPublishedListener(listener?: () => void): void

  • 直播内置 cdn 资源发布回调

    Parameters

    • Optional listener: () => void
        • (): void

        • Returns void

    Returns void

setOnRemoteLiveMixInnerCdnStreamUnpublishedListener

  • setOnRemoteLiveMixInnerCdnStreamUnpublishedListener(listener?: () => void): void

  • 直播内置 cdn 资源取消发布回调

    Parameters

    • Optional listener: () => void
        • (): void

        • Returns void

    Returns void

setOnRemoteLiveMixPublishedListener

  • setOnRemoteLiveMixPublishedListener(listener?: (type: RCRTCMediaType) => void): void

  • 远端用户发布直播资源操作回调, 仅供直播观众用户使用

    memberof

    RCRTCEngineEventsInterface

    Parameters

    Returns void

setOnRemoteLiveMixUnpublishedListener

  • setOnRemoteLiveMixUnpublishedListener(listener?: (type: RCRTCMediaType) => void): void

  • 远端用户取消发布直播资源操作回调, 仅供直播观众用户使用

    memberof

    RCRTCEngineEventsInterface

    Parameters

    Returns void

setOnRemoteLiveRoleSwitchedListener

  • setOnRemoteLiveRoleSwitchedListener(listener?: (roomId: string, userId: string, role: RCRTCRole) => void): void

  • 远端用户身份切换回调

    Parameters

    • Optional listener: (roomId: string, userId: string, role: RCRTCRole) => void
        • (roomId: string, userId: string, role: RCRTCRole): void

        • Parameters

          Returns void

    Returns void

setOnRemotePublishedListener

  • setOnRemotePublishedListener(listener?: (roomId: string, userId: string, type: RCRTCMediaType) => void): void

  • 远端用户发布资源操作回调, 仅供会议用户或直播主播用户使用

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, type: RCRTCMediaType) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

    Returns void

setOnRemoteStateChangedListener

  • setOnRemoteStateChangedListener(listener?: (roomId: string, userId: string, type: RCRTCMediaType, disabled: boolean) => void): void

  • 远端用户开关麦克风或摄像头操作回调

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, type: RCRTCMediaType, disabled: boolean) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (roomId: string, userId: string, type: RCRTCMediaType, disabled: boolean): void

        • Parameters

          Returns void

    Returns void

setOnRemoteUnpublishedListener

  • setOnRemoteUnpublishedListener(listener?: (roomId: string, userId: string, type: RCRTCMediaType) => void): void

  • 远端用户取消发布资源操作回调, 仅供会议用户或直播主播用户使用

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string, type: RCRTCMediaType) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

    Returns void

setOnRemoteVideoStatsListener

  • setOnRemoteVideoStatsListener(listener?: (roomId: string, userId: string, stats: RCRTCRemoteVideoStats) => void): void

  • 上报远端视频统计信息

    memberof

    RCRTCEngineEventsInterface

    Parameters

    Returns void

setOnRoomJoinedListener

  • setOnRoomJoinedListener(listener?: (code: number, message: string) => void): void

  • 本地用户加入房间回调

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (code: number, message: string): void

        • Parameters

          • code: number
          • message: string

          Returns void

    Returns void

setOnRoomLeftListener

  • setOnRoomLeftListener(listener?: (code: number, message: string) => void): void

  • 本地用户离开房间回调

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (code: number, message: string): void

        • Parameters

          • code: number
          • message: string

          Returns void

    Returns void

setOnSeiEnabledListener

  • setOnSeiEnabledListener(listener?: (enable: boolean, code: number, errMsg: string) => void): void

  • 开启 SEI 功能结果回调

    Parameters

    • Optional listener: (enable: boolean, code: number, errMsg: string) => void
        • (enable: boolean, code: number, errMsg: string): void

        • Parameters

          • enable: boolean
          • code: number
          • errMsg: string

          Returns void

    Returns void

setOnSeiReceivedListener

  • setOnSeiReceivedListener(listener?: (roomId: string, userId: string, sei: string) => void): void

  • 收到 SEI 信息回调

    Parameters

    • Optional listener: (roomId: string, userId: string, sei: string) => void
        • (roomId: string, userId: string, sei: string): void

        • Parameters

          • roomId: string
          • userId: string
          • sei: string

          Returns void

    Returns void

setOnSubRoomBandedListener

  • setOnSubRoomBandedListener(listener?: (roomId: string) => void): void

  • 连麦中的子房间回调, 仅供直播主播用户使用

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string) => void
        • (roomId: string): void

        • Parameters

          • roomId: string

          Returns void

    Returns void

setOnSubRoomDisbandListener

  • setOnSubRoomDisbandListener(listener?: (roomId: string, userId: string) => void): void

  • 子房间结束连麦回调, 仅供直播主播用户使用

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string) => void
        • (roomId: string, userId: string): void

        • Parameters

          • roomId: string
          • userId: string

          Returns void

    Returns void

setOnSubRoomJoinedListener

  • setOnSubRoomJoinedListener(listener?: (roomId: string, code: number, message: string) => void): void

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

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, code: number, message: string) => void
        • (roomId: string, code: number, message: string): void

        • Parameters

          • roomId: string
          • code: number
          • message: string

          Returns void

    Returns void

setOnSubRoomLeftListener

  • setOnSubRoomLeftListener(listener?: (roomId: string, code: number, message: string) => void): void

  • 离开子房间回调, 仅供直播主播用户使用

    回调参数

    memberof

    RCRTCStatsEventsInterface

    Parameters

    • Optional listener: (roomId: string, code: number, message: string) => void
        • (roomId: string, code: number, message: string): void

        • Parameters

          • roomId: string
          • code: number
          • message: string

          Returns void

    Returns void

setOnSubscribedListener

  • setOnSubscribedListener(listener?: (userId: string, type: RCRTCMediaType, code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (userId: string, type: RCRTCMediaType, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (userId: string, type: RCRTCMediaType, code: number, message: string): void

        • Parameters

          Returns void

    Returns void

setOnSwitchCameraListener

  • setOnSwitchCameraListener(listener?: (camera: RCRTCCamera, code: number, message: string) => void): void

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

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (camera: RCRTCCamera, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (camera: RCRTCCamera, code: number, message: string): void

        • Parameters

          Returns void

    Returns void

setOnUnpublishedListener

  • setOnUnpublishedListener(listener?: (type: RCRTCMediaType, code: number, message: string) => void): void

  • 本地用户取消发布资源回调

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (type: RCRTCMediaType, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

    Returns void

setOnUnsubscribedListener

  • setOnUnsubscribedListener(listener?: (userId: string, type: RCRTCMediaType, code: number, message: string) => void): void

  • 取消订阅远端用户发布的资源, 仅供会议用户或直播主播用户使用

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (userId: string, type: RCRTCMediaType, code: number, message: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (userId: string, type: RCRTCMediaType, code: number, message: string): void

        • Parameters

          Returns void

    Returns void

setOnUserJoinedListener

  • setOnUserJoinedListener(listener?: (roomId: string, userId: string) => void): void

  • 远端用户加入房间操作回调, 仅供会议用户或直播主播用户使用

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (roomId: string, userId: string): void

        • Parameters

          • roomId: string
          • userId: string

          Returns void

    Returns void

setOnUserLeftListener

  • setOnUserLeftListener(listener?: (roomId: string, userId: string) => void): void

  • 远端用户离开房间操作回调, 仅供会议用户或直播主播用户使用

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (roomId: string, userId: string): void

        • Parameters

          • roomId: string
          • userId: string

          Returns void

    Returns void

setOnUserOfflineListener

  • setOnUserOfflineListener(listener?: (roomId: string, userId: string) => void): void

  • 远端用户因离线离开房间操作回调, 仅供会议用户或直播主播用户使用

    memberof

    RCRTCEngineEventsInterface

    Parameters

    • Optional listener: (roomId: string, userId: string) => void

      回调函数，不传值表示移除当前事件的所有监听。

      回调参数

        • (roomId: string, userId: string): void

        • Parameters

          • roomId: string
          • userId: string

          Returns void

    Returns void

setOnWatermarkRemovedListener

  • setOnWatermarkRemovedListener(listener?: (code: number, errMsg: string) => void): void

  • 移除水印的回调

    Parameters

    • Optional listener: (code: number, errMsg: string) => void
        • (code: number, errMsg: string): void

        • Parameters

          • code: number
          • errMsg: string

          Returns void

    Returns void

setOnWatermarkSetListener

  • setOnWatermarkSetListener(listener?: (code: number, errMsg: string) => void): void

  • 设置水印的回调

    Parameters

    • Optional listener: (code: number, errMsg: string) => void
        • (code: number, errMsg: string): void

        • Parameters

          • code: number
          • errMsg: string

          Returns void

    Returns void

setRemoteCustomStreamView

  • setRemoteCustomStreamView(userId: string, tag: string, view: number): Promise<RCRTCErrorCode>

  • 设置远端自定义视频预览窗口

    memberof

    RCRTCEngineInterface

    Parameters

    • userId: string
    • tag: string
    • view: number

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setRemoteView

  • 设置远端视频窗口

    memberof

    RCRTCEngineInterface

    Parameters

    • userId: string

      远端用户Id

    • tag: number

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setVideoConfig

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

    memberof

    RCRTCEngineInterface

    Parameters

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

setWatermark

  • 设置水印

    memberof

    RCRTCEngineInterface

    Parameters

    • imagePath: string

      水印图片的 tag

    • position: RCRTCIWPoint

      水印的位置和尺寸参数，参数取值范围 0 ~ 1，SDK 内部会根据视频分辨率计算水印实际的像素位置和尺寸。

    • zoom: number

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

startEchoTest

  • startEchoTest(timeInterval: number): Promise<number>

  • 开始麦克风&扬声器检测

    Parameters

    • timeInterval: number

      麦克风录制时间

    Returns Promise<number>

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

startNetworkProbe

  • 开启网络探测

    memberof

    RCRTCEngineInterface

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

stopAllAudioEffects

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

    memberof

    RCRTCEngineInterface

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

stopAudioEffect

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

    memberof

    RCRTCEngineInterface

    Parameters

    • effectId: number

      自定义全局唯一音效Id

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

stopEchoTest

  • stopEchoTest(): Promise<number>

  • 停止麦克风&扬声器检测，结束检测后必须手动调用停止方法

    Returns Promise<number>

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

stopNetworkProbe

  • stopNetworkProbe(): Promise<number>

  • 停止网络探测

    Returns Promise<number>

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

subscribe

  • memberof

    RCRTCEngineInterface

    Parameters

    • userId: string

      远端用户 userId

    • type: RCRTCMediaType

      媒体资源类型

    • tiny: boolean

      视频小流, true:订阅视频小流 false:订阅视频大流

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

subscribeCustomStream

  • subscribeCustomStream(userId: string, tag: string, type: number, tiny: boolean): Promise<RCRTCErrorCode>

  • 订阅自定义流

    memberof

    RCRTCEngineInterface

    Parameters

    • userId: string
    • tag: string
    • type: number
    • tiny: boolean

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

subscribeLiveMix

  • 订阅主播合流资源, 仅供直播观众用户使用

    memberof

    RCRTCEngineInterface 错误码

    Parameters

    • type: RCRTCMediaType

      媒体资源类型

    • tiny: boolean

      是否视频小流 true:订阅视频小流 false:订阅视频大流

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

subscribeLiveMixInnerCdnStream

  • subscribeLiveMixInnerCdnStream(): Promise<number>

  • 订阅直播内置 cdn 流

    Returns Promise<number>

    0: 成功, 非0: 失败

subscribes

  • 加入房间后, 订阅远端多个用户发布的资源

    memberof

    RCRTCEngineInterface 错误码

    Parameters

    • userIds: string[]

      远端用户 userId 数组

    • type: RCRTCMediaType

      媒体资源类型

    • tiny: boolean

      是否视频小流 true:订阅视频小流 false:订阅视频大流

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

switchCamera

  • 切换前后摄像头

    memberof

    RCRTCEngineInterface

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

switchLiveRole

  • switchLiveRole(role: RCRTCRole): Promise<number>

  • 切换直播角色

    Parameters

    Returns Promise<number>

    0: 成功, 非0: 失败

switchToCamera

  • 切换到指定摄像头

    memberof

    RCRTCEngineInterface

    Parameters

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

unpublish

  • 加入房间后, 取消发布已经发布的本地资源

    memberof

    RCRTCEngineInterface 错误码

    Parameters

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

unpublishCustomStream

  • 取消发布自定义视频

    memberof

    RCRTCEngineInterface

    Parameters

    • tag: string

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

unsubscribe

  • 加入房间后, 取消订阅远端单个用户发布的资源

    memberof

    RCRTCEngineInterface 错误码

    Parameters

    • userId: string

      远端用户 userId

    • type: RCRTCMediaType

      媒体资源类型

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

unsubscribeCustomStream

  • unsubscribeCustomStream(userId: string, tag: string, type: number): Promise<RCRTCErrorCode>

  • 取消订阅自定义流

    memberof

    RCRTCEngineInterface

    Parameters

    • userId: string
    • tag: string
    • type: number

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

unsubscribeLiveMix

  • 取消订阅主播合流资源, 仅供直播观众用户使用

    memberof

    RCRTCEngineInterface 错误码

    Parameters

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

unsubscribeLiveMixInnerCdnStream

  • unsubscribeLiveMixInnerCdnStream(): Promise<number>

  • 取消订阅直播内置 cdn 流

    Returns Promise<number>

    0: 成功, 非0: 失败

unsubscribes

  • 加入房间后, 取消订阅远端多个用户发布的资源

    memberof

    RCRTCEngineInterface

    Parameters

    • userIds: string[]

      远端用户 userId 数组

    • type: RCRTCMediaType

      媒体资源类型

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

whichCamera

  • 获取当前使用摄像头位置

    memberof

    RCRTCEngineInterface

    Returns Promise<RCRTCCamera>

    {Promise} 摄像头类型

Static create

  • 创建 RTC 接口引擎

    Parameters

    Returns default

    引擎实例

混音 Methods

pauseAudioMixing

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

    memberof

    RCRTCEngineInterface

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

startAudioMixing

  • 开始混音, 仅支持混合本地音频文件数据, 仅供会议用户或直播主播用户使用

    memberof

    RCRTCEngineInterface

    Parameters

    • path: string

      仅支持本地音频文件

    • mode: RCRTCAudioMixingMode

      混音行为模式

    • playback: boolean = true

      是否本地播放， 默认 true

    • loop: number = 1

      循环混音或者播放次数，默认播放 1 次

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

stopAudioMixing

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

    memberof

    RCRTCEngineInterface

    Returns Promise<RCRTCErrorCode>

    0: 成功, 非0: 失败

Generated using TypeDoc