///
import { EventEmitter } from 'events';
import { YUVRender } from "../utils/yuv_render";
import { SubscribeConfig, RenderOptions, ByteStream, AudioVolumeInfo, RtcRoomStats, VideoFrame, ErrorCode, WarningCode, SubscribeState, ConnectionState, UserOfflineReasonType, MediaDeviceType, MediaDeviceState, Rectangle, VideoSolution, ScreenCaptureSourceInfo, ScreenCaptureSourceType, ThumbnailInfo, StreamRemoveReason, MessageSendResultCode, AudioMixingState, AudioMixingError, NetworkType, PerformanceAlarmMode, PerformanceAlarmReason, MediaDeviceError, JoinRoomType, LocalStreamStats, RemoteStreamStats, MuteState, StreamIndex, RemoteStreamKey, RemoteStreamSwitch, VideoFrameInfo, LocalAudioStreamState, LocalAudioStreamError, RemoteAudioState, RemoteAudioStateChangeReason, LocalVideoStreamState, LocalVideoStreamError, RemoteVideoState, RemoteVideoStateChangeReason, RtcUser, FirstFrameSendState, FirstFramePlayState, RemoteUserPriority, RTCRoomConfig, SubscribeVideoConfig, MirrorMode, PauseResumeControlMediaType, AudioMixingConfig, MouseCursorCaptureState, ScreenCaptureParameters, HighlightConfig, SysStats, StreamMixingEvent, StreamMixingType, RecordingConfig, RTCASRConfig, RecordingInfo, RecordingProgress } from "../types";
import { AudioFrame } from '..';
/** {zh}
* 用户信息
*/
interface UserInfo {
/**
* @brief 用户 ID
*/
userId: string;
/**
* @brief 视频渲染
*/
videoRender?: YUVRender | null;
/**
* @brief 屏幕渲染
*/
screenRender?: YUVRender | null;
/**
* @brief 渲染选项
*/
renderOptions?: any;
}
/** {zh}
* @list 85530
* @detail 85532
*/
declare class veRTCEngine extends EventEmitter {
private instance;
private remoteUsers;
private localChannelId;
private localUserId;
private localUser;
constructor();
/** {zh}
* @brief 创建和初始化引擎
* @param appId 每个应用的唯一标识符,由 RTC 控制台随机生成的。不同的 AppId 生成的实例在 RTC 中进行音视频通话完全独立,无法互通。
* @param documentPath 存放日志路径
* @param params 用以覆盖默认参数的本引擎实例参数。JSON 字符串格式。
* @return
* + 0:成功
* + !0:失败
* @region 引擎管理
*/
init(appId: string, documentPath: string, params: string): number;
/** {zh}
* @brief 销毁引擎
* @return
* + 0:成功
* + !0:失败
* @region 引擎管理
*/
uninit(): number;
/** {zh}
* @brief 获取当前 SDK 版本信息
* @return {string} 当前 SDK 版本信息
* @region 引擎管理
*/
static getSDKVersion(): string;
/** {zh}
* @brief 获取加载引擎进程的 ID 方便调试
* @return {string} 进程的 ID
*/
static getCurrentProcessId(): string;
/**
* @region 引擎管理
* @brief 设置业务标识参数
* @param business_id 用户设置的自己的 business_id 值。business_id 相当于一个 sub AppId,可以分担和细化现在 AppId 的逻辑划分的功能, 但不需要鉴权。business_id 只是一个标签,颗粒度需要用户自定义。
* @return + 0: 成功。
* + <0: 失败
* + -6001: 用户已经在房间中。
* + -6002: 输入非法,合法字符包括所有小写字母、大写字母和数字,除此外还包括四个独立字符分别是:英文句号,短横线,下划线和 `@`。
* @notes
* + 可通过 business_id 区分不同的业务场景(角色/策略等)。business_id 由客户自定义,相当于一个“标签”,可以分担和细化现在 AppId 的逻辑划分的功能。
* + 需要在调用 joinRoom{@link #JoinRoom} 之前调用,joinRoom{@link #JoinRoom}之后调用该方法无效。
*/
setBusinessId(business_id: string): number;
/** {zh}
* @region 房间管理
* @brief 创建/加入房间:房间不存在时即创建房间;房间存在时即加入这个房间。
* @param token 动态密钥,用于对登录用户进行鉴权验证。进入房间需要携带 Token。测试时可使用控制台生成临时 Token,正式上线需要使用密钥 SDK 在您的服务端生成并下发 Token。
* @param room_id 加入的房间 ID。房间 ID 为长度在 128 字节以内的非空字符串,支持以下字符集范围: 1. 26 个大写字母 A ~ Z 。 2. 26 个小写字母 a ~ z 。 3. 10 个数字 0 ~ 9 。 4. 下划线 "_",at 符 "@",减号 "-"。
* @param uid 用户 ID用户 ID 在 appId 的维度下是唯一的。
* @param info 用户信息
* @param roomConfig 房间参数配置,设置房间模式以及是否自动发布或订阅流。
* @return
* + 0: 成功
* + -1: room_id 为空,失败
* + -2: user_info 为空,失败
* @notes
* + 同一房间内的用户间可以相互通话。
* + 进房后重复调用无效,用户必须调用 leaveRoom{@link #LeaveRoom} 退出当前房间后,才能加入下一个房间。
* + 本地用户调用此方法加入房间成功后,会收到 onJoinRoomResult{@link 85533#OnJoinRoomResult} 回调通知。
* + 本地用户调用 setUserVisibility{@link #SetUserVisibility} 将自身设为可见后加入房间,远端用户会收到 OnUserJoined{@link 85533#OnUserJoined}。+ 使用不同 App ID 的 App 是不能互通的。
* + 请务必保证生成 Token 使用的 App ID 和创建引擎时使用的 App ID 相同,否则会导致加入房间失败。
* + 用户加入房间成功后,在本地网络状况不佳的情况下,SDK 可能会与服务器失去连接,此时 SDK 将会自动重连。重连成功后,本地会收到 OnJoinRoomResult{@link 85533#OnJoinRoomResult} 回调通知。
* + 同一个 App ID 的同一个房间内,每个用户的用户 ID 必须是唯一的。如果两个用户的用户 ID 相同,则后进房的用户会将先进房的用户踢出房间,并且先进房的用户会收到 OnError{@link 85533#OnError} 回调通知,错误类型详见 ErrorCode{@link #ErrorCode} 中的 kErrorCodeDuplicateLogin。
*/
joinRoom(token: string, room_id: string, uid: string, info: string, roomConfig: RTCRoomConfig): number;
/** {zh}
* @region 房间管理
* @brief 设置用户可见性。默认为可见。
* @param enable 设置用户是否对房间内其他用户可见: + `true`: 可以被房间中的其他用户感知,且可以在房间内发布和订阅音视频流; + `false`: 无法被房间中的其他用户感知,且只能在房间内订阅音视频流。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 通过对用户可见性进行设置,可以控制用户在房间内的行为:
* + 能否发布音视频流;
* + 用户自身是否在房间中隐身。
* + 该方法在加入房间前后均可调用。
* + 在房间内调用此方法,房间内其他用户会收到相应的回调通知:
* - 从 false 切换至 true 时,房间内其他用户会收到 onUserJoined{@link 85533#OnUserJoined} 回调通知;
* - 从 true 切换至 false 时,房间内其他用户会收到 onUserLeave{@link 85533#OnUserLeave} 回调通知。
* + 若调用该方法将可见性设为 false,此时尝试发布流会收到 onWarning{@link 85533#OnWarning} 警告,具体原因参看 WarningCode{@link #WarningCode} 中的 kWarningCodePublishStreamForbiden 警告码。
*/
setUserVisibility(enable: boolean): number;
/** {zh}
* @region 房间管理
* @brief 离开房间。调用此方法离开房间,结束通话过程,释放所有通话相关的资源。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 加入房间后,必须调用此方法结束通话,否则无法开始下一次通话。无论当前是否在房间内,都可以调用此方法。重复调用此方法没有负面影响。
* + 此方法是异步操作,调用返回时并没有真正退出房间。真正退出房间后,本地会收到 onLeaveRoom{@link 85533#OnLeaveRoom} 回调通知。
* + 调用 setUserVisibility{@link #SetUserVisibility} 将自身设为可见的用户离开房间后,房间内其他用户会收到 OnUserLeave{@link 85533#OnUserLeave} 回调通知。
* + 如果调用此方法后立即销毁引擎,SDK 将无法触发 onLeaveRoom{@link 85533#OnLeaveRoom} 回调。
*/
leaveRoom(): number;
/** {zh}
* @region 房间管理
* @brief 更新 Token
* @param token 更新的动态密钥。
* @return
* + 0:成功
* + !0:失败
* @notes
* + Token 有一定的有效期,当 Token 过期时,用户需调用此方法更新房间的 Token 信息。
* + 用户调用 joinRoom{@link #JoinRoom} 方法加入房间时,如果使用了过期的 Token 将导致加入房间失败,并会收到 OnJoinRoomResult{@link #OnJoinRoomResult} 回调通知,错误码为 ErrorCode.kErrorCodeInvalidToken{@link #ErrorCode}。此时需要重新获取 Token,并调用此方法更新 Token。
* + 如果用户因 Token 过期导致加入房间失败,则调用此方法更新 Token 后,SDK 会自动重新加入房间,而不需要用户自己调用 joinRoom{@link #JoinRoom} 方法。
* + Token 过期时,如果已经加入房间成功,则不会受到影响。Token 过期的错误会在下一次使用过期 Token 加入房间时,或因本地网络状况不佳导致断网重新连入房间时通知给用户。
*/
updateToken(token: string): number;
/** {zh}
* @type api
* @region 音频管理
* @brief 调节本地播放的所有远端用户混音后的音量
* @param volume 音频播放音量,取值范围: [0,400] + 0: 静音 + 100: 原始音量 + 400: 最大可为原始音量的 4 倍(自带溢出保护)
* @return
* + 0:成功
* + !0:失败
* @notes 为保证更好的通话质量,建议将 volume 值设为 [0,100]。
*/
setPlaybackVolume(volume: number): number;
/** {zh}
* @region 音频管理
* @brief 开启内部音频采集。默认为关闭状态。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 进房前调用该方法,本地用户会收到 onMediaDeviceStateChanged{@link 85533#OnMediaDeviceStateChanged} 的回调。
* + 进房后调用该方法,房间中的其他用户会收到 onUserStartAudioCapture{@link 85533#OnUserStartAudioCapture} 的回调。
* + 若未取得当前设备的麦克风权限,调用该方法后会触发 onWarning{@link 85533#OnWarning} 回调。
* + 调用 stopAudioCapture{@link #StopAudioCapture} 可以关闭音频采集设备,否则,SDK 只会在销毁引擎的时候自动关闭设备。
* + 无论是否发布音频数据,你都可以调用该方法开启音频采集,并且调用后方可发布音频。
* + 尚未进房并且已使用自定义采集时,关闭自定义采集后并不会自动开启内部采集。你需调用此方法手动开启内部采集。
*/
startAudioCapture(): number;
/** {zh}
* @region 音频管理
* @brief 关闭内部音频采集。默认为关闭状态。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 进房前调用该方法,本地用户会收到 onMediaDeviceStateChanged{@link 85533#OnMediaDeviceStateChanged} 的回调。
* + 进房后调用该方法后,房间中的其他用户会收到 onUserStopAudioCapture{@link #OnUserStopAudioCapture} 的回调。
* + 调用 startAudioCapture{@link #StartAudioCapture} 可以开启音频采集设备。
* + 设备开启后若一直未调用该方法关闭,则 SDK 会在销毁引擎的时候自动关闭音频采集设备。
*/
stopAudioCapture(): number;
/** {zh}
* @region 媒体流管理
* @brief 控制本地音频流的发送状态:发送/不发送
* @param muteState 发送状态,标识是否发送本地音频流
* @return
* + 0:成功
* + !0:失败
* @notes
* + 使用此方法后,房间中的其他用户会收到回调: onUserMuteAudio{@link 85533#OnUserMuteAudio}
* + 本方法仅控制本地音频流的发送状态,并不影响本地音频采集状态。
*/
muteLocalAudio(muteState: number): number;
/** {zh}
* @region 多房间
* @brief 开启/关闭音量提示。默认关闭。
* @param interval 收到音量提示回调的时间间隔:
建议设置为大于等于 200 毫秒;小于 10 毫秒时,行为未定义。
≤ 0:禁用音量提示功能。 > 0:启用音量提示功能,并设置收到音量提示回调的时间间隔。单位为毫秒。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 开启音量提示后,将按设置的时间间隔收到本地采集音量或订阅的远端用户的音量信息回调。
* + 关于回调的具体信息,参看 onAudioVolumeIndication{@link 85533#OnAudioVolumeIndication}
*/
setAudioVolumeIndicationInterval(interval: number): number;
/** {zh}
* @region 音频管理
* @brief 调节来自远端用户的音频播放音量
* @param strUserId 音频来源的远端用户 ID
* @param volume 播放音量,取值范围: [0,400] 0: 静音 100: 原始音量 400: 最大可为原始音量的 4 倍(自带溢出保护)
* @return
* + 0:成功
* + !0:失败
*/
setRemoteAudioPlaybackVolume(strUserId: string, volume: number): number;
/** {zh}
* @region 媒体流管理
* @brief 恢复接收来自远端的媒体流
* @param type 媒体流类型,指定需要暂停接收音频还是视频流
* @return
* + 0:成功
* + !0:失败
* @notes
* + 该方法仅恢复远端流的接收,并不影响远端流的采集和发送;
* + 该方法不改变用户的订阅状态以及订阅流的属性。
*/
resumeAllSubscribedStream(type: PauseResumeControlMediaType): number;
/** {zh}
* @region 视频管理
* @brief 开启内部视频采集。默认为关闭状态
* @return
* + 0:成功
* + !0:失败
* @notes
* + 调用该方法后,本地用户会收到 onMediaDeviceStateChanged{@link 85533#OnMediaDeviceStateChanged} 的回调。
* + 进房后调用该方法后,房间中的其他用户会收到 onUserStartVideoCapture{@link 85533#OnUserStartVideoCapture} 的回调。
* + 内部视频采集指:使用 RTC SDK 内置视频采集模块,进行采集。
* + 若未取得当前设备的摄像头权限,调用该方法会不成功,并触发 onMediaDeviceStateChanged{@link #OnMediaDeviceStateChanged} 回调。
* + 调用 stopVideoCapture{@link #StopVideoCapture} 可以关闭视频采集设备,否则,SDK 只会在销毁引擎的时候自动关闭设备。
* + 无论是否发布视频数据,你都可以调用该方法开启视频采集,并且调用后方可发布视频。
* + 如果需要从自定义视频采集切换为内部视频采集,你必须先关闭自定义采集,再调用此方法手动开启内部采集。
*/
startVideoCapture(): number;
/** {zh}
* @region 视频管理
* @brief 关闭内部视频采集。默认为关闭状态。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 调用该方法后,本地用户会收到 onMediaDeviceStateChanged{@link 85533#OnMediaDeviceStateChanged} 的回调。
* + 进房后调用该方法后,房间中的其他用户会收到 onUserStopVideoCapture{@link 85533#OnUserStopVideoCapture} 的回调。
* + 调用 startVideoCapture{@link #StartVideoCapture} 可以开启视频采集设备。
* + 设备开启后若一直未调用此方法关闭本地视频采集,则 SDK 会在销毁引擎的时候自动关闭。
*/
stopVideoCapture(): number;
/** {zh}
* @region 视频管理
* @brief 启动推送多路视频流,设置推送多路流时的各路视频参数,包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。
* @param index 主流 or 屏幕流主流。包括:由摄像头/麦克风通过内部采集机制,采集到的视频/音频;通过自定义采集,采集到的视频/音频。屏幕流。屏幕共享时共享的视频流,或来自声卡的本地播放音频流。
* @param solutions 视频参数数组首地址。
最多支持 3 路参数。当设置了多路参数时,分辨率必须是依次减小,从大到小排列的。
最大分辨率没有限制。但是如果设置的分辨率无法编码,就会导致编码推流失败。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 当使用内部采集时,视频采集的分辨率、帧率会根据编码参数进行适配。
* + 默认的视频编码参数为:分辨率 640px * 360px,帧率 15fps。
* + 变更编码分辨率后马上生效,可能会引发相机重启。
* + 屏幕流只取视频参数数组的第一组数据。
*/
setVideoEncoderConfig(index: number, solutions: VideoSolution[]): number;
/** {zh}
* @region 视频管理
* @brief 停止/启动发送本地视频流,默认不发送。
* @param muteState 发送状态,标识是否发送本地视频流
* @return
* + 0:成功
* + !0:失败
* @notes
* + 无论你使用内部视频采集,还是自定义视频采集,你都应使用此接口启动发送本地视频流。
* + 调用该方法后,房间中的其他用户会收到 onUserMuteVideo{@link #OnUserMuteVideo} 的回调。
* + 本方法只是停止/启动本地视频流的发送,不影响视频采集状态。
* + 无论是否开启视频采集,你都可以启动发送本地视频流。这样,一旦开始采集视频,即可进行发送。
*/
muteLocalVideo(muteState: number): number;
/** {zh}
* @type api
* @region 视频管理
* @brief 切换视频内部采集时使用的前置/后置摄像头。默认使用前置摄像头。
* @param camera_id 移动端摄像头。可通过 enumerateVideoCaptureDevices{@link #enumerateVideoCaptureDevices} 获取。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 调用此接口后,在本地会触发 onMediaDeviceStateChanged{@link 85533#onMediaDeviceStateChanged} 回调。
* + 如果你正在使用相机进行视频采集,切换操作当即生效;如果相机未启动,后续开启内部采集时,会打开设定的摄像头。
* + 如果本地有多个摄像头且想选择特定工作摄像头可通过 IVideoDeviceManager{@link #IVideoDeviceManager} 来控制。
*/
switchCamera(camera_id: number): number;
/** {zh}
* @region 视频管理
* @brief 设置采用前置摄像头采集时,是否开启镜像模式。
* @param nMode 是否开启镜像模式
* @return
* + 0:成功
* + !0:失败
*/
setLocalVideoMirrorMode(nMode: MirrorMode): number;
/** {zh}
* @region 媒体流处理
* @brief 暂停接收来自远端的媒体流。
* @param type 媒体流类型,指定需要暂停接收音频还是视频流
* @return
* + 0:成功
* + !0:失败
* @notes
* + 该方法仅暂停远端流的接收,并不影响远端流的采集和发送;
* + 该方法不改变用户的订阅状态以及订阅流的属性。
* + 若想恢复接收远端流,需调用 resumeAllSubscribedStream{@link #ResumeAllSubscribedStream}。
*/
pauseAllSubscribedStream(type: PauseResumeControlMediaType): number;
/** {zh}
* @region 屏幕共享
* @brief 采集屏幕视频流,用于共享。屏幕视频流包括:屏幕上显示的内容,应用窗口中显示的内容,或虚拟屏幕中显示的内容。其中,虚拟屏幕中显示的内容仅在 Windows 平台上支持。
* @param info 待共享的屏幕源,你可以调用 getScreenCaptureSourceList{@link #GetScreenCaptureSourceList} 获得所有可以共享的屏幕源。
* @param params 共享参数
* @return
* + 0:成功
* + !0:失败
* @notes
* + 调用此方法仅开启屏幕流视频采集,不会发布采集到的视频。发布屏幕流视频需要调用 publishScreen{@link #PublishScreen} 。
* + 要关闭屏幕视频源采集,调用 stopScreenVideoCapture{@link #StopScreenVideoCapture}。
* + 调用成功后,本端会收到 onFirstLocalVideoFrameCaptured{@link 85533#OnFirstLocalVideoFrameCaptured} 回调。
* + 调用此接口前,你可以调用 setVideoEncoderConfig{@link #SetVideoEncoderConfig} 设置屏幕视频流的采集帧率和编码分辨率。
* + 在收到 onFirstLocalVideoFrameCaptured{@link 85533#OnFirstLocalVideoFrameCaptured} 事件后通过调用 setLocalVideoCanvas{@link #SetLocalVideoCanvas} 或 SetLocalVideoSink{@link #SetLocalVideoSink} 函数设置本地屏幕共享视图。
* + 监听 onLocalScreenFrame{@link #IVideoFrameObserver#OnLocalScreenFrame} 本地屏幕视频回调事件
*/
startScreenVideoCapture(info: ScreenCaptureSourceInfo, params: ScreenCaptureParameters): number;
/** {zh}
* @region 屏幕共享
* @brief 更新屏幕共享区域。
* @param regionRect 当共享屏幕时,指定待共享区域相对于虚拟屏幕的位置当共享窗口时,指定待共享区域相对于整个窗口的位置
* @return
* + 0:成功
* + !0:失败
*/
updateScreenCaptureRegion(regionRect: Rectangle): number;
/** {zh}
* @type api
* @region 屏幕共享
* @brief 通过 RTC SDK 提供的采集模块采集屏幕视频流时,更新对鼠标的处理设置。默认采集鼠标。
* @param state 内部采集屏幕视频流时,是否采集鼠标信息
* @return
* + 0:成功
* + !0:失败
* @notes 调用此接口前,必须已通过调用 startScreenVideoCapture{@link #StartScreenVideoCapture} 开启了内部屏幕流采集。
*/
UpdateScreenCaptureMouseCursor(state: MouseCursorCaptureState): number;
/** {zh}
* @region 屏幕共享
* @brief 通过 RTC SDK 提供的采集模块采集屏幕视频流时,更新边框高亮设置。默认展示表框。
* @param highlight_config 边框高亮设置
* @return
* + 0:成功
* + !0:失败
* @notes 调用此接口前,必须已通过调用 startScreenVideoCapture{@link #StartScreenVideoCapture} 开启了内部屏幕流采集。
*/
updateScreenCaptureHighlightConfig(highlight_config: HighlightConfig): number;
/** {zh}
* @private
* @region 屏幕共享
* @brief 通过 RTC SDK 提供的采集模块采集屏幕视频流时,设置需要过滤的窗口。
* @param screenFilterConfig 窗口过滤设置,TODO参看 ScreenFilterConfig{@link #ScreenFilterConfig}
* @return
* + 0:成功
* + !0:失败
* @notes
* + 调用此接口前,必须已通过调用 startScreenVideoCapture{@link #StartScreenVideoCapture} 开启了内部屏幕流采集。
* + 本函数在屏幕源类别是屏幕而非应用窗体时才起作用。详见:ScreenCaptureSourceType{@link #ScreenCaptureSourceType}
*/
updateScreenCaptureFilterConfig(screenFilterConfig: number[]): number;
/** {zh}
* @region 屏幕共享
* @brief 停止屏幕视频流采集。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 要开启屏幕视频流采集,调用 startScreenVideoCapture{@link #StartScreenVideoCapture}
* + 调用此接口不影响屏幕视频流发布。
*/
stopScreenVideoCapture(): number;
/** {zh}
* @brief 获取屏幕采集对象列表。
* @return 屏幕采集对象列表
*/
getScreenCaptureSourceList(): ScreenCaptureSourceInfo[];
/** {zh}
* @brief 获取屏幕共享对象 thumbnail。
* @param type 屏幕采集对象的类型
* @param sourceId 屏幕分享时,共享对象的 ID
* @param maxWidth 最大宽度
* @param maxHeight 最大高度
* @return 屏幕共享对象
*/
getThumbnail(type: ScreenCaptureSourceType, sourceId: number, maxWidth: number, maxHeight: number): ThumbnailInfo;
/** {zh}
* @region 屏幕共享
* @brief 发布本地屏幕共享流到房间。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 你必须先加入房间,才能调用此方法。
* + 直播、游戏、云游戏房间模式下,仅可见的用户可以调用此方法。你可以调用 setUserVisibility{@link #setUserVisibility} 方法设置用户在房间中的可见性。
* + 此方法只影响屏幕共享视频流的发布状态,并不影响屏幕视频流的采集情况。参看 startScreenVideoCapture{@link #startScreenVideoCapture} 和 StartScreenAudioCapture{@link #StartScreenAudioCapture}
* + 发布成功后,远端会收到 onStreamAdd{@link 85533#OnStreamAdd} 回调和 onRemoteScreenFrame{@link 85533#OnRemoteScreenFrame} 回调。
* + 调用 unpublishScreen{@link #unpublishScreen} 取消发布。
*/
publishScreen(): number;
/** {zh}
* @region 屏幕共享
* @brief 停止发布本地屏幕共享流到房间。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 远端会收到 onStreamRemove{@link 85533#OnStreamRemove} 事件。
* + 此方法只影响屏幕共享视频流的发布状态,并不影响屏幕视频流的采集情况。
* + 调用 publishScreen{@link #PublishScreen} 启动发布。
*/
unpublishScreen(): number;
/** {zh}
* @region 音量管理
* @brief 调节音频采集音量
* @param index 流索引,指定调节主流还是调节屏幕流的音量主流。包括:由摄像头/麦克风通过内部采集机制,采集到的视频/音频;通过自定义采集,采集到的视频/音频。屏幕流。屏幕共享时共享的视频流,或来自声卡的本地播放音频流。
* @param volume 采集的音量值和原始音量的比值,范围是 [0, 400],单位为 %,自带溢出保护。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 无论是采集来自麦克风的音频流,还是屏幕音频流;无论是 RTC SDK 内部采集,还是自定义采集,都可以使用此接口进行音量调节。
* + 在开启音频采集前后,你都可以使用此接口设定采集音量。
*/
setCaptureVolume(index: number, volume: number): number;
/** {zh}
* @region 混音
* @brief 开始播放音乐文件及混音
* @param id 混音 ID,用于标识混音,请保证混音 ID 唯一性。
如果已经通过 preloadAudioMixing{@link #PreloadAudioMixing} 将音效加载至内存,确保此处的 ID 与 preloadAudioMixing{@link #PreloadAudioMixing} 设置的 ID 相同。
如果使用相同的 ID 重复调用本方法,前一次混音会停止,后一次混音开始,且 SDK 会使用 onAudioMixingStateChanged{@link 85533#OnAudioMixingStateChanged} 回调通知前一次混音已停止。
* @param file_path 指定需要混音的本地文件的绝对路径,支持音频文件格式有: mp3,aac,m4a,3gp,wav。
可以通过传入不同的 ID 和 file_path 多次调用本方法,以实现同时播放多个音乐文件,实现混音叠加。
* @param mixingconfig 混音配置,设置混音的播放次数、是否本地播放混音、以及是否将混音发送至远端,详见 AudioMixingConfig{@link #AudioMixingConfig}
* @return
* + 0:成功
* + !0:失败
* @notes
* + 调用本方法成功播放音乐文件后,SDK 会向本地回调当前的混音状态,见 onAudioMixingStateChanged{@link 85533#OnAudioMixingStateChanged}。
* + 开始播放音乐文件及混音后,可以调用 stopAudioMixing{@link #StopAudioMixing} 方法停止播放音乐文件。
*/
startAudioMixing(id: number, file_path: string, mixingconfig: AudioMixingConfig): number;
/** {zh}
* @region 混音
* @brief 停止播放音乐文件及混音
* @param id 混音 ID
* @return
* + 0:成功
* + !0:失败
* @notes
* + 调用 startAudioMixing{@link #StartAudioMixing} 方法开始播放音乐文件及混音后,可以调用本方法停止播放音乐文件及混音。
* + 调用本方法停止播放音乐文件后,SDK 会向本地回调通知已停止混音,见 onAudioMixingStateChanged{@link 85533#OnAudioMixingStateChanged}。
* + 调用本方法停止播放音乐文件后,该音乐文件会被自动卸载。
*/
stopAudioMixing(id: number): number;
/**
* @type api
* @region 混音
* @brief 暂停播放音乐文件及混音
* @param id 混音 ID
* @return
* + 0:成功
* + !0:失败
* @notes
* + 调用 startAudioMixing{@link #StartAudioMixing} 方法开始播放音乐文件及混音后,可以通过调用本方法暂停播放音乐文件及混音。
* + 调用本方法暂停播放音乐文件及混音后,可调用 resumeAudioMixing{@link #ResumeAudioMixing} 方法恢复播放及混音。
* + 调用本方法暂停播放音乐文件后,SDK 会向本地回调通知已暂停混音,见 onAudioMixingStateChanged{@link 85533#OnAudioMixingStateChanged}。
*/
pauseAudioMixing(id: number): number;
/** {zh}
* @region 混音
* @brief 恢复播放音乐文件及混音
* @param id
* 混音 ID
* @return
* + 0:成功
* + !0:失败
* @notes
* + 调用 pauseAudioMixing{@link #PauseAudioMixing} 方法暂停播放音乐文件及混音后,可以通过调用本方法恢复播放及混音。
* + 调用本方法恢复播放音乐文件及混音后,SDK 会向本地回调通知音乐文件正在播放中,见 onAudioMixingStateChanged{@link #OnAudioMixingStateChanged}。
*/
resumeAudioMixing(id: number): number;
/** {zh}
* @region 混音
* @brief 调节音乐文件在本地和远端播放的音量大小
* @param id 混音 ID
* @param volume 音乐文件播放音量范围为 0~400。 0:静音 100:原始音量 400: 最大可调音量 (自带溢出保护)
* @param type 混音播放类型
设置音乐文件是否本地播放、以及是否发送到远端,由此控制音乐文件本地或远端播放的音量,详见 AudioMixingType{@link #AudioMixingType}。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 调用本方法设置音量前,请先调用 preloadAudioMixing{@link #PreloadAudioMixing} 或 startAudioMixing{@link #StartAudioMixing}。
* + 为保证更好的音质,建议将 volume 值设为 [0,100]。
*/
setAudioMixingVolume(id: number, volume: number, type: number): number;
/** {zh}
* @region 混音
* @brief 获取音乐文件时长
* @param id 混音 ID
* @return
* + `>0`: 成功, 音乐文件时长,单位为毫秒。
* + `<0`: 失败
* @notes 调用本方法获取音乐文件时长前,需要先调用 preloadAudioMixing{@link #PreloadAudioMixing} 或 startAudioMixing{@link #StartAudioMixing}。
*/
getAudioMixingDuration(id: number): number;
/** {zh}
* @type api
* @region 混音
* @brief 获取音乐文件播放进度
* @param id 混音 ID
* @return
* + `>0`: 成功, 音乐文件播放进度,单位为毫秒。
* + `<0`: 失败
* @notes 调用本方法获取音乐文件播放进度前,需要先调用 startAudioMixing{@link #StartAudioMixing} 开始播放音乐文件。
*/
getAudioMixingCurrentPosition(id: number): number;
/** {zh}
* @type api
* @region 混音
* @brief 设置音乐文件的播放位置
* @param id 混音 ID
* @param pos 进度条位置,整数,单位为毫秒。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 本方法可以设置音乐文件的播放位置,这样你可以根据实际情况从指定的位置播放音乐文件,无需从头到尾完整播放一个音乐文件。
* + 调用本方法设置音乐文件的播放位置前,需要先调用 StartAudioMixing{@link #StartAudioMixing} 开始播放音乐文件。
*/
setAudioMixingPosition(id: number, pos: number): number;
/** {zh}
* @type api
* @region 混音
* @brief 预加载指定音乐文件到内存中
* @param id 混音 ID
应用调用者维护,请保证唯一性。
如果使用相同的 ID 调用本方法,后一次会覆盖前一次。
如果先调用 startAudioMixing{@link #StartAudioMixing} ,再使用相同的 ID 调用本方法 ,会先回调 onAudioMixingStateChanged{@link 85533#OnAudioMixingStateChanged} 上一个混音停止,然后加载后一个混音。
使用一个 ID 调用本方法预加载 A.mp3 后,如果需要使用相同的 ID 调用 startAudioMixing{@link #StartAudioMixing} 播放 B.mp3,请先调用 unloadAudioMixing{@link #UnloadAudioMixing} 卸载 A.mp3 ,否则会报错 kAudioMixingErrorLoadConflict。
* @param file_path 指定需要混音的本地文件的绝对路径,支持音频文件格式有: mp3,aac,m4a,3gp,wav。
如果音乐文件长度超过 20s,会回调加载失败,见 onAudioMixingStateChanged{@link 85533#OnAudioMixingStateChanged}。
* @return
* + 0:成功
* + !0:失败
* @notes
* + 需要频繁播放某个音乐文件的时候,调用本方法预加载该文件,在播放的时候可以只加载一次该文件,减少 CPU 占用。
* + 本方法只是预加载指定音乐文件,只有调用 startAudioMixing{@link #StartAudioMixing} 方法才开始播放指定音乐文件。
* + 调用本方法预加载音乐文件后,SDK 会回调通知音乐文件已加载,见 onAudioMixingStateChanged{@link 85533#OnAudioMixingStateChanged}。
* + 调用本方法预加载的指定音乐文件可以通过 unloadAudioMixing{@link #UnloadAudioMixing} 卸载。
*/
preloadAudioMixing(id: number, file_path: string): number;
/** {zh}
* @type api
* @region 混音
* @brief 卸载指定音乐文件
* @param id 混音 ID
* @return
* + 0:成功
* + !0:失败
* @notes 不论音乐文件是否播放,调用本方法卸载该文件后,SDK 会回调通知混音已停止,见 onAudioMixingStateChanged{@link 85533#OnAudioMixingStateChanged}。
*/
unloadAudioMixing(id: number): number;
/** {zh}
* @type api
* @region 视频设备管理
* @brief 获取当前系统内视频采集设备列表。
* @return 包含系统中所有视频采集设备的列表和相关信息
*/
enumerateVideoCaptureDevices(): Object;
/** {zh}
* @type api
* @region 视频设备管理
* @brief 设置当前视频采集设备
* @param deviceId 视频设备 ID,可以通过 EnumerateVideoCaptureDevices{@link #EnumerateVideoCaptureDevice} 获取
* @return
* + 0:方法调用成功
* + !0:方法调用失败
*/
setVideoCaptureDevice(deviceId: string): number;
/** {zh}
* @type api
* @region 视频设备管理
* @brief 获取当前 SDK 正在使用的视频采集设备信息
* @return 当前 SDK 正在使用的视频采集设备信息
*/
getVideoCaptureDevice(): string;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 获取当前系统内音频播放设备列表。如果后续设备有变更,你会收到 onMediaDeviceStateChanged{@link 85533#OnMediaDeviceStateChanged} 回调通知,然后需要重新调用本接口以获得新的设备列表。
* @return 包含系统中所有音频播放设备的列表和相关信息
*/
enumerateAudioPlaybackDevices(): Object;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 获取当前系统内音频采集设备列表。如果后续设备有变更,你需要重新调用本接口以获得新的设备列表。
* @return 包含系统中所有音频采集设备列表和相关信息
*/
enumerateAudioCaptureDevices(): Object;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 设置音频播放设备。
* @param deviceId 音频播放设备 ID,可通过 enumerateAudioPlaybackDevices{@link #EnumerateAudioPlaybackDevices} 获取。
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
*/
setAudioPlaybackDevice(deviceId: string): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 设置音频采集设备。
* @param deviceId 音频采集设备 ID,可通过 enumerateAudioCaptureDevices{@link #EnumerateAudioCaptureDevices} 获取。
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
*/
setAudioCaptureDevice(deviceId: string): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 获取当前音频播放设备 ID。
* @param device_id 音频播放设备 ID
* @return 当前音频播放设备 ID
*/
getAudioPlaybackDevice(): string;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 获取当前音频采集设备 ID。
* @return 当前音频采集设备 ID
*/
getAudioCaptureDevice(): string;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 启动音频播放设备测试。
该方法测试播放设备是否能正常工作。SDK 播放指定的音频文件,测试者如果能听到声音,说明播放设备能正常工作。
* @param test_audio_file_path 音频文件的绝对路径,路径字符串使用 UTF-8 编码格式,支持以下音频格式: mp3,aac,m4a,3gp,wav。
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
* @notes
* + 该方法必须在 JoinRoom{@link #JoinRoom} 前调用,且不可与其它音频设备测试功能同时应用。
* + 你需调用 StopAudioPlaybackDeviceTest{@link #IAudioDeviceManager#StopAudioPlaybackDeviceTest} 停止测试。
*/
startAudioPlaybackDeviceTest(test_audio_file_path: String): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 停止音频播放设备测试。
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
* @notes 调用 StartAudioPlaybackDeviceTest{@link #IAudioDeviceManager#StartAudioPlaybackDeviceTest} 后,需调用本方法停止测试。
*/
stopAudioPlaybackDeviceTest(): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 启动音频采集设备测试。 该方法测试音频采集设备是否能正常工作。启动测试后,会收到 OnAudioVolumeIndication{@link 85533#OnAudioVolumeIndication} 回调上报的音量信息。
* @param indication_interval onAudioVolumeIndication{@link 85533#OnAudioVolumeIndication} 回调的时间间隔,单位为毫秒。建议设置到大于 200 毫秒。最小不得少于 10 毫秒。小于10 毫秒行为未定义。
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
* @notes
* + 该方法必须在 joinRoom{@link #JoinRoom} 前调用,且不可与其它音频设备测试功能同时应用。
* + 你需调用 stopAudioCaptureDeviceTest{@link #IAudioDeviceManager#StopAudioCaptureDeviceTest} 停止测试。
*/
startAudioCaptureDeviceTest(indication_interval: number): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 停止音频采集设备测试。
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
* @notes 调用 startAudioCaptureDeviceTest{@link #IAudioDeviceManager#StartAudioCaptureDeviceTest} 后,需调用本方法停止测试。
*/
stopAudioCaptureDeviceTest(): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 设置当前音频播放设备音量
* @param volume 音频播放设备音量,取值范围为 [0,255], 超出此范围设置无效。
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
*/
setAudioPlaybackDeviceVolume(volume: number): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 获取当前音频播放设备音量
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
*/
getAudioPlaybackDeviceVolume(): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 设置当前音频采集设备音量
* @param volume 音频采集设备音量,取值范围为 [0,255], 超出此范围设置无效。
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
*/
setAudioCaptureDeviceVolume(volume: number): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 获取当前音频采集设备音量
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
*/
getAudioCaptureDeviceVolume(): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 开始音频设备回路测试。
该方法测试音频采集设备和音频播放设备是否能正常工作。一旦测试开始,音频采集设备会采集本地声音,并通过音频播放设备播放出来,同时用户 App 会收到 onAudioVolumeIndication{@link 85533#OnAudioVolumeIndication} 回调上报的音量信息。
* @param indication_interval onAudioVolumeIndication{@link 85533#OnAudioVolumeIndication} 回调的时间间隔,单位为毫秒。建议设置到大于 200 毫秒。最小不得少于 10 毫秒。小于 10 毫秒行为未定义。
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
* @notes
* + 该方法必须在 JoinRoom{@link #IRtcEngine#JoinRoom} 前调用。且不可与其它音频设备测试功能同时应用。
* + 你需调用 StopAudioDeviceLoopbackTest{@link #IAudioDeviceManager#StopAudioDeviceLoopbackTest} 停止测试。
* + 该方法仅在本地进行音频设备测试,不涉及网络连接。
*/
startAudioDeviceLoopbackTest(indication_interval: number): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 停止音频设备回路测试。
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
* @notes 调用 StartAudioDeviceLoopbackTest{@link #IAudioDeviceManager#StartAudioDeviceLoopbackTest} 后,需调用本方法停止测试。
*/
stopAudioDeviceLoopbackTest(): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 尝试初始化音频播放设备,可检测出设备不存在、权限被拒绝/禁用等异常问题。
* @param deviceId 设备索引号
* @return 设备状态错误码
* + 0: 设备检测结果正常
* + -1: 接口状态不正确,例如在正常启动采集后再调用该接口进行检测
* + -2: 采集设备无麦克风权限,尝试初始化设备失败
* + -3: 设备不存在,当前没有设备或设备被移除时返回
* + -4: 设备音频格式不支持
* + -5: 其它原因错误
* @notes 1. 该接口需在进房前调用;
* 2. 检测成功不代表设备一定可以启动成功,还可能因设备被其他应用进程独占,或 CPU/内存不足等原因导致启动失败。
*/
initAudioPlaybackDeviceForTest(deviceId: string): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 尝试初始化音频播放设备,可检测出设备不存在、权限被拒绝/禁用等异常问题。
* @param deviceId 设备索引号
* @return 设备状态错误码
* + 0: 设备检测结果正常
* + -1: 接口状态不正确,例如在正常启动采集后再调用该接口进行检测
* + -2: 采集设备无麦克风权限,尝试初始化设备失败
* + -3: 设备不存在,当前没有设备或设备被移除时返回
* + -4: 设备音频格式不支持
* + -5: 其它原因错误
* @notes 1. 该接口需在进房前调用;
* 2. 检测成功不代表设备一定可以启动成功,还可能因设备被其他应用进程独占,或 CPU/内存不足等原因导致启动失败。
*/
initAudioCaptureDeviceForTest(deviceId: string): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 设置当前音频播放设备静音状态,默认为非静音。
* @param mute true:静音false:非静音
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
*/
setAudioPlaybackDeviceMute(mute: boolean): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 获取当前音频播放设备是否静音的信息。
* @param mute true:静音false:非静音
* @return 方法调用结果
* + `true`:方法调用成功
* + `false`:方法调用失败
*/
getAudioPlaybackDeviceMute(): boolean;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 设置当前音频采集设备静音状态,默认为非静音。
* @param mute true:静音false:非静音
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
*/
setAudioCaptureDeviceMute(mute: boolean): number;
/** {zh}
* @type api
* @region 音频设备管理
* @brief 获取当前音频采集设备是否静音的信息。
* @return
* + true:静音
* + false:非静音
*/
getAudioCaptureDeviceMute(): boolean;
/** {zh}
* @type api
* @region 音视频回退
* @brief 设置发布的音视频流回退选项 。
你可以调用这个接口来设置网络情况不佳或设备性能不足时只发送小流,以保证通话质量。
* @param option 本地发布的音视频流回退选项 0:(默认)上行网络较弱或性能不佳时,不对音视频流作回退处理。 >1:上行网络较弱或性能不佳时,只发送视频小流。
* @return
* + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 这个方法只在设置了发送多个流的情况下有效。
* + 你必须在进房前设置,进房后设置或更改设置无效。
* + 设置回退选项后,本端发布的音视频流发生回退或从回退中恢复时,订阅该音视频流的客户端会收到 onSimulcastSubscribeFallback{@link #OnSimulcastSubscribeFallback} 回调通知。
* + 你可以调用 API 或者在服务端下发策略设置回退。当使用服务端下发配置实现时,下发配置优先级高于在客户端使用 API 设定的配置。
*/
setPublishFallbackOption(option: number): number;
/** {zh}
* @type api
* @region 音视频回退
* @brief 设置订阅的音视频流回退选项。
你可以通过调用该接口来设置网络情况不佳或性能不足时只订阅小流或音频流,以保证通话质量。
* @param option 远端订阅流回退处理选项`0`: 关闭订阅音视频流时的性能回退功能 `1`: 只接收视频小流`2`: 先尝试只接收视频小流;如果网络环境无法显示视频,则再回退到只接收远端订阅的音频流
* @return 方法调用结果
* + 0:方法调用成功
* + <0:方法调用失败
* @notes
* + 你必须在进房前设置,进房后设置或更改设置无效。
* + 设置回退选项后,本端订阅的音视频流发生回退或从回退中恢复时,会收到 onSimulcastSubscribeFallback{@link 85533#OnSimulcastSubscribeFallback} 回调通知。
* + 设置回退选项后,本端订阅的视频流因为回退分辨率发生变化时,会收到 onRemoteVideoSizeChanged{@link 85533#OnRemoteVideoSizeChanged} 回调通知。
* + 你可以调用 API 或者在服务端下发策略设置回退。当使用服务端下发配置实现时,下发配置优先级高于在客户端使用 API 设定的配置。
*/
setSubscribeFallbackOption(option: number): number;
/** {zh}
* @region 音视频回退
* @brief 设置用户优先级
* @param userId 远端用户的 ID
* @param priority 远端用户的需求优先级,详见枚举类型 RemoteUserPriority{@link #RemoteUserPriority}
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 1. 该方法与 setSubscribeFallbackOption{@link #SetSubscribeFallbackOption} 搭配使用。
* + 2. 如果开启了订阅流回退选项,弱网或性能不足时会优先保证收到的高优先级用户的流的质量。
* + 3. 该方法在进房前后都可以使用,可以修改远端用户的优先级。
*/
setRemoteUserPriority(userId: string, priority: RemoteUserPriority): number;
/** {zh}
* @brief 在当前房间内手动开始发布本地音视频流
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 如果你已经在用户进房时通过调用 [joinRoom](#joinroom) 选择了自动发布,则无需再调用本接口。
* + 调用 setUserVisibility{@link #setUserVisibility} 方法将自身设置为不可见后无法调用该方法,需将自身切换至可见后方可调用该方法发布音视频流。
* + 同一用户,同一时间,只能在一个房间内发流。如果你需要发布屏幕共享流,调用 publishScreen{@link #publishScreen}。
* + 用户调用此方法成功发布音视频流后,房间中的其他用户将会收到 onStreamAdd{@link 85533#onStreamAdd} 回调通知。
*/
publish(): number;
/** {zh}
* @brief 在当前房间内停止发布本地音视频流。
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 调用 publish{@link #publish} 手动发布音视频流后或在用户进房时设置为自动发布,都可以调用此接口停止发布。
* + 用户调用此方法停止发布音视频流后,房间中的其他用户将会收到 onStreamRemove{@link 85533#onStreamRemove} 回调通知。
*/
unpublish(): number;
/** {zh}
* @region 多房间
* @brief 订阅房间内指定的远端音视频流。 或更新已经订阅的流的属性、媒体类型等配置。
* @param user_id 指定订阅的远端发布音视频流的用户 ID。
* @param stream_type 流属性,用于指定订阅主流/屏幕流。主流。包括:由摄像头/麦克风通过内部采集机制,采集到的视频/音频;通过自定义采集,采集到的视频/音频。屏幕流。屏幕共享时共享的视频流,或来自声卡的本地播放音频流。
* @param media_type 媒体类型,用于指定订阅音/视频,参看 SubscribeMediaType{@link #SubscribeMediaType}。Todo
* @param subConfig 视频订阅配置
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 无论是自动订阅还是手动订阅模式,你都可以调用此方法按需订阅房间中的音视频流。
* + 你可以通过 onStreamAdd{@link 85533#OnStreamAdd} 和 onStreamRemove{@link 85533#OnStreamRemove} 两个回调获取当前房间你的音视频流信息,并调用本方法按需订阅流或修改订阅配置。
* + 若订阅失败,你会收到 onRoomError{@link 85533#OnRoomError} 回调通知,具体失败原因参看 ErrorCode{@link #ErrorCode}。
* + 若调用 pauseAllSubscribedStream{@link #PauseAllSubscribedStream} 暂停接收远端音视频流,此时仍可使用该方法对暂停接收的流进行设置,你会在调用 resumeAllSubscribedStream{@link #ResumeAllSubscribedStream} 恢复接收流后收到修改设置后的流。
*/
subscribeUserStream(user_id: string, stream_type: number, media_type: number, subConfig: SubscribeVideoConfig): number;
/** {zh}
* @brief 停止订阅指定的房间内远端音视频流。无论自动订阅还是手动订阅模式,你都可以调用此方法取消已订阅的音视频流。
* @param userId 指定需要取消订阅的远端音视频流的所属的用户的 ID 。
* @param isScreen 是否为屏幕共享流。
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes 无论是否订阅了指定的远端音视频流,都可以调用此方法。`userId` 无效或未订阅时,SDK 不会做任何处理,没有负面影响。
* */
unsubscribe(userId: string, isScreen: boolean): number;
/** {zh}
* @region 流消息
* @brief 给房间内指定的用户发送消息,返回这次发送消息的编号。
调用该函数后会收到一次 userMessageSendResult 回调,告知发送结果。
* @param userId 指定用户 ID 。
* @param message 发送的消息内容。
* @return 这次发送消息的编号,从 1 开始递增。
* @notes
* + 调用该函数后会收到一次 userMessageSendResult 回调;
* + 若消息发送成功,则 uid 所指定的用户会收到 userMessageReceived 回调。
*/
sendUserMessage(userId: string, message: string): number;
/** {zh}
* @type api
* @region 多房间
* @brief 给房间内指定的用户发送二进制消息(P2P)
* @param uid 消息接收用户的 ID
* @param message 二进制消息的内容。消息不超过 46KB。
* @return 这次发送消息的编号,从 1 开始递增。
* @notes
* + 在发送房间内二进制消息前,必须先调用 joinRoom{@link #JoinRoom} 加入房间。
* + 调用该函数后会收到一次 onUserMessageSendResult{@link 85533#OnUserMessageSendResult} 回调,通知消息发送方发送成功或失败;
* + 若二进制消息发送成功,则 uid 所指定的用户会收到 onUserBinaryMessageReceived{@link 85533#OnUserBinaryMessageReceived} 回调。
*/
sendUserBinaryMessage(uid: string, message: string): number;
/** {zh}
* @type api
* @region 音频数据回调
* @brief 设置本地麦克风录制的音频数据回调参数
* @param sample_rate 音频采样率(单位HZ),可以设置的值有 8000,16000,32000,44100,48000
* @param channels 音频通道数,支持单声道(1)和双声道(2)
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes 使用本方法设置参数后可以在 onRecordAudioFrame{@link 85533#OnRecordAudioFrame} 收到数据
*/
setRecordingAudioFrameParameters(sample_rate: number, channels: number): number;
/** {zh}
* @type api
* @region 音频数据回调
* @brief 设置远端所有用户音频数据混音后的音频数据回调参数
* @param sample_rate 音频采样率(单位HZ),可以设置的值有 8000,16000,32000,44100,48000
* @param channels 音频通道数,支持单声道(1)和双声道(2)
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes 使用本方法设置参数后可以在 onPlaybackAudioFrame{@link 85533#OnPlaybackAudioFrame} 收到数据
*/
setPlaybackAudioFrameParameters(sample_rate: number, channels: number): number;
/** {zh}
* @type api
* @region 音频数据回调
* @brief 设置本地麦克风录制音频数据和远端所有用户音频数据混音后的音频数据回调参数
* @param sample_rate 音频采样率(单位HZ),可以设置的值有 8000,16000,32000,44100,48000
* @param channels 音频通道数,支持单声道(1)和双声道(2)
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes 使用本方法设置参数后可以在 onMixedAudioFrame{@link 85533#OnMixedAudioFrame} 收到数据
*/
setMixedAudioFrameParameters(sample_rate: number, channels: number): number;
/** {zh}
* @type api
* @region 本地录制
* @brief 该方法将通话过程中的音视频数据录制到本地的文件中。
* @param type 流属性,指定录制主流还是屏幕流主流。包括:由摄像头/麦克风通过内部采集机制,采集到的视频/音频;通过自定义采集,采集到的视频/音频。屏幕流。屏幕共享时共享的视频流,或来自声卡的本地播放音频流。
* @param config 本地录制参数配置
* @return
* + 0: 正常
* + -1: 参数设置异常
* + -2: 当前版本 SDK 不支持该特性,请联系技术支持人员
* @notes
* + 调用该方法后,你会收到 onRecordingStateUpdate{@link 85533#OnRecordingStateUpdate} 回调。
* + 如果录制正常,系统每秒钟会通过 onRecordingProgressUpdate{@link 85533#OnRecordingProgressUpdate} 回调通知录制进度。
*/
startFileRecording(type: Number, config: RecordingConfig): number;
/** {zh}
* @type api
* @region 本地录制
* @brief 停止本地录制
* @param type 流属性,指定停止主流或者屏幕流录制主流。包括:由摄像头/麦克风通过内部采集机制,采集到的视频/音频;通过自定义采集,采集到的视频/音频。屏幕流。屏幕共享时共享的视频流,或来自声卡的本地播放音频流。
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 调用 startFileRecording{@link #StartFileRecording} 开启本地录制后,你必须调用该方法停止录制。
* + 调用该方法后,你会收到 onRecordingStateUpdate{@link 85533#OnRecordingStateUpdate} 回调提示录制结果。
*/
stopFileRecording(type: Number): number;
/** {zh}
* @type api
* @region 语音识别服务
* @brief 开启自动语音识别服务。该方法将识别后的用户语音转化成文字,并通过 onMessage{@link 85533#OnMessage} 事件回调给用户。
* @param asr_config 校验信息
* @return + 0: 方法调用成功
* + <0: 方法调用失败
*/
startASR(asr_config: RTCASRConfig): number;
/** {zh}
* @type api
* @region 语音识别服务
* @brief 关闭语音识别服务
* @return + 0: 方法调用成功
* + <0: 方法调用失败
*/
stopASR(): number;
/** {zh}
* @type api
* @region 流消息
* @brief 给房间内所有的用户发送消息。
* @param message 用户发送的广播消息
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 调用该函数后会收到一次 roomMessageSendResult 回调;
* + 同一房间内的其他用户会收到 roomMessageReceived 回调。
*/
sendRoomMessage(message: string): number;
/** {zh}
* @type api
* @region 多房间
* @brief 给房间内的所有其他用户发送广播消息。
* @param message 用户发送的二进制广播消息,每条消息不超过 46KB。
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 在发送房间内二进制消息前,必须先调用 joinRoom{@link #JoinRoom} 加入房间。
* + 调用该函数后,会收到一次 onRoomMessageSendResult{@link 85533#OnRoomMessageSendResult} 回调。
* + 同一房间内的其他用户会收到 onRoomBinaryMessageReceived{@link 85533#OnRoomBinaryMessageReceived} 回调。
*/
sendRoomBinaryMessage(message: string): number;
/** {zh}
* @type api
* @region 实时消息通信
* @brief 必须先登录注册一个 uid,才能发送房间外消息和向业务服务器发送消息
* @param token 动态密钥
用户登录必须携带的 Token,用于鉴权验证。
本 Token 与加入房间时必须携带的 Token 不同。测试时可使用控制台生成临时 Token,正式上线需要使用密钥 SDK 在你的服务端生成并下发 Token。
* @param uid 用户 ID
用户 ID 在 appid 的维度下是唯一的。
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 在调用本接口登录后,如果想要登出,需要调用 Logout{@link #Logout}。
* + 本地用户调用此方法登录后,会收到 OnLoginResult{@link 85533#OnLoginResult} 回调通知登录结果,远端用户不会收到通知。
*/
login(token: String, uid: String): number;
/** {zh}
* @type api
* @region 实时消息通信
* @brief 调用本接口登出后,无法调用房间外消息以及端到服务器消息相关的方法或收到相关回调。
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 调用本接口登出前,必须先调用 login{@link #Login} 登录。
* + 本地用户调用此方法登出后,会收到 onLogout{@link 85533#OnLogout} 回调通知结果,远端用户不会收到通知。
*/
logout(): number;
/** {zh}
* @type api
* @region 实时消息通信
* @brief 更新用户用于登录的 Token
Token 有一定的有效期,当 Token 过期时,需调用此方法更新登录的 Token 信息。
调用 login{@link #Login} 方法登录时,如果使用了过期的 Token 将导致登录失败,并会收到 onLoginResult{@link 85533#OnLoginResult} 回调通知,错误码为 kLoginErrorCodeInvalidToken。此时需要重新获取 Token,并调用此方法更新 Token。
* @param token
* 更新的动态密钥
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 如果 Token 无效导致登录失败,则调用此方法更新 Token 后,SDK 会自动重新登录,而用户不需要自己调用 login{@link #Login} 方法。
* + Token 过期时,如果已经成功登录,则不会受到影响。Token 过期的错误会在下一次使用过期 Token 登录时,或因本地网络状况不佳导致断网重新登录时通知给用户。
*/
updateLoginToken(token: String): number;
/** {zh}
* @type api
* @region 实时消息通信
* @brief 设置业务服务器参数
客户端调用 sendServerMessage{@link #SendServerMessage} 或 sendServerBinaryMessage{@link #SendServerBinaryMessage} 发送消息给业务服务器之前,必须设置有效签名和业务服务器地址。
* @param signature 动态签名
业务服务器会使用该签名对请求进行鉴权验证。
* @param url 业务服务器的地址
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 用户必须调用 login{@link #Login} 登录后,才能调用本接口。
* + 调用本接口后,SDK 会使用 onServerParamsSetResult{@link 85533#OnServerParamsSetResult} 返回相应结果。
*/
setServerParams(signature: String, url: String): number;
/** {zh}
* @type api
* @region 实时消息通信
* @brief 查询对端用户或本端用户的登录状态
* @param peer_user_id 需要查询的用户 ID
* @return + 0: 方法调用成功
* + <0: 方法调用失败
* @notes
* + 必须调用 login{@link #Login} 登录后,才能调用本接口。
* + 调用本接口后,SDK 会使用 onGetPeerOnlineStatus{@link 85533#OnGetPeerOnlineStatus} 回调通知查询结果。
* + 在发送房间外消息之前,用户可以通过本接口了解对端用户是否登录,从而决定是否发送消息。也可以通过本接口查询自己查看自己的登录状态。
*/
getPeerOnlineStatus(peer_user_id: String): number;
/** {zh}
* @type api
* @region 实时消息通信
* @brief 给房间外指定的用户发送文本消息(P2P)
* @param uid 消息接收用户的 ID
* @param message 发送的文本消息内容,消息不超过 62KB。
* @return
* + \>0:发送成功,返回这次发送消息的编号,从 1 开始递增
* + -1:发送失败,RtcEngine 实例未创建
* + -2:发送失败,uid 为空
* @notes
* + 在发送房间外文本消息前,必须先调用 login{@link #Login} 完成登录。
* + 用户调用本接口发送文本信息后,会收到一次 onUserMessageSendResultOutsideRoom{@link 85533#OnUserMessageSendResultOutsideRoom} 回调,得知消息是否成功发送。
* + 若文本消息发送成功,则 uid 所指定的用户会通过 onUserMessageReceivedOutsideRoom{@link 85533#OnUserMessageReceivedOutsideRoom} 回调收到该消息。
*/
SendUserMessageOutsideRoom(uid: String, message: String): number;
/** {zh}
* @type api
* @region 错误码
* @brief 获取错误码的描述
* @param code 需要获取描述的错误码
* @return 错误码的描述
* @notes 该接口是通用功能,调用时不需要依赖引擎对象。
*/
getErrorDescription(code: number): string;
/** {zh}
* @type api
* @region 实时消息通信
* @brief 给房间外指定的用户发送二进制消息(P2P)
* @param uid 消息接收用户的 ID
* @param message 发送的二进制消息内容,每条消息不超过 46KB。
* @return
* + >0:发送成功,返回这次发送消息的编号,从 1 开始递增
* + -1:发送失败,RtcEngine 实例未创建
* + -2:发送失败,uid 为空
* @notes
* + 在发送房间外二进制消息前,必须先调用 login{@link #Login} 完成登录。
* + 用户调用本接口发送二进制消息后,会收到一次 onUserMessageSendResultOutsideRoom{@link 85533#OnUserMessageSendResultOutsideRoom} 回调,通知消息是否发送成功。
* + 若二进制消息发送成功,则 uid 所指定的用户会通过 onUserBinaryMessageReceivedOutsideRoom{@link 85533#OnUserBinaryMessageReceivedOutsideRoom} 回调收到该条消息。
*/
sendUserBinaryMessageOutsideRoom(uid: String, message: String): number;
/** {zh}
* @type api
* @region 实时消息通信
* @brief 客户端给业务服务器发送文本消息(P2Server)
* @param message 发送的文本消息内容,消息不超过 62KB。
* @return
* + \>0:发送成功,返回这次发送消息的编号,从 1 开始递增
* + -1:发送失败,RtcEngine 实例未创建
* @notes
* + 在向业务服务器发送文本消息前,必须先调用 Login{@link #Login} 完成登录,随后调用 SetServerParams{@link #SetServerParams} 设置业务服务器。
* + 调用本接口后,会收到一次 OnServerMessageSendResult{@link 85533#OnServerMessageSendResult} 回调,通知消息发送方是否发送成功。
* + 若文本消息发送成功,则之前调用 SetServerParams{@link #SetServerParams} 设置的业务服务器会收到该条消息。
*/
sendServerMessage(message: String): number;
/** {zh}
* @type api
* @region 实时消息通信
* @brief 客户端给业务服务器发送二进制消息(P2Server)
* @param length 二进制字符串的长度
* @param message 发送的二进制消息内容,消息不超过 46KB。
* @return
* + \>0:发送成功,返回这次发送消息的编号,从 1 开始递增
* + -1:发送失败,RtcEngine 实例未创建
* @notes
* + 在向业务服务器发送二进制消息前,必须先调用 login{@link #Login} 完成登录,随后调用 setServerParams{@link #SetServerParams} 设置业务服务器。
* + 调用本接口后,会收到一次 onServerMessageSendResult{@link 85533#OnServerMessageSendResult} 回调,通知消息发送方发送成功或失败。
* + 若二进制消息发送成功,则之前调用 setServerParams{@link #SetServerParams} 设置的业务服务器会收到该条消息。
*/
sendServerBinaryMessage(message: String): number;
/** {zh}
* @type api
* @region 视频特效
* @brief 关闭背景
* @return + 0: 方法调用成功
* + <0: 方法调用失败
*/
disableBackground(): number;
/** {zh}
* @type api
* @region 视频特效
* @brief 视频特效许可证检查
* @param licensePath 许可证文件绝对路径
* @return
* + 0: 调用成功
* + 1000: 未集成 CV SDK
* + 1001: 本RTC版本不支持cv功能
* + <0: 调用失败,具体错误码请参考 [CV SDK 文档](http://ailab-cv-sdk.bytedance.com/docs/2036/99783/)。
* @notes 开始使用视频特效前,你必须先调用这个方法进行许可证验证
*/
checkLicense(licensePath: string): number;
/** {zh}
* @type api
* @region 视频特效
* @brief 从 CV SDK 获取授权消息,用于获取在线许可证。
* @return 授权消息字符串
* @notes
* + 使用 CV 的功能前,你必须获取 CV SDK 的在线许可证。
* + 通过此接口获取授权消息后,你必须参考 [在线授权说明](http://ailab-cv-sdk.bytedance.com/docs/2036/99798/)。
* + 自行实现获取在线许可证的业务逻辑。获取许可证后,你必须调用 CheckLicense{@link #CheckLicense} 确认许可证有效。然后,你才可以使用 CV 功能。
* + 获取授权消息后,调用 FreeAuthMessage{@link #FreeAuthMessage} 释放内存。
*/
getAuthMessage(): string;
/** {zh}
* @type api
* @region 视频特效
* @brief 开启关闭视频特效
* @param enabled 是否开启特效,true: 开启,false: 关闭
* @return
* + 0: 调用成功
* + 1000: 未集成 CV SDK
* + <0: 调用失败,具体错误码含义请参考 CV SDK 文档
* @notes 在调用 checkLicense{@link #CheckLicense}和 setAlgoModelPath{@link #SetAlgoModelPath}后调用此方法
*/
enableEffect(enabled: boolean): number;
/** {zh}
* @region 视频特效
* @brief 设置视频特效算法模型路径
* @param modelPath 模型路径
* @return
* + 0:成功
* + !0:失败
*/
setAlgoModelPath(modelPath: string): number;
/** {zh}
* @type api
* @region 视频特效
* @brief 设置视频特效素材包,支持同时设置多个素材包
* @param effectNodePaths 特效素材包路径数组
* @return
* + 0: 调用成功
* + 1000: 未集成 CV SDK
* + 1001: 本 RTC 版本不支持 CV 功能
* + <0: 调用失败,具体错误码,请参考 [CV SDK 文档](http://ailab-cv-sdk.bytedance.com/docs/2036/99783/)。
*/
setEffectNodes(effectNodePaths: string[]): number;
/** {zh}
* @type api
* @region 视频特效
* @brief 设置特效强度
* @param nodePath 特效素材包路径
* @param nodeKey 需要设置的素材 key 名称,取值请参考 [素材 key 对应说明](http://ailab-cv-sdk.bytedance.com/docs/2036/99769/)。
* @param nodeValue 需要设置的强度值 取值范围 [0,1],超出范围时设置无效。
* @return
* + 0: 调用成功
* + 1000: 未集成 CV SDK
* + 1001: 本 RTC 版本不支持 CV 功能
* + <0: 调用失败,具体错误码,请参考 [CV SDK 文档](http://ailab-cv-sdk.bytedance.com/docs/2036/99783/)。
*/
updateNode(nodePath: string, nodeKey: string, nodeValue: number): number;
/** {zh}
* @type api
* @region 视频特效
* @brief 设置颜色滤镜
* @param resPath 滤镜资源包绝对路径。
* @return
* + 0: 调用成功
* + 1000: 未集成 CV SDK
* + 1001: 本 RTC 版本不支持 CV 功能
* + <0: 调用失败,具体错误码,请参考 [CV SDK 文档](http://ailab-cv-sdk.bytedance.com/docs/2036/99783/)。
*/
setColorFilter(resPath: string): number;
/** {zh}
* @type api
* @region 视频特效
* @brief 设置已启用颜色滤镜的强度
* @param intensity 滤镜强度。取值范围 [0,1],超出范围时设置无效。
* @return
* + 0: 调用成功
* + 1000: 未集成 CV SDK
* + 1001: 本 RTC 版本不支持 CV 功能
* + <0: 调用失败,具体错误码,请参考 [CV SDK 文档](http://ailab-cv-sdk.bytedance.com/docs/2036/99783/)。
*/
setColorFilterIntensity(intensity: number): number;
/** {zh}
* @type api
* @region 视频管理
* @brief 在视频通信时,通过视频帧发送 SEI 数据。
* @param stream_index 媒体流类型主流。包括:由摄像头/麦克风通过内部采集机制,采集到的视频/音频;通过自定义采集,采集到的视频/音频。屏幕流。屏幕共享时共享的视频流,或来自声卡的本地播放音频流。
* @param message SEI 消息。长度不超过 4 kB。
* @param repeat_count 消息发送重复次数。取值范围是 [0, 30]。
调用此接口后,SEI 数据会添加到当前视频帧开始的连续 `repeatCount` 个视频帧中。
* @return
* + \>=0: 将被添加到视频帧中的 SEI 的数量
* + < 0: 发送失败
* @notes
* + 如果调用此接口之后的 2s 内,没有可带 SEI 的视频帧(比如没有开启视频采集和传输),那么,SEI 数据不会被加进视频帧中。
* + 消息发送成功后,远端会收到 OnSEIMessageReceived{@link 85533#OnSEIMessageReceived} 回调。
*/
sendSEIMessage(stream_index: number, message: string, repeat_count: number): number;
/** {zh}
* @type api
* @region 屏幕共享
* @brief 在屏幕共享时,设置屏幕音频流和麦克风采集到的音频流的混流方式
* @param index 混流方式 `0`: 将屏幕音频流和麦克风采集到的音频流混流 `1`: 将屏幕音频流和麦克风采集到的音频流分为两路音频流
* @notes 你应该在 publishScreen{@link #PublishScreen} 之前,调用此方法。否则,你将收到 onWarning{@link 85533#OnWarning} `的报错:kWarningCodeSetScreenAudioStreamIndexFailed`
*/
setScreenAudioStreamIndex(index: number): number;
/** {zh}
* @type api
* @region 屏幕共享
* @brief 在屏幕共享时,开始使用 RTC SDK 内部采集方式,采集屏幕音频
* @notes
* + 采集后,你还需要调用 publishScreen{@link #PublishScreen} 将采集到的屏幕音频推送到远端。
* + 要关闭屏幕音频内部采集,调用 stopScreenAudioCapture{@link #StopScreenAudioCapture}。
*/
startScreenAudioCapture(): number;
/** {zh}
* @type api
* @region 屏幕共享
* @brief 在屏幕共享时,停止使用 RTC SDK 内部采集方式,采集屏幕音频。
* @notes 要开始屏幕音频内部采集,调用 startScreenAudioCapture{@link #StartScreenAudioCapture}。
*/
stopScreenAudioCapture(): number;
/** {zh}
* @type api
* @region 引擎管理
* @brief 本次通话质量打分评价
* @param data 上报的数据。JSON 格式,必须包含以下 4 个字段: types: 预设的问题类型集合,可多选。具体的类型参考 [ProblemFeedbackOption](../70098/#problemfeedbackoption) problem_desc: 预设问题以外的其他问题的具体描述 os_version: 系统版本 network_type: 网络类型:包括 WiFi, 2g, 3g, 4g, 5g。如果是台式机,填写 pc 。
* @return
* + 0: 上报成功
* + -1: 上报失败,还没加入过房间
* + -2: 上报失败,传入 JSON 解析失败
* + -3: 上报失败,传入 JSON 字段缺失
* @notes + 如果用户上报时在房间内,那么问题会定位到用户当前所在的一个或多个房间;
* + 如果用户上报时不在房间内,那么问题会定位到引擎此前退出的房间。
*/
feedback(data: String): number;
/** {zh}
* @private
* @type api
* @region 引擎管理
* @brief 设置运行时的参数
* @param json_string json 序列化之后的字符串,用以覆盖全局参数,详情可见 setParameters,业务方传入
*/
setRuntimeParameters(json_string: String): void;
/** {zh}
* @region 加密
* @brief 设置传输时使用内置加密的方式
* @param encrypt_type 加密算法 `0`: 不使用内置加密`1`:AES-128-CBC 加密算法`2`:AES-256-CBC 加密算法`3`:AES-128-ECB 加密算法`4`:AES-256-ECB 加密算法
* @param key 加密密钥,长度限制为 36 位,超出部分将会被截断
* @notes
* + 使用传输时内置加密时,使用此方法;如果需要使用传输时自定义加密,参看 onEncryptData{@link 85533#OnEncryptData}。 内置加密和自定义加密互斥,根据最后一个调用的方法确定传输是加密的方案。
* + 该方法必须在进房之前调用,可重复调用,以最后调用的参数作为生效参数。
*/
setEncryptInfo(encrypt_type: number, key: string): void;
/**
* @private
*/
setupLocalVideo(view: HTMLDivElement, renderOptions?: RenderOptions): number;
/**
* @private
*/
removeLocalVideo(): number;
/**
* @private
*/
setupRemoteVideo(userId: string, view: HTMLDivElement, renderOptions?: RenderOptions): number;
/**
* @private
*/
removeRemoteVideo(userId: string): number;
/**
* @private
*/
removeAllRemoteVideo(userId: string): number;
/**
* @private
*/
setupLocalScreen(view: HTMLDivElement, renderOptions?: RenderOptions): number;
/**
* @private
*/
removeLocalScreen(): number;
/**
* @private
*/
setupRemoteScreen(userId: string, view: HTMLDivElement, renderOptions?: RenderOptions): number;
/**
* @private
*/
removeRemoteScreen(userId: string): number;
/**
* @private
*/
OnLeaveRoom(): void;
/**
* @private
*/
OnUserJoined(obj: any): void;
/**
* @private
*/
OnUserLeave(obj: any): void;
/**
* @private
*/
OnLocalVideoFrame(obj: any): void;
/**
* @private
*/
OnLocalScreenFrame(obj: any): void;
/**
* @private
*/
OnRemoteVideoFrame(obj: any): void;
/**
* @private
*/
OnRemoteScreenFrame(obj: any): void;
/**
* @private
*/
clearLocalVideoCanvas(): void;
/**
* @private
*/
clearLocalScreenCanvas(): void;
/**
* @private
*/
clearRemoteVideoCanvas(userId: string): void;
/**
* @private
*/
clearAllRemoteVideoCanvas(): void;
/**
* @private
*/
clearRemoteScreenCanvas(userId: string): void;
/**
* @private
*/
cbEngine(obj: any): void;
/**
* @private
*/
fire(event: string, ...args: Array): void;
/**
* @private
*/
processCallback(obj: any): void;
/**
* @private
*/
convertYUVBuffer(obj: any): void;
/**
* @private
*/
findUser(userId: string): UserInfo | null | undefined;
}
/** {zh}
* @list 85530
* @detail 85533
*/
interface CALLBACK {
/** {zh}
* @region 视频管理
* @brief 本地屏幕视频流采集成功后,会收到此回调。
* @param frame 视频数据
* @notes 对于回调的视频数据,你可以进行自定义渲染。
*/
OnLocalScreenFrame(frame: VideoFrame): void;
/** {zh}
* @type callback
* @region 视频管理
* @brief 本地视频流数据回调
* @param frame 视频数据
*/
OnLocalVideoFrame(frame: VideoFrame): void;
/** {zh}
* @type callback
* @region 视频管理
* @brief 远端屏幕共享流数据回调
* @param frame 视频数据
*/
OnRemoteScreenFrame(frame: VideoFrame): void;
/** {zh}
* @type callback
* @region 视频管理
* @brief 远端视频数据回调
* @param frame 视频数据
*/
OnRemoteVideoFrame(frame: VideoFrame): void;
/** {zh}
* @type callback
* @region 警告码
* @brief 当内部发生警告事件时触发该回调
* @param warn 警告标识码
*/
OnWarning(warn: WarningCode): void;
/** {zh}
* @type callback
* @region 错误码
* @brief 当内部发生不可逆转错误时触发该回调
* @param error 错误标识码
*/
OnError(error: ErrorCode): void;
/** {zh}
* @type callback
* @region 混音
* @brief 本地音乐文件播放已结束回调。当调用 startAudioMixing{@link 85532#StartAudioMixing} 启动的混音文件播放结束后,会触发该回调。
*/
OnAudioMixingFinished(): void;
/** {zh}
* @type callback
* @region 混音
* @brief 音频混音文件播放状态改变时回调
* @param id 混音 ID
* @param state 混音状态
* @param error 错误码
* @notes
* + 此回调会被触发的时机汇总如下:
* + 当调用 startAudioMixing{@link 85532#StartAudioMixing} 方法成功后,会触发 state 值为 kAudioMixingStatePlaying 回调;否则触发 state 值为 kAudioMixingStateFailed 的回调。
* + 当使用相同的 ID 重复调用 startAudioMixing{@link 85532#StartAudioMixing} 后,后一次会覆盖前一次,且本回调会以 kAudioMixingStateStopped 通知前一次混音已停止。
* + 当调用 pauseAudioMixing{@link 85532#PauseAudioMixing} 方法暂停播放成功后,会触发 state 值为 kAudioMixingStatePaused 回调;否则触发 state 值为 kAudioMixingStateFailed 的回调。
* + 当调用 resumeAudioMixing{@link 85532#ResumeAudioMixing} 方法恢复播放成功后,会触发 state 值为 kAudioMixingStatePlaying 回调;否则触发 state 值为 kAudioMixingStateFailed 的回调。
* + 当调用 stopAudioMixing{@link 85532#StopAudioMixing} 方法暂停止播放成功后,会触发 state 值为 kAudioMixingStateStopped 回调;否则触发 state 值为 kAudioMixingStateFailed 的回调。
* + 播放结束会触发 state 值为 kAudioMixingStateFinished 回调。
*/
OnAudioMixingStateChanged(id: Number, state: AudioMixingState, error: AudioMixingError): void;
/** {zh}
* @type callback
* @brief SDK 与信令服务器连接状态改变回调。连接状态改变时触发。
* @param state 当前 SDK 与信令服务器的连接状态
*/
OnConnectionStateChanged(state: ConnectionState): void;
/** {zh}
* @type callback
* @region 引擎管理
* @brief SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。
* @param type SDK 当前的网络连接类型
*/
OnNetworkTypeChanged(type: NetworkType): void;
/** {zh}
* @type callback
* @region 音视频回退
* @brief 本地未开启发布性能回退,检测到设备性能不足时,收到此回调。
本地开启发布性能回退,因设备性能/网络原因,造成发布性能回退/恢复时,收到此回调。
* @param mode 指示本地是否开启发布回退功能 当发布端未开启发布性能回退时,mode 值为 kPerformanceAlarmModeNormal。 当发布端开启发布性能回退时,mode 值为 kPerformanceAlarmModeSimulcast。
* @param room_id 未开启发布性能回退时,room_id 为空 开启发布性能回退时,room_id 是告警影响的房间 ID。
* @param reason 告警原因
* @param sourceWantedDataObject 性能回退相关数据
*/
OnPerformanceAlarms(mode: PerformanceAlarmMode, room_id: String, reason: PerformanceAlarmReason, sourceWantedDataObject: Object): void;
/** {zh}
* @type callback
* @region 引擎管理
* @brief 媒体设备事件回调。
* @param deviceId 设备 id
* @param deviceType 媒体设备类型
* @param deviceState 媒体设备状态类型
* @param deviceError 媒体设备错误类型
* @notes 该回调包括了系统内媒体设备的事件通知,如设备的插入、拔出事件通知。
*/
OnMediaDeviceStateChanged(deviceId: string, deviceType: MediaDeviceType, deviceState: MediaDeviceState, deviceError: MediaDeviceError): void;
/** {zh}
* @type callback
* @region 引擎管理
* @brief 周期性地发出回调,报告当前cpu与memory使用率
* @param stats 返回包含当前系统状态信息的结构体
*/
OnSysStats(stats: SysStats): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief 首次加入房间/重连加入房间的回调。此回调表示用户调用 joinRoom{@link #JoinRoom} 的结果,根据错误码判断成功/失败以及区别是否为重连。
* @param roomId 房间 ID。
* @param userId 用户 ID。
* @param errorCode 用户加入房间回调的状态码。 `0`: 加入房间成功;
* @param joinType 用户加入房间的类型,标识用户第一次加入或断网重连加入。参看 joinRoomType{@link #JoinRoomType}。
* @param elapsed 重连耗时。本地用户从连接断开到重连成功所经历的时间间隔,单位为 ms,加入房间失败为 `-1`
*/
OnJoinRoomResult(roomId: string, userId: string, errorCode: Number, joinType: JoinRoomType, elapsed: number): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief 离开房间回调。
用户调用 leaveRoom{@link #LeaveRoom} 方法后,SDK 会停止所有的发布订阅流,并在释放所有与通话相关的音视频资源后,通过此回调通知用户离开房间成功。
离开房间后,如果 App 需要使用系统音视频设备,则建议收到此回调后再初始化音视频设备,否则可能由于 SDK 占用音视频设备而导致初始化失败。
* @param stat 本次通话的统计数据 。
*/
OnLeaveRoom(stat: Object): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief SDK 发生警告回调。
SDK 内部遇到可恢复错误时,在尝试自动恢复的同时,会通过此回调通知用户。此回调事件仅用作通知。
* @param warn 警告码,参看 WarningCode{@link #WarningCode}。
Todo +
*/
OnRoomWarning(warn: number): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief SDK 发生错误回调。
SDK 内部遇到不可恢复错误时,会通过此回调通知 App,需要 App 根据错误码进行操作或提示用户。
* @param error 错误码,参看 ErrorCode{@link #ErrorCode}。
*/
OnRoomError(error: number): void;
/** {zh}
* @type callback
* @region 音频事件回调
* @brief 提示房间内谁正在说话以及说话者音量的回调
* @param speakers 房间内所有用户ID, 以及每个用户对应的音量,包括发送流和接收流。详见:AudioVolumeInfo{@link #AudioVolumeInfo}。
* @param totalVolume 音频源总音量,只包含接收流
* @notes
* + 该回调提示房间内所有用户的用户ID及他们的音量。默认禁用。
* + 可以通过启用说话者音量提示 enableAudioVolumeIndication 方法开启。
* + 开启后,无论房间内是否有人说话,都会按方法中设置的时间间隔返回提示音量。
*/
OnAudioVolumeIndication(speakers: AudioVolumeInfo[], totalVolume: number): void;
/** {zh}
* @type callback
* @region 视频管理
* @brief 用户加入房间成功后,每 2s 会收到一次房间内统计信息的回调。
* @param stats 当前 RtcEngine 统计数据
*/
OnRoomStats(stats: RtcRoomStats): void;
/** {zh}
* @type callback
* @region 数据统计
* @brief 反映通话中本地设备发送音/视频流的统计信息以及网络状况的回调,每 2s 触发一次。
* @param stats 当前 RtcEngine 统计数据
*/
OnLocalStreamStats(stats: LocalStreamStats): void;
/** {zh}
* @type callback
* @region 数据统计
* @brief 通话中本地设备接收订阅的远端音/视频流的统计信息以及网络状况,每 2s 触发一次。
* @param stats 当前 RtcEngine 统计数据
*/
OnRemoteStreamStats(stats: RemoteStreamStats): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief 远端用户加入房间回调。
* @param userId 用户ID 。新加入的远端用户的用户ID 。
* @param elapsed 本地用户调用 joinChannel 加入房间到收到该事件经历的时间,单位为 ms 。
* @notes
* + 此回调用于提示房间中有新用户加入。如果本地用户已经在房间中,有新的远端用户加入时,SDK 通过此回调方法通知房间中有新用户加入;如果用户加入房间前,房间中已有其他用户,加入房间后用户也会收到这些已在房间中的远端用户的加入房间回调。
* + 回调的具体触发时机如下:
* 1.远端的房间模式为通信模式的用户或房间模式为其他模式的主播、观众角色的用户,调用 joinChannel 方法加入房间。
* 2.远端的房间模式为通信模式的用户或房间模式为其他模式的主播、观众角色的用户,在断网后重连入房间。
* 3.远端已在房间中的房间模式为直播、游戏或云游戏模式的静默观众角色的用户,调用 setClientRole 方法将用户角色切换至主播或观众。
* 4.本地用户加入房间时,会收到已在房间中的远端的房间模式为通信模式的用户或房间模式为其他模式的主播、观众角色的用户的加入房间回调。
*/
OnUserJoined(userId: string, elapsed: number): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief 远端用户离开房间回调。
* @param userId 用户ID 。离开房间的远端用户的用户ID 。
* @param reason 用户离开的原因
* @notes
* + 此回调用于提示房间中有远端用户离开。用户离开房间的原因有两个,即用户主动调用 leaveChannel 方法离开房间和超时掉线。
* + 回调的具体触发时机如下:
* 1.远端的房间模式为通信模式的用户或房间模式为其他模式的主播、观众角色的用户,调用 leaveChannel 方法离开房间。用户离开的原因为 USER_OFFLINE_QUIT{@link #USER_OFFLINE_QUIT}。
* 2.远端已在房间中的房间模式为直播、游戏或云游戏模式的主播、观众角色的用户调用 setClientRole 方法将用户角色切换至静默观众。用户离开的原因为 USER_OFFLINE_QUIT{@link #USER_OFFLINE_QUIT}。
* 3.远端的房间模式为通信模式的用户或房间模式为其他模式的主播、观众角色的用户,断网且一直未恢复。用户离开的原因为 USER_OFFLINE_DROPPED{@link #USER_OFFLINE_DROPPED}。
*/
OnUserLeave(userId: string, reason: UserOfflineReasonType): void;
/** {zh}
* @hidden
* @type callback
* @region 媒体流管理
* @brief 当房间内用户调用 muteAllRemoteAudio{@link 85532#MuteAllRemoteAudio},改变接收所有远端音频流的状态时, 房间内其他用户收到这个回调。
* @param userId 改变接收状态的用户 ID
* @param muteState 接收状态
*/
OnMuteAllRemoteAudio(userId: string, muteState: MuteState): void;
/** {zh}
* @hidden
* @type callback
* @region 媒体流管理
* @brief 房间内用户暂停/恢复接收所有视频流时,房间内其他用户收到此回调。参看 muteAllRemoteVideo{@link 85532#MuteAllRemoteVideo}。
* @param userId 暂停/恢复接收视频流的用户 ID。
* @param muteState 暂停/恢复接收视频流的状态。
*/
OnMuteAllRemoteVideo(userId: string, muteState: MuteState): void;
/** {zh}
* @type callback
* @region 媒体流管理
* @brief 房间内某用户调用 muteLocalAudio{@link 85532#muteLocalAudio} ,改变本地音频发送状态时,房间内其他用户会收到此回调。
* @param userId 改变本地音频发送状态的用户 ID
* @param muteState 发送状态
*/
OnUserMuteAudio(userId: string, muteState: MuteState): void;
/** {zh}
* @type callback
* @region 媒体流管理
* @brief 房间内用户暂停/恢复发送视频流时,房间内其他用户会收到此回调。参看 muteLocalVideo{@link 85532#MuteLocalVideo}。
* @param userId 暂停/恢复发送视频流的用户 ID。
* @param muteState 暂停/恢复发送视频流的状态
*/
OnUserMuteVideo(userId: string, muteState: MuteState): void;
/** {zh}
* @type callback
* @region 音频事件回调
* @brief 房间内的用户调用 startAudioCapture{@link 85532#StartAudioCapture} 开启音频采集时,房间内其他用户会收到此回调。
* @param userId 开启音频采集的远端用户 ID
*/
OnUserStartAudioCapture(userId: string): void;
/** {zh}
* @type callback
* @region 音频事件回调
* @brief 房间内的用户调用 stopAudioCapture{@link 85533#StopAudioCapture} 关闭音频采集时,房间内其他用户会收到此回调。
* @param userId 关闭音频采集的远端用户 ID
*/
OnUserStopAudioCapture(userId: string): void;
/** {zh}
* @type callback
* @region 音频事件回调
* @brief 本地采集到第一帧音频帧时,收到该回调
* @param index 音频流属性
*/
OnFirstLocalAudioFrame(index: StreamIndex): void;
/** {zh}
* @type callback
* @region 音频事件回调
* @brief 接收到来自远端某音频流的第一帧时,收到该回调。
* @param key 远端音频流信息
* @notes 用户刚收到房间内每一路音频流时,都会收到该回调。
*/
OnFirstRemoteAudioFrame(key: RemoteStreamKey): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief 房间内远端流移除回调。
房间内的远端用户停止发布音视频流时,本地用户会收到此回调通知。
* @param stream 流的属性
* @param reason 远端流移除的原因
*/
OnStreamRemove(stream: ByteStream, reason: StreamRemoveReason): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief 房间内新流发布回调。
房间内的远端用户发布新的音视频流时,本地用户会收到此回调通知。
* @param stream 流的属性
*/
OnStreamAdd(stream: ByteStream): void;
/** {zh}
* @type callback
* @region 音视频回退
* @brief 因发布/订阅性能回退或退出回退状态,订阅的音视频流,发生流的切换时,收到该回调。
* @param stream 流切换信息
* @notes 你必须先通过 API 或控制台设置音视频流订阅回退功能时,你才能收到此回调。
*/
OnSimulcastSubscribeFallback(stream: RemoteStreamSwitch): void;
/** {zh}
* @type callback
* @region 视频管理
* @brief 第一帧本地采集的视频/屏幕共享画面在本地视图渲染完成时,收到此回调。
* @param index 流属性
* @param info 视频信息
*/
OnFirstLocalVideoFrameCaptured(index: StreamIndex, info: VideoFrameInfo): void;
/** {zh}
* @type callback
* @region 视频管理
* @brief 本地视频大小或旋转配置发生改变时,收到此回调。
* @param index 流属性
* @param info 视频帧信息
*/
OnLocalVideoSizeChanged(index: StreamIndex, info: VideoFrameInfo): void;
/** {zh}
* @type callback
* @region 视频管理
* @brief 远端视频大小或旋转配置发生改变时,房间内订阅此视频流的用户会收到此回调。
* @param key 远端流信息
* @param stream 视频帧信息
*/
OnRemoteVideoSizeChanged(key: RemoteStreamKey, stream: VideoFrameInfo): void;
/** {zh}
* @type callback
* @region 视频管理
* @brief 第一帧远端视频流在视图上渲染成功后,收到此回调。
* @param key 远端流信息
* @param stream 视频帧信息
*/
OnFirstRemoteVideoFrameRendered(key: RemoteStreamKey, stream: VideoFrameInfo): void;
/** {zh}
* @type callback
* @region 视频事件回调
* @brief 房间内的用户调用 startVideoCapture{@link 85532#StartVideoCapture} 开启视频采集时,房间内其他用户会收到此回调。
* @param userId 开启视频采集的远端用户 ID
*/
OnUserStartVideoCapture(userId: string): void;
/** {zh}
* @type callback
* @region 视频事件回调
* @brief 房间内的用户调用 stopVideoCapture{@link 85532#StopVideoCapture} 关闭视频采集时,房间内其他用户会收到此回调。
* @param userId 关闭视频采集的远端用户 ID
*/
OnUserStopVideoCapture(userId: string): void;
/** {zh}
* @type callback
* @region 音频事件回调
* @brief 本地音频的状态发生改变时,该回调通知当前的本地音频状态。
* @param state 本地音频设备的状态
* @param error 本地音频状态改变时的错误码
*/
OnLocalAudioStateChanged(state: LocalAudioStreamState, error: LocalAudioStreamError): void;
/** {zh}
* @type callback
* @region 音频事件回调
* @brief 用户订阅来自远端的音频流状态发生改变时,会收到此回调,了解当前的远端音频流状态。
* @param key 远端流信息
* @param state 远端音频流状态
* @param reason 远端音频流状态改变的原因
*/
OnRemoteAudioStateChanged(key: RemoteStreamKey, state: RemoteAudioState, reason: RemoteAudioStateChangeReason): void;
/** {zh}
* @type callback
* @region 视频管理
* @brief 本地视频流的状态发生改变时,收到该事件。
* @param index 音/视频属性
* @param state 本地视频流状态
* @param error 本地视频状态改变时的错误码
*/
OnLocalVideoStateChanged(index: StreamIndex, state: LocalVideoStreamState, error: LocalVideoStreamError): void;
/** {zh}
* @type callback
* @region 视频管理
* @brief 远端视频流的状态发生改变时,房间内订阅此流的用户会收到该事件。
* @param key 远端视频流的信息,房间、用户 ID、流属性等。
* @param state 远端视频流状态
* @param reason 远端视频流状态改变的原因
*/
OnRemoteVideoStateChanged(key: RemoteStreamKey, state: RemoteVideoState, reason: RemoteVideoStateChangeReason): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief 音频首帧发送状态改变回调
* @param user 本地用户信息
* @param state 首帧发送状态
*/
OnAudioFrameSendStateChanged(user: RtcUser, state: FirstFrameSendState): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief 视频首帧发送状态改变回调
* @param user 本地用户信息
* @param state 首帧发送状态
*/
OnVideoFrameSendStateChanged(user: RtcUser, state: FirstFrameSendState): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief 屏幕共享流视频首帧发送状态改变回调
* @param user 本地用户信息
* @param state 首帧发送状态
*/
OnScreenVideoFrameSendStateChanged(user: RtcUser, state: FirstFrameSendState): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief 音频首帧播放状态改变回调
* @param user 远端用户信息
* @param state 首帧播放状态
*/
OnAudioFramePlayStateChanged(user: RtcUser, state: FirstFramePlayState): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief 视频首帧播放状态改变回调
* @param user 远端用户信息
* @param state 首帧播放状态
*/
OnVideoFramePlayStateChanged(user: RtcUser, state: FirstFramePlayState): void;
/** {zh}
* @type callback
* @region 房间管理
* @brief 屏幕共享流视频首帧播放状态改变回调
* @param user 远端用户信息
* @param state 首帧播放状态
*/
OnScreenVideoFramePlayStateChanged(user: RtcUser, state: FirstFramePlayState): void;
/** {zh}
* @type callback
* @region 音频事件回调
* @brief 远端用户开启/关闭音频设备采集时,房间内其他人会收到这个回调。
该回调由远端用户调用 enableLocalAudio 方法触发。
* @param userId 远端用户ID
* @param enabled 该用户是否开启了音频设备采集
*/
OnUserEnableLocalAudio(userId: string, enabled: boolean): void;
/** {zh}
* @type callback
* @region 流消息
* @brief 接收到房间内广播消息的回调。
* @param uid 远端用户ID
* @param message 收到的消息内容
* @notes 同一房间内其他用户调用 sendMessageToRoom 发送广播消息时会收到该回调。
*/
OnRoomMessageReceived(uid: string, message: string): void;
/** {zh}
* @type callback
* @region 视频管理
* @brief 远端用户开启/关闭本地视频采集时回调该事件,当远端用户调用 enableLocalVideo 时,其他用户会触发此回调。
* @param userI 用户ID,提示是哪个用户的视频流。
* @param enabled 是否启用本地视频功能。 true:该用户已启用本地视频功能。启用后,其他用户可以接收到该用户的视频流。 false:该用户已关闭视频功能。关闭后,该用户仍然可以接收其他用户的视频流,但其他用户接收不到该用户的视频流。
* @notes 提示有其他用户启用/关闭了本地视频功能。
*/
OnUserEnableLocalVideo(userId: string, enabled: boolean): void;
/** {zh}
* @type callback
* @region 流消息
* @brief 当调用 sendMessageToRoom 函数发送消息后,回调此条消息的发送结果(反馈)。
* @param msgId 本条消息的 ID
* @param error 消息发送结果
*/
OnRoomMessageSendResult(msgId: number, error: MessageSendResultCode): void;
/** {zh}
* @type callback
* @region 实时消息通信
* @brief 接收到房间内二进制广播消息的回调。
* @param uid 消息发送者 ID
* @param message 收到的二进制消息内容
* @notes 同一房间内其他用户调用 sendRoomBinaryMessage{@link 85532#SendRoomBinaryMessage} 发送二进制广播消息时会收到该回调。
*/
OnRoomBinaryMessageReceived(uid: string, message: string): void;
/** {zh}
* @type callback
* @region 流消息
* @brief 点对点消息回调。接收到同一房间内 uid 所属用户发来消息时触发。
* @param userId 消息发送者 ID 。
* @param message 收到的消息内容。
* @notes 同一房间内其他用户调用 sendMessageToUser 发送消息给本地用户时会收到该回调。
*/
OnUserMessageReceived(userId: string, message: string): void;
/** {zh}
* @type callback
* @region 流消息
* @brief 当调用 sendMessageToUser 函数发送消息后,回调此条消息的发送结果(反馈)。
* @param msgId 本条消息的 ID
* @param error 消息发送结果
*/
OnUserMessageSendResult(msgId: number, error: MessageSendResultCode): void;
/** {zh}
* @type callback
* @region 实时消息通信
* @brief 单个用户接收到同一房间内其他 uid 所属用户发来二进制消息的回调(P2P)。
* @param uid 消息发送者 ID 。
* @param message 收到的二进制消息内容。
* @notes 同一房间内其他用户调用 sendUserBinaryMessage{@link 85532#SendUserBinaryMessage} 发送二进制消息给本地用户时,本地用户会收到该回调。
*/
OnUserBinaryMessageReceived(uid: string, message: string): void;
/** {zh}
* @hidden
* @type callback
* @region 房间管理
* @brief 当订阅一个流成功的时候回调该事件
* 当更新流的内容时比如增加或者减少音视频流成功更新时也会回调该事件
* @param stateCode 订阅流的结果
* @param userId 用户的标识
* @param info 流的属性
*/
OnStreamSubscribed(stateCode: SubscribeState, userId: string, info: SubscribeConfig): void;
/** {zh}
* @type callback
* @region 视频管理
* @brief 收到通过 sendSEIMessage{@link 85532#SendSEIMessage} 发送的带有 SEI 消息的视频帧时,收到此回调
* @param stream_key 包含 SEI 发送者的用户名,所在的房间名和媒体流
* @param message 收到的 SEI 消息内容
*/
OnSEIMessageReceived(stream_key: RemoteStreamKey, message: String): void;
/** {zh}
* @type callback
* @region 转推直播
* @brief 通知 Transcoding 关键事件
* @param event 事件类型
* @param event_data 事件参数
* @param error 错误类型
* @param mix_type 合流类型
*/
OnStreamMixingEvent(event: StreamMixingEvent, event_data: String, error: number, mix_type: StreamMixingType): void;
/** {zh}
* @type callback
* @region 转推直播
* @brief 合流视频回调,运行在视频回调线程
* @param video_frame 视频帧
*/
OnStreamMixingVideoFrame(video_frame: VideoFrame): void;
/** {zh}
* @type callback
* @region 本地录制
* @brief 获取本地录制状态回调。
该回调由 startFileRecording{@link 85532#StartFileRecording} 或 StopFileRecording{@link #StopFileRecording} 触发。
* @param type 录制流的流属性
* @param state 录制状态
* @param error_code 录制错误码
* @param info 录制文件的详细信息
*/
OnRecordingStateUpdate(type: StreamIndex, state: number, error_code: number, info: RecordingInfo): void;
/** {zh}
* @type callback
* @region 本地录制
* @brief 本地录制进度回调。 该回调由 StartFileRecording{@link 85532#StartFileRecording} 触发,录制状态正常时,系统每秒钟都会通过该回调提示录制进度。
* @param type 录制流的流属性
* @param process 录制进度
* @param info 录制文件的详细信息
*/
OnRecordingProgressUpdate(type: StreamIndex, process: RecordingProgress, info: RecordingInfo): void;
/** {zh}
* @type callback
* @region 实时消息通信
* @brief 登录结果回调
* @param uid 登录用户 ID
* @param error_code 登录结果
* @param elapsed 从调用 Login{@link #Login} 接口开始到返回结果所用时长,单位为 ms。
* @notes 调用 login{@link 85532#Login} 后,会收到此回调。
*/
OnLoginResult(uid: string, error_code: number, elapsed: number): void;
/** {zh}
* @type callback
* @region 实时消息通信
* @brief 登出结果回调
* @notes 调用 logout{@link 85532#Logout} 后,会收到此回调。
*/
OnLogout(): void;
/** {zh}
* @type callback
* @region 实时消息通信
* @brief 设置业务服务器参数的返回结果
* @param error 设置结果 返回 200,设置成功 返回其他,设置失败
* @notes 调用 setServerParams{@link 85532#SetServerParams} 后,会收到此回调。
*/
OnServerParamsSetResult(error: number): void;
/** {zh}
* @type callback
* @region 实时消息通信
* @brief 查询对端或本端用户登录状态的返回结果
* @param peer_user_id 需要查询的用户 ID
* @param status 查询的用户登录状态
* @notes 必须先调用 getPeerOnlineStatus{@link 85532#GetPeerOnlineStatus},才能收到此回调。
*/
OnGetPeerOnlineStatus(peer_user_id: string, status: number): void;
/** {zh}
* @type callback
* @region 实时消息通信
* @brief 收到房间外用户调用 sendUserMessageOutsideRoom{@link 85532#SendUserMessageOutsideRoom} 发来的文本消息时,会收到此回调
* @param uid 消息发送者 ID
* @param message 收到的文本消息内容
*/
OnUserMessageReceivedOutsideRoom(uid: string, message: string): void;
/** {zh}
* @type callback
* @region 实时消息通信
* @brief 收到房间外用户调用 SendUserBinaryMessageOutsideRoom{@link #SendUserBinaryMessageOutsideRoom} 发来的二进制消息时,会收到此回调
* @param uid 消息发送者 ID
* @param message 收到的二进制消息内容
*/
OnUserBinaryMessageReceivedOutsideRoom(uid: string, message: string): void;
/** {zh}
* @type callback
* @region 实时消息通信
* @brief 给房间外指定的用户发送消息的回调
* @param msgid 本条消息的 ID。所有的 P2P 和 P2Server 消息共用一个 ID 序列。
* @param error 消息发送结果
* @notes 当调用 sendUserMessageOutsideRoom{@link 85532#SendUserMessageOutsideRoom} 或 sendUserBinaryMessageOutsideRoom{@link 85532#SendUserBinaryMessageOutsideRoom} 发送消息后,会收到此回调。
*/
OnUserMessageSendResultOutsideRoom(msgid: number, error: number): void;
/** {zh}
* @type callback
* @region 实时消息通信
* @brief 给业务服务器发送消息的回调
* @param msgid 本条消息的 ID。所有的 P2P 和 P2Server 消息共用一个 ID 序列。
* @param error 消息发送结果
* @notes 当调用 SendServerMessage{@link 85532#SendServerMessage} 或 sendServerBinaryMessage{@link 85532#SendServerBinaryMessage} 接口发送消息后,会收到此回调。
*/
OnServerMessageSendResult(msgid: number, error: number): void;
/** {zh}
* @type callback
* @region 音频数据回调
* @brief 返回麦克风录制的音频数据
* @param audio_frame 麦克风录制的音频数据
*/
OnRecordAudioFrame(audio_frame: AudioFrame): void;
/** {zh}
* @type callback
* @region 音频数据回调
* @brief 返回远端所有用户混音后的音频数据
* @param audio_frame 远端所有用户混音后的音频数据
*/
OnPlaybackAudioFrame(audio_frame: AudioFrame): void;
/** {zh}
* @type callback
* @region 音频数据回调
* @brief 返回本地麦克风录制和远端所有用户混音后的音频数据
* @param audio_frame 本地麦克风录制和远端所有用户混音后的音频数据
*/
OnMixedAudioFrame(audio_frame: AudioFrame): void;
/** {zh}
* @type callback
* @brief 语音识别服务开启成功回调
*/
OnASRSuccess(): void;
/** {zh}
* @type callback
* @brief 语音转文字成功回调,该回调返回识别后的全量消息。
* @param message 识别完成后得到的文字消息
* @notes 若识别过程中发生了网络连接中断,则重连后回调的信息中只包含重连后识别的文字消息,不再包含上一次连接后识别的消息。
*/
OnMessage(message: string): void;
/** {zh}
* @type callback
* @brief 当语音识别服务内部发生错误事件时触发该回调。
* @param error_code 错误码 <0: 参数错误或 API 调用顺序错误,参看 RTCASRErrorCode{@link #RTCASRErrorCode}; >0: 参看 [语音识别服务错误码](https://bytedance.feishu.cn/docs/doccnMx9153dZEpfLX2I6BkFsMg#VPknqs)
* @param error_message 错误原因说明
*/
OnASRError(error_code: number, error_message: string): void;
}
/** The veRtcEngine interface. */
declare interface veRTCEngine {
on(evt: 'OnLocalScreenFrame', cb: CALLBACK['OnLocalScreenFrame']): this;
on(evt: 'OnLocalVideoFrame', cb: CALLBACK['OnLocalVideoFrame']): this;
on(evt: 'OnRemoteScreenFrame', cb: CALLBACK['OnRemoteScreenFrame']): this;
on(evt: 'OnRemoteVideoFrame', cb: CALLBACK['OnRemoteVideoFrame']): this;
on(evt: 'OnWarning', cb: CALLBACK['OnWarning']): this;
on(evt: 'OnError', cb: CALLBACK['OnError']): this;
on(evt: 'OnAudioMixingFinished', cb: CALLBACK['OnAudioMixingFinished']): this;
on(evt: 'OnAudioMixingStateChanged', cb: CALLBACK['OnAudioMixingStateChanged']): this;
on(evt: 'OnLogReport', cb: (logType: String, logContent: String) => void): this;
on(evt: 'OnConnectionStateChanged', cb: CALLBACK['OnConnectionStateChanged']): this;
on(evt: 'OnNetworkTypeChanged', cb: CALLBACK['OnNetworkTypeChanged']): this;
on(evt: 'OnPerformanceAlarms', cb: CALLBACK['OnPerformanceAlarms']): this;
on(evt: 'OnMediaDeviceStateChanged', cb: CALLBACK['OnMediaDeviceStateChanged']): this;
on(evt: 'OnSysStats', cb: CALLBACK['OnSysStats']): this;
on(evt: 'OnJoinRoomResult', cb: CALLBACK["OnJoinRoomResult"]): this;
on(evt: 'OnLeaveRoom', cb: CALLBACK['OnLeaveRoom']): this;
on(evt: 'OnRoomWarning', cb: CALLBACK['OnRoomWarning']): this;
on(evt: 'OnRoomError', cb: CALLBACK['OnRoomError']): this;
on(evt: 'OnAudioVolumeIndication', cb: CALLBACK['OnAudioVolumeIndication']): this;
on(evt: 'OnRoomStats', cb: CALLBACK['OnRoomStats']): this;
on(evt: 'OnLocalStreamStats', cb: CALLBACK['OnLocalStreamStats']): this;
on(evt: 'OnRemoteStreamStats', cb: CALLBACK['OnRemoteStreamStats']): this;
on(evt: 'OnUserJoined', cb: CALLBACK['OnUserJoined']): this;
on(evt: 'OnUserLeave', cb: CALLBACK['OnUserLeave']): this;
on(evt: 'OnMuteAllRemoteAudio', cb: CALLBACK['OnMuteAllRemoteAudio']): this;
on(evt: 'OnMuteAllRemoteVideo', cb: CALLBACK['OnMuteAllRemoteVideo']): this;
on(evt: 'OnUserMuteAudio', cb: CALLBACK['OnUserMuteAudio']): this;
on(evt: 'OnUserMuteVideo', cb: CALLBACK['OnUserMuteVideo']): this;
on(evt: 'OnUserStartAudioCapture', cb: CALLBACK['OnUserStartAudioCapture']): this;
on(evt: 'OnUserStopAudioCapture', cb: CALLBACK['OnUserStopAudioCapture']): this;
on(evt: 'OnFirstLocalAudioFrame', cb: CALLBACK['OnFirstLocalAudioFrame']): this;
on(evt: 'OnFirstRemoteAudioFrame', cb: CALLBACK['OnFirstRemoteAudioFrame']): this;
on(evt: 'OnStreamRemove', cb: CALLBACK['OnStreamRemove']): this;
on(evt: 'OnStreamAdd', cb: CALLBACK['OnStreamAdd']): this;
on(evt: 'OnSimulcastSubscribeFallback', cb: CALLBACK['OnSimulcastSubscribeFallback']): this;
on(evt: 'OnFirstLocalVideoFrameCaptured', cb: CALLBACK['OnFirstLocalVideoFrameCaptured']): this;
on(evt: 'OnLocalVideoSizeChanged', cb: CALLBACK['OnLocalVideoSizeChanged']): this;
on(evt: 'OnFirstRemoteVideoFrameRendered', cb: CALLBACK['OnFirstRemoteVideoFrameRendered']): this;
on(evt: 'OnRemoteVideoSizeChanged', cb: CALLBACK['OnRemoteVideoSizeChanged']): this;
on(evt: 'OnUserStartVideoCapture', cb: CALLBACK['OnUserStartVideoCapture']): this;
on(evt: 'OnUserStopVideoCapture', cb: CALLBACK['OnUserStopVideoCapture']): this;
on(evt: 'OnLocalAudioStateChanged', cb: CALLBACK['OnLocalAudioStateChanged']): this;
on(evt: 'OnRemoteAudioStateChanged', cb: CALLBACK['OnRemoteAudioStateChanged']): this;
on(evt: 'OnLocalVideoStateChanged', cb: CALLBACK['OnLocalVideoStateChanged']): this;
on(evt: 'OnRemoteVideoStateChanged', cb: CALLBACK['OnRemoteVideoStateChanged']): this;
on(evt: 'OnAudioFrameSendStateChanged', cb: CALLBACK['OnAudioFrameSendStateChanged']): this;
on(evt: 'OnVideoFrameSendStateChanged', cb: CALLBACK['OnVideoFrameSendStateChanged']): this;
on(evt: 'OnScreenVideoFrameSendStateChanged', cb: CALLBACK['OnScreenVideoFrameSendStateChanged']): this;
on(evt: 'OnAudioFramePlayStateChanged', cb: CALLBACK['OnAudioFramePlayStateChanged']): this;
on(evt: 'OnVideoFramePlayStateChanged', cb: CALLBACK['OnVideoFramePlayStateChanged']): this;
on(evt: 'OnScreenVideoFramePlayStateChanged', cb: CALLBACK['OnScreenVideoFramePlayStateChanged']): this;
on(evt: 'OnUserEnableLocalAudio', cb: CALLBACK['OnUserEnableLocalAudio']): this;
on(evt: 'OnRoomMessageReceived', cb: CALLBACK['OnRoomMessageReceived']): this;
on(evt: 'OnUserEnableLocalVideo', cb: CALLBACK['OnUserEnableLocalVideo']): this;
on(evt: 'OnRoomMessageSendResult', cb: CALLBACK['OnRoomMessageSendResult']): this;
on(evt: 'OnRoomBinaryMessageReceived', cb: CALLBACK['OnRoomBinaryMessageReceived']): this;
on(evt: 'OnUserMessageReceived', cb: CALLBACK['OnUserMessageReceived']): this;
on(evt: 'OnUserMessageSendResult', cb: CALLBACK['OnUserMessageSendResult']): this;
on(evt: 'OnUserBinaryMessageReceived', cb: CALLBACK['OnUserBinaryMessageReceived']): this;
on(evt: 'OnStreamSubscribed', cb: CALLBACK['OnStreamSubscribed']): this;
on(evt: 'OnSEIMessageReceived', cb: CALLBACK['OnSEIMessageReceived']): this;
on(evt: 'OnStreamMixingEvent', cb: CALLBACK['OnStreamMixingEvent']): this;
on(evt: 'OnStreamMixingVideoFrame', cb: CALLBACK['OnStreamMixingVideoFrame']): this;
on(evt: 'OnRecordingStateUpdate', cb: CALLBACK['OnRecordingStateUpdate']): this;
on(evt: 'OnRecordingProgressUpdate', cb: CALLBACK['OnRecordingProgressUpdate']): this;
on(evt: 'OnLoginResult', cb: CALLBACK['OnLoginResult']): this;
on(evt: 'OnLogout', cb: CALLBACK['OnLogout']): this;
on(evt: 'OnServerParamsSetResult', cb: CALLBACK['OnServerParamsSetResult']): this;
on(evt: 'OnGetPeerOnlineStatus', cb: CALLBACK['OnGetPeerOnlineStatus']): this;
on(evt: 'OnUserMessageReceivedOutsideRoom', cb: CALLBACK['OnUserMessageReceivedOutsideRoom']): this;
on(evt: 'OnUserBinaryMessageReceivedOutsideRoom', cb: CALLBACK['OnUserBinaryMessageReceivedOutsideRoom']): this;
on(evt: 'OnUserMessageSendResultOutsideRoom', cb: CALLBACK['OnUserMessageSendResultOutsideRoom']): this;
on(evt: 'OnServerMessageSendResult', cb: CALLBACK['OnServerMessageSendResult']): this;
on(evt: 'OnRecordAudioFrame', cb: CALLBACK['OnRecordAudioFrame']): this;
on(evt: 'OnPlaybackAudioFrame', cb: CALLBACK['OnPlaybackAudioFrame']): this;
on(evt: 'OnMixedAudioFrame', cb: CALLBACK['OnMixedAudioFrame']): this;
on(evt: 'OnASRSuccess', cb: CALLBACK['OnASRSuccess']): this;
on(evt: 'OnMessage', cb: CALLBACK['OnMessage']): this;
on(evt: 'OnASRError', cb: CALLBACK['OnASRError']): this;
}
export { veRTCEngine };