IAudioMixingManager

成员方法

方法详情

startAudioMixing

开启混音

(id: number, filePath: string, options: MixOption) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 如果已经通过 preloadAudioMixing 加载音效，确保此处的 ID 与上次调用 preloadAudioMixing 设置的 ID 相同。
  
• 如果使用相同的 ID 重复调用本方法，前一次混音会停止，后一次混音开始
  
• 开始播放音频文件后，可以调用 stopAudioMixing 方法停止播放音频文件。
  
• 本方法的混音数据来源于外部文件，而 enableAudioMixingFrame 的混音数据来源于外部缓存且音频格式为 PCM，这两种混音方式可以共存。

stopAudioMixing

停止播放音频文件

(id: number) => void

参数

注意

• 调用 startAudioMixing 方法开始播放音频文件后，可以调用本方法停止播放音频文件。
  
• 调用本方法停止播放音频文件后，该音频文件会被自动卸载。

pauseAudioMixing

暂停播放音频文件

(id: number) => void

参数

注意

• 调用 startAudioMixing 方法开始播放音频文件后，可以通过调用本方法暂停播放音频文件。
  
• 调用本方法暂停播放音频文件后，可调用 resumeAudioMixing 方法恢复播放及混音。
  

resumeAudioMixing

恢复播放音频文件

(id: number) => void

参数

注意

调用 pauseAudioMixing 方法暂停播放音频文件后，可以通过调用本方法恢复播放及混音。

preloadAudioMixing

预加载指定音频文件到内存中

(id: number, filePath: string) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 需要频繁播放某个音频文件的时候，调用本方法预加载该文件，在播放的时候可以只加载一次该文件，减少 CPU 占用。
  
• 本方法只是预加载指定音频文件，只有调用 startAudioMixing 方法才开始播放指定音频文件。
  
• 调用本方法预加载的指定音频文件可以通过 unloadAudioMixing 卸载。

unloadAudioMixing

卸载指定音频文件

(id: number) => void

参数

setAudioMixingVolume

调节混音的音量大小，包括音频文件混音和 PCM 混音。

(id: number, volume: number) => void

参数

getAudioMixingVolume

获取音频文件的音量

(id: number) => number

参数

返回值

类型: number

• 0: 获取失败
  
• >0: 成功，音量值
  

getAudioMixingDuration

获取音频文件时长

(id: number) => number

参数

返回值

类型: number

• 0: 成功, 音频文件时长，单位为毫秒。
  

• < 0: 失败

注意

调用本方法获取音频文件时长前，需要先调用 preloadAudioMixing 或 startAudioMixing。

getAudioMixingCurrentPosition

获取音频文件播放进度

(id: number) => number

参数

返回值

类型: number

• 0: 成功, 音频文件播放进度，单位为毫秒。
  

• < 0: 失败

注意

调用本方法获取音频文件播放进度前，需要先调用 startAudioMixing 开始播放音频文件。

setAudioMixingPosition

设置音频文件的起始播放位置

(id: number, position: number) => void

参数

注意

• 调用本方法你可以根据实际情况从指定的位置播放音频文件，无需从头到尾完整播放一个音频文件。
  
• 调用本方法设置音频文件起始播放位置前，需要先调用 startAudioMixing 开始播放音频文件。

enableAudioMixingBuffer

启动 PCM 音频数据混音

(type: AudioMixingType) => void

参数

注意

• 必须先调用本方法启动 PCM 音频数据混音，随后调用 pushAudioMixingFrame 方法，才会开始混音。
  
• 如要结束 PCM 音频数据混音，使用 disableAudioMixingFrame。

disableAudioMixingBuffer

关闭 PCM 混音

() => void

pushAudioMixingBuffer

推送 PCM 音频数据用于混音

(buffer: AudioBuffer) => void

参数

注意

调用该方法前，须通过 enableAudioMixingFrame 启动外部音频流混音。

IRTCEngine

成员方法

方法详情

joinRoom

加入房间。

调用此方法加入房间，同房间内其他用户进行音视频通话。

(token: string | null, roomId: string, userInfo: UserInfo, roomConfig: RoomConfig) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 同一个 App ID 的同一个房间内，每个用户的用户 ID 必须是唯一的。如果两个用户的用户 ID 相同，则先进房的用户将自动退房并收到 DUPLICATE_LOGIN 错误。
  
• 本地用户调用 setUserVisibility 将自身设为可见后加入房间，远端用户会收到 onUserJoined 回调通知。
  
• 用户加入房间成功后，在本地网络状况不佳的情况下，SDK 可能会与服务器失去连接，此时 SDK 将会自动重连。重连成功后，如果加入房间的为可见用户，远端用户会收到 onUserJoined 回调通知。
  

leaveRoom

离开房间。

用户调用此方法离开房间，结束通话过程，释放所有通话相关的资源。

() => void

注意

• 可见的用户离开房间后，房间内其他用户会收到 onUserLeave 回调通知。
  
• 调用 joinRoom 方法加入房间后，必须调用此方法结束通话，否则无法开始下一次通话。重复调用此方法没有负面影响。
  

destroy

销毁 createEngine 所创建引擎实例，并释放所有相关资源。

() => void

注意

• 请确保和需要销毁的 RTCEngine 实例相关的业务场景全部结束后，才调用此方法
  
• 该方法在调用之后，会销毁所有和此 RTCEngine 实例相关的内存，并且停止与媒体服务器的任何交互
  
• 本方法为阻塞调用，会阻塞当前线程直到 SDK 彻底完成退出逻辑，因而需要注意不要在回调线程中直接调用本方法，也需要注意不要在回调方法中等待主线程的执行，而同时在主线程调用本方法，从而造成死锁
  

publish

在当前所在房间内手动开始发布本地音视频流

() => Promise<void>

返回值

类型: Promise<void>

注意

• 如果你已经在用户进房时通过调用 joinRoom 选择了自动发布，则无需再调用本接口。
  
• 调用 setUserVisibility 方法将自身设置为不可见后无法调用该方法，需将自身切换至可见后方可调用该方法发布音视频流。
  
• 同一用户，同一时间，只能在一个房间内发流。如果你需要发布屏幕共享流，调用 publishScreen。
• 用户调用此方法成功发布音视频流后，房间中的其他用户将会收到 onStreamAdd 回调通知。

unpublish

在当前所在房间内停止发布本地音视频流。

() => Promise<void>

返回值

类型: Promise<void>

注意

• 调用 publish 手动发布音视频流后或在用户进房时设置为自动发布，都可以调用此接口停止发布。
  
• 用户调用此方法停止发布音视频流后，房间中的其他用户将会收到 onStreamRemove 回调通知。

subscribeUserStream

订阅房间内指定的远端音视频流。

无论自动订阅还是手动订阅模式，你都可以调用此方法按需订阅房间中的音视频流。

该方法也可用于更新已经订阅的流的属性、媒体类型等配置。

(userId: string, mediaType: SubscribeMediaType, streamType?: StreamIndex, configure?: SubscribeVideoConfig) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 你可以通过 onStreamAdd 和 onStreamRemove 两个事件获取当前房间你的音视频流信息，并调用本方法按需订阅流或修改订阅配置。
  
• 若调用 pauseAllSubscribedStream 暂停接收远端音视频流，此时仍可使用该方法对暂停接收的流进行设置，你会在调用 resumeAllSubscribedStream 恢复接收流后收到修改设置后的流。
  

unSubscribe

停止订阅指定的房间内远端音视频流。
无论自动订阅还是手动订阅模式，你都可以调用此方法取消已订阅的音视频流。

(userId: string, isScreen: boolean) => Promise<void>

参数

返回值

类型: Promise<void>

注意

无论是否订阅了指定的远端音视频流，都可以调用此方法。userId 无效或未订阅时，SDK 不会做任何处理，没有负面影响。

updateToken

更新 Token。

用于加入房间的 Token 有一定的有效期。当 Token 过期时，需要调用此方法更新房间的 Token 信息。

(token: string) => void

参数

注意

• 调用 joinRoom 方法加入房间或断网重连进入房间时，如果 Token 过期，将导致加入房间失败，回调错误码为 INVALID_TOKEN。此时需要重新获取 Token，并调用此方法更新 Token。
  
• 如果因 Token 过期导致加入房间失败，则调用此方法更新 Token 后，SDK 会自动重新加入房间，不需要再次调用 joinRoom 方法。
  
• Token 过期时，如果已经加入房间成功，则不会受到影响。

switchMicrophone

切换内部采集时使用的麦克风

(deviceId: string) => Promise<void>

参数

返回值

类型: Promise<void>

注意

如果你正在使用麦克风进行音频采集，切换操作当即生效；如果麦克风未启动，后续开启内部采集时，会打开设定的麦克风。

switchCamera

切换内部采集时使用的摄像头

默认摄像头由浏览器指定。

(deviceId: string) => Promise<void>

参数

返回值

类型: Promise<void>

注意

如果你正在使用相机进行视频采集，切换操作当即生效；如果相机未启动，后续开启内部采集时，会打开设定的摄像头。

startVideoCapture

立即开启内部视频采集。默认为关闭状态。

内部视频采集是指：使用 RTC SDK 内置的视频采集机制进行视频采集。
发布流后调用该方法，房间中的其他用户会收到 onUserStartVideoCapture 的回调。

(deviceId?: string) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 调用 stopVideoCapture 可以停止内部视频采集。否则，只有当销毁引擎实例时，内部视频采集才会停止。
  
• 创建引擎后，无论是否发布视频数据，你都可以调用该方法开启内部视频采集。只有当（内部或外部）视频采集开始以后视频流才会发布。
  
• 内部视频采集使用的摄像头由 switchCamera 接口指定。

stopVideoCapture

关闭内部视频采集。默认为关闭状态。

内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。

发布流后调用该方法，房间中的其他用户会收到 onUserStopVideoCapture 的回调。

() => Promise<void>

返回值

类型: Promise<void>

注意

• 调用 startVideoCapture 可以开启内部视频采集。
  
• 如果不调用本方法停止内部视频采集，则只有当销毁引擎实例时，内部视频采集才会停止。
  

startAudioCapture

立即开启内部音频采集。默认为关闭状态。

内部采集是指：使用 RTC SDK 内置的视频采集机制进行视频采集。
发布流后调用该方法，房间中的其他用户会收到 onUserStartAudioCapture 的回调。

(deviceId?: string) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 调用 stopVideoCapture 可以停止内部音频采集。否则，只有当销毁引擎实例时，内部音频采集才会停止。
• 创建引擎后，无论是否发布音频数据，你都可以调用该方法开启音频采集，只有当（内部或外部）音频采集开始以后视频流才会发布。
  

stopAudioCapture

立即关闭内部音频采集。默认为关闭状态。

内部采集是指：使用 RTC SDK 内置的视频采集机制进行视频采集。
调用该方法，本地用户会收到 onUserStopAudioCapture 的回调。

() => Promise<void>

返回值

类型: Promise<void>

注意

• 调用 startAudioCapture 可以开启内部音频采集。
  
• 如果不调用本方法停止内部视频采集，则只有当销毁引擎实例时，内部音频采集才会停止。
  

startScreenCapture

使用内部采集模块，采集当前屏幕视频流，用于共享。

(screenConfig?: ScreenConfig) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 调用此方法仅开启屏幕流视频采集，不会发布采集到的视频。发布屏幕流视频需要调用 publishScreen。
  
• 要关闭屏幕视频源采集，调用 stopScreenVideoCapture。
  
• 调用此接口前，你可以调用 setVideoEncoderConfig 设置屏幕视频流的采集帧率和编码分辨率。
  

stopScreenCapture

停止屏幕共享流内部采集。

() => Promise<void>

返回值

类型: Promise<void>

注意

调用该接口后远端会收到 onStreamRemove 事件

publishScreen

发布本地屏幕共享流。

() => Promise<void>

返回值

类型: Promise<void>

注意

• 你必须先加入房间，才能调用此方法。
  
• 该方法仅适用于可见的用户。
  
• 调用后，远端会收到 onStreamAdd 回调。
  
• 调用 unpublishScreen 取消发布。

unpublishScreen

停止发布本地屏幕共享流。

() => Promise<void>

返回值

类型: Promise<void>

注意

• 要开启发布，调用 publishScreen。
  
• 调用后，远端会收到 onStreamRemove 回调。

setLocalVideoPlayer

设置本地视频渲染时，使用的视图，并设置渲染模式。
调用本方法绑定视图以后，你可以通过 onPlayerEvent 来监听播放状态。
你可以通过再次调用本方法，并绑定空视图来解除绑定。

(streamIndex: StreamIndex, videoPlayerOption?: VideoPlayerOption) => HTMLVideoElement | undefined

参数

返回值

类型: HTMLVideoElement | undefined

注意

你应在加入房间后，绑定视图。退出房间后，此设置仍然有效。

setRemoteVideoPlayer

设置远端视频渲染时，使用的视图，并设置渲染模式。
建议在收到 onVideoFirstFrameRendered 事件后，调用本方法对远端视频视图进行设置。
你可以通过再次调用本方法，并绑定空视图来解除绑定。

(streamIndex: StreamIndex, videoPlayerOption: VideoPlayerOption) => HTMLVideoElement | undefined

参数

返回值

类型: HTMLVideoElement | undefined

注意

你应在加入房间后，绑定视图。退出房间后，此设置仍然有效。

setLocalVideoMirrorType

是否开启本地视频流镜像模式。

(mirrorType: MirrorType) => void

参数

setAudioPlaybackDevice

设置音频播放设备，例如扬声器或者耳机，默认使用扬声器。

(deviceId: string) => Promise<void>

参数

返回值

类型: Promise<void>

注意

进房前和进房后，均可调用此方法设置音频播放设备。

play

手动开启音视频流播放
进房时未开启自动播放或自动播放失败时，可以调用本方法手动开启音视频流播放。

(userId: string) => Promise<void>

参数

返回值

类型: Promise<void>

muteLocalAudio

控制本地音频流的发送状态：发送/不发送。

非隐身用户使用此方法后，房间中的其他用户会收到回调 onUserMuteAudio。

(muteState: MuteState) => Promise<boolean>

参数

返回值

类型: Promise<boolean>

注意

• 本方法仅控制本地音频流的发送状态，并不影响本地音频采集状态。
• 无论是否开启音频采集，你都可以启动发送本地音频流。如果在采集前启用发送，音频将在采集开始后立即发送。

muteLocalVideo

控制本地视频流的发送状态：发送/不发送。

无论你使用内部视频采集，还是自定义视频采集，你都应使用此接口启动发送本地视频流。

非隐身用户使用此方法后，房间中的其他用户会收到回调 onUserMuteAudio。

(muteState: MuteState) => Promise<boolean>

参数

返回值

类型: Promise<boolean>

本地视频发送状态

注意

• 本方法仅控制本地视频流的发送状态，并不影响本地视频采集状态。
• 无论是否开启视频采集，你都可以启动发送本地视频流。如果在采集前启用发送，视频将在采集开始后立即发送。

pauseAllSubscribedStream

暂停接收来自远端的媒体流。

(mediaType: PauseResumeControlMediaType) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 该方法仅暂停远端流的接收，并不影响远端流的采集和发送。
  
• 该方法不改变用户的订阅状态以及订阅流的属性。
  
• 若想恢复接收远端流，需调用 resumeAllSubscribedStream。

resumeAllSubscribedStream

恢复接收来自远端的媒体流

(mediaType: PauseResumeControlMediaType) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 该方法仅恢复远端流的接收，并不影响远端流的采集和发送；
  
• 该方法不改变用户的订阅状态以及订阅流的属性。

sendUserMessage

给房间内指定的用户发送点对点文本消息。

若消息发送成功，则 userId 所指定的用户会收到 onUserMessageReceived 回调。

(userId: string, message: string) => Promise<unknown> | undefined

参数

返回值

类型: Promise<unknown> | undefined

注意

在发送房间内文本消息前，必须先调用 joinRoom 加入房间。

sendUserBinaryMessage

给房间内指定的用户发送点对点二进制消息。

若消息发送成功，则 userId 所指定的用户会收到 onUserBinaryMessageReceived 回调。

(userId: string, message: ArrayBuffer) => Promise<unknown>

参数

返回值

类型: Promise<unknown>

注意

在发送房间内二进制消息前，必须先调用 joinRoom 加入房间。

sendRoomMessage

给房间内的所有其他用户群发文本消息。

若消息发送成功，同一房间内的其他用户会收到 onRoomMessageReceived 回调。

(message: string) => Promise<any> | undefined

参数

返回值

类型: Promise<any> | undefined

sendRoomBinaryMessage

给房间内的所有其他用户群发二进制消息。

若消息发送成功，同一房间内的其他用户会收到通过 onRoomBinaryMessageReceived 回调发送的消息

(message: ArrayBuffer) => Promise<any> | undefined

参数

返回值

类型: Promise<any> | undefined

sendSEIMessage

在视频通信时，通过视频帧发送 SEI 数据。

(streamIndex: StreamIndex, message: Uint8Array | string, repeatCount: number) => void

参数

注意

• 你可以通过此接口对 RTC SDK 内部采集的视频帧添加 SEI。
• 如果调用此接口之后的 2s 内，没有可带 SEI 的视频帧（比如没有开启视频采集和传输），那么，SEI 数据不会被加进视频帧中。
• 消息发送成功后，远端会收到 onSEIMessageReceived 事件。

setVideoEncoderConfig

启动推送多路视频流，设置推送多路流时的各路视频参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。

(streamIndex: StreamIndex, descriptions: VideoEncoderConfig[]) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 默认的视频编码参数为 500bps。
  
• 屏幕流只取视频参数数组的第一组数据。

setAudioVolumeIndicationInterval

开启/关闭音量提示。默认关闭。

开启音量提示后，将按设置的时间间隔，收到本地采集音量或订阅的远端用户的音量信息回调。
关于回调的具体信息，参看 onAudioVolumeIndication。

(interval?: number) => void

参数

startLiveTranscoding

开启转推直播，并设置合流的视频视图布局和音频属性。

(transcode: LiveTranscodeConfig) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 调用该方法后，关于启动结果和推流过程中的错误，会收到 onLiveTransCodingResult 回调。
• 调用 stopLiveTranscoding 停止转推直播。

updateLiveTranscoding

更新转推直播参数。
使用 startLiveTranscoding 启用转推直播功能后，使用此方法更新功能配置参数。

(transcode: Partial<LiveTranscodeConfig>) => Promise<void>

参数

返回值

类型: Promise<void>

stopLiveTranscoding

停止转推直播。
关于启动转推直播，参看 startLiveTranscoding。

() => Promise<void>

返回值

类型: Promise<void>

setBusinessId

设置业务标识参数
可通过 businessId 区分不同的业务场景。businessId 由客户自定义，相当于一个“标签”，可以分担和细化现在 AppId 的逻辑划分的功能，但不需要鉴权。

(businessId: string) => boolean

参数

返回值

类型: boolean

注意

需要在调用 joinRoom 之前调用，joinRoom 之后调用该方法无效。

setUserVisibility

设置用户可见性。默认可见。

(enable: boolean) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 该方法在加入房间前后均可调用。
  
• 在房间内调用此方法，房间内其他用户会收到相应的回调通知：
  
  • 从 false 切换至 true 时，房间内其他用户会收到 onUserJoined 回调通知；
    
  • 从 true 切换至 false 时，房间内其他用户会收到 onUserLeave 回调通知。
    

setExternalVideoTrack

使用用户自定义的 videoTrack
请确保在你调用本方法前已调用 setVideoSourceType 设置为自定义视频采集。

(index: StreamIndex, track: MediaStreamTrack) => Promise<void>

参数

返回值

类型: Promise<void>

setExternalAudioTrack

使用用户自定义的 audioTrack
使用自定义的 audioTrack 之后, 再开启摄像头，或者切换摄像头时。SDK 会采集新的视频流替换自定义的 audioTrack

(index: StreamIndex, track: MediaStreamTrack) => Promise<void>

参数

返回值

类型: Promise<void>

setVideoSourceType

设置向 SDK 输入的视频源
默认使用内部采集。内部采集指：使用 RTC SDK 内置的视频采集机制进行视频采集。
该方法进房前后均可调用。
当你已调用 startVideoCapture 开启内部采集后，再调用此方法切换至自定义采集时，SDK 会自动关闭内部采集。
当你调用此方法开启自定义采集后，想要切换至内部采集，你必须先调用此方法关闭自定义采集，然后调用 startVideoCapture 手动开启内部采集

(index: StreamIndex, videoSourceType: VideoSourceType) => Promise<void>

参数

返回值

类型: Promise<void>

setAudioSourceType

设置向 SDK 输入的音频源
默认使用内部采集。内部采集指：使用 RTC SDK 内置的音频采集机制进行音频采集。
该方法进房前后均可调用。
当你已调用 startAudioCapture 开启内部采集后，再调用此方法切换至自定义采集时，SDK 会自动关闭内部采集。
当你调用此方法开启自定义采集后，想要切换至内部采集，你必须先调用此方法关闭自定义采集，然后调用 startAudioCapture 手动开启内部采集

(index: StreamIndex, audioSourceType: AudioSourceType) => Promise<void>

参数

返回值

类型: Promise<void>

getAudioMixingManager

混音管理接口创建

() => IAudioMixingManager

返回值

类型: IAudioMixingManager

混音管理对象

setAudioCaptureConfig

设置 RTC SDK 内部采集时的音频采集参数。默认参数由浏览器决定。

(config: TrackCaptureConfig) => Promise<void>

参数

返回值

类型: Promise<void>

setVideoCaptureConfig

设置 RTC SDK 内部采集时的视频采集参数。默认参数由浏览器决定。

(config: TrackCaptureConfig) => Promise<void>

参数

返回值

类型: Promise<void>

login

登录即时消息服务器
调用此方法登录后，可以向同 appID 下其他已登陆用户发送文本或二进制消息。

(token: string | null, userId: string) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 在调用本接口登录后，如果想要登出，需要调用 logout。
• 同一个 App ID 的每个用户的用户 ID 必须是唯一的。如果两个用户的用户 ID 相同，则先登录的用户将自动登出，并收到 RTM_DUPLICATE_LOGIN 错误。
  

logout

调用本接口登出后，无法调用房间外消息以及端到服务器消息相关的方法或收到相关回调。

() => Promise<void>

返回值

类型: Promise<void>

updateLoginToken

更新用户用于登录的 Token。Token 有一定的有效期，当 Token 过期时，需调用此方法更新登录的 Token 信息。

(token: string | null) => Promise<void>

参数

返回值

类型: Promise<void>

注意

• 如果 Token 无效导致登录失败，则调用此方法更新 Token 后，SDK 会自动重新登录，你无需再次调用 login 方法。
• Token 过期时，如果已经成功登录，则不会受到影响。Token 过期的错误会在下一次使用过期 Token 登录时，或因本地网络状况不佳导致断网重新登录时通知。

getPeerOnlineStatus

查询对端用户或本端用户的登录状态。在发送房间外消息之前，用户可以通过本接口了解对端用户是否登录，从而决定是否发送消息。也可以通过本接口查询自己查看自己的登录状态。

(userId: string) => Promise<USER_ONLINE_STATUS>

参数

返回值

类型: Promise<USER_ONLINE_STATUS>

注意

必须调用 login 登录后，才能调用本接口。

sendUserMessageOutsideRoom

给房间外指定的用户发送文本消息（P2P）

(userId: string, message: string) => Promise<any>

参数

返回值

类型: Promise<any>

注意

• 必须调用 login 登录后，才能调用本接口。
• 若文本消息发送成功，指定的用户会通过 onUserMessageReceivedOutsideRoom 回调收到该消息。

sendUserBinaryMessageOutsideRoom

给房间外指定的用户发送二进制消息（P2P）

(userId: string, message: ArrayBuffer) => Promise<any>

参数

返回值

类型: Promise<any>

注意

• 必须调用 login 登录后，才能调用本接口。
• 若文本消息发送成功，则 uid 所指定的用户会通过 onUserBinaryMessageReceivedOutsideRoom 回调收到该消息。

setServerParams

设置业务服务器参数。调用 sendServerMessage 或 sendServerBinaryMessage 发送消息给业务服务器之前，必须需要设置有效签名和业务服务器地址。

(signature: string, url: string) => Promise<any>

参数

返回值

类型: Promise<any>

注意

用户必须调用 login 登录后，才能调用本接口。

sendServerMessage

客户端给业务服务器发送文本消息（P2Server）

(message: string) => Promise<any>

参数

返回值

类型: Promise<any>

注意

在向业务服务器发送文本消息前，必须先调用 login 完成登录，随后调用 setServerParams 设置业务服务器。

sendServerBinaryMessage

客户端给业务服务器发送二进制消息（P2Server）

(message: ArrayBuffer) => Promise<any>

参数

返回值

类型: Promise<any>

注意

在向业务服务器发送文本消息前，必须先调用 login 完成登录，随后调用 setServerParams 设置业务服务器。

defaultTranscoding

获取合流转推默认参数。

() => Required<LiveTranscodeConfig>

返回值

类型: Required<LiveTranscodeConfig>

转推直播默认音视频参数

IVERTC

成员方法

方法详情

enableDevices

向用户获取设备权限

(options?: { video: boolean; audio: boolean;}) => Promise<{ video: boolean; audio: boolean;}>

参数

返回值

类型: Promise<{ video: boolean; audio: boolean; }>

() => Promise<RTCDevice[]>

() => Promise<RTCDevice[]>

() => Promise<RTCDevice[]>

() => Promise<boolean>

(appId: string) => IRTCEngine

(engine: IRTCEngine) => void

() => string

() => Promise<RTCDevice[]>