RTCEngine class
Constructors
RTCEngine ([NativeClassOptions? options
Properties
$resource → NativeResource
no setter inherited
hashCode → int
The hash code for this object.
no setter inherited
ready → Future <void >
Whether the instance is initialized
no setter inherited
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
Methods
clearVideoWatermark ()
→ FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author zhushufan.ref
@brief 移除指定视频流的水印。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
createGameRoom (String roomId , GameRoomConfig config → FutureOr <IGameRoom
@detail api
@author luomingkang
@brief 创建游戏语音房间实例。 [a-zA-Z0-9_\@\\-\\.]{1,128}。
@param config 游戏语音房间配置。参看 GameRoomConfig{@link #GameRoomConfig}。
@return 创建的 IGameRoom{@link #IGameRoom} 房间实例。
返回 NULL 时，请确认指定房间是否已经存在或 roomId 格式错误。
@note
- 如果需要加入的房间已存在，你仍需先调用本方法来获取 IGameRoom实例，再调用 joinRoom{@link #IGameRoom#joinRoom} 加入房间。
- 请勿使用同样的 roomId 创建多个房间，否则后创建的房间实例会替换先创建的房间实例。
- 如果你需要在多个房间发布音视频流，无须创建多房间，直接调用 startForwardStreamToRooms{@link #RTCRoom#startForwardStreamToRooms} 开始跨房间转发媒体流。
createRTCRoom (String roomId → FutureOr <RTCRoom
@detail api
@author shenpengliang
@brief 创建 RTC 房间实例。 [a-zA-Z0-9_\@\\-\\.]{1,128}。
@return 创建的 RTCRoom{@link #RTCRoom} 房间实例。
返回 NULL 时，请确认指定房间是否已经存在或 roomId 格式错误。
@note
- 如果需要加入的房间已存在，你仍需先调用本方法来获取 RTCRoom 实例，再调用 joinRoom{@link #RTCRoom#joinRoom} 加入房间。
- 请勿使用同样的 roomId 创建多个房间，否则后创建的房间实例会替换先创建的房间实例。
- 如果你需要在多个房间发布音视频流，无须创建多房间，直接调用 startForwardStreamToRooms{@link #RTCRoom#startForwardStreamToRooms} 开始跨房间转发媒体流。
createRTSRoom (String roomId → FutureOr <RTSRoom
@detail api
@brief 创建 RTSRoom{@link #RTSRoom} 实例。[a-zA-Z0-9_\@\\-\\.]{1,128}。
@return 创建的 RTSRoom{@link #RTSRoom} 房间实例。
@note 请勿使用同样的 roomId 创建多个房间，否则后创建的房间实例会替换先创建的房间实例。
destroy ()
→ void
inherited
disableAlphaChannelVideoEncode ()
→ FutureOr <int
@valid since 3.58
@detail api
@hiddensdk(audiosdk)
@author zhuhongshuyu
@brief 关闭外部采集视频帧的 Alpha 通道编码功能。
@return 方法调用结果：
disableAudioFrameCallback (AudioFrameCallbackMethod method → FutureOr <int
@detail api
@author gongzhengduo
@brief 关闭音频回调
@param method 音频回调方法，参看 AudioFrameCallbackMethod{@link #AudioFrameCallbackMethod}。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note 该方法需要在调用 enableAudioFrameCallback{@link #RTCEngine#enableAudioFrameCallback} 之后调用。
disableAudioProcessor (AudioProcessorMethod method → FutureOr <int
@detail api
@author gongzhengduo
@brief 关闭自定义音频处理。
@param method 音频帧类型，参看 AudioProcessorMethod{@link #AudioProcessorMethod}。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
enableAlphaChannelVideoEncode (AlphaLayout alphaLayout → FutureOr <int
@valid since 3.58
@detail api
@hiddensdk(audiosdk)
@author zhuhongshuyu
@brief 开启自定义采集视频帧的 Alpha 通道编码功能。
enableAudioAEDReport (int interval → FutureOr <int
@hidden 3.60 for internal use only
@detail api
@region 音频管理
@author shiyayun
@brief 启用音频信息提示。开启提示后，你可以收到 onAudioAEDStateUpdate{@link #IRTCEngineEventHandler#onAudioAEDStateUpdate。
@param interval 回调间隔，单位毫秒。<= 0: 关闭回调。
+ [100, 3000]: 开启回调，并将信息提示间隔设置为此值。推荐设置为 2000。
+ 不合法的 interval 值：小于 100 设置为 100，超出 3000 设置为 3000。
@return
+ 0: 调用成功。
+ < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
enableAudioDecoding (boolean enable → FutureOr <void >
@hidden for internal use only
@region 自定义音频采集渲染
@brief 是否使用sdk音频解码功能。
@param enable 是否使用sdk音频解码功能。
true: 打开音频解码功能（默认）
false: 关闭音频解码功能直接转推。
@note
- 在registerRemoteEncodedAudioFrameObserver之前调用。
enableAudioEncoding (boolean enable → FutureOr <void >
@hidden for internal use only
@region 自定义音频采集渲染
@brief 是否使用sdk音频编码功能。
@param enable 是否使用sdk音频编码功能。
true: 打开音频编码（默认）
false: 关闭音频编码直接转推。
@note
- 在pushExternalEncodedAudioFrame{@link #RTCEngine#pushExternalEncodedAudioFrame}之前调用。
enableAudioFrameCallback (AudioFrameCallbackMethod method , AudioFormat format → FutureOr <int
@detail api
@author gongzhengduo
@brief 设置并开启指定的音频数据帧回调
@param method 音频回调方法，参看 AudioFrameCallbackMethod{@link #AudioFrameCallbackMethod}。 AUDIO_FRAME_CALLBACK_RECORD(0)、AUDIO_FRAME_CALLBACK_PLAYBACK(1)、AUDIO_FRAME_CALLBACK_MIXED(2)、 AUDIO_FRAME_CALLBACK_CAPTURE_MIXED(5) 时，你需要在参数 format 中指定准确的采样率和声道，暂不支持设置为自动。 AUDIO_FRAME_CALLBACK_REMOTE_USER(3)时，将 format 中的各个字段设置为默认值。
@param format 音频参数格式，参看 AudioFormat{@link #AudioFormat}。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note 开启音频回调并调用 registerAudioFrameObserver{@link #RTCEngine#registerAudioFrameObserver} 后，IAudioFrameObserver{@link #IAudioFrameObserver} 会收到对应的音频回调。两者调用顺序没有限制且相互独立。
enableAudioProcessor (AudioProcessorMethod method , AudioFormat format → FutureOr <int
@detail api
@author gongzhengduo
@brief 设置并开启指定的音频帧回调，进行自定义处理。
@param method 音频帧类型，参看 AudioProcessorMethod{@link #AudioProcessorMethod}。可多次调用此接口，处理不同类型的音频帧。
enableAudioPropertiesReport (AudioPropertiesConfig config → FutureOr <int
@detail api
@author wangjunzheng
@brief 启用音频信息提示。开启提示后，你可以收到 onLocalAudioPropertiesReport{@link #IRTCEngineEventHandler#onLocalAudioPropertiesReport}，onRemoteAudioPropertiesReport{@link #IRTCEngineEventHandler#onRemoteAudioPropertiesReport} 和 onActiveSpeaker{@link #IRTCEngineEventHandler#onActiveSpeaker}。
@param config 详见 AudioPropertiesConfig{@link #AudioPropertiesConfig}
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
enableAudioVADReport (int interval → FutureOr <int
@hidden 3.60 for internal use only
@detail api
@region 音频管理
@author gengjunjie
@brief 启用人声检测。开启提示后，你可以收到 onAudioVADStateUpdate{@link #IRTCEngineEventHandler#onAudioVADStateUpdate}。
@param interval 回调间隔，单位毫秒.
+ <= 0: 关闭人声识别能力回调。
+ [100, 3000]: 开启人声识别能力回调，并将信息提示间隔设置为此值。
+ 不合法的 interval 值：小于 100 设置为 100，超出 3000 设置为 3000。
@return
+ 0: 调用成功。
+ < 0: 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
enableCameraAutoExposureFaceMode (boolean enable → FutureOr <int
@valid since 353
@detail api
@author yinkaisheng
@brief 启用或禁用内部采集时人脸自动曝光模式。此模式会改善强逆光下，脸部过暗的问题；但也会导致 ROI 以外区域过亮/过暗的问题。
@param enable 是否启用。iOS默认开启，Android默认关闭。
@return
- 0: 成功。
- < 0: 失败。
@note 你必须在调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 开启内部采集前，调用此接口方可生效。
enableEffectBeauty (boolean enable → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangjunlin.3182
@brief 开启/关闭基础美颜。
@param enable 基础美颜开关 错误码表 。
@note
- 本方法不能与高级视频特效接口共用。如已购买高级视频特效，建议参看集成指南 使用高级美颜、特效、贴纸功能等。
- 使用此功能需要集成特效 SDK，建议使用特效 SDK v4.4.2+ 版本。更多信息参看 Native 端基础美颜 。
- 调用 setBeautyIntensity{@link #RTCEngine#setBeautyIntensity} 设置基础美颜强度。若在调用本方法前没有设置美颜强度，则使用默认强度。各基础美颜模式的强度默认值分别为：美白 0.7，磨皮 0.8，锐化 0.5，清晰 0.7。
- 本方法仅适用于视频源，不适用于屏幕源。
enableExternalSoundCard (boolean enable → FutureOr <int
@detail api
@author zhangyuanyuan.0101
@brief 启用匹配外置声卡的音频处理模式
@param enable
enableLocalVoiceReverb (boolean enable → FutureOr <int
@detail api
@author wangjunzheng
@brief 开启本地音效混响效果
@param enable 是否开启
@return
- 0： 成功。
- < 0： 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note 调用 setLocalVoiceReverbParam{@link #RTCEngine#setLocalVoiceReverbParam} 设置混响效果。
enablePlaybackDucking (boolean enable → FutureOr <int
@detail api
@author majun.lvhiei
@brief 打开/关闭音量闪避功能，适用于在 RTC 通话过程中会同时播放短视频或音乐的场景，如“一起看”等。
enableVocalInstrumentBalance (boolean enable → FutureOr <int
@detail api
@author majun.lvhiei
@brief 开启/关闭音量均衡功能。
feedback (List <ProblemFeedbackOption types , ProblemFeedbackInfo info → FutureOr <int
@detail api
@author wangzhanqiang
@brief 将用户反馈的问题上报到 RTC。
@param types 预设问题列表，参看 ProblemFeedbackOption{@link #ProblemFeedbackOption}
@param info 预设问题以外的其他问题的具体描述、房间信息，参看 ProblemFeedbackInfo{@link #ProblemFeedbackInfo}
@return
- 0: 成功。
- -3: 失败。
@note
- 你可以在 RTC 控制台 上查看用户通过此接口提交的反馈详情和整体趋势。
- 如果用户上报时在房间内，那么问题会定位到用户当前所在的一个或多个房间；如果用户上报时不在房间内，那么问题会定位到引擎此前退出的房间。
getAudioDeviceManager ()
→ FutureOr <IRTCAudioDeviceManager
@detail api
@author dixing
@brief 获取音频设备管理接口
@return 音频设备管理接口 IRTCAudioDeviceManager{@link #IRTCAudioDeviceManager}
getAudioEffectPlayer ()
→ FutureOr <IAudioEffectPlayer
@valid since 3.53
@detail api
@author zhangyuanyuan.0101
@brief 创建音效播放器实例。
@return 音效播放器。详见 IAudioEffectPlayer{@link #IAudioEffectPlayer}。
getAudioRoute ()
→ FutureOr <AudioRoute
@detail api
@author dixing
@brief 获取当前使用的音频播放路由。
@return 详见 AudioRoute{@link #AudioRoute}
@note 要设置音频路由，详见 setAudioRoute{@link #RTCEngine#setAudioRoute}。
getCameraZoomMaxRatio ()
→ FutureOr <float
@detail api
@author zhangzhenyu.samuel
@brief 获取当前使用的摄像头（前置/后置）的最大变焦倍数
@return 最大变焦倍数
@note 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集时，才能检测摄像头最大变焦倍数。
getMediaPlayer (int playerId → FutureOr <IMediaPlayer
@valid since 3.53
@detail api
@author zhangyuanyuan.0101
@brief 创建音乐播放器实例。
@param playerId 音乐播放器实例 id。取值范围为 [0, 3]。最多同时存在 4 个实例，超出取值范围时返回 nullptr。
@return 音乐播放器实例，详见 IMediaPlayer{@link #IMediaPlayer}
getNativeHandle ()
→ FutureOr <long
@valid since 353
@detail api
@author likai.666
@valid since 353
@brief 获取 C++ 层 IRTCEngine 句柄 。
@return
- >0：方法调用成功, 返回 C++ 层 IRTCEngine 的地址。
- -1：方法调用失败
@note 在一些场景下，获取 C++ 层 IRTCEngine，并通过其完成操作，相较于通过 Java 封装层完成有显著更高的执行效率。典型的场景有：视频/音频帧自定义处理，音视频通话加密等。
getNetworkTimeInfo ()
→ FutureOr <NetworkTimeInfo
@detail api
@author songxiaomeng.19
@brief 通过 NTP 协议，获取网络时间。
@return 网络时间。参看 NetworkTimeInfo{@link #NetworkTimeInfo}。
@note
- 第一次调用此接口会启动网络时间同步功能，并返回 0。同步完成后，会收到 onNetworkTimeSynchronized{@link #IRTCEngineEventHandler#onNetworkTimeSynchronized}，此后，再次调用此 API，即可获取准确的网络时间。
- 在合唱场景下，合唱参与者应在相同的网络时间播放背景音乐。
getPeerOnlineStatus (String peerUserID → FutureOr <int
@detail api
@author hanchenchen.c
@brief 查询对端用户或本端用户的登录状态
@param peerUserID 需要查询的用户 ID
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 必须调用 login{@link #RTCEngine#login} 登录后，才能调用本接口。
- 调用本接口后，SDK 会使用 onGetPeerOnlineStatus{@link #IRTCEngineEventHandler#onGetPeerOnlineStatus} 回调通知查询结果。
- 在发送房间外消息之前，用户可以通过本接口了解对端用户是否登录，从而决定是否发送消息。也可以通过本接口查询自己查看自己的登录状态。
getVideoDeviceManager ()
→ FutureOr <IVideoDeviceManager
@valid since 3.56
@detail api
@author likai.666
@brief 创建视频设备管理实例
@return 视频设备管理实例，详见 IVideoDeviceManager{@link #IVideoDeviceManager}
getVideoEffectInterface ()
→ FutureOr <IVideoEffect
@detail api
@author zhushufan.ref
@brief 获取视频特效接口。
@return 视频特效接口，参看 IVideoEffect{@link #IVideoEffect}。
getWTNStream ()
→ FutureOr <IWTNStream
@detail api
@author lihuan.wuti2ha
@brief 获取 WTN 管理接口。
@return WTN 管理接口，参看 IWTNStream{@link #IWTNStream}。
isCameraExposurePositionSupported ()
→ FutureOr <boolean
@detail api
@author zhangzhenyu.samuel
@brief 检查当前使用的摄像头是否支持手动设置曝光点。
@return
- true: 支持。
- false: 不支持。
@note 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集时，才能检查曝光点设置能力。
isCameraFocusPositionSupported ()
→ FutureOr <boolean
@detail api
@author zhangzhenyu.samuel
@brief 检查当前使用的摄像头是否支持手动对焦。
@return
- true: 支持。
- false: 不支持。
@note 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集，才能检查摄像头是否支持手动对焦。
isCameraTorchSupported ()
→ FutureOr <boolean
@detail api
@author zhangzhenyu.samuel
@brief 检测当前使用的摄像头（前置/后置），是否支持闪光灯。
@return
- true: 支持
- false: 不支持
@note 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集时，才能检测闪光能力。
isCameraZoomSupported ()
→ FutureOr <boolean
@detail api
@author zhangzhenyu.samuel
@brief 检测当前使用的摄像头（前置/后置），是否支持变焦（数码/光学变焦）。
@return
- true: 支持
- false: 不支持
@note 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集时，才能检测摄像头变焦能力。
login (String token , String uid → FutureOr <int
@detail api
@author hanchenchen.c
@brief 登陆 RTS 服务器。 控制台 生成临时 Token，roomId 填任意值。 roomId 置空，Token 有效期及生成方式参看使用 Token 完成鉴权 。
@param uid
logout ()
→ FutureOr <int
@detail api
@author hanchenchen.c
@brief 登出 RTS 服务器。
muteAudioCapture (boolean mute → FutureOr <int
@valid since 3.58.1
@detail api
@author shiyayun
@brief 设置是否将采集到的音频信号静音，而不影响改变本端硬件采集状态。
@param mute 是否静音音频采集。
muteScreenAudioCapture (boolean mute → FutureOr <int
@valid since 3.60.
@detail api
@author shiyayun
@brief 静音/取消静音屏幕共享时采集的音频。
nativeCall <T > (String method , [List ?args , NativeMethodMeta? meta → Future <T >
Call instance method
inherited
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pullExternalAudioFrame (AudioFrame audioFrame → FutureOr <int
@detail api
@author gongzhengduo
@brief 拉取下行音频数据用于自定义音频渲染。
pushClientMixedStreamExternalVideoFrame (String uid , VideoFrameData frame → FutureOr <int
pushExternalAudioFrame (AudioFrame audioFrame → FutureOr <int
@detail api
@author gongzhengduo
@brief 推送自定义采集的音频数据到 RTC SDK。
@param audioFrame 音频数据帧，详见 AudioFrame{@link #AudioFrame}
pushExternalEncodedVideoFrame (int videoIndex , RTCEncodedVideoFrame encodedVideoFrame → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangzhanqiang
@brief 推送自定义编码后的视频流
@param videoIndex 对应的编码流下标，从 0 开始，如果调用 setVideoEncoderConfig{@link #RTCEngine#setVideoEncoderConfig} 设置了多路流，此处数量须与之保持一致
@param encodedVideoFrame 编码流视频帧信息，参看 RTCEncodedVideoFrame{@link #RTCEncodedVideoFrame}。
@return 方法调用结果：
pushExternalVideoFrame (VideoFrameData frame → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author liuyangyang
@brief 推送外部视频帧。
@param frame 视频帧的数据信息
@return 方法调用结果： eglContext与 frame 中的 eglContext 为 sharedContext 或者相同，否则会无法编码。
- 支持的格式：Raw： I420, NV12, RGBA；纹理： Texture2D, TextureOES。
pushReferenceAudioPCMData (AudioFrame audioFrame → FutureOr <int
@detail api
@region 自定义音频回声消除参考信号
@author cuiyao
@brief 向 SDK 发送由自定义处理后的 PCM 音频数据，作为回声消除的参考信号
@param audioFrame 音频数据帧，详见 AudioFrame{@link #AudioFrame}
@return 方法调用结果
pushScreenAudioFrame (AudioFrame audioFrame → FutureOr <int
@detail api
@author liyi.000
@brief 使用自定义采集方式，采集屏幕共享时的屏幕音频时，将音频帧推送至 RTC SDK 处进行编码等处理。
@param audioFrame 音频数据帧，参见 AudioFrame{@link #AudioFrame}
registerAudioFrameObserver (IAudioFrameObserver observer → FutureOr <int
@detail api
@author gongzhengduo
@brief 注册音频数据回调观察者。
@param observer 音频数据观察者，参看 IAudioFrameObserver{@link #IAudioFrameObserver}。如果传入 null，则取消注册。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note 注册音频数据回调观察者并调用 enableAudioFrameCallback{@link #RTCEngine#enableAudioFrameCallback} 后，IAudioFrameObserver{@link #IAudioFrameObserver} 会收到对应的音频回调。对回调中收到的音频数据进行处理，不会影响 RTC 的编码发送或渲染。
registerAudioProcessor (IAudioFrameProcessor processor → FutureOr <int
@detail api
@author gongzhengduo
@brief 注册自定义音频处理器。
registerLocalEncodedVideoFrameObserver (ILocalEncodedVideoFrameObserver observer → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author liuyangyang
@brief 注册本地视频帧监测器。
registerLocalVideoProcessor (IVideoProcessor processor , VideoPreprocessorConfig config → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author zhushufan.ref
@brief 设置自定义视频前处理器。 config 中的 required_pixel_format 仅支持：I420、TEXTURE_2D 和 Unknown： Unknown 时，RTC SDK 给出供 processor 处理的视频帧格式即采集的格式。
你可以通过 pixelFormat{@link #IVideoFrame#pixelFormat} 获取实际采集的视频帧格式，支持的格式为：kVideoPixelFormatI420、 kVideoPixelFormatTexture2D 和 kVideoPixelFormatTextureOES I420 或 TEXTURE_2D 时，RTC SDK 会将采集得到的视频转变为对应的格式，供前处理使用。
- 设置为其他值时，此方法调用失败。
@return
- 0： 成功。
- < 0： 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note 经前处理后，返回给 RTC SDK 的视频帧格式仅支持 I420 和 TEXTURE_2D。
registerRemoteEncodedVideoFrameObserver (IRemoteEncodedVideoFrameObserver observer → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangzhanqiang
@brief 注册远端编码后视频数据回调。 自定义视频编解码 。
- 该方法适用于手动订阅，并且进房前后均可调用，建议在进房前调用。
- 引擎销毁前需取消注册，调用该方法将参数设置为 "null" 即可。
requestRemoteVideoKeyFrame (String streamId → FutureOr <int
@detail api
@brief 在订阅远端视频流之后，向远端请求关键帧
@param streamId 远端流 ID。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 该方法仅适用于手动订阅模式，并且在成功订阅远端流之后使用。
- 该方法适用于调用 setVideoDecoderConfig{@link #RTCEngine#setVideoDecoderConfig} 开启自定义解码功能后，并且自定义解码失败的情况下使用
sendInstanceGet <T > (String property → Future <T >
Get instance property
inherited
sendInstancePropertiesGet (dynamic nativeClass → Future <Map <String dynamic >
Get instance properties
inherited
sendInstanceSet (String property , dynamic value → Future <void >
Set instance property
inherited
sendPublicStreamSEIMessage (int channelId , ArrayBuffer message , int repeatCount , SEICountPerFrame mode → FutureOr <int
@hidden for internal use only
@valid since 3.56
@detail api
@hiddensdk(audiosdk)
@author wangzhanqiang
@brief WTN 流视频帧发送 SEI 数据。
@param channelId SEI 消息的传输通道，取值范围 0 - 255。通过此参数，你可以为不同接受方设置不同的 ChannelID，这样不同接收方可以根据回调中的 ChannelID 选择应关注的 SEI 信息。
@param message SEI 消息。
@param repeatCount 消息发送重复次数。取值范围是 0, max{29, \%{video帧率}-1}。推荐范围 2,4。 repeat_count+1 个视频帧中。
@param mode SEI 发送模式，参看 SEICountPerFrame{@link #SEICountPerFrame}。
@return
- < 0：说明调用失败
- = 0：说明当前发送队列已满，无法发送
- > 0: 说明调用成功，该数值为已经发送 SEI 的数量
@note
- 每秒发送的 SEI 消息数量建议不超过当前的视频帧率
- 视频通话场景中，使用自定义采集并通过 pushExternalVideoFrame{@link #RTCEngine#pushExternalVideoFrame} 推送至 SDK 的视频帧，若本身未携带 SEI 数据，也可通过本接口发送 SEI 数据；若原视频帧中已添加了 SEI 数据，则调用此方法不生效。
- 视频帧仅携带前后 2s 内收到的 SEI 数据
- 消息发送成功后，远端会收到 onWTNSEIMessageReceived{@link #IWTNStreamEventHandler#onWTNSEIMessageReceived} 回调。
- 调用失败时，本地及远端都不会收到回调。
sendSEIMessage (ArrayBuffer message , int repeatCount , SEICountPerFrame mode → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangzhanqiang
@brief 通过视频帧发送 SEI 数据。 0, max{29, \%{视频帧率}-1}。推荐范围 2,4。 \%{repeatCount}+1 个视频帧中。
@param mode SEI 发送模式，参看 SEICountPerFrame{@link #SEICountPerFrame}。
@return
- >= 0: 将被添加到视频帧中的 SEI 的数量。
- < 0: 发送失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note
- 每秒发送的 SEI 消息数量建议不超过当前的视频帧率。在语音通话场景下，黑帧帧率为 15 fps。
- 语音通话场景中，仅支持在内部采集模式下调用该接口发送 SEI 数据。
- 视频通话场景中，使用自定义采集并通过 pushExternalVideoFrame{@link #RTCEngine#pushExternalVideoFrame} 推送至 SDK 的视频帧，若本身未携带 SEI 数据，也可通过本接口发送 SEI 数据；若原视频帧中已添加了 SEI 数据，则调用此方法不生效。
- 视频帧仅携带前后 2s 内收到的 SEI 数据；语音通话场景下，若调用此接口后 1min 内未有 SEI 数据发送，则 SDK 会自动取消发布视频黑帧。
- 消息发送成功后，远端会收到 onSEIMessageReceived{@link #IRTCEngineEventHandler#onSEIMessageReceived} 回调。
- 语音通话切换至视频通话时，会停止使用黑帧发送 SEI 数据，自动转为用采集到的正常视频帧发送 SEI 数据。
sendServerBinaryMessage (ArrayBuffer buffer → FutureOr <long
@detail api
@author hanchenchen.c
@brief 客户端给应用服务器发送二进制消息（P2Server）
@param buffer
sendServerMessage (String message → FutureOr <long
@detail api
@author hanchenchen.c
@brief 客户端给应用服务器发送文本消息（P2Server）
@param message
sendStreamSyncInfo (ArrayBuffer data , StreamSyncInfoConfig config → FutureOr <int
@detail api
@author wangjunzheng
@brief 发送音频流同步信息。将消息通过音频流发送到远端，并实现与音频流同步，该接口调用成功后，远端用户会收到 onStreamSyncInfoReceived{@link #IRTCEngineEventHandler#onStreamSyncInfoReceived} 回调。
@param data 消息内容。
@param config 音频流同步信息的相关配置。详见 StreamSyncInfoConfig{@link #StreamSyncInfoConfig} 。
@return
- >=0: 消息发送成功。返回成功发送的次数。
- -1: 消息发送失败。消息长度大于 255 字节。
- -2: 消息发送失败。传入的消息内容为空。
- -3: 消息发送失败。通过屏幕流进行消息同步时，此屏幕流还未发布。
- -4: 消息发送失败。通过用麦克风或自定义设备采集到的音频流进行消息同步时，此音频流还未发布，详见错误码 ErrorCode{@link #ErrorCode}。
@note
sendUserBinaryMessageOutsideRoom (String uid , ArrayBuffer message , MessageConfig config → FutureOr <long
@detail api
@author hanchenchen.c
@brief 给房间外指定的用户发送二进制消息（P2P）
@param uid
sendUserMessageOutsideRoom (String uid , String message , MessageConfig config → FutureOr <long
@detail api
@author hanchenchen.c
@brief 给房间外指定的用户发送文本消息（P2P）
@param uid
setAnsMode (AnsMode ansMode → FutureOr <int
@valid since 3.52
@detail api
@author liuchuang
@brief 支持根据业务场景，设置通话中的音频降噪模式。
@param ansMode 降噪模式。具体参见 AnsMode{@link #AnsMode}。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 该接口进房前后均可调用，可重复调用，仅最后一次调用生效。
- 降噪算法包含传统降噪和 AI 降噪。传统降噪主要是抑制平稳噪声，比如空调声、风扇声等。而 AI 降噪主要是抑制非平稳噪声，比如键盘敲击声、桌椅碰撞声等。
- 只有以下 ChannelProfile{@link #ChannelProfile} 场景时，调用本接口可以开启 AI 降噪。其余场景的 AI 降噪不会生效。
- 游戏语音模式： CHANNEL_PROFILE_GAME(2)
- 高音质游戏模式： CHANNEL_PROFILE_GAME_HD(8)
- 云游戏模式： CHANNEL_PROFILE_CLOUD_GAME(3)
- 1 vs 1 音视频通话： CHANNEL_PROFILE_CHAT(5)
- 多端同步播放音视频： CHANNEL_PROFILE_LW_TOGETHER(7)
- 云端会议中的个人设备： CHANNEL_PROFIEL_MEETING
- 课堂互动模式： CHANNEL_PROFILE_MEETING_ROOM(17)
- 云端会议中的会议室终端： CHANNEL_PROFILE_CLASSROOM(18)
setAudioAlignmentProperty (String streamId , AudioAlignmentMode mode → FutureOr <int
@detail api
@hidden internal use only
@author majun.lvhiei
@brief 在听众端，设置订阅的所有远端音频流精准对齐后播放。
@param streamId 流 ID，作为对齐基准的远端音频流。一般选择主唱的音频流。CHANNEL_PROFILE_CHORUS。
- 订阅的所有远端流必须通过 startAudioMixing 开启了背景音乐混音，并将 AudioMixingConfig中的 syncProgressToRecordFrame 设置为 true。
- 如果订阅的某个音频流延迟过大，可能无法实现精准对齐。
- 合唱的参与者不应调用此 API，因为调用此 API 会增加延迟。如果希望从听众变为合唱参与者，应关闭对齐功能。
setAudioProfile (AudioProfileType audioProfile → FutureOr <int
@detail api
@author zhangyuanyuan.0101
@brief 设置音质档位。
setAudioRenderType (AudioRenderType type → FutureOr <int
@detail api
@author gongzhengduo
@brief 切换音频渲染方式
@param type 音频输出类型，详见 AudioRenderType{@link #AudioRenderType}
setAudioRoute (AudioRoute audioRoute → FutureOr <int
@detail api
@author dixing
@brief 强制切换当前的音频播放路由。默认使用 setDefaultAudioRoute{@link #RTCEngine#setDefaultAudioRoute} 中设置的音频路由。 移动端设置音频路由 。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 对于绝大多数音频场景，推荐使用 setDefaultAudioRoute{@link #RTCEngine#setDefaultAudioRoute} 设置默认音频路由，并借助 RTC SDK 的音频路由自动切换逻辑即可完成。切换逻辑参见移动端设置音频路由 。你应仅在例外的场景下，使用此接口，比如在接入外接音频设备时，手动切换音频路由。
- 本接口仅支持在通话模式下使用。
- 不同音频场景中，音频路由和发布订阅状态到音量类型的映射关系详见 AudioScenarioType{@link #AudioScenarioType} 。
setAudioScenario (AudioScenarioType audioScenario → FutureOr <int
@hidden(macOS,Windows,Linux)
@valid since 3.60.
@detail api
@author gongzhengduo
@brief 设置音频场景类型。
setAudioSourceType (AudioSourceType type → FutureOr <int
@detail api
@author gongzhengduo
@brief 切换音频采集方式
@param type 音频数据源，详见 AudioSourceType{@link #AudioSourceType}。
setBeautyIntensity (EffectBeautyMode beautyMode , float intensity → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangjunlin.3182
@brief 调整基础美颜强度
@param beautyMode 基础美颜模式，参看 EffectBeautyMode{@link #EffectBeautyMode}。
@param intensity 美颜强度，取值范围为 0,1。强度为 0 表示关闭。 intensity 范围超限。
- –1001: RTC SDK 版本不支持此功能。
- <0: 调用失败，特效 SDK 内部错误，具体错误码请参考错误码表 。
@note
- 若在调用 enableEffectBeauty{@link #RTCEngine#enableEffectBeauty} 前设置美颜强度，则对应美颜功能的强度初始值会根据设置更新。
- 销毁引擎后，美颜功能强度恢复默认值。
setBusinessId (String businessId → FutureOr <int
@detail api
@author wangzhanqiang
@brief 设置业务标识参数
setCameraAdaptiveMinimumFrameRate (int framerate → FutureOr <int
@hidden(macOS)
@valid since 353
@detail api
@author yinkaisheng
@brief 设置内部采集适用动态帧率时，帧率的最小值。
@param framerate 最小值。单位为 fps。默认值是 7。
setCameraExposureCompensation (float val → FutureOr <int
@detail api
@author zhangzhenyu.samuel
@brief 设置当前使用的摄像头的曝光补偿。
@param val 曝光补偿值，取值范围 -1, 1，0 为系统默认值(没有曝光补偿)。
@return
- 0: 成功。
- < 0: 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note
- 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集时，才能设置曝光补偿。
- 调用 stopVideoCapture{@link #RTCEngine#stopVideoCapture} 关闭内部采集后，设置的曝光补偿失效。
setCameraExposurePosition (float x , float y → FutureOr <int
@detail api
@author zhangzhenyu.samuel
@brief 设置当前使用的摄像头的曝光点
@param x 曝光点水平方向归一化坐标。以本地预览画布的左上为原点，取值范围为 0, 1，0 表示最左边，1 表示最右边。
@param y 曝光点垂直方向归一化坐标。以本地预览画布的左上为原点，取值范围为 0, 1，0 表示最上边，1 表示最下边。
@return
- 0: 成功。
- < 0: 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note
- 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集，并且使用 SDK 内部渲染时，才能设置曝光点。
- 移动设备时，自动取消曝光点设置。
- 调用 stopVideoCapture{@link #RTCEngine#stopVideoCapture} 关闭内部采集后，设置的曝光点失效。
setCameraFocusPosition (float x , float y → FutureOr <int
@detail api
@author zhangzhenyu.samuel
@brief 设置当前使用的摄像头的对焦点。
@param x 对焦点水平方向归一化坐标。以本地预览画布的左上为原点，取值范围为 0, 1，0 表示最左边，1 表示最右边。
@param y 对焦点垂直方向归一化坐标。以本地预览画布的左上为原点，取值范围为 0, 1，0 表示最上边，1 表示最下边。
@return
- 0: 成功。
- < 0: 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note
- 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集，并且使用 SDK 内部渲染时，才能设置对焦点。
- 移动设备时，自动取消对焦点设置。
- 调用 stopVideoCapture{@link #RTCEngine#stopVideoCapture} 关闭内部采集后，设置的对焦点失效。
setCameraTorch (TorchState torchState → FutureOr <int
@detail api
@author zhangzhenyu.samuel
@brief 打开/关闭当前使用的摄像头（前置/后置）的闪光灯
@param torchState 闪光灯状态。参考 TorchState{@link #TorchState}
@return
- 0： 成功。
- < 0： 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note
- 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集时，才能设置闪光灯。
- 设置结果在调用 stopVideoCapture{@link #RTCEngine#stopVideoCapture} 关闭内部采集后失效。
setCameraZoomRatio (float zoom → FutureOr <int
@detail api
@author zhangzhenyu.samuel
@brief 设置当前使用的摄像头（前置/后置）的光学变焦倍数
@param zoom 变焦倍数。取值范围是 1, <最大变焦倍数>。
setCaptureVolume (int volume → FutureOr <int
@detail api
@author huangshouqin
@brief 调节音频采集音量
@param volume 采集的音量值和原始音量的百分比，范围是 0, 400，单位为 %，自带溢出保护。 0,100。
setCellularEnhancement (MediaTypeEnhancementConfig config → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangfeng.1004
@brief 启用蜂窝网络辅助增强，改善通话质量。
@param config 参看 MediaTypeEnhancementConfig{@link #MediaTypeEnhancementConfig}。
@return 方法调用结果：
setClientMixedStreamObserver (IClientMixedStreamObserver observer → FutureOr <int
setDefaultAudioRoute (AudioRoute route → FutureOr <int
@detail api
@author dixing
@brief 将默认的音频播放设备设置为听筒或扬声器。
@param route 音频播放设备。参看 AudioRoute{@link #AudioRoute}。仅支持听筒或扬声器。
@return
- 0: 方法调用成功。
- < 0: 方法调用失败。
@note 对于音频路由切换逻辑，参见移动端设置音频路由 。
setDummyCaptureImagePath (String filePath → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author liuyangyang
@brief 摄像头处于关闭状态时，使用静态图片填充本地推送的视频流。 stopVideoCapture 接口时，会开始推静态图片。若要停止发送图片，可传入空字符串或启用内部摄像头采集。
setEarMonitorMode (EarMonitorMode mode , EarMonitorAudioFilter filter → FutureOr <int
@detail api
@valid since 3.60.
@brief 开启/关闭耳返功能，并控制是否对耳返音频应用本地音频处理。
@param mode 是否开启耳返功能，参看 EarMonitorMode{@link #EarMonitorMode}。默认关闭。
@param filter 是否对耳返音频应用本地音频处理，参看 EarMonitorAudioFilter{@link #EarMonitorAudioFilter}。默认不经过音频处理。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note
- 耳返功能仅适用于由 RTC SDK 内部采集的音频。
- 使用耳返功能必须佩戴耳机。为保证低延时耳返最佳体验，建议佩戴有线耳机。蓝牙耳机不支持硬件耳返。
- RTC SDK 支持硬件耳返和软件耳返。一般来说，硬件耳返延时低且音质好。如果 App 在手机厂商的硬件耳返白名单内，且运行环境存在支持硬件耳返的 SDK，RTC SDK 默认启用硬件耳返。使用华为手机硬件耳返功能时，请添加华为硬件耳返的依赖配置 。
setEarMonitorVolume (int volume → FutureOr <int
@detail api
@author majun.lvhiei
@brief 设置耳返音量。
@param volume 耳返音量，调节范围：0,100，单位：%
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 设置耳返音量前，你必须先调用 setEarMonitorMode{@link #RTCEngine#setEarMonitorMode} 打开耳返功能。
setEncryptInfo (int aesType , String key → FutureOr <int
@detail api
@author wangjunlin.3182
@brief 设置传输时使用内置加密的方式。
@param aesType 加密类型。可选参数为 0、1、2、3、4。代表的含义如下：
setExternalVideoEncoderEventHandler (IExternalVideoEncoderEventHandler handler → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangzhanqiang
@brief 注册自定义编码帧推送事件回调
@param handler 自定义编码帧回调类，参看 IExternalVideoEncoderEventHandler{@link #IExternalVideoEncoderEventHandler}
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 该方法需在进房前调用。
- 引擎销毁前需取消注册，调用该方法将参数设置为 "null" 即可。
setLocalProxy (List <LocalProxyConfiguration configurations → FutureOr <int
@detail api
@author keshixing.rtc
@brief 设置本地代理。
@param configurations 本地代理配置参数。参看 LocalProxyConfiguration{@link #LocalProxyConfiguration}。
setLocalSimulcastMode (VideoSimulcastMode mode , Array <VideoEncoderConfig streamConfig → FutureOr <int
@valid since 3.60.
@detail api
@author zhoubohui
@brief 发布端进行大小流(simulcast)设置。
@param mode 详见 VideoSimulcastMode{@link #VideoSimulcastMode}。默认为只发送单流。你应在进房前调用修改本参数。
@param streamConfig 小流参数。最多可设置 3 路。分辨率按照从小到大顺序，且每路流参数分辨率需小于大流 setVideoEncoderConfig{@link #RTCEngine#setVideoEncoderConfig} 设置参数。否则可能会设置失败。参看 VideoEncoderConfig{@link #VideoEncoderConfig}。
其余模式下，默认小流参数为 160px × 90px, 码率为 50kpbs。
@return 方法调用结果： 推送多路流 文档。
setLocalVideoCanvas (VideoCanvas videoCanvas → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author sunhang.io
@brief 设置本地视频渲染时使用的视图，并设置渲染模式。
@param videoCanvas 视图信息和渲染模式, 参看 VideoCanvas{@link #VideoCanvas}
@return
- 0: 成功
- -2: 参数错误。
- -12: 本方法不支持在 Audio SDK 中使用。
@note
- 你应在加入房间前，绑定本地视图。退出房间后，此设置仍然有效。
- 如果需要解除绑定，你可以调用本方法传入空视图。
setLocalVideoMirrorType (MirrorType mirrorType → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangjunlin.3182
@brief 为采集到的视频流开启镜像
@param mirrorType 镜像类型，参看 MirrorType{@link #MirrorType}
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 切换视频源不影响镜像设置。
- 屏幕视频流始终不受镜像设置影响。
- 使用外部渲染器时，mirrorType 支持设置为 0（无镜像）和 3（本地预览和编码传输镜像），不支持设置为 1（本地预览镜像）。
- 该接口调用前，各视频源的初始状态如下：
setLocalVideoSink (IVideoSink videoSink , int requiredFormat → FutureOr <int
@deprecated since 3.60, use setLocalVideoSink(IVideoSink videoSink, LocalVideoSinkConfig config) instead.
@detail api
@hiddensdk(audiosdk)
@author sunhang.io
@brief 将本地视频流与自定义渲染器绑定。
@param videoSink 自定义视频渲染器，参看 IVideoSink{@link #IVideoSink}
@param requiredFormat videoSink 适用的视频帧编码格式，参看 PixelFormat{@link #PixelFormat}
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- RTC SDK 默认使用自带的渲染器（内部渲染器）进行视频渲染。
- 退房时将清除绑定状态。
- 如果需要解除绑定，你必须将 videoSink 设置为 null。
- 一般在收到 onFirstLocalVideoFrameCaptured{@link #IRTCEngineEventHandler#onFirstLocalVideoFrameCaptured} 回调通知完成本地视频首帧采集后，调用此方法为视频流绑定自定义渲染器；然后加入房间。
- 本方法获取的是前处理后的视频帧。
setLocalVoiceEqualization (VoiceEqualizationConfig voiceEqualizationConfig → FutureOr <int
@detail api
@author wangjunzheng
@brief 设置本地采集语音的均衡效果。包含内部采集和外部采集，但不包含混音音频文件。
@param voiceEqualizationConfig 语音均衡效果，参看 VoiceEqualizationConfig{@link #VoiceEqualizationConfig}
@return
- 0： 成功。
- < 0： 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note 根据奈奎斯特采样率，音频采样率必须大于等于设置的中心频率的两倍，否则，设置不生效。
setLocalVoicePitch (int pitch → FutureOr <int
@detail api
@author wangjunzheng
@brief 开启本地语音变调功能，多用于 K 歌场景。 -12，12，默认值为 0，即不做调整。 WARNING_CODE_SET_SCREEN_STREAM_INVALID_VOICE_PITCH 设置语音音调不合法
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
setLocalVoiceReverbParam (VoiceReverbConfig config → FutureOr <int
@detail api
@author wangjunzheng
@brief 设置本地采集音频的混响效果。包含内部采集和外部采集，但不包含混音音频文件。
@param config 混响效果，参看 VoiceReverbConfig{@link #VoiceReverbConfig}
@return
- 0： 成功。
- < 0： 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note 调用 enableLocalVoiceReverb{@link #RTCEngine#enableLocalVoiceReverb} 开启混响效果。
setPlaybackVolume (int volume → FutureOr <int
@detail api
@author huangshouqin
@brief 调节本地播放的所有远端用户音频混音后的音量，混音内容包括远端人声、音乐、音效等。 0, 400，单位为 %，自带溢出保护。 0,100。
setPublishFallbackOption (PublishFallbackOption option → FutureOr <int
@detail api
@author panjian.fishing
@brief 设置发布的音视频流的回退选项。
setRemoteAudioPlaybackVolume (String streamId , int volume → FutureOr <int
@detail api
@author huanghao
@brief 调节本端播放收到的远端流时的音量。你必须在进房后进行设置。流的发布状态改变不影响设置生效。
@param streamId 流 ID，用于指定要调节音量的远端流。
@param volume 音量值和原始音量的比值，范围是 0, 400，单位为 %，自带溢出保护。 0,100。
@return 方法调用结果：
setRemoteUserPriority (String roomid , String uid , RemoteUserPriority priority → FutureOr <int
@detail api
@author panjian.fishing
@brief 设置用户优先级。
@param roomid 房间 ID
@param uid
setRemoteVideoCanvas (String streamId , VideoCanvas videoCanvas → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author sunhang.io
@brief 渲染来自指定远端用户的视频流时，设置使用的视图和渲染模式。 videoCanvas 设置为空。
@param streamId 流 ID，用于指定需要设置视图和渲染模式的视频流。
@param videoCanvas 视图信息和渲染模式，参看 VideoCanvas{@link #VideoCanvas}。3.56 版本起支持通过 renderRotation 设置远端视频渲染的旋转角度。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note 本地用户离开房间时，会解除调用此 API 建立的绑定关系；远端用户离开房间则不会影响。
setRemoteVideoMirrorType (String streamId , RemoteMirrorType mirrorType → FutureOr <int
@valid since 3.57
@detail api
@hiddensdk(audiosdk)
@brief 使用内部渲染时，为远端流开启镜像。
@param streamId 流 ID，用于指定需要镜像的视频流。
@param mirrorType 远端流的镜像类型，参看 RemoteMirrorType{@link #RemoteMirrorType}。
@return
- 0: 调用成功。
- < 0: 调用失败，参看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
setRemoteVideoSink (String streamId , IVideoSink videoSink , int requiredFormat → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@deprecated since 3.57, use setRemoteVideoSink{@link #RTCEngine#setRemoteVideoSink} instead.
@region 自定义视频采集渲染
@author sunhang.io
@brief 将远端视频流与自定义渲染器绑定。
@param streamId 流 ID，用于指定需要渲染的视频流。
@param videoSink 自定义视频渲染器，参看 IVideoSink{@link #IVideoSink}
@param requiredFormat videoSink 适用的视频帧编码格式，参看 PixelFormat{@link #PixelFormat}
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- RTC SDK 默认使用 RTC SDK 自带的渲染器（内部渲染器）进行视频渲染。
- 该方法进房前后均可以调用。若想在进房前调用，你需要在加入房间前获取远端流信息；若无法预先获取远端流信息，你可以在加入房间并通过 onUserPublishStreamVideo{@link #IRTCRoomEventHandler#onUserPublishStreamVideo} 回调获取到远端流信息之后，再调用该方法。
- 如果需要解除绑定，你必须将 videoSink 设置为 null。退房时将清除绑定状态。
- 本方法获取的是后处理后的视频帧。
setRemoteVideoSuperResolution (String streamId , VideoSuperResolutionMode mode → FutureOr <int
@hidden for internal use only
@valid since 3.54
@detail api
@hiddensdk(audiosdk)
@author yinkaisheng
@brief 设置远端视频超分模式。
@param streamId 流 ID，用于指定需要设置超分模式的视频流。
@param mode 超分模式，参看 VideoSuperResolutionMode{@link #VideoSuperResolutionMode}。
@return
- 0: RETURN_STATUS_SUCCESS，SDK 调用成功，并不代表超分模式实际状态，需要根据回调 onRemoteVideoSuperResolutionModeChanged{@link #IRTCEngineEventHandler#onRemoteVideoSuperResolutionModeChanged} 判断实际状态。
- -1: RETURN_STATUS_NATIVE_IN_VALID，native library 未加载。
- -2: RETURN_STATUS_PARAMETER_ERR，参数非法，指针为空或字符串为空。
- -9: RETURN_STATUS_SCREEN_NOT_SUPPORT，不支持对屏幕流开启超分。
@note
- 该功能仅 arm 架构支持。
- 该方法须进房后调用。
- 远端用户视频流的原始分辨率不能超过 640 × 360 px。
- 支持对一路远端流开启超分，不支持对多路流开启超分。
setRtcVideoEventHandler (IRTCEngineEventHandler engineEventHandler → FutureOr <int
@detail api
@hidden for internal use only
@author wangzhanqiang
@brief 设置引擎事件回调的接收类，必须继承自 IRTCEngineEventHandler{@link #IRTCEngineEventHandler} 。
@param engineEventHandler
setRuntimeParameters (dynamic params → FutureOr <int
@detail api
@author panjian.fishing
@brief 设置运行时的参数
@param params 保留参数
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note 该接口需在 joinRoom{@link #RTCRoom#joinRoom} 和 startAudioCapture{@link #RTCEngine#startAudioCapture} 之前调用。
setScreenAudioSourceType (AudioSourceType sourceType → FutureOr <int
@detail api
@author liyi.000
@brief 在屏幕共享时，设置屏幕音频的采集方式（内部采集/自定义采集）
@param sourceType 屏幕音频输入源类型, 参看 AudioSourceType{@link #AudioSourceType}。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 默认采集方式是 RTC SDK 内部采集。
- 如果设定为内部采集，你必须再调用 startScreenCapture 开始采集。开启后，可以再次本接口切换为外部采集，此时内部采集将自动停止。
- 如果设定为自定义采集，你必须再调用 pushScreenAudioFrame{@link #RTCEngine#pushScreenAudioFrame} 将自定义采集到的屏幕音频帧推送到 RTC SDK。
@order 5
setScreenCaptureVolume (int volume → FutureOr <int
@detail api
@valid Available since 3.60.
@author wangjunzheng
@brief 调节屏幕共享时采集的音频音量。0, 400，单位为 %，自带溢出保护。0, 100。
setServerParams (String signature , String url → FutureOr <int
@detail api
@author hanchenchen.c
@brief 设置应用服务器参数
setSubscribeFallbackOption (SubscribeFallbackOptions option → FutureOr <int
@detail api
@author panjian.fishing
@brief 设置订阅的音视频流的回退选项。
setVideoCaptureConfig (VideoCaptureConfig videoCaptureConfig → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author liuyangyang
@brief 设置 RTC SDK 内部采集时的视频采集参数。
setVideoCaptureRotation (VideoRotation rotation → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangxiaosen
@brief 设置本端采集的视频帧的旋转角度。 VIDEO_ROTATION_0(0)，无旋转角度。详见 VideoRotation{@link #VideoRotation}。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 对于内部采集的视频画面，如果已调用 setVideoRotationMode{@link #RTCEngine#setVideoRotationMode} 设置了旋转方向，会在此基础上叠加旋转角度。
- 调用本接口也将对自定义采集视频画面生效，在原有的旋转角度基础上叠加本次设置。
- 视频贴纸特效或通过 enableVirtualBackground{@link #IVideoEffect#enableVirtualBackground} 增加的虚拟背景，也会跟随本接口的设置进行旋转。
- 本地渲染视频和发送到远端的视频都会相应旋转，但不会应用到单流转推中。如果希望在单流转推的视频中应用旋转，调用 setVideoOrientation{@link #RTCEngine#setVideoOrientation}。
setVideoDecoderConfig (String streamId , VideoDecoderConfig config → FutureOr <int
@detail api
@brief 在订阅远端视频流之前，设置远端视频数据解码方式
@param streamId 远端流 ID，指定对哪一路视频流进行解码方式设置
@param config 视频解码方式，参看 VideoDecoderConfig{@link #VideoDecoderConfig}。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 当你想要对远端流进行自定义解码时，你需要先调用 registerRemoteEncodedVideoFrameObserver{@link #RTCEngine#registerRemoteEncodedVideoFrameObserver} 注册远端视频流监测器，然后再调用该接口将解码方式设置为自定义解码。监测到的视频数据会通过 onRemoteEncodedVideoFrame{@link #IRemoteEncodedVideoFrameObserver#onRemoteEncodedVideoFrame} 回调出来。
- 自 3.56 起，要用于自动订阅场景下，你可以设置 key 中的 RoomId 和 UserId 为 nullptr，此时，通过此接口设置的解码方式根据 key 中的 StreamIndex 值，适用于所有的远端主流或屏幕流的解码方式。
setVideoDenoiser (VideoDenoiseMode mode → FutureOr <int
@hidden for internal use only
@valid since 3.54
@detail api
@hiddensdk(audiosdk)
@author Yujianli
@brief 设置视频降噪模式。
@param mode 视频降噪模式。参看 VideoDenoiseMode{@link #VideoDenoiseMode}。
@return
- 0: API 调用成功。 用户可以根据回调函数 onVideoDenoiseModeChanged{@link #IRTCEngineEventHandler#onVideoDenoiseModeChanged} 判断视频降噪是否开启。
- < 0: API 调用失败。
@note 该功能仅 arm 架构支持。
setVideoDigitalZoomConfig (ZoomConfigType type , float size → FutureOr <int
@valid since 3.51
@detail api
@hiddensdk(audiosdk)
@author likai.666
@brief 设置本地摄像头数码变焦参数，包括缩放倍数，移动步长。
@param type 数码变焦参数类型，缩放系数或移动步长。参看 ZoomConfigType{@link #ZoomConfigType}。必填。
@param size 缩放系数或移动步长，保留到小数点后三位。默认值为 0。必填。 type 时有不同的取值范围。当计算后的结果超过缩放和移动边界时，取临界值。 ZOOM_FOCUS_OFFSET(0)：缩放系数增量，范围为 0, 7。例如，设置为 0.5 时，如果调用 setVideoDigitalZoomControl{@link #RTCEngine#setVideoDigitalZoomControl} 选择 Zoom in，则缩放系数增加 0.5。缩放系数范围 1，8，默认为 1，原始大小。
- ZOOM_MOVE_OFFSET(1)：移动百分比，范围为 0, 0.5，默认为 0，不移动。如果调用 setVideoDigitalZoomControl{@link #RTCEngine#setVideoDigitalZoomControl} 选择的是左右移动，则移动距离为 size x 原始视频宽度；如果选择的是上下移动，则移动距离为 size x 原始视频高度。例如，视频帧边长为 1080 px，设置为 0.5 时，实际移动距离为 0.5 x 1080 px = 540 px。
@return
- 0： 成功。
- < 0： 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note
- 每次调用本接口只能设置一种参数。如果缩放系数和移动步长都需要设置，分别调用本接口传入相应参数。
- 由于移动步长的默认值为 0 ，在调用 setVideoDigitalZoomControl{@link #RTCEngine#setVideoDigitalZoomControl} 或 startVideoDigitalZoomControl{@link #RTCEngine#startVideoDigitalZoomControl} 进行数码变焦操作前，应先调用本接口。
setVideoDigitalZoomControl (ZoomDirectionType direction → FutureOr <int
@valid since 3.51
@detail api
@hiddensdk(audiosdk)
@author likai.666
@brief 控制本地摄像头数码变焦，缩放或移动一次。设置对本地预览画面和发布到远端的视频都生效。
@param direction 数码变焦操作类型，参看 ZoomDirectionType{@link #ZoomDirectionType}。
@return
- 0： 成功。
- < 0： 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note
- 由于默认步长为 0，调用该方法前需通过 setVideoDigitalZoomConfig{@link #RTCEngine#setVideoDigitalZoomConfig} 设置参数。
- 调用该方法进行移动前，应先使用本方法或 startVideoDigitalZoomControl{@link #RTCEngine#startVideoDigitalZoomControl} 进行放大，否则无法移动。
- 当数码变焦操作超出范围时，将置为临界值。例如，移动到了图片边界、放大到了 8 倍、缩小到原图大小。
- 如果你希望实现持续数码变焦操作，调用 startVideoDigitalZoomControl{@link #RTCEngine#startVideoDigitalZoomControl}。
- 如果你需要对摄像头进行光学变焦控制，参看 setCameraZoomRatio{@link #RTCEngine#setCameraZoomRatio}。
setVideoEncoderConfig (VideoEncoderConfig encoderConfig , dynamic parameters → FutureOr <int
@hidden for internal use only
@detail api
@author wangyu.1705
@brief 发布端设置全景视频，包括分辨率、高清视野和低清背景分辨率、Tile 大小，以及其他常规编码参数。
@param encoderConfig 期望发布的最大分辨率视频流参数。参看 VideoEncoderConfig{@link #VideoEncoderConfig}。 0 等距柱状投影（Equirectangular Projection，ERP）模式
setVideoOrientation (VideoOrientation orientation → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangjunlin.3182
@brief 在自定义视频前处理及编码前，设置 RTC 链路中的视频帧朝向，默认为 Adaptive 模式。 视频帧朝向 。
@param orientation 视频帧朝向，参看 VideoOrientation{@link #VideoOrientation}。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 视频帧朝向设置仅适用于内部采集视频源。对于自定义采集视频源，设置视频帧朝向可能会导致错误，例如宽高对调。屏幕源不支持设置视频帧朝向。
- 编码分辨率的更新与视频帧处理是异步操作，进房后切换视频帧朝向可能导致画面出现短暂的裁切异常，因此建议在进房前设置视频帧朝向，且不在进房后进行切换。
setVideoRotationMode (VideoRotationMode rotationMode → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangjunlin.3182
@brief 设置采集视频的旋转模式。默认以 App 方向为旋转参考系。 视频采集方向 。
setVideoSourceType (VideoSourceType type → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author liuyangyang
@brief 设置向 SDK 输入的视频源，包括屏幕流
setVideoWatermark (String imagePath , RTCWatermarkConfig watermarkConfig → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author zhushufan.ref
@brief 在指定视频流上添加水印。
@param imagePath 水印图片路径，支持本地文件绝对路径、Asset 资源路径（/assets/xx.png）、URI 地址（content://），长度限制为 512 字节。
setVoiceChangerType (VoiceChangerType voiceChanger → FutureOr <int
@valid since 3.32
@detail api
@author wangjunzheng
@brief 设置变声特效类型
@param voiceChanger 变声特效类型，参看 VoiceChangerType{@link #VoiceChangerType}
@return 方法调用结果： 按需集成插件 文档。
- 在进房前后都可设置。
- 对 RTC SDK 内部采集的音频和自定义采集的音频都生效。
- 只对单声道音频生效。
- 与 setVoiceReverbType{@link #RTCEngine#setVoiceReverbType} 互斥，后设置的特效会覆盖先设置的特效。
setVoiceReverbType (VoiceReverbType voiceReverb → FutureOr <int
@valid since 3.32
@detail api
@author wangjunzheng
@brief 设置混响特效类型
@param voiceReverb 混响特效类型，参看 VoiceReverbType{@link #VoiceReverbType}
@return 方法调用结果：
startAudioCapture ()
→ FutureOr <int
@detail api
@author dixing
@brief 开启内部音频采集。默认为关闭状态。 MediaDeviceError.MEDIA_DEVICE_ERROR_NOPERMISSION = 1。
- 调用 stopAudioCapture{@link #RTCEngine#stopAudioCapture} 可以关闭音频采集设备，否则，SDK 只会在销毁引擎的时候自动关闭设备。
- 由于不同硬件设备初始化响应时间不同，频繁调用 stopAudioCapture{@link #RTCEngine#stopAudioCapture} 和本接口闭麦/开麦可能出现短暂无声问题，建议使用 publishStreamAudio{@link #RTCRoom#publishStreamAudio} 实现临时闭麦和重新开麦。
- 创建引擎后，无论是否发布音频数据，你都可以调用该方法开启音频采集，并且调用后方可发布音频。
- 如果需要从自定义音频采集切换为内部音频采集，你必须先停止发布流，调用 setAudioSourceType{@link #RTCEngine#setAudioSourceType} 关闭自定义采集，再调用此方法手动开启内部采集。
startAudioRecording (AudioRecordingConfig config → FutureOr <int
@detail api
@author huangshouqin
@brief 开启录制语音通话，生成本地文件。
startClientMixedStream (String taskId , MixedStreamConfig mixedConfig , → FutureOr <int
startCloudProxy (List <CloudProxyInfo cloudProxiesInfo → FutureOr <int
@detail api
@author daining.nemo
@brief 开启云代理
@param cloudProxiesInfo 云代理服务器信息列表。参看 CloudProxyInfo{@link #CloudProxyInfo}。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 在加入房间前调用此接口
- 在开启云代理后，进行通话前网络探测
- 开启云代理后，并成功链接云代理服务器后，会收到 onCloudProxyConnected{@link #IRTCEngineEventHandler#onCloudProxyConnected}。
- 要关闭云代理，调用 stopCloudProxy{@link #RTCEngine#stopCloudProxy}。
startEchoTest (EchoTestConfig config , int delayTime → FutureOr <int
@detail api
@author qipengxiang
@brief 开启音视频回路测试。 2,10，单位为秒，默认为 2 秒。
@return 方法调用结果： WARNING_CODE_IN_ECHO_TEST_MODE。
- 音视频回路检测的结果会通过 onEchoTestResult{@link #IRTCEngineEventHandler#onEchoTestResult} 回调通知。
startFileRecording (RecordingConfig config , RecordingType recordingType → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangzhanqiang
@brief 该方法将通话过程中的音视频数据录制到本地的文件中。
@param config 本地录制参数配置，参看 RecordingConfig{@link #RecordingConfig}
@param recordingType 本地录制的媒体类型，参看 RecordingType{@link #RecordingType}
startHardwareEchoDetection (String testAudioFilePath → FutureOr <int
@detail api
@author zhangcaining
@brief 开启通话前回声检测
@param testAudioFilePath 用于回声检测的音频文件的绝对路径，路径字符串使用 UTF-8 编码格式，支持以下音频格式: mp3，aac，m4a，3gp，wav。 CHANNEL_PROFIEL_MEETING 和 CHANNEL_PROFILE_MEETING_ROOM 时支持开启本功能。
- 开启检测前，你需要向用户获取音频设备的使用权限。
- 开启检测前，请确保音频设备没有被静音，采集和播放音量正常。
- 调用本接口后监听 onHardwareEchoDetectionResult 获取检测结果。
- 检测期间，进程将独占音频设备，无法使用其他音频设备测试接口： startEchoTest{@link #RTCEngine#startEchoTest}、startAudioDeviceRecordTest{@link #IRTCAudioDeviceManager#startAudioDeviceRecordTest} 或 startAudioPlaybackDeviceTest{@link #IRTCAudioDeviceManager#startAudioPlaybackDeviceTest}。
- 调用 stopHardwareEchoDetection{@link #RTCEngine#stopHardwareEchoDetection} 停止检测，释放对音频设备的占用。
startNetworkDetection (boolean isTestUplink , int expectedUplinkBitrate , boolean isTestDownlink , int expectedDownlinkBitrate → FutureOr <int
@detail api
@author hanchenchen.c
@brief 开启通话前网络探测
@param isTestUplink 是否探测上行带宽
@param expectedUplinkBitrate 期望上行带宽，单位：kbps{0, [100-10000]}，其中， 0 表示由 SDK 指定最高码率。
@param isTestDownlink 是否探测下行带宽
@param expectedDownlinkBitrate 期望下行带宽，单位：kbps{0, [100-10000]}，其中， 0 表示由 SDK 指定最高码率。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 成功调用本接口后，会在 3s 内收到一次 onNetworkDetectionResult{@link #IRTCEngineEventHandler#onNetworkDetectionResult} 回调，此后每 2s 收到一次该回调，通知探测结果；
- 若探测停止，则会收到一次 onNetworkDetectionStopped{@link #IRTCEngineEventHandler#onNetworkDetectionStopped} 通知探测停止。
startPushMixedStream (String taskId , MixedStreamPushTargetConfig pushTargetConfig , MixedStreamConfig mixedConfig → FutureOr <int
@valid since 3.60. 自 3.60 起，该接口替代了 startPushMixedStreamToCDN 和 startPushPublicStream 方法用于实现下述功能。如果你已升级至 3.60 及以上版本，并且仍在使用这两个方法，请迁移到此接口。
@detail api
@hiddensdk(audiosdk)
@author lizheng
@brief 指定房间中的媒体流，合成后一路流发布到 CDN 或发布一路 WTN 流。
@param taskId 转推直播任务 ID，长度不超过 127 字节。 当 MixedStreamConfig{@link #MixedStreamConfig} 中的 PushTargetType = 0 时， 用于标识转推直播任务。你可以在同一房间内发起多个转推直播任务，并用不同的 ID 加以区分。当你需要发起多个转推直播任务时，应使用多个 ID；当你仅需发起一个转推直播任务时，建议使用空字符串。 PushTargetType = 1 时，为公共流，此参数设置无效，传空即可。
@param pushTargetConfig 推流目标配置参数，比如设置推流地址、WTN 流 ID。参看 MixedStreamPushTargetConfig{@link #MixedStreamPushTargetConfig}。
@param mixedConfig 合流转推配置参数，比如设置合流的图片、视频视图布局和音频属性。参看 MixedStreamConfig{@link #MixedStreamConfig}。
@return
- 0: 成功。你可以通过 onMixedStreamEvent{@link #IRTCEngineEventHandler#onMixedStreamEvent} 回调获取启动结果和推流过程中的事件。
- !0: 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 在控制台 配置了转推直播和 WTN 流的服务端回调后，调用本接口会收到相应回调。重复调用该接口时，第二次调用会同时触发 TranscodeStarted 和 TranscodeUpdated 。
- 调用 stopPushMixedStream{@link #RTCEngine#stopPushMixedStream} 停止转推直播。
- 调用 updatePushMixedStream{@link #RTCEngine#updatePushMixedStream} 可以更新部分任务参数。
startPushSingleStream (String taskId , PushSingleStreamParam param → FutureOr <int
@valid since 3.60.
@detail api
@hiddensdk(audiosdk)
@author lizheng
@brief 将房间内某一路音视频流，推送到指定的 RTC 房间或 CDN 地址。此过程不涉及编解码。
@param taskId 任务 ID。 控制台 开启转推直播功能。
- 调用该方法后，关于启动结果和推流过程中的错误，会收到 onSingleStreamEvent{@link #IRTCEngineEventHandler#onSingleStreamEvent} 回调。
- 在控制台 配置了转推直播服务端回调后，调用本接口会收到相应回调。重复调用该接口时，第二次调用会同时触发 TranscodeStarted 和 TranscodeUpdated 。
- 调用 stopPushSingleStream{@link #RTCEngine#stopPushSingleStream} 停止任务。
- 由于本功能不进行编解码，所以推到 RTMP 的视频流会根据推流端的分辨率、编码方式、关闭摄像头等变化而变化。
startScreenCapture (ScreenMediaType type , dynamic mediaProjectionResultData → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangqianqian.1104
@brief 使用 RTC SDK 内部采集模块开始采集屏幕音频流和（或）视频流。
@param type 媒体类型，参看 ScreenMediaType{@link #ScreenMediaType}。
@param mediaProjectionResultData 向 Android 设备申请屏幕共享权限后，拿到的 Intent 数据，参看 getMediaProjection 。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 调用本接口时，采集模式应为内部模式。在外部采集模式下调用无效，并将触发 onVideoDeviceWarning{@link #IRTCEngineEventHandler#onVideoDeviceWarning} 或 onAudioDeviceWarning{@link #IRTCEngineEventHandler#onAudioDeviceWarning} 回调。
- 采集后，你还需要调用 publishStreamAudio{@link #RTCRoom#publishStreamAudio} 和 publishStreamVideo{@link #RTCRoom#publishStreamVideo} 发布采集到的屏幕音视频。
- 开启屏幕音频/视频采集成功后，本地用户会收到 onVideoDeviceStateChanged{@link #IRTCEngineEventHandler#onVideoDeviceStateChanged} 和 onAudioDeviceStateChanged{@link #IRTCEngineEventHandler#onAudioDeviceStateChanged} 的回调。
- 要关闭屏幕音视频内部采集，调用 stopScreenCapture{@link #RTCEngine#stopScreenCapture}。
startVideoCapture ()
→ FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author zhangzhenyu.samuel
@brief 立即开启内部视频采集。默认为关闭状态。
startVideoDigitalZoomControl (ZoomDirectionType direction → FutureOr <int
@valid since 3.51
@detail api
@hiddensdk(audiosdk)
@author likai.666
@brief 开启本地摄像头持续数码变焦，缩放或移动。设置对本地预览画面和发布到远端的视频都生效。
@param direction 数码变焦操作类型，参看 ZoomDirectionType{@link #ZoomDirectionType}。
@return
- 0： 成功。
- < 0： 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note
- 由于默认步长为 0，调用该方法前需通过 setVideoDigitalZoomConfig{@link #RTCEngine#setVideoDigitalZoomConfig} 设置参数。
- 调用该方法进行移动前，应先使用本方法或 setVideoDigitalZoomControl{@link #RTCEngine#setVideoDigitalZoomControl} 进行放大，否则无法移动。
- 当数码变焦操作超出范围时，将置为临界值并停止操作。例如，移动到了图片边界、放大到了 8 倍、缩小到原图大小。
- 你也可以调用 stopVideoDigitalZoomControl{@link #RTCEngine#stopVideoDigitalZoomControl} 手动停止控制。
- 如果你希望实现单次数码变焦操作，调用 setVideoDigitalZoomControl{@link #RTCEngine#setVideoDigitalZoomControl}。
- 如果你需要对摄像头进行光学变焦控制，参看 setCameraZoomRatio{@link #RTCEngine#setCameraZoomRatio}。
stopAudioCapture ()
→ FutureOr <int
@detail api
@author dixing
@brief 立即关闭内部音频采集。默认为关闭状态。
stopAudioRecording ()
→ FutureOr <int
@detail api
@author huangshouqin
@brief 停止音频文件录制
@return
- 0: 正常
- -3: 当前版本 SDK 不支持该特性，请联系技术支持人员
@note 调用 startAudioRecording{@link #RTCEngine#startAudioRecording} 开启本地录制后，你必须调用该方法停止录制。
stopChorusCacheSync ()
→ FutureOr <int
@hidden internal use only
@detail api
@hiddensdk(audiosdk)
@author liujingchao
@brief 关闭缓存同步功能。
@return 查看 ReturnStatus{@link #ReturnStatus}。
stopClientMixedStream (String taskId → FutureOr <int
@hidden for internal use only
@hiddensdk(audiosdk)
stopCloudProxy ()
→ FutureOr <int
@detail api
@author daining.nemo
@brief 关闭云代理
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note 要开启云代理，调用 startCloudProxy{@link #RTCEngine#startCloudProxy}。
stopEchoTest ()
→ FutureOr <int
@detail api
@author qipengxiang
@brief 停止音视频回路测试。
stopFileRecording ()
→ FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangzhanqiang
@brief 停止本地录制
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 调用 startFileRecording{@link #RTCEngine#startFileRecording} 开启本地录制后，你必须调用该方法停止录制。
- 调用该方法后，你会收到 onRecordingStateUpdate{@link #IRTCEngineEventHandler#onRecordingStateUpdate} 回调提示录制结果。
stopHardwareEchoDetection ()
→ FutureOr <int
@detail api
@author zhangcaining
@brief 停止通话前回声检测
@return 方法调用结果：
stopNetworkDetection ()
→ FutureOr <int
@detail api
@author hanchenchen.c
@brief 停止通话前网络探测
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 调用本接口后，会收到一次 onNetworkDetectionStopped{@link #IRTCEngineEventHandler#onNetworkDetectionStopped} 回调通知探测停止。
stopPushMixedStream (String taskId , MixedStreamPushTargetType targetType → FutureOr <int
@valid since 3.60. 自 3.60 起，该接口替代了 stopPushStreamToCDN 方法来停止合流转推任务。如果你已升级至 3.60 及以上版本，并且仍在使用该方法，请迁移到此接口。
@detail api
@hiddensdk(audiosdk)
@brief 停止由 startPushMixedStream{@link #RTCEngine#startPushMixedStream} 启动的任务。
@param taskId 转推直播任务 ID。指定想要更新参数设置的转推直播任务。
@param targetType 参看 MixedStreamPushTargetType{@link #MixedStreamPushTargetType}。
@return
- 0: 成功
- !0: 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
stopPushSingleStream (String taskId → FutureOr <int
@valid since 3.60. 自 3.60 起，该接口替代了 stopPushStreamToCDN 方法来停止单流转推直播任务。如果你已升级至 3.60 及以上版本，并且仍在使用该方法，请迁移到此接口。
@detail api
@hiddensdk(audiosdk)
@author liujingchao
@brief 停止通过 startPushSingleStream{@link #RTCEngine#startPushSingleStream} 发起的单流转推任务。
@param taskId 任务 ID。可以指定想要停止的单流转推直播任务。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
stopScreenCapture ()
→ FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangqianqian.1104
@brief 在屏幕共享时，停止使用 RTC SDK 内部采集方式采集屏幕音视频。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 调用本接口时，采集模式应为内部模式。在外部采集模式下调用无效，并将触发 onVideoDeviceWarning{@link #IRTCEngineEventHandler#onVideoDeviceWarning} 或 onAudioDeviceWarning{@link #IRTCEngineEventHandler#onAudioDeviceWarning} 回调。
- 要开始屏幕音视频内部采集，调用 startScreenCapture{@link #RTCEngine#startScreenCapture}。
stopVideoCapture ()
→ FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author zhangzhenyu.samuel
@brief 立即关闭内部视频采集。默认为关闭状态。
stopVideoDigitalZoomControl ()
→ FutureOr <int
@valid since 3.51
@detail api
@hiddensdk(audiosdk)
@author likai.666
@brief 停止本地摄像头持续数码变焦。
@return
- 0： 成功。
- < 0： 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note 关于开始数码变焦，参看 startVideoDigitalZoomControl{@link #RTCEngine#startVideoDigitalZoomControl}。
switchCamera (CameraId cameraId → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author zhangzhenyu.samuel
@brief 切换视频内部采集时使用的前置/后置摄像头
takeLocalSnapshot (ISnapshotResultCallback callback → FutureOr <long
@detail api
@hiddensdk(audiosdk)
@author wangfujun.911
@brief 截取本地视频画面
@param callback 本地截图的回调。参看 ISnapshotResultCallback{@link #ISnapshotResultCallback}。
@return 本地截图任务的编号，从 1 开始递增。
@note
- 对截取的画面，包含本地视频处理的全部效果，包含旋转，镜像，美颜等。
- 不管采用 SDK 内部采集，还是自定义采集，都可以进行截图。
takeLocalSnapshotToFile (String filePath → FutureOr <long
@detail api
@author wangfujun.911
@brief 截取本地的视频流画面，生成 JPG 文件，并保存到本地指定路径。 .jpg，并请确保路径存在且可写。示例：/sdcard/Pictures/snapshot.jpg。
@return 远端截图任务的编号，从 1 开始递增。此编号可用于追踪任务状态或进行其他管理操作。
takeRemoteSnapshot (String streamId , ISnapshotResultCallback callback → FutureOr <long
@detail api
@hiddensdk(audiosdk)
@author wangfujun.911
@brief 截取本地视频画面
@param streamId 远端用户的 streamId。
@param callback 本地截图的回调。参看 ISnapshotResultCallback{@link #ISnapshotResultCallback}。
@return 本地截图任务的编号，从 1 开始递增。
@note
- 对截取的画面，包含本地视频处理的全部效果，包含旋转，镜像，美颜等。
- 不管采用 SDK 内部采集，还是自定义采集，都可以进行截图。
takeRemoteSnapshotToFile (String streamId , String filePath → FutureOr <long
@detail api
@author wangfujun.911
@brief 截取远端的视频流画面，生成 JPG 文件，并保存到本地指定路径。 .jpg，并请确保路径存在且可写。示例：/sdcard/Pictures/snapshot.jpg。
@return 远端截图任务的编号，从 1 开始递增。此编号可用于追踪任务状态或进行其他管理操作。
toString ()
→ String
A string representation of this object.
inherited
updateClientMixedStream (String taskId , MixedStreamConfig mixedConfig , → FutureOr <int
@hidden for internal use only
@hiddensdk(audiosdk)
updateLocalVideoCanvas (int renderMode , int backgroundColor → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangfujun.911
@brief 修改本地视频渲染模式和背景色。
@param renderMode 渲染模式。参看 VideoCanvas{@link #VideoCanvas}.renderMode
@param backgroundColor 背景颜色。参看 VideoCanvas{@link #VideoCanvas}.backgroundColor
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
@note 你可以在本地视频渲染过程中，调用此接口。调用结果会实时生效。
updateLoginToken (String token → FutureOr <int
@detail api
@author hanchenchen.c
@brief 更新用户用于登录的 Token LOGIN_ERROR_CODE_INVALID_TOKEN。此时需要重新获取 Token，并调用此方法更新 Token。
@param token
updatePushMixedStream (String taskId , MixedStreamPushTargetConfig pushTargetConfig , MixedStreamConfig mixedConfig → FutureOr <int
@valid since 3.60. 自 3.60 起，该接口替代了 updatePushMixedStreamToCDN 和 updatePublicStreamParam 方法用于实现下述功能。如果你已升级至 3.60 及以上版本，并且仍在使用这两个方法，请迁移到此接口。
@detail api
@hiddensdk(audiosdk)
@author lizheng
@brief 更新由 startPushMixedStream{@link #RTCEngine#startPushMixedStream} 启动的任务参数，会收到 onMixedStreamEvent{@link #IRTCEngineEventHandler#onMixedStreamEvent} 回调。
@param taskId 转推直播任务 ID。指定想要更新参数设置的转推直播任务。仅当 MixedStreamConfig{@link #MixedStreamConfig} 中的 PushTargetType = 0 时有效。
@param pushTargetConfig 推流目标配置参数，比如设置推流地址、WTN 流 ID。参看 MixedStreamPushTargetConfig{@link #MixedStreamPushTargetConfig}。
@param mixedConfig 转推直播配置参数，参看 MixedStreamConfig{@link #MixedStreamConfig}。除特殊说明外，均支持过程中更新。
updateRemoteStreamVideoCanvas (String streamId , int renderMode , int backgroundColor → FutureOr <int
@deprecated since 3.56 and will be deleted in 3.62. Use updateRemoteStreamVideoCanvas instead.
@detail api
@hiddensdk(audiosdk)
@author wangfujun.911
@brief 修改远端视频帧的渲染设置，包括渲染模式和背景颜色。
@param streamId 流 ID，用于指定需要修改渲染设置的视频流。
@param renderMode 渲染模式，参看 VideoCanvas{@link #VideoCanvas}.renderMode
@param backgroundColor 背景颜色，参看 VideoCanvas{@link #VideoCanvas}.backgroundColor
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note 你可以在远端视频渲染过程中，调用此接口。调用结果会实时生效。
updateResource (NativeResource resource → void
inherited
updateScreenCapture (ScreenMediaType type → FutureOr <int
@detail api
@hiddensdk(audiosdk)
@author wangqianqian.1104
@brief 使用 RTC SDK 内部屏幕采集后，更新采集的媒体类型。
@param type 媒体类型，指定屏幕采集媒体类型，参看 ScreenMediaType{@link #ScreenMediaType}。
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note 在 startScreenCapture{@link #RTCEngine#startScreenCapture} 后调用该方法。
Static Methods
createRTCEngine (EngineConfig config , IRTCEngineEventHandler handler → FutureOr <RTCEngine
@detail api
@author wangzhanqiang
@brief 创建引擎对象
destroyRTCEngine ()
→ FutureOr <void >
@detail api
@author wangzhanqiang
@brief 销毁由 createRTCEngine{@link #RTCEngine#createRTCEngine} 所创建的引擎实例，并释放所有相关资源。
@note
- 请确保和需要销毁的 RTCEngine{@link #RTCEngine} 实例相关的业务场景全部结束后，才调用此方法
- 该方法在调用之后，会销毁所有和此 RTCEngine{@link #RTCEngine} 实例相关的内存，并且停止与媒体服务器的任何交互
- 调用本方法会启动 SDK 退出逻辑。引擎线程会保留，直到退出逻辑完成。因此，不要在回调线程中直接调用此 API，会导致死锁。同时此方法是耗时操作，不建议在主线程调用本方法，避免主线程阻塞。
getSDKVersion ()
→ FutureOr <String
@detail api
@author wangzhanqiang
@brief 获取 SDK 当前的版本号。
@return SDK 当前的版本号。
setLogConfig (RTCLogConfig logConfig → FutureOr <int
@detail api
@author caofanglu
@brief 配置 SDK 本地日志参数，包括日志级别、存储路径、日志文件最大占用的总空间、日志文件名前缀。
@param logConfig 本地日志参数，参看 RTCLogConfig{@link #RTCLogConfig}。
@return
- 0：成功。
- –1：失败，本方法必须在创建引擎前调用。
- –2：失败，参数填写错误。
@note 本方法必须在调用 createRTCEngine{@link #RTCEngine#createRTCEngine} 之前调用。
