RTCEngine class
@detail api @brief RTCEngine Class
Constructors
-
RTCEngine({id<
ByteRTCEngineDelegate> ? delegate, id<ByteRTCMonitorDelegate> ? monitorDelegate})
Properties
- $instance → dynamic
-
no setterinherited
-
delegate
↔ FutureOr<
id< ByteRTCEngineDelegate> ?> -
@platform ios
@detail callback
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
-
monitorDelegate
↔ FutureOr<
id< ByteRTCMonitorDelegate> ?> -
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
$createInstance(
List args) → dynamic -
Factory method for creating instances
override
-
$destroy(
) → void -
inherited
-
$init(
List args) → void -
inherited
-
android_setRtcVideoEventHandler(
IRTCEngineEventHandler engineEventHandler) → Future< int?> -
@platform android
@detail api
@hidden for internal use only
@author wangzhanqiang
@brief 设置引擎事件回调的接收类，必须继承自 IRTCEngineEventHandler{@link #IRTCEngineEventHandler} 。
@param engineEventHandler
事件处理器接口类，详见 IRTCEngineEventHandler{@link #IRTCEngineEventHandler} 。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 调用方需要自行实现一个继承自 IRTCEngineEventHandler{@link #IRTCEngineEventHandler} 的类，并重载其中需要关注的事件。 - 该回调为异步回调 - 所有的事件回调均会在独立的回调线程内触发，请接收回调事件时注意所有与线程运行环境有关的操作，如需要在 UI 线程内执行的操作等， 请勿直接在回调函数的实现中直接进行操作。 -
clearVideoWatermark(
) → Future< int?> - @detail api @hiddensdk(audiosdk) @author zhushufan.ref @brief 移除指定视频流的水印。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
-
createGameRoom(
string roomId, GameRoomConfig config) → Future< IGameRoom?> -
@detail api
@author luomingkang
@brief 创建游戏语音房间实例。
调用此方法仅返回一个房间实例，你仍需调用 joinRoom{@link #IGameRoom#joinRoom} 才能真正地创建/加入房间。
多次调用此方法以创建多个 IGameRoom{@link #IGameRoom} 实例。分别调用各 RTCRoom 实例中的 joinRoom{@link #IGameRoom#joinRoom} 方法，同时加入多个房间。
多房间模式下，用户可以同时订阅各房间的音视频流。 @param roomId 标识通话房间的房间 ID。该字符串符合正则表达式：[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) → Future< RTCRoom?> -
@detail api
@author shenpengliang
@brief 创建 RTC 房间实例。
调用此方法仅返回一个房间实例，你仍需调用 joinRoom{@link #RTCRoom#joinRoom} 才能真正地创建/加入房间。
多次调用此方法以创建多个 RTCRoom{@link #RTCRoom} 实例。分别调用各 RTCRoom 实例中的 joinRoom{@link #RTCRoom#joinRoom} 方法，同时加入多个房间。
多房间模式下，用户可以同时订阅各房间的音视频流。 @param roomId 标识通话房间的房间 ID。该字符串符合正则表达式：[a-zA-Z0-9_\@\\-\\.]{1,128}。 @return 创建的 RTCRoom{@link #RTCRoom} 房间实例。 返回 NULL 时，请确认指定房间是否已经存在或 roomId 格式错误。 @note - 如果需要加入的房间已存在，你仍需先调用本方法来获取 RTCRoom 实例，再调用 joinRoom{@link #RTCRoom#joinRoom} 加入房间。 - 请勿使用同样的 roomId 创建多个房间，否则后创建的房间实例会替换先创建的房间实例。 - 如果你需要在多个房间发布音视频流，无须创建多房间，直接调用 startForwardStreamToRooms{@link #RTCRoom#startForwardStreamToRooms} 开始跨房间转发媒体流。 -
disableAlphaChannelVideoEncode(
) → Future< int?> -
@valid since 3.58
@detail api
@hiddensdk(audiosdk)
@author zhuhongshuyu
@brief 关闭外部采集视频帧的 Alpha 通道编码功能。
@return 方法调用结果：
- 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。 @note 该接口须在停止发布视频流之后调用。 -
disableAudioFrameCallback(
AudioFrameCallbackMethod method) → Future< int?> - @detail api @author gongzhengduo @brief 关闭音频回调 @param method 音频回调方法，参看 AudioFrameCallbackMethod{@link #AudioFrameCallbackMethod}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note 该方法需要在调用 enableAudioFrameCallback{@link #RTCEngine#enableAudioFrameCallback} 之后调用。
-
enableAlphaChannelVideoEncode(
{required AlphaLayout alphaLayout}) → Future< int?> -
@valid since 3.58
@detail api
@hiddensdk(audiosdk)
@author zhuhongshuyu
@brief 开启自定义采集视频帧的 Alpha 通道编码功能。
适用于需要分离推流端视频主体与背景，且在拉流端可自定义渲染背景的场景。 @param alphaLayout 分离后的 Alpha 通道相对于 RGB 通道信息的排列位置。当前仅支持 AlphaLayout.TOP，即置于 RGB 通道信息上方。 @return 方法调用结果：
- 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。 @note - 该接口仅作用于自定义采集的、并且使用 RGBA 色彩模型的视频帧，包括 VideoPixelFormat.TEXTURE_2D、VideoPixelFormat.TEXTURE_OES、VideoPixelFormat.RGBA。 - 该接口须在发布视频流之前调用。 - 调用本接口开启 Alpha 通道编码后，你需调用 pushExternalVideoFrame{@link #RTCEngine#pushExternalVideoFrame} 把自定义采集的视频帧推送至 RTC SDK。若推送了不支持的视频帧格式，则调用 pushExternalVideoFrame{@link #RTCEngine#pushExternalVideoFrame} 时会返回错误码 ReturnStatus.RETURN_STATUS_PARAMETER_ERR。 -
enableAudioAEDReport(
int interval) → Future< 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(
bool enable) → Future - @hidden for internal use only @region 自定义音频采集渲染 @brief 是否使用sdk音频解码功能。 @param enable 是否使用sdk音频解码功能。 true: 打开音频解码功能（默认） false: 关闭音频解码功能直接转推。 @note - 在registerRemoteEncodedAudioFrameObserver之前调用。
-
enableAudioEncoding(
bool enable) → Future - @hidden for internal use only @region 自定义音频采集渲染 @brief 是否使用sdk音频编码功能。 @param enable 是否使用sdk音频编码功能。 true: 打开音频编码（默认） false: 关闭音频编码直接转推。 @note - 在pushExternalEncodedAudioFrame{@link #RTCEngine#pushExternalEncodedAudioFrame}之前调用。
-
enableAudioFrameCallback(
{required AudioFrameCallbackMethod method, required AudioFormat format}) → Future< 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} 会收到对应的音频回调。两者调用顺序没有限制且相互独立。 -
enableAudioPropertiesReport(
AudioPropertiesConfig config) → Future< 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) → Future< 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(
bool enable) → Future< int?> - @valid since 353 @detail api @author yinkaisheng @brief 启用或禁用内部采集时人脸自动曝光模式。此模式会改善强逆光下，脸部过暗的问题；但也会导致 ROI 以外区域过亮/过暗的问题。 @param enable 是否启用。iOS默认开启，Android默认关闭。 @return - 0: 成功。 - < 0: 失败。 @note 你必须在调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 开启内部采集前，调用此接口方可生效。
-
enableEffectBeauty(
bool enable) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author wangjunlin.3182
@brief 开启/关闭基础美颜。
@param enable 基础美颜开关
- true: 开启基础美颜 - false: 关闭基础美颜（默认） @return - 0: 调用成功。 - –1001: RTC SDK 版本不支持此功能。 - -12: 本方法不支持在 Audio SDK 中使用。 - <0: 调用失败，特效 SDK 内部错误，具体错误码请参考错误码表。 @note - 本方法不能与高级视频特效接口共用。如已购买高级视频特效，建议参看集成指南使用高级美颜、特效、贴纸功能等。 - 使用此功能需要集成特效 SDK，建议使用特效 SDK v4.4.2+ 版本。更多信息参看 Native 端基础美颜。 - 调用 setBeautyIntensity{@link #RTCEngine#setBeautyIntensity} 设置基础美颜强度。若在调用本方法前没有设置美颜强度，则使用默认强度。各基础美颜模式的强度默认值分别为：美白 0.7，磨皮 0.8，锐化 0.5，清晰 0.7。 - 本方法仅适用于视频源，不适用于屏幕源。 -
enableExternalSoundCard(
bool enable) → Future< int?> -
@detail api
@author zhangyuanyuan.0101
@brief 启用匹配外置声卡的音频处理模式
@param enable
- true: 开启 - false: 不开启(默认) @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 当采用外接声卡进行音频采集时，建议开启此模式，以获得更好的音质。 - 开启此模式时，仅支持耳机播放。如果需要使用扬声器或者外置音箱播放，关闭此模式。 -
enableLocalVoiceReverb(
bool enable) → Future< int?> - @detail api @author wangjunzheng @brief 开启本地音效混响效果 @param enable 是否开启 @return - 0： 成功。 - < 0： 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。 @note 调用 setLocalVoiceReverbParam{@link #RTCEngine#setLocalVoiceReverbParam} 设置混响效果。
-
enablePlaybackDucking(
bool enable) → Future< int?> -
@detail api
@author majun.lvhiei
@brief 打开/关闭音量闪避功能，适用于在 RTC 通话过程中会同时播放短视频或音乐的场景，如“一起看”等。
开启该功能后，当检测到远端人声时，RTC 的本地的媒体播放音量会自动减弱，从而保证远端人声的清晰可辨；当远端人声消失时，RTC 的本地媒体音量会恢复到闪避前的音量水平。 @param enable 是否开启音量闪避：
- true: 是 - false: 否 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 -
enableVocalInstrumentBalance(
bool enable) → Future< int?> -
@detail api
@author majun.lvhiei
@brief 开启/关闭音量均衡功能。
开启音量均衡功能后，人声的响度会调整为 -16lufs。如果已调用 setAudioMixingLoudness 传入了混音音乐的原始响度，此音乐播放时，响度会调整为 -20lufs。 @param enable 是否开启音量均衡功能：
- true: 是 - false: 否 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note 该接口须在调用 start{@link #IAudioEffectPlayer#start} 开始播放音频文件之前调用。 -
findOverrideIndices(
List args, List< List< indicesList) → List<int> >int> -
查找重载参数下标列表
@desc android 构造函数存在重载
此方法通过实际传入参数与构造函数参数列表集合的比对，来获取当前实际的需要使用的参数列表
inherited
-
fn2AndroidClass(
Function callback, dynamic nativeClass(), String methodName) → dynamic -
与 ts runtime 中的 fn2AndroidClass 功能一致
将 Dart 函数转换为 Android 回调类实例供 Android 侧使用
inherited
-
getAudioDeviceManager(
) → Future< AudioDeviceManager?> - @detail api @author dixing @brief 获取音频设备管理接口 @return 音频设备管理接口 IRTCAudioDeviceManager{@link #IRTCAudioDeviceManager}
-
getAudioRoute(
) → Future< AudioRoute?> - @detail api @author dixing @brief 获取当前使用的音频播放路由。 @return 详见 AudioRoute{@link #AudioRoute} @note 要设置音频路由，详见 setAudioRoute{@link #RTCEngine#setAudioRoute}。
-
getCameraZoomMaxRatio(
) → Future< float?> - @detail api @author zhangzhenyu.samuel @brief 获取当前使用的摄像头（前置/后置）的最大变焦倍数 @return 最大变焦倍数 @note 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集时，才能检测摄像头最大变焦倍数。
-
getNetworkTimeInfo(
) → Future< NetworkTimeInfo?> -
@detail api
@author songxiaomeng.19
@brief 通过 NTP 协议，获取网络时间。
@return 网络时间。参看 NetworkTimeInfo{@link #NetworkTimeInfo}。
@note
- 第一次调用此接口会启动网络时间同步功能，并返回
0。同步完成后，会收到 onNetworkTimeSynchronized{@link #IRTCEngineEventHandler#onNetworkTimeSynchronized}，此后，再次调用此 API，即可获取准确的网络时间。 - 在合唱场景下，合唱参与者应在相同的网络时间播放背景音乐。 -
getPeerOnlineStatus(
string peerUserID) → Future< 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(
) → Future< IVideoDeviceManager?> - @valid since 3.56 @detail api @author likai.666 @brief 创建视频设备管理实例 @return 视频设备管理实例，详见 IVideoDeviceManager{@link #IVideoDeviceManager}
-
getVideoEffectInterface(
) → Future< IVideoEffect?> - @detail api @author zhushufan.ref @brief 获取视频特效接口。 @return 视频特效接口，参看 IVideoEffect{@link #IVideoEffect}。
-
getWTNStream(
) → Future< IWTNStream?> - @detail api @author lihuan.wuti2ha @brief 获取 WTN 管理接口。 @return WTN 管理接口，参看 IWTNStream{@link #IWTNStream}。
-
ios_enableAGC(
BOOL enable) → Future< int?> -
@platform ios
@hidden(iOS)
@valid since 3.51
@detail api
@author liuchuang
@brief 打开/关闭 AGC(Analog Automatic Gain Control)模拟自动增益控制功能。
开启该功能后，SDK 会自动调节麦克风的采集音量，确保音量稳定。 @param enable 是否打开 AGC 功能:
- true: 打开 AGC 功能。 - false: 关闭 AGC 功能。 @return - 0: 调用成功。 - -1: 调用失败。 @note 该方法在进房前后均可调用。如果你需要在进房前使用 AGC 功能，请联系技术支持获得私有参数，传入对应 ByteRTCRoomProfile{@link #ByteRTCRoomProfile} 。
要想在进房后开启 AGC 功能，你需要把 ByteRTCRoomProfile{@link #ByteRTCRoomProfile} 设为ByteRTCRoomProfileMeeting、ByteRTCRoomProfileMeetingRoom或ByteRTCRoomProfileClassroom。
AGC 功能生效后，不建议再调用setAudioCaptureDeviceVolume:来调节设备麦克风的采集音量。 -
ios_getScreenCaptureSourceList(
) → Future< ByteRTCScreenCaptureSourceInfo?> -
@platform ios
@hidden(iOS)
@detail api
@author liyi.000
@brief 获取共享对象(应用窗口和桌面)列表。
@return 共享对象(应用窗口和桌面)列表。参看 ByteRTCScreenCaptureSourceInfo{@link #ByteRTCScreenCaptureSourceInfo}。
枚举值可作为调用 startScreenVideoCapture:captureParameters:{@link #ByteRTCEngine#startScreenVideoCapture:captureParameters} 开启屏幕共享时的输入参数。 @note 仅桌面端可用。 -
ios_getThumbnail(
ByteRTCScreenCaptureSourceType sourceType, intptr_t sourceId, int maxWidth, int maxHeight) → Future -
@platform ios
@hidden(iOS)
@detail api
@author liyi.000
@brief 获取屏幕采集对象缩略图
@param sourceType 屏幕采集对象的类型。详见 ByteRTCScreenCaptureSourceType{@link #ByteRTCScreenCaptureSourceType}。
@param sourceId 屏幕分享时，共享对象的 ID。可通过 getScreenCaptureSourceList{@link #ByteRTCEngine#getScreenCaptureSourceList} 返回的
ByteRTCScreenCaptureSourceInfo共享对象列表中获取。 @param maxWidth 最大宽度。保持采集对象本身的宽高比不变，将缩略图缩放到指定范围内的最大宽高。如果给出的尺寸与共享对象比例不同，得到的缩略图会有黑边。 @param maxHeight 最大高度。参见 maxWidth 的说明。 @return 屏幕采集对象缩略图。缩略图由屏幕共享对象等比缩放而来。缩略图的大小小于等于此接口设定的尺寸。 -
ios_getWindowAppIcon(
intptr_t sourceId, int width, int height) → Future -
@platform ios
@hidden(iOS)
@brief 获取应用窗体所属应用的图标。
@region 屏幕共享
@author liyi.000
@param sourceId 屏幕共享对象的 ID，可通过 getScreenCaptureSourceList{@link #ByteRTCEngine#getScreenCaptureSourceList} 返回的
ByteRTCScreenCaptureSourceInfo共享对象列表中获取。 @param width 最大宽度。返回的图标将是宽高相等的，输入的宽高不等时，取二者较小值。宽高范围为32,256，超出该范围将返回nullptr，默认输出 100 x 100 的图像。 @param height 最大高度。参见width的说明。 @return 应用图标。当屏幕共享对象为应用窗体时有效，否则返回nullptr。 -
ios_registerRemoteEncodedAudioFrameObserver(
id< ByteRTCRemoteEncodedAudioFrameObserver> observer) → Future -
@platform ios
@detail api
@hidden for internal use only
@brief 注册远端音频帧监测器。
调用该方法后，SDK 每监测到一帧远端音频帧时，都会将音频帧信息通过 onRemoteEncodedAudioFrame:info:audioFrame: 回调给用户 @param observer 远端音频帧监测器，参看 IRemoteEncodedAudioFrameObserver。 @note - 该方法建议在进房前调用。 - 将参数设置为 nullptr 则取消注册。 - 调用前，必须先调用 enableAudioDecoding{@link #ByteRTCEngine#enableAudioDecoding} 关闭音频解码功能。 -
ios_sendScreenCaptureExtensionMessage(
NSData messsage) → Future< int?> - @platform ios @hidden(macOS) @detail api @hiddensdk(audiosdk) @author wangzhanqiang @brief 向屏幕共享 Extension 发送自定义消息 @param messsage 发送给 Extension 的消息内容 @return - 0: Success. - < 0 : Fail. See ByteRTCReturnStatus{@link #ByteRTCReturnStatus} for more details @note - 在 startScreenCapture:bundleId:{@link #ByteRTCEngine#startScreenCapture:bundleId} 后调用该方法。 - 通过 onReceiveMessageFromApp:{@link #ByteRtcScreenCapturerExtDelegate#onReceiveMessageFromApp} 回调发送的消息。
-
ios_setBluetoothMode(
ByteRTCBluetoothMode mode) → Future< int?> - @platform ios @hidden(macOS) @detail api @author dixing @brief 在纯媒体音频场景下,切换 iOS 设备与耳机之间的蓝牙传输协议。 @param mode 蓝牙传输协议。详见 ByteRTCBluetoothMode{@link #ByteRTCBluetoothMode}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus} 获得更多错误说明 @note 以下场景你会收到 rtcEngine:onAudioDeviceWarning:deviceType:deviceWarning:{@link #ByteRTCEngineDelegate#rtcEngine:onAudioDeviceWarning:deviceType:deviceWarning} 回调：1）当前不支持设置 HFP；2）非纯媒体音频场景，建议在调用此接口前调用 setAudioScenario:{@link #ByteRTCEngine#setAudioScenario} 设置纯媒体音频场景。
-
ios_setCustomizeEncryptHandler(
id< ByteRTCEncryptHandler> handler) → Future<int?> - @platform ios @detail api @author wangjunlin.3182 @brief 设置自定义加密和解密方式。 @param handler 自定义加密 handler，需要实现里面的加密和解密方法。参看 ByteRTCEncryptHandler{@link #ByteRTCEncryptHandler}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus} 获得更多错误说明 @note - 该方法与 setEncryptInfo:key:{@link #ByteRTCEngine#setEncryptInfo:key} 为互斥关系，即按照调用顺序，最后一个调用的方法为最终生效的版本。 - 该方法必须在调用 joinRoom:userInfo:userVisibility:roomConfig:{@link #ByteRTCRoom#joinRoom:userInfo:userVisibility:roomConfig} 之前调用，可重复调用，以最后调用的参数作为生效参数。 - 无论加密或者解密，其对原始数据的长度修改，需要控制在 180% 之间，即如果输入数据为 100 字节，则处理完成后的数据必须不超过 180 字节，如果加密或解密结果超出该长度限制，则该音视频帧可能会被丢弃。 - 数据加密/解密为串行执行，因而视实现方式不同，可能会影响到最终渲染效率，是否使用该方法，需要由使用方谨慎评估。
-
ios_setLowLightAdjusted(
ByteRTCVideoEnhancementMode mode) → Future< int?> -
@platform ios
@hidden(iOS)
@valid since 3.57
@detail api
@author zhoubohui
@brief 设置视频暗光增强模式。
对于光线不足、照明不均匀或背光等场景下推荐开启，可有效改善画面质量。 @param mode 默认不开启。参看 ByteRTCVideoEnhancementMode{@link #ByteRTCVideoEnhancementMode}。 @return - 0: API 调用成功。会立即生效，但需要等待下载和检测完成后才能看到增强后的效果。 - < 0: API 调用失败。查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus} 获得更多错误说明。 @note - 开启后会影响设备性能，应根据实际需求和设备性能决定是否开启。 - 对 RTC SDK 内部采集的视频和自定义采集的视频都生效。 -
ios_setScreenAudioChannel(
ByteRTCAudioChannel channel) → Future< int?> - @platform ios @hidden(iOS) @detail api @author zhangcaining @brief 在屏幕共享时，设置屏幕音频流的声道数 @param channel 声道数，参看 ByteRTCAudioChannel{@link #ByteRTCAudioChannel} @return - 0: 调用成功。 - < 0 : 调用失败。查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus} 获得更多错误说明 @note 当你调用 setScreenAudioStreamIndex: 并设置屏幕音频流和麦克风音频流混流时，此接口不生效，音频通道数由 setAudioProfile:{@link #ByteRTCEngine#setAudioProfile} 控制。
-
ios_startChorusCacheSync(
ByteRTCChorusCacheSyncConfig config, id< ByteRTCChorusCacheSyncObserver> observer) → Future<int?> - @platform ios @hidden internal use only @detail api @hiddensdk(audiosdk) @author liujingchao @brief 开启缓存同步功能。开启后，会缓存收到的实时音视频数据，并对齐不同数据中的时间戳完成同步。此功能会影响音视频数据消费的实时性。 @param config 参看 ByteRTCChorusCacheSyncConfig{@link #ByteRTCChorusCacheSyncConfig}。 @param observer 事件和数据观察者，参看 ByteRTCChorusCacheSyncObserver{@link #ByteRTCChorusCacheSyncObserver}。 @return 查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus}。 @note 要关闭缓存同步功能，调用 stopChorusCacheSync{@link #ByteRTCEngine#stopChorusCacheSync}。
-
ios_startScreenAudioCapture(
string deviceId) → Future< int?> -
@platform ios
@hidden(iOS)
@detail api
@author yezijian.me
@brief 在屏幕共享时，开始使用 RTC SDK 内部采集方式，采集屏幕音频
@param deviceId 虚拟设备 ID
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus} 获得更多错误说明
@note
- 本接口仅对内部采集生效，RTC SDK 默认使用内部采集模块采集屏幕音频。若已调用 setScreenAudioSourceType:{@link #ByteRTCEngine#setScreenAudioSourceType} 将音频输入源设置为
ByteRTCAudioSourceTypeExternal自定义采集，需先切换为ByteRTCAudioSourceTypeInternal内部采集，否则该接口调用无效，并将触发 rtcEngine:onAudioDeviceWarning:deviceType:deviceWarning:{@link #ByteRTCEngineDelegate#rtcEngine:onAudioDeviceWarning:deviceType:deviceWarning} 回调。 - 采集后，你还需要调用 publishScreenAudio: 将采集到的屏幕音频推送到远端。 - 要关闭屏幕音频内部采集，调用 stopScreenAudioCapture{@link #ByteRTCEngine#stopScreenAudioCapture}。 -
ios_startScreenVideoCapture(
ByteRTCScreenCaptureSourceInfo sourceInfo, ByteRTCScreenCaptureParam captureParameters) → Future< int?> -
@platform ios
@hidden(iOS)
@detail api
@hiddensdk(audiosdk)
@author liyi.000
@brief 采集屏幕视频流，用于共享。屏幕视频流包括：屏幕上显示的内容，或应用窗口中显示的内容。
@param sourceInfo 待共享的屏幕源，参看 ByteRTCScreenCaptureSourceInfo{@link #ByteRTCScreenCaptureSourceInfo}。
你可以调用 getScreenCaptureSourceList{@link #ByteRTCEngine#getScreenCaptureSourceList} 获得所有可以共享的屏幕源。 @param captureParameters 共享参数。参看 ByteRTCScreenCaptureParam{@link #ByteRTCScreenCaptureParam}。 @return - 0: 成功 - -1: 失败 @note - 调用本接口时，采集模式应为内部模式。在外部采集模式下调用无效，并将触发 rtcEngine:onVideoDeviceWarning:deviceType:deviceWarning:{@link #ByteRTCEngineDelegate#rtcEngine:onVideoDeviceWarning:deviceType:deviceWarning} 回调。 - 调用此方法仅开启屏幕流视频采集，不会发布采集到的视频。发布屏幕流视频需要调用 publishScreenVideo:{@link #ByteRTCRoom#publishScreenVideo}。 - 调用 stopScreenVideoCapture{@link #ByteRTCEngine#stopScreenVideoCapture} 关闭屏幕视频源采集。 - 本地用户通过 rtcEngine:onVideoDeviceStateChanged:device_type:device_state:device_error:{@link #ByteRTCEngineDelegate#rtcEngine:onVideoDeviceStateChanged:device_type:device_state:device_error} 的回调获取屏幕采集状态，包括开始、暂停、恢复、错误等。 - 调用成功后，本端会收到 rtcEngine:onFirstLocalVideoFrameCaptured:withFrameInfo:{@link #ByteRTCEngineDelegate#rtcEngine:onFirstLocalVideoFrameCaptured:withFrameInfo} 回调。 - 调用此接口前，你可以调用 setScreenVideoEncoderConfig:{@link #ByteRTCEngine#setScreenVideoEncoderConfig} 设置屏幕视频流的采集帧率和编码分辨率。 - 在收到 rtcEngine:onFirstLocalVideoFrameCaptured:withFrameInfo:{@link #ByteRTCEngineDelegate#rtcEngine:onFirstLocalVideoFrameCaptured:withFrameInfo} 回调后，通过调用 setLocalVideoCanvas:withCanvas:{@link #ByteRTCEngine#setLocalVideoCanvas:withCanvas} 或 setLocalVideoSink:withSink:withPixelFormat:{@link #ByteRTCEngine#setLocalVideoSink:withSink:withPixelFormat} 函数设置本地屏幕共享视图。 - 再开启采集屏幕视频流后，你可以调用 updateScreenCaptureHighlightConfig:{@link #ByteRTCEngine#updateScreenCaptureHighlightConfig} 更新边框高亮设置，调用 updateScreenCaptureMouseCursor:{@link #ByteRTCEngine#updateScreenCaptureMouseCursor} 更新对鼠标的处理设置，PC 端还可以调用 updateScreenCaptureFilterConfig:{@link #ByteRTCEngine#updateScreenCaptureFilterConfig} 设置需要过滤的窗口。 -
ios_stopScreenAudioCapture(
) → Future< int?> - @platform ios @hidden(iOS) @detail api @author liyi.000 @brief 在屏幕共享时，停止使用 RTC SDK 内部采集方式，采集屏幕音频。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus} 获得更多错误说明 @note - 调用本接口时，采集模式应为内部模式。在外部采集模式下调用无效，并将触发 rtcEngine:onAudioDeviceWarning:deviceType:deviceWarning:{@link #ByteRTCEngineDelegate#rtcEngine:onAudioDeviceWarning:deviceType:deviceWarning} 回调。 - 要开始屏幕音频内部采集，调用 startScreenAudioCapture:{@link #ByteRTCEngine#startScreenAudioCapture}。
-
ios_stopScreenVideoCapture(
) → Future< int?> - @platform ios @hidden(iOS) @detail api @hiddensdk(audiosdk) @author liyi.000 @brief 停止屏幕视频流采集。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus} 获得更多错误说明 @note - 调用本接口时，采集模式应为内部模式。在外部采集模式下调用无效，并将触发 rtcEngine:onVideoDeviceWarning:deviceType:deviceWarning:{@link #ByteRTCEngineDelegate#rtcEngine:onVideoDeviceWarning:deviceType:deviceWarning} 回调。 - 要开启屏幕视频流采集，调用 startScreenVideoCapture:captureParameters:{@link #ByteRTCEngine#startScreenVideoCapture:captureParameters}。 - 调用后，本地用户会收到 rtcEngine:onVideoDeviceStateChanged:device_type:device_state:device_error:{@link #ByteRTCEngineDelegate#rtcEngine:onVideoDeviceStateChanged:device_type:device_state:device_error} 的回调。 - 调用此接口不影响屏幕视频流发布。
-
ios_updateScreenCaptureFilterConfig(
NSArray< NSNumber> excludedWindowList) → Future<int?> - @platform ios @hidden(iOS) @detail api @hiddensdk(audiosdk) @author liyi.000 @brief 通过 RTC SDK 提供的采集模块采集屏幕视频流时，设置需要过滤的窗口。 @param excludedWindowList 过滤掉的窗口列表。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus} 获得更多错误说明 @note - 调用此接口前，必须已通过调用 startScreenVideoCapture:captureParameters:{@link #ByteRTCEngine#startScreenVideoCapture:captureParameters} 开启了内部屏幕流采集。 - 本函数在屏幕源类别是屏幕而非应用窗体时才起作用。详见：ByteRTCScreenCaptureSourceType{@link #ByteRTCScreenCaptureSourceType}。 - 调用本接口排除指定窗口时，共享视频的帧率无法达到 30fps。
-
ios_updateScreenCaptureHighlightConfig(
ByteRTCHighlightConfig config) → Future< int?> - @platform ios @hidden(iOS) @detail api @hiddensdk(audiosdk) @author liyi.000 @brief 内部屏幕流采集时，更新边框高亮设置。默认展示边框。 @param config 边框高亮设置。参见 ByteRTCHighlightConfig{@link #ByteRTCHighlightConfig}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus} 获得更多错误说明 @note 调用此接口前，必须已通过调用 startScreenVideoCapture:captureParameters:{@link #ByteRTCEngine#startScreenVideoCapture:captureParameters} 开启了内部屏幕流采集。
-
ios_updateScreenCaptureMouseCursor(
ByteRTCMouseCursorCaptureState mouseCursorCaptureState) → Future< int?> - @platform ios @hidden(iOS) @detail api @hiddensdk(audiosdk) @author liyi.000 @brief 内部屏幕流采集时，更新对鼠标的处理设置。默认采集鼠标。 @param mouseCursorCaptureState 参看 ByteRTCMouseCursorCaptureState{@link #ByteRTCMouseCursorCaptureState}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus} 获得更多错误说明 @note 调用此接口前，必须已通过调用 startScreenVideoCapture:captureParameters:{@link #ByteRTCEngine#startScreenVideoCapture:captureParameters} 开启了内部屏幕流采集。
-
ios_updateScreenCaptureRegion(
dynamic regionRect) → Future< int?> - @platform ios @hidden(iOS) @detail api @hiddensdk(audiosdk) @author liyi.000 @brief 内部屏幕流采集时，更新采集区域。 @param regionRect 采集区域相对 startScreenVideoCapture:captureParameters:{@link #ByteRTCEngine#startScreenVideoCapture:captureParameters} 中设定区域的值。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ByteRTCReturnStatus{@link #ByteRTCReturnStatus} 获得更多错误说明 @note 调用此接口前，必须先通过调用 startScreenVideoCapture:captureParameters:{@link #ByteRTCEngine#startScreenVideoCapture:captureParameters} 开启了内部屏幕流采集。
-
isCameraExposurePositionSupported(
) → Future< bool?> - @detail api @author zhangzhenyu.samuel @brief 检查当前使用的摄像头是否支持手动设置曝光点。 @return - true: 支持。 - false: 不支持。 @note 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集时，才能检查曝光点设置能力。
-
isCameraFocusPositionSupported(
) → Future< bool?> - @detail api @author zhangzhenyu.samuel @brief 检查当前使用的摄像头是否支持手动对焦。 @return - true: 支持。 - false: 不支持。 @note 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集，才能检查摄像头是否支持手动对焦。
-
isCameraTorchSupported(
) → Future< bool?> - @detail api @author zhangzhenyu.samuel @brief 检测当前使用的摄像头（前置/后置），是否支持闪光灯。 @return - true: 支持 - false: 不支持 @note 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集时，才能检测闪光能力。
-
isCameraZoomSupported(
) → Future< bool?> - @detail api @author zhangzhenyu.samuel @brief 检测当前使用的摄像头（前置/后置），是否支持变焦（数码/光学变焦）。 @return - true: 支持 - false: 不支持 @note 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集时，才能检测摄像头变焦能力。
-
login(
{required string token, required string uid}) → Future< int?> -
@detail api
@author hanchenchen.c
@brief 登陆 RTS 服务器。
必须先登录，才能调用 sendUserMessageOutsideRoom{@link #RTCEngine#sendUserMessageOutsideRoom} 和 sendServerMessage{@link #RTCEngine#sendServerMessage} 发送房间外点对点消息和向应用服务器发送消息
在调用本接口登录后，如果想要登出，需要调用 logout{@link #RTCEngine#logout}。 @param token 用户登录必须携带的 Token，用于鉴权验证。
测试时可使用控制台生成临时 Token，roomId填任意值。
正式上线需要使用密钥 SDK 在你的服务端生成并下发 Token，roomId置空，Token 有效期及生成方式参看使用 Token 完成鉴权。 @param uid
用户 ID
用户 ID 在 appid 的维度下是唯一的。 @return - 0：成功； - <0：失败。具体失败原因参看 ReturnStatus{@link #ReturnStatus}。 @note 本地用户调用此方法登录成功后，会收到 onLoginResult{@link #IRTCEngineEventHandler#onLoginResult} 回调通登录结果，远端用户不会收到通知。 -
logout(
) → Future< int?> -
@detail api
@author hanchenchen.c
@brief 登出 RTS 服务器。
调用本接口登出后，无法调用房间外消息以及端到服务器消息相关的方法或收到相关回调。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 调用本接口登出后，必须先调用 login{@link #RTCEngine#login} 登录。 - 本地用户调用此方法登出后，会收到 onLogout{@link #IRTCEngineEventHandler#onLogout} 回调通知结果，远端用户不会收到通知。 -
muteAudioCapture(
{required bool mute}) → Future< int?> -
@valid since 3.58.1
@detail api
@author shiyayun
@brief 设置是否将采集到的音频信号静音，而不影响改变本端硬件采集状态。
@param mute 是否静音音频采集。
- True：静音（关闭麦克风） - False：（默认）开启麦克风 @return - 0: 调用成功。 - < 0 : 调用失败。具体失败原因参看 ReturnStatus{@link #ReturnStatus}。 @note - 该方法用于设置是否使用静音数据替换设备采集到的音频数据进行推流，不影响 SDK 音频流的采集发布状态。 - 静音后通过 setCaptureVolume{@link #RTCEngine#setCaptureVolume} 调整音量不会取消静音状态，音量状态会保存至取消静音。 - 调用 startAudioCapture{@link #RTCEngine#startAudioCapture} 开启音频采集前后，都可以使用此接口设置采集音量。 -
muteScreenAudioCapture(
bool mute) → Future< int?> -
@valid since 3.60.
@detail api
@author shiyayun
@brief 静音/取消静音屏幕共享时采集的音频。
调用此方法后，SDK 将发送静音数据来代替真实的屏幕音频数据，不影响本端音频设备的采集状态和 SDK 音频流的采集发布状态。 @param mute 是否静音屏幕音频。
- True：静音。远端用户听不到来自你屏幕共享的声音。 - False：（默认）取消静音。恢复发送屏幕共享的音频。 @return - 0：调用成功。 - < 0：调用失败。具体失败原因参看 ReturnStatus{@link #ReturnStatus}。 @note - 静音后通过 setCaptureVolume{@link #RTCEngine#setCaptureVolume} 调整音量不会取消静音状态，音量状态会保存至取消静音。 - 调用 startAudioCapture{@link #RTCEngine#startAudioCapture} 开启音频采集前后，都可以使用此接口设置采集音量。 -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pullExternalAudioFrame(
AudioFrame audioFrame) → Future< int?> -
@detail api
@author gongzhengduo
@brief 拉取下行音频数据用于自定义音频渲染。
调用该方法后，SDK 会主动拉取待播放的音频数据，包括远端已解码和混音后的音频数据，用于外部播放。 @param audioFrame 音频数据帧，详见 AudioFrame{@link #AudioFrame} @return 方法调用结果
- 0: 设置成功 - < 0: 设置失败 @note - 拉取外部音频数据前，必须先调用 setAudioRenderType{@link #RTCEngine#setAudioRenderType} 启用自定义音频渲染。 - 由于 RTC SDK 的帧长为 10 毫秒，你应当每隔 10 毫秒拉取一次音频数据。确保音频采样点数（sample）x 拉取频率等于 audioFrame 的采样率 （sampleRate）。如设置采样率为 48000 时，每 10 毫秒调用本接口拉取数据，每次应拉取 480 个采样点。 - 音频采样格式为 S16。音频缓冲区内的数据格式为 PCM 数据，其容量大小为 audioFrame.samples × audioFrame.channel × 2。 -
pushClientMixedStreamExternalVideoFrame(
string uid, VideoFrameData frame) → Future< int?> -
pushReferenceAudioPCMData(
AudioFrame audioFrame) → Future< int?> -
@detail api
@region 自定义音频回声消除参考信号
@author cuiyao
@brief 向 SDK 发送由自定义处理后的 PCM 音频数据，作为回声消除的参考信号
@param audioFrame 音频数据帧，详见 AudioFrame{@link #AudioFrame}
@return 方法调用结果
+ 0：方法调用成功
+ <-1：方法调用失败
@note
+ 由于 RTC SDK 的帧长为 10 毫秒，你应当每隔 10 毫秒发送一次音频数据。确保音频采样点数（sample）x 发送频率等于 audioFrame 的采样率 （sampleRate）。如设置采样率为 48000 时，每 10 毫秒调用本接口发送数据，每次应发送 480 个采样点。
+ 音频采样格式为 S16。音频缓冲区内的数据格式为 PCM 数据，其容量大小为 audioFrame.samples × audioFrame.channel × 2。 -
registerAudioFrameObserver(
IAudioFrameObserver observer) → Future< 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) → Future< int?> -
@detail api
@author gongzhengduo
@brief 注册自定义音频处理器。
注册完成后，你可以调用 enableAudioProcessor{@link #RTCEngine#enableAudioProcessor}，对本地采集到的音频进行处理，RTC SDK 将对处理后的音频进行编码和发送。也可以对接收到的远端音频进行自定义处理，RTC SDK 将对处理后的音频进行渲染。 @param processor 自定义音频处理器，详见 IAudioFrameProcessor{@link #IAudioFrameProcessor}。
SDK 只持有 processor 的弱引用，你应保证其生命周期。需要取消注册时，设置此参数为 nullptr。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note -
registerLocalEncodedVideoFrameObserver(
ILocalEncodedVideoFrameObserver observer) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author liuyangyang
@brief 注册本地视频帧监测器。
无论使用内部采集还是自定义采集，调用该方法后，SDK 每监测到一帧本地视频帧时，都会将视频帧信息通过 onLocalEncodedVideoFrame{@link #ILocalEncodedVideoFrameObserver#onLocalEncodedVideoFrame} 回调给用户。 @param observer 本地频帧监测器，参看 ILocalEncodedVideoFrameObserver{@link #ILocalEncodedVideoFrameObserver} 。将参数设置为 null 则取消注册。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。 @note 该方法可在进房前后的任意时间调用，在进房前调用可保证尽可能早地监测视频帧并触发回调 -
registerLocalVideoProcessor(
VideoProcessor processor, VideoPreprocessorConfig config) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author zhushufan.ref
@brief 设置自定义视频前处理器。
使用这个视频前处理器，你能够调用 processVideoFrame{@link #IVideoProcessor#processVideoFrame} 对 RTC SDK 采集得到的视频帧进行前处理，并将处理后的视频帧用于 RTC 音视频通信。 @param processor 自定义视频处理器，详见 IVideoProcessor{@link #IVideoProcessor}。如果传入 null，则不对 RTC SDK 采集得到的视频帧进行前处理。
SDK 只持有 processor 的弱引用，你应保证其生命周期。 @param config 自定义视频前处理器适用的设置，详见 VideoPreprocessorConfig{@link #VideoPreprocessorConfig}。
当前，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) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author wangzhanqiang
@brief 注册远端编码后视频数据回调。
完成注册后，当 SDK 监测到远端编码后视频帧时，会触发 onRemoteEncodedVideoFrame{@link #IRemoteEncodedVideoFrameObserver#onRemoteEncodedVideoFrame} 回调 @param observer 远端编码后视频数据监测器，参看 IRemoteEncodedVideoFrameObserver{@link #IRemoteEncodedVideoFrameObserver} @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 更多自定义解码功能说明参看 自定义视频编解码。 - 该方法适用于手动订阅，并且进房前后均可调用，建议在进房前调用。 - 引擎销毁前需取消注册，调用该方法将参数设置为 "null" 即可。 -
requestRemoteVideoKeyFrame(
string streamId) → Future< int?> - @detail api @brief 在订阅远端视频流之后，向远端请求关键帧 @param streamId 远端流 ID。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 该方法仅适用于手动订阅模式，并且在成功订阅远端流之后使用。 - 该方法适用于调用 setVideoDecoderConfig{@link #RTCEngine#setVideoDecoderConfig} 开启自定义解码功能后，并且自定义解码失败的情况下使用
-
sendPublicStreamSEIMessage(
int channelId, ArrayBuffer message, int repeatCount, SEICountPerFrame mode) → Future< 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。
调用此接口后，SEI 数据会添加到从当前视频帧开始的连续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) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author wangzhanqiang
@brief 通过视频帧发送 SEI 数据。
在视频通话场景下，SEI 数据会随视频帧发送；在语音通话场景下，SDK 会自动生成一路 16px × 16px 的黑帧视频流用来发送 SEI 数据。 @param message SEI 消息，建议每帧 SEI 数据总长度不超过 4 KB。超过长度限制的消息会被丢弃。 @param repeatCount 消息发送重复次数。取值范围是0, max{29, \%{视频帧率}-1}。推荐范围2,4。
调用此接口后，这些 SEI 数据会添加到从当前视频帧开始的连续\%{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) → Future< int?> -
@detail api
@author hanchenchen.c
@brief 客户端给应用服务器发送二进制消息（P2Server）
@param buffer
发送的二进制消息内容
消息不超过 64KB。 @return - >0：发送成功，返回这次发送消息的编号，从 1 开始递增。 - -1：发送失败。消息为空。 @note - 在向应用服务器发送二进制消息前，必须先调用 login{@link #RTCEngine#login} 完成登录，随后调用 setServerParams{@link #RTCEngine#setServerParams} 设置应用服务器。 - 调用本接口后，会收到一次 onServerMessageSendResult{@link #IRTCEngineEventHandler#onServerMessageSendResult} 回调，通知消息发送方发送成功或失败； - 若二进制消息发送成功，则之前调用 setServerParams{@link #RTCEngine#setServerParams} 设置的应用服务器会收到该条消息。 -
sendServerMessage(
string message) → Future< int?> -
@detail api
@author hanchenchen.c
@brief 客户端给应用服务器发送文本消息（P2Server）
@param message
发送的文本消息内容
消息不超过 64 KB。 @return - >0：发送成功，返回这次发送消息的编号，从 1 开始递增。 @note - 在向应用服务器发送文本消息前，必须先调用 login{@link #RTCEngine#login} 完成登录，随后调用 setServerParams{@link #RTCEngine#setServerParams} 设置应用服务器。 - 调用本接口后会收到一次 onServerMessageSendResult{@link #IRTCEngineEventHandler#onServerMessageSendResult} 回调，通知消息发送方是否发送成功。 - 若文本消息发送成功，则之前调用 setServerParams{@link #RTCEngine#setServerParams} 设置的应用服务器会收到该条消息。 -
sendStreamSyncInfo(
{required ArrayBuffer data, required StreamSyncInfoConfig config}) → Future< 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(
{required string uid, required ArrayBuffer message, required MessageConfig config}) → Future< int?> -
@detail api
@author hanchenchen.c
@brief 给房间外指定的用户发送二进制消息（P2P）
@param uid
消息接收用户的 ID @param buffer
发送的二进制消息内容
消息不超过 64KB。 @param config 消息类型，参看 MessageConfig{@link #MessageConfig}。 @return - >0：发送成功，返回这次发送消息的编号，从 1 开始递增。 - -1：发送失败。消息为空。 @note - 在发送房间外二进制消息前，必须先调用 login{@link #RTCEngine#login} 完成登录。 - 用户调用本接口发送二进制消息后，会收到一次 onUserMessageSendResultOutsideRoom{@link #IRTCEngineEventHandler#onUserMessageSendResultOutsideRoom} 回调，通知消息是否发送成功； - 若二进制消息发送成功，则 uid 所指定的用户会通过 onUserBinaryMessageReceivedOutsideRoom{@link #IRTCEngineEventHandler#onUserBinaryMessageReceivedOutsideRoom} 回调收到该条消息。 -
sendUserMessageOutsideRoom(
{required string uid, required string message, required MessageConfig config}) → Future< int?> -
@detail api
@author hanchenchen.c
@brief 给房间外指定的用户发送文本消息（P2P）
@param uid
消息接收用户的 ID @param message
发送的文本消息内容。
消息不超过 64 KB。 @param config 消息类型，参看 MessageConfig{@link #MessageConfig}。 @return - >0：发送成功，返回这次发送消息的编号，从 1 开始递增。 @note - 在发送房间外文本消息前，必须先调用 login{@link #RTCEngine#login} 完成登录。 - 用户调用本接口发送文本信息后，会收到一次 onUserMessageSendResultOutsideRoom{@link #IRTCEngineEventHandler#onUserMessageSendResultOutsideRoom} 回调，得知消息是否成功发送。 - 若文本消息发送成功，则 uid 所指定的用户会通过 onUserMessageReceivedOutsideRoom{@link #IRTCEngineEventHandler#onUserMessageReceivedOutsideRoom} 回调收到该消息。 -
setAnsMode(
AnsMode ansMode) → Future< 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(
{required string streamId, required AudioAlignmentMode mode}) → Future< int?> -
@detail api
@hidden internal use only
@author majun.lvhiei
@brief 在听众端，设置订阅的所有远端音频流精准对齐后播放。
@param streamId 流 ID，作为对齐基准的远端音频流。一般选择主唱的音频流。
你必须在收到 onUserPublishStreamAudio{@link #IRTCRoomEventHandler#onUserPublishStreamAudio}, 确认此音频流已发布后，调用此 API。 @param mode 是否对齐，默认不对齐。参看 AudioAlignmentMode{@link #AudioAlignmentMode}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 你必须在实时合唱场景下使用此功能。在加入房间时，所有人应设置 ChannelProfile{@link #ChannelProfile} 为CHANNEL_PROFILE_CHORUS。 - 订阅的所有远端流必须通过 startAudioMixing 开启了背景音乐混音，并将 AudioMixingConfig中的syncProgressToRecordFrame设置为true。 - 如果订阅的某个音频流延迟过大，可能无法实现精准对齐。 - 合唱的参与者不应调用此 API，因为调用此 API 会增加延迟。如果希望从听众变为合唱参与者，应关闭对齐功能。 -
setAudioProfile(
AudioProfileType audioProfile) → Future< int?> -
@detail api
@author zhangyuanyuan.0101
@brief 设置音质档位。
当所选的 ChannelProfile{@link #ChannelProfile} 中的音频参数无法满足你的场景需求时，调用本接口切换的音质档位。 @param audioProfile 音质档位，参看 AudioProfileType{@link #AudioProfileType} @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 该方法在进房前后均可调用； - 支持通话过程中动态切换音质档位。 -
setAudioRenderType(
AudioRenderType type) → Future< int?> -
@detail api
@author gongzhengduo
@brief 切换音频渲染方式
@param type 音频输出类型，详见 AudioRenderType{@link #AudioRenderType}
默认使用内部音频渲染。音频采集和渲染方式无需对应。 @return 方法调用结果：
- =0: 切换成功。 - <0：切换失败。 @note - 进房前后调用此方法均有效。 - 如果你调用此方法切换至自定义渲染，调用 pullExternalAudioFrame{@link #RTCEngine#pullExternalAudioFrame} 获取音频数据。 -
setAudioRoute(
AudioRoute audioRoute) → Future< int?> -
@detail api
@author dixing
@brief 强制切换当前的音频播放路由。默认使用 setDefaultAudioRoute{@link #RTCEngine#setDefaultAudioRoute} 中设置的音频路由。
音频播放路由发生变化时，会收到 onAudioRouteChanged{@link #IRTCEngineEventHandler#onAudioRouteChanged} 回调。 @param audioRoute 音频播放路由，参见 AudioRoute{@link #AudioRoute}。
对 Android 设备，不同的音频设备连接状态下，可切换的音频设备情况不同。参见移动端设置音频路由。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 对于绝大多数音频场景，推荐使用 setDefaultAudioRoute{@link #RTCEngine#setDefaultAudioRoute} 设置默认音频路由，并借助 RTC SDK 的音频路由自动切换逻辑即可完成。切换逻辑参见移动端设置音频路由。你应仅在例外的场景下，使用此接口，比如在接入外接音频设备时，手动切换音频路由。 - 本接口仅支持在通话模式下使用。 - 不同音频场景中，音频路由和发布订阅状态到音量类型的映射关系详见 AudioScenarioType{@link #AudioScenarioType} 。 -
setAudioScenario(
AudioScenarioType audioScenario) → Future< int?> -
@hidden(macOS,Windows,Linux)
@valid since 3.60.
@detail api
@author gongzhengduo
@brief 设置音频场景类型。
选择音频场景后，SDK 会自动根据场景切换对应的音量模式（通话音量/媒体音量）和改场景下的最佳音频配置。
@param audioScenario 音频场景类型，参看 AudioScenarioType{@link #AudioScenarioType}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 此接口在进房前后调用都有效。 - 通话音量更适合通话、会议等对信息准确度更高的场景。通话音量会激活系统硬件信号处理，使通话声音更清晰。同时，音量无法降低到 0。 - 媒体音量更适合娱乐场景，因其声音的表现力会更强。媒体音量下，最低音量可以为 0。 -
setAudioSourceType(
AudioSourceType type) → Future< int?> -
@detail api
@author gongzhengduo
@brief 切换音频采集方式
@param type 音频数据源，详见 AudioSourceType{@link #AudioSourceType}。
默认使用内部音频采集。音频采集和渲染方式无需对应。 @return 方法调用结果：
- =0: 切换成功。 - <0：切换失败。 @note - 进房前后调用此方法均有效。 - 如果你调用此方法由内部采集切换至自定义采集，SDK 会自动关闭内部采集。然后，调用 pushExternalAudioFrame{@link #RTCEngine#pushExternalAudioFrame} 推送自定义采集的音频数据到 RTC SDK 用于传输。 - 如果你调用此方法由自定义采集切换至内部采集，你必须再调用 startAudioCapture{@link #RTCEngine#startAudioCapture} 手动开启内部采集。 -
setBeautyIntensity(
{required EffectBeautyMode beautyMode, required float intensity}) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author wangjunlin.3182
@brief 调整基础美颜强度
@param beautyMode 基础美颜模式，参看 EffectBeautyMode{@link #EffectBeautyMode}。
@param intensity 美颜强度，取值范围为
0,1。强度为 0 表示关闭。
各基础美颜模式的强度默认值分别为：美白 0.7，磨皮 0.8，锐化 0.5，清晰 0.7。 @return - 0: 调用成功。 - –2:intensity范围超限。 - –1001: RTC SDK 版本不支持此功能。 - <0: 调用失败，特效 SDK 内部错误，具体错误码请参考错误码表。 @note - 若在调用 enableEffectBeauty{@link #RTCEngine#enableEffectBeauty} 前设置美颜强度，则对应美颜功能的强度初始值会根据设置更新。 - 销毁引擎后，美颜功能强度恢复默认值。 -
setBusinessId(
string businessId) → Future< int?> -
@detail api
@author wangzhanqiang
@brief 设置业务标识参数
可通过 businessId 区分不同的业务场景。businessId 由客户自定义，相当于一个“标签”，可以分担和细化现在 AppId 的逻辑划分的功能，但不需要鉴权。 @param businessId
用户设置的自己的 businessId 值
businessId 只是一个标签，颗粒度需要用户自定义。 @return - 0： 成功。 - -2： 输入非法，合法字符包括所有小写字母、大写字母和数字，除此外还包括四个独立字符，分别是：英文句号，短横线，下划线和 @ 。 @note - 需要在进房前调用，进房后调用该方法无效。 -
setCameraAdaptiveMinimumFrameRate(
int framerate) → Future< int?> -
@hidden(macOS)
@valid since 353
@detail api
@author yinkaisheng
@brief 设置内部采集适用动态帧率时，帧率的最小值。
@param framerate 最小值。单位为 fps。默认值是 7。
动态帧率的最大帧率是通过 setVideoCaptureConfig{@link #RTCEngine#setVideoCaptureConfig} 设置的帧率值。当传入参数大于最大帧率时，使用固定帧率模式，帧率为最大帧率；当传入参数小于最大帧率时，使用动态帧率。 @return - 0: 成功. - !0: 失败. @note - 你必须在调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 开启内部采集前，调用此接口方可生效。 - 如果由于性能降级、静态适配等原因导致采集最大帧率变化时，已设置的最小帧率值会与新的采集最大帧率值重新比较。比较结果变化可能导致固定/动态帧率模式切换。 - 对 Android，默认开启动态帧率模式 - 对 iOS，默认使用固定帧率模式 -
setCameraExposureCompensation(
float val) → Future< 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} 关闭内部采集后，设置的曝光补偿失效。 -
setCameraTorch(
TorchState torchState) → Future< 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) → Future< int?> -
@detail api
@author zhangzhenyu.samuel
@brief 设置当前使用的摄像头（前置/后置）的光学变焦倍数
@param zoom 变焦倍数。取值范围是
1, <最大变焦倍数>。
最大变焦倍数可以通过调用 getCameraZoomMaxRatio{@link #RTCEngine#getCameraZoomMaxRatio} 获取。 @return - 0： 成功。 - < 0： 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。 @note - 必须已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 使用 SDK 内部采集模块进行视频采集时，才能设置摄像头变焦倍数。 - 设置结果在调用 stopVideoCapture{@link #RTCEngine#stopVideoCapture} 关闭内部采集后失效。 - 你可以调用 setVideoDigitalZoomConfig{@link #RTCEngine#setVideoDigitalZoomConfig} 设置数码变焦参数， 调用 setVideoDigitalZoomControl{@link #RTCEngine#setVideoDigitalZoomControl} 进行数码变焦。 -
setCaptureVolume(
{required int volume}) → Future< int?> -
@detail api
@author huangshouqin
@brief 调节音频采集音量
@param volume 采集的音量值和原始音量的百分比，范围是
0, 400，单位为 %，自带溢出保护。
只改变音频数据的音量信息，不涉及本端硬件的音量调节。
为保证更好的通话质量，建议将 volume 值设为0,100。
- 0：静音 - 100：原始音量 - 400: 最大可为原始音量的 4 倍(自带溢出保护) @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note 在开启音频采集前后，你都可以使用此接口设定采集音量。 -
setCellularEnhancement(
MediaTypeEnhancementConfig config) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author wangfeng.1004
@brief 启用蜂窝网络辅助增强，改善通话质量。
@param config 参看 MediaTypeEnhancementConfig{@link #MediaTypeEnhancementConfig}。
@return 方法调用结果：
- 0: 成功。 - -1：失败，内部错误。 - -2: 失败，输入参数错误。 @note 此功能默认不开启。 -
setClientMixedStreamObserver(
IClientMixedStreamObserver observer) → Future< int?> -
setDefaultAudioRoute(
AudioRoute route) → Future< int?> - @detail api @author dixing @brief 将默认的音频播放设备设置为听筒或扬声器。 @param route 音频播放设备。参看 AudioRoute{@link #AudioRoute}。仅支持听筒或扬声器。 @return - 0: 方法调用成功。 - < 0: 方法调用失败。 @note 对于音频路由切换逻辑，参见移动端设置音频路由。
-
setDummyCaptureImagePath(
string filePath) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author liuyangyang
@brief 摄像头处于关闭状态时，使用静态图片填充本地推送的视频流。
调用stopVideoCapture接口时，会开始推静态图片。若要停止发送图片，可传入空字符串或启用内部摄像头采集。
可重复调用该接口来更新图片。 @param filePath 设置静态图片的路径。
支持本地文件绝对路径和 Asset 资源路径(/assets/xx.png)，不支持网络链接，长度限制为 512 字节。
静态图片支持类型为 JPEG/JPG、PNG、BMP。
若图片宽高比与设置的编码宽高比不一致，图片会被等比缩放，黑边填充空白区域。推流帧率与码率与设置的编码参数一致。 @return - 0: 成功。 - -2: 失败。确保传入的 filePath 为有效路径。 - -12: 本方法不支持在 Audio SDK 中使用。 @note - 该接口只适用于 SDK 内部摄像头采集，不适用于自定义视频采集。 - 本地预览无法看到静态图片。 - 进入房间前后均可调用此方法。在多房间场景中，静态图片仅在发布的房间中生效。 - 针对该静态图片，滤镜和镜像效果不生效，水印效果生效。 - 只有主流能设置静态图片，屏幕流不支持设置。 - 开启大小流后，静态图片对大小流均生效，且针对小流进行等比例缩小。 -
setEarMonitorMode(
EarMonitorMode mode, EarMonitorAudioFilter filter) → Future< 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) → Future< int?> -
@detail api
@author majun.lvhiei
@brief 设置耳返音量。
@param volume 耳返音量，调节范围：
0,100，单位：% @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 设置耳返音量前，你必须先调用 setEarMonitorMode{@link #RTCEngine#setEarMonitorMode} 打开耳返功能。 -
setExternalVideoEncoderEventHandler(
IExternalVideoEncoderEventHandler handler) → Future< 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) → Future<int?> -
@detail api
@author keshixing.rtc
@brief 设置本地代理。
@param configurations 本地代理配置参数。参看 LocalProxyConfiguration{@link #LocalProxyConfiguration}。
你可以根据自己的需要选择同时设置 Http 隧道 和 Socks5 两类代理，或者单独设置其中一类代理。如果你同时设置了 Http 隧道 和 Socks5 两类代理，此时，媒体和信令采用 Socks5 代理， Http 请求采用 Http 隧道代理；如果只设置 Http 隧道 或 Socks5 一类代理，媒体、信令和 Http 请求均采用已设置的代理。
调用此接口设置本地代理后，若想清空当前已有的代理设置，可再次调用此接口，选择不设置任何代理即可清空。 @note - 该方法需要在进房前调用。 - 调用该方法设置本地代理后，SDK 会触发 onLocalProxyStateChanged{@link #IRTCEngineEventHandler#onLocalProxyStateChanged} ，返回代理连接的状态。 -
setLocalSimulcastMode(
VideoSimulcastMode mode, List< VideoEncoderConfig> streamConfig) → Future<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 方法调用结果：
- 0：成功 - !0：失败 @note - 调用本方法前，SDK 默认仅发布一条分辨率为 640px × 360px @15fps 的视频流。 - 本方法适用于摄像头采集的视频流。 - 更多信息详见推送多路流文档。 -
setLocalVideoCanvas(
VideoCanvas videoCanvas) → Future< int?> - @detail api @hiddensdk(audiosdk) @author sunhang.io @brief 设置本地视频渲染时使用的视图，并设置渲染模式。 @param videoCanvas 视图信息和渲染模式, 参看 VideoCanvas{@link #VideoCanvas} @return - 0: 成功 - -2: 参数错误。 - -12: 本方法不支持在 Audio SDK 中使用。 @note - 你应在加入房间前，绑定本地视图。退出房间后，此设置仍然有效。 - 如果需要解除绑定，你可以调用本方法传入空视图。
-
setLocalVideoMirrorType(
MirrorType mirrorType) → Future< 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（本地预览镜像）。 - 该接口调用前，各视频源的初始状态如下： -
setLocalVoiceEqualization(
VoiceEqualizationConfig voiceEqualizationConfig) → Future< int?> - @detail api @author wangjunzheng @brief 设置本地采集语音的均衡效果。包含内部采集和外部采集，但不包含混音音频文件。 @param voiceEqualizationConfig 语音均衡效果，参看 VoiceEqualizationConfig{@link #VoiceEqualizationConfig} @return - 0： 成功。 - < 0： 失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。 @note 根据奈奎斯特采样率，音频采样率必须大于等于设置的中心频率的两倍，否则，设置不生效。
-
setLocalVoicePitch(
int pitch) → Future< int?> -
@detail api
@author wangjunzheng
@brief 开启本地语音变调功能，多用于 K 歌场景。
使用该方法，你可以对本地语音的音调进行升调或降调等调整。 @param pitch 相对于语音原始音调的升高/降低值，取值范围-12，12，默认值为 0，即不做调整。
取值范围内每相邻两个值的音高距离相差半音，正值表示升调，负值表示降调，设置的绝对值越大表示音调升高或降低越多。
超出取值范围则设置失败，并且会触发 onWarning{@link #IRTCEngineEventHandler#onWarning} 回调，提示 WarningCode{@link #WarningCode} 错误码为WARNING_CODE_SET_SCREEN_STREAM_INVALID_VOICE_PITCH设置语音音调不合法 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 -
setLocalVoiceReverbParam(
VoiceReverbConfig config) → Future< 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) → Future< int?> -
@detail api
@author huangshouqin
@brief 调节本地播放的所有远端用户音频混音后的音量，混音内容包括远端人声、音乐、音效等。
播放音频前或播放音频时，你都可以使用此接口设定播放音量。 @param volume 音频播放音量值和原始音量的比值，范围是0, 400，单位为 %，自带溢出保护。
为保证更好的通话质量，建议将 volume 值设为0,100。
- 0：静音 - 100：原始音量 - 400: 最大可为原始音量的 4 倍(自带溢出保护) @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note 假设某远端用户 A 始终在被调节的目标用户范围内，当该方法与 setRemoteAudioPlaybackVolume{@link #RTCEngine#setRemoteAudioPlaybackVolume} 或 setRemoteRoomAudioPlaybackVolume{@link #RTCRoom#setRemoteRoomAudioPlaybackVolume} 共同使用时，本地收听用户 A 的音量将为两次设置的音量效果的叠加。 -
setPublishFallbackOption(
PublishFallbackOption option) → Future< int?> -
@detail api
@author panjian.fishing
@brief 设置发布的音视频流的回退选项。
你可以调用该接口设置网络不佳或设备性能不足时从大流起进行降级处理，以保证通话质量。 @param option 本地发布的音视频流回退选项，参看 PublishFallbackOption{@link #PublishFallbackOption}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 该方法仅在调用 setLocalSimulcastMode{@link #RTCEngine#setlocalsimulcastmode-2} 开启了发送多路视频流的情况下生效。 - 该方法必须在进房前设置，进房后设置或更改设置无效。 - 调用该方法后，如因性能或网络不佳产生发布性能回退或恢复，本端会提前收到 onPerformanceAlarms{@link #IRTCEngineEventHandler#onPerformanceAlarms} 回调发出的告警，以便采集设备配合调整。 - 设置回退后，本地发布的音视频流发生回退或从回退中恢复时，远端会收到 onSimulcastSubscribeFallback{@link #IRTCEngineEventHandler#onSimulcastSubscribeFallback} 回调，通知该情况。 - 你可以调用客户端 API 或者在服务端下发策略设置回退。当使用服务端下发配置实现时，下发配置优先级高于在客户端使用 API 设定的配置。 -
setRemoteAudioPlaybackVolume(
{required string streamId, required int volume}) → Future< int?> -
@detail api
@author huanghao
@brief 调节本端播放收到的远端流时的音量。你必须在进房后进行设置。流的发布状态改变不影响设置生效。
@param streamId 流 ID，用于指定要调节音量的远端流。
@param volume 音量值和原始音量的比值，范围是
0, 400，单位为 %，自带溢出保护。
为保证更好的通话质量，建议将 volume 值设为0,100。 @return 方法调用结果：
- 0：成功； - <0：失败。具体失败原因参看 ReturnStatus{@link #ReturnStatus}。 @note 假设某远端用户 A 始终在被调节的目标用户范围内：
- 当该方法与 setRemoteRoomAudioPlaybackVolume{@link #RTCRoom#setRemoteRoomAudioPlaybackVolume} 共同使用时，本地收听用户 A 的音量为后调用的方法设置的音量； - 当该方法与 setPlaybackVolume{@link #RTCEngine#setPlaybackVolume} 方法共同使用时，本地收听用户 A 的音量将为两次设置的音量效果的叠加。 - 当你调用该方法设置远端流音量后，如果远端退房，接口设置失效。 -
setRemoteVideoCanvas(
string streamId, VideoCanvas videoCanvas) → Future< 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) → Future< int?> - @valid since 3.57 @detail api @hiddensdk(audiosdk) @brief 使用内部渲染时，为远端流开启镜像。 @param streamId 流 ID，用于指定需要镜像的视频流。 @param mirrorType 远端流的镜像类型，参看 RemoteMirrorType{@link #RemoteMirrorType}。 @return - 0: 调用成功。 - < 0: 调用失败，参看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。
-
setRemoteVideoSuperResolution(
{required string streamId, required VideoSuperResolutionMode mode}) → Future< 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。 - 支持对一路远端流开启超分，不支持对多路流开启超分。
-
setRuntimeParameters(
dynamic params) → Future< 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) → Future< 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) → Future< int?> -
@detail api
@valid Available since 3.60.
@author wangjunzheng
@brief 调节屏幕共享时采集的音频音量。
只改变音频数据的音量信息，不影响麦克风采集的音量，也不会改变本端音频设备本身的音量。 @param volume 采集的音量值和原始音量的百分比，范围是0, 400，单位为 %，自带溢出保护。
为保证更好的通话质量，建议将 volume 值设为0, 100。
- 0：静音 - 100：原始音量 - 400: 最大可为原始音量的 4 倍(自带溢出保护) @return + 0: 调用成功。
+ < 0: 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。 @note 在开启屏幕音频采集前后，你都可以使用此接口设定采集音量。 -
setServerParams(
{required string signature, required string url}) → Future< int?> -
@detail api
@author hanchenchen.c
@brief 设置应用服务器参数
客户端调用 sendServerMessage{@link #RTCEngine#sendServerMessage} 或 sendServerBinaryMessage{@link #RTCEngine#sendServerBinaryMessage} 发送消息给应用服务器之前，必须需要设置有效签名和应用服务器地址。 @param signature 动态签名，应用服务器可使用该签名验证消息来源。
签名需自行定义，可传入任意非空字符串，建议将 uid 等信息编码为签名。
设置的签名会以 post 形式发送至通过本方法中 url 参数设置的应用服务器地址。 @param url 应用服务器的地址 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 用户必须调用 login{@link #RTCEngine#login} 登录后，才能调用本接口。 - 调用本接口后，SDK 会使用 onServerParamsSetResult{@link #IRTCEngineEventHandler#onServerParamsSetResult} 返回相应结果。 -
setSubscribeFallbackOption(
SubscribeFallbackOptions option) → Future< int?> -
@detail api
@author panjian.fishing
@brief 设置订阅的音视频流的回退选项。
你可调用该接口设置网络不佳或设备性能不足时允许订阅流进行降级或只订阅音频流，以保证通话流畅。 @param option 订阅的音视频流回退选项，参看 SubscribeFallbackOptions{@link #SubscribeFallbackOptions}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。 @note - 你必须在进房前设置，进房后设置或更改设置无效。 - 设置回退选项后，订阅的音视频流发生回退或从回退中恢复时，会收到 onSimulcastSubscribeFallback{@link #IRTCEngineEventHandler#onSimulcastSubscribeFallback} 和 onRemoteVideoSizeChanged{@link #IRTCEngineEventHandler#onRemoteVideoSizeChanged} 回调通知。 - 你可以调用 API 或者在服务端下发策略设置回退。当使用服务端下发配置实现时，下发配置优先级高于在客户端使用 API 设定的配置。 -
setVideoCaptureConfig(
VideoCaptureConfig videoCaptureConfig) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author liuyangyang
@brief 设置 RTC SDK 内部采集时的视频采集参数。
如果你的项目使用了 SDK 内部采集模块，可以通过本接口指定视频采集参数包括模式、分辨率、帧率。 @param videoCaptureConfig 视频采集参数。参看: VideoCaptureConfig{@link #VideoCaptureConfig}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。 @note -
setVideoCaptureRotation(
VideoRotation rotation) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author wangxiaosen
@brief 设置本端采集的视频帧的旋转角度。
当摄像头倒置或者倾斜安装时，可调用本接口进行调整。对于手机等普通设备，可调用 setVideoRotationMode{@link #RTCEngine#setVideoRotationMode} 实现旋转。 @param rotation 相机朝向角度，默认为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(
{required string streamId, required VideoDecoderConfig config}) → Future< 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(
{required VideoDenoiseMode mode}) → Future< 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(
{required ZoomConfigType type, required float size}) → Future< 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) → Future< 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}。 -
setVideoOrientation(
VideoOrientation orientation) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author wangjunlin.3182
@brief 在自定义视频前处理及编码前，设置 RTC 链路中的视频帧朝向，默认为 Adaptive 模式。
移动端开启视频特效贴纸，或使用自定义视频前处理时，建议固定视频帧朝向为 Portrait 模式。单流转推场景下，建议根据业务需要固定视频帧朝向为 Portrait 或 Landscape 模式。不同模式的具体显示效果参看视频帧朝向。 @param orientation 视频帧朝向，参看 VideoOrientation{@link #VideoOrientation}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 视频帧朝向设置仅适用于内部采集视频源。对于自定义采集视频源，设置视频帧朝向可能会导致错误，例如宽高对调。屏幕源不支持设置视频帧朝向。 - 编码分辨率的更新与视频帧处理是异步操作，进房后切换视频帧朝向可能导致画面出现短暂的裁切异常，因此建议在进房前设置视频帧朝向，且不在进房后进行切换。 -
setVideoRotationMode(
VideoRotationMode rotationMode) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author wangjunlin.3182
@brief 设置采集视频的旋转模式。默认以 App 方向为旋转参考系。
接收端渲染视频时，将按照和发送端相同的方式进行旋转。 @param rotationMode 视频旋转参考系为 App 方向或重力方向，参看 VideoRotationMode{@link #VideoRotationMode}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 旋转仅对内部视频采集生效，不适用于外部视频源和屏幕源。 - 调用该接口时已开启视频采集，将立即生效；调用该接口时未开启视频采集，则将在采集开启后生效。 - 更多信息请参考视频采集方向。 -
setVideoSourceType(
{required VideoSourceType type}) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author liuyangyang
@brief 设置向 SDK 输入的视频源，包括屏幕流
默认使用内部采集。内部采集指：使用 RTC SDK 内置的视频采集机制进行视频采集。 @param type 视频输入源类型，参看 VideoSourceType{@link #VideoSourceType} @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 该方法进房前后均可调用。 - 当你已调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 开启内部采集后，再调用此方法切换至自定义采集时，SDK 会自动关闭内部采集。 - 当你调用此方法开启自定义采集后，想要切换至内部采集，你必须先调用此方法关闭自定义采集，然后调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 手动开启内部采集。 - 当你需要向 SDK 推送自定义编码后的视频帧，你需调用该方法将视频源切换至自定义编码视频源。 -
setVideoWatermark(
string imagePath, WatermarkConfig watermarkConfig) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author zhushufan.ref
@brief 在指定视频流上添加水印。
@param imagePath 水印图片路径，支持本地文件绝对路径、Asset 资源路径（/assets/xx.png）、URI 地址（content://），长度限制为 512 字节。
水印图片为 PNG 或 JPG 格式。 @param watermarkConfig 水印参数，参看 RTCWatermarkConfig{@link #RTCWatermarkConfig}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 调用 clearVideoWatermark{@link #RTCEngine#clearVideoWatermark} 移除指定视频流的水印。 - 同一路流只能设置一个水印，新设置的水印会代替上一次的设置。你可以多次调用本方法来设置不同流的水印。 - 进入房间前后均可调用此方法。 - 若开启本地预览镜像，或开启本地预览和编码传输镜像，则远端水印均不镜像；在开启本地预览水印时，本端水印会镜像。 - 开启大小流后，水印对大小流均生效，且针对小流进行等比例缩小。 -
setVoiceChangerType(
VoiceChangerType voiceChanger) → Future< int?> -
@valid since 3.32
@detail api
@author wangjunzheng
@brief 设置变声特效类型
@param voiceChanger 变声特效类型，参看 VoiceChangerType{@link #VoiceChangerType}
@return 方法调用结果：
- 0：成功； - <0：失败。具体失败原因参看 ReturnStatus{@link #ReturnStatus}。 @note - 如需使用该功能，需集成 SAMI 动态库，详情参看按需集成插件文档。 - 在进房前后都可设置。 - 对 RTC SDK 内部采集的音频和自定义采集的音频都生效。 - 只对单声道音频生效。 - 与 setVoiceReverbType{@link #RTCEngine#setVoiceReverbType} 互斥，后设置的特效会覆盖先设置的特效。 -
setVoiceReverbType(
VoiceReverbType voiceReverb) → Future< int?> -
@valid since 3.32
@detail api
@author wangjunzheng
@brief 设置混响特效类型
@param voiceReverb 混响特效类型，参看 VoiceReverbType{@link #VoiceReverbType}
@return 方法调用结果：
- 0：成功； - <0：失败。具体失败原因参看 ReturnStatus{@link #ReturnStatus}。 @note - 在进房前后都可设置。 - 对 RTC SDK 内部采集的音频和自定义采集的音频都生效。 - 只对单声道音频生效。 - 与 setVoiceChangerType{@link #RTCEngine#setVoiceChangerType} 互斥，后设置的特效会覆盖先设置的特效。 -
startAudioCapture(
) → Future< int?> -
@detail api
@author dixing
@brief 开启内部音频采集。默认为关闭状态。
内部采集是指：使用 RTC SDK 内置的音频采集机制进行音频采集。
调用该方法开启后，本地用户会收到 onAudioDeviceStateChanged{@link #IRTCEngineEventHandler#onAudioDeviceStateChanged} 的回调。
非隐身用户进房后调用该方法，房间中的其他用户会收到 onUserStartAudioCapture{@link #IRTCEngineEventHandler#onUserStartAudioCapture} 的回调。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 若未取得当前设备的麦克风权限，调用该方法后会触发 onAudioDeviceStateChanged{@link #IRTCEngineEventHandler#onAudioDeviceStateChanged} 回调，对应的错误码为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) → Future< int?> -
@detail api
@author huangshouqin
@brief 开启录制语音通话，生成本地文件。
在进房前后开启录制，如果未打开麦克风采集，录制任务正常进行，只是不会将数据写入生成的本地文件；只有调用 startAudioCapture{@link #RTCEngine#startAudioCapture} 接口打开麦克风采集后，才会将录制数据写入本地文件。 @param config 参看 AudioRecordingConfig{@link #AudioRecordingConfig} @return - 0: 正常 - -2: 参数设置异常 - -3: 当前版本 SDK 不支持该特性，请联系技术支持人员 @note - 录制包含各种音频效果。但不包含混音的背景音乐。 - 调用 stopAudioRecording{@link #RTCEngine#stopAudioRecording} 关闭录制。 - 加入房间前后均可调用。在进房前调用该方法，退房之后，录制任务不会自动停止，需调用 stopAudioRecording{@link #RTCEngine#stopAudioRecording} 关闭录制。在进房后调用该方法，退房之后，录制任务会自动被停止。如果加入了多个房间，录制的文件中会包含各个房间的音频。 - 调用该方法后，你会收到 onAudioRecordingStateUpdate{@link #IRTCEngineEventHandler#onAudioRecordingStateUpdate} 回调。 -
startCloudProxy(
List< CloudProxyInfo> cloudProxiesInfo) → Future<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}。
-
startFileRecording(
{required RecordingConfig config, required RecordingType recordingType}) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author wangzhanqiang
@brief 该方法将通话过程中的音视频数据录制到本地的文件中。
@param config 本地录制参数配置，参看 RecordingConfig{@link #RecordingConfig}
@param recordingType 本地录制的媒体类型，参看 RecordingType{@link #RecordingType}
注意：屏幕流仅支持录制视频（RECORD_VIDEO_ONLY）；主流支持录制所有类型。 @return 0: 正常
-1: 参数设置异常
-2: 当前版本 SDK 不支持该特性，请联系技术支持人员 @note - 该方法需在进房后调用。 - 调用该方法后，你会收到 onRecordingStateUpdate{@link #IRTCEngineEventHandler#onRecordingStateUpdate} 回调。 - 如果录制正常，系统每秒钟会通过 onRecordingProgressUpdate{@link #IRTCEngineEventHandler#onRecordingProgressUpdate} 回调通知录制进度。 -
startHardwareEchoDetection(
string testAudioFilePath) → Future< int?> -
@detail api
@author zhangcaining
@brief 开启通话前回声检测
@param testAudioFilePath 用于回声检测的音频文件的绝对路径，路径字符串使用 UTF-8 编码格式，支持以下音频格式: mp3，aac，m4a，3gp，wav。
音频文件不为静音文件，推荐时长为 10 ～ 20 秒。 @return 方法调用结果：
- 0: 成功。 - -1：失败。上一次检测未结束，请先调用 stopHardwareEchoDetection{@link #RTCEngine#stopHardwareEchoDetection} 停止检测 后重新调用本接口。 - -2：失败。路径不合法或音频文件格式不支持。 @note - 只有当 ChannelProfile{@link #ChannelProfile} 为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(
{required bool isTestUplink, required int expectedUplinkBitrate, required bool isTestDownlink, required int expectedDownlinkBitrate}) → Future< 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} 通知探测停止。 -
startPushSingleStream(
{required string taskId, required PushSingleStreamParam param}) → Future< int?> -
@valid since 3.60.
@detail api
@hiddensdk(audiosdk)
@author lizheng
@brief 将房间内某一路音视频流，推送到指定的 RTC 房间或 CDN 地址。此过程不涉及编解码。
@param taskId 任务 ID。
你可以发起多个转推直播任务，并用不同的任务 ID 加以区分。当你需要发起多个转推直播任务时，应使用多个 ID；当你仅需发起一个转推直播任务时，建议使用空字符串。 @param param 转推直播配置参数。详见 PushSingleStreamParam{@link #PushSingleStreamParam}。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明。 @note - 在调用该接口前，你需要在控制台开启转推直播功能。 - 调用该方法后，关于启动结果和推流过程中的错误，会收到 onSingleStreamEvent{@link #IRTCEngineEventHandler#onSingleStreamEvent} 回调。 - 在控制台配置了转推直播服务端回调后，调用本接口会收到相应回调。重复调用该接口时，第二次调用会同时触发 TranscodeStarted 和 TranscodeUpdated。 - 调用 stopPushSingleStream{@link #RTCEngine#stopPushSingleStream} 停止任务。 - 由于本功能不进行编解码，所以推到 RTMP 的视频流会根据推流端的分辨率、编码方式、关闭摄像头等变化而变化。 -
startVideoCapture(
) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author zhangzhenyu.samuel
@brief 立即开启内部视频采集。默认为关闭状态。
内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。
调用该方法后，本地用户会收到 onVideoDeviceStateChanged{@link #IRTCEngineEventHandler#onVideoDeviceStateChanged} 的回调。
本地用户在非隐身状态下调用该方法后，房间中的其他用户会收到 onUserStartVideoCapture{@link #IRTCEngineEventHandler#onUserStartVideoCapture} 的回调。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 自 v3.37.0 版本，使用本接口需要在 Gradle 里引入 Kotlin。 - 调用 stopVideoCapture{@link #RTCEngine#stopVideoCapture} 可以停止内部视频采集。否则，只有当销毁引擎实例时，内部视频采集才会停止。 - 创建引擎后，无论是否发布视频数据，你都可以调用该方法开启内部视频采集。只有当（内部或外部）视频采集开始以后视频流才会发布。 - 如果需要从自定义视频采集切换为内部视频采集，你必须先停止发布流，关闭自定义采集，再调用此方法手动开启内部采集。 - 内部视频采集使用的摄像头由 switchCamera{@link #RTCEngine#switchCamera} 接口指定。 - 你还可以联系技术支持人员，帮助你在服务端配置采集格式并下发到 Android 端。 -
startVideoDigitalZoomControl(
ZoomDirectionType direction) → Future< 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(
) → Future< int?> -
@detail api
@author dixing
@brief 立即关闭内部音频采集。默认为关闭状态。
内部采集是指：使用 RTC SDK 内置的音频采集机制进行音频采集。
调用该方法，本地用户会收到 onAudioDeviceStateChanged{@link #IRTCEngineEventHandler#onAudioDeviceStateChanged} 的回调。
非隐身用户进房后调用该方法，房间中的其他用户会收到 onUserStopAudioCapture{@link #IRTCEngineEventHandler#onUserStopAudioCapture} 的回调。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 调用 startAudioCapture{@link #RTCEngine#startAudioCapture} 可以开启内部音频采集设备。 - 如果不调用本方法停止内部音频采集，则只有当销毁引擎实例时，内部音频采集才会停止。 -
stopAudioRecording(
) → Future< int?> - @detail api @author huangshouqin @brief 停止音频文件录制 @return - 0: 正常 - -3: 当前版本 SDK 不支持该特性，请联系技术支持人员 @note 调用 startAudioRecording{@link #RTCEngine#startAudioRecording} 开启本地录制后，你必须调用该方法停止录制。
-
stopChorusCacheSync(
) → Future< int?> - @hidden internal use only @detail api @hiddensdk(audiosdk) @author liujingchao @brief 关闭缓存同步功能。 @return 查看 ReturnStatus{@link #ReturnStatus}。
-
stopClientMixedStream(
string taskId) → Future< int?> - @hidden for internal use only @hiddensdk(audiosdk)
-
stopCloudProxy(
) → Future< int?> - @detail api @author daining.nemo @brief 关闭云代理 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note 要开启云代理，调用 startCloudProxy{@link #RTCEngine#startCloudProxy}。
-
stopEchoTest(
) → Future< int?> -
@detail api
@author qipengxiang
@brief 停止音视频回路测试。
调用 startEchoTest{@link #RTCEngine#startEchoTest} 开启音视频回路检测后，你必须调用该方法停止检测。 @return 方法调用结果：
- 0：成功。 - -3：失败，未开启回路检测。 @note 音视频回路检测结束后，所有对系统设备及音视频流的控制均会恢复到开始检测前的状态。 -
stopFileRecording(
) → Future< int?> - @detail api @hiddensdk(audiosdk) @author wangzhanqiang @brief 停止本地录制 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 调用 startFileRecording{@link #RTCEngine#startFileRecording} 开启本地录制后，你必须调用该方法停止录制。 - 调用该方法后，你会收到 onRecordingStateUpdate{@link #IRTCEngineEventHandler#onRecordingStateUpdate} 回调提示录制结果。
-
stopHardwareEchoDetection(
) → Future< int?> -
@detail api
@author zhangcaining
@brief 停止通话前回声检测
@return 方法调用结果：
- 0: 成功。 - -1：失败。 @note - 关于开启通话前回声检测，参看 startHardwareEchoDetection{@link #RTCEngine#startHardwareEchoDetection} 。 - 建议在收到 onHardwareEchoDetectionResult{@link #IRTCEngineEventHandler#onHardwareEchoDetectionResult} 通知的检测结果后，调用本接口停止检测。 - 在用户进入房间前结束回声检测，释放对音频设备的占用，以免影响正常通话。 -
stopNetworkDetection(
) → Future< int?> - @detail api @author hanchenchen.c @brief 停止通话前网络探测 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 调用本接口后，会收到一次 onNetworkDetectionStopped{@link #IRTCEngineEventHandler#onNetworkDetectionStopped} 回调通知探测停止。
-
stopPushMixedStream(
string taskId, MixedStreamPushTargetType targetType) → Future< 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) → Future< 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(
) → Future< 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(
) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author zhangzhenyu.samuel
@brief 立即关闭内部视频采集。默认为关闭状态。
内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。
调用该方法，本地用户会收到 onVideoDeviceStateChanged{@link #IRTCEngineEventHandler#onVideoDeviceStateChanged} 的回调。
非隐身用户进房后调用该方法，房间中的其他用户会收到 onUserStopVideoCapture{@link #IRTCEngineEventHandler#onUserStopVideoCapture} 的回调。 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 调用 startVideoCapture{@link #RTCEngine#startVideoCapture} 可以开启内部视频采集。 - 如果不调用本方法停止内部视频采集，则只有当销毁引擎实例时，内部视频采集才会停止。 -
stopVideoDigitalZoomControl(
) → Future< 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) → Future< int?> -
@detail api
@hiddensdk(audiosdk)
@author zhangzhenyu.samuel
@brief 切换视频内部采集时使用的前置/后置摄像头
调用此接口后，在本地会触发 onVideoDeviceStateChanged{@link #IRTCEngineEventHandler#onVideoDeviceStateChanged} 回调。 @param cameraId 摄像头 ID，参看 CameraId{@link #CameraId} @return - 0：方法调用成功 - < 0：方法调用失败 @note - 默认使用前置摄像头。 - 如果你正在使用相机进行视频采集，切换操作当即生效；如果相机未启动，后续开启内部采集时，会打开设定的摄像头。 -
takeLocalSnapshotToFile(
string filePath) → Future< int?> -
@detail api
@author wangfujun.911
@brief 截取本地的视频流画面，生成 JPG 文件，并保存到本地指定路径。
调用该方法后，SDK 会触发回调 onLocalSnapshotTakenToFile{@link #IRTCEngineEventHandler#onLocalSnapshotTakenToFile} 报告截图是否成功，以及截取的图片信息。 @param filePath 截图的本地保存路径（绝对路径），需精确到文件名及格式，文件扩展名必须为.jpg，并请确保路径存在且可写。示例：/sdcard/Pictures/snapshot.jpg。 @return 远端截图任务的编号，从1开始递增。此编号可用于追踪任务状态或进行其他管理操作。 -
takeRemoteSnapshotToFile(
string streamId, string filePath) → Future< int?> -
@detail api
@author wangfujun.911
@brief 截取远端的视频流画面，生成 JPG 文件，并保存到本地指定路径。
调用该方法后，SDK 会触发回调 onRemoteSnapshotTakenToFile{@link #IRTCEngineEventHandler#onRemoteSnapshotTakenToFile} 报告截图是否成功，以及截取的图片信息。 @param streamId 待截取的远端视频流 ID。 @param filePath 截图的本地保存路径（绝对路径），需精确到文件名及格式，文件扩展名必须为.jpg，并请确保路径存在且可写。示例：/sdcard/Pictures/snapshot.jpg。 @return 远端截图任务的编号，从1开始递增。此编号可用于追踪任务状态或进行其他管理操作。 -
toString(
) → String -
A string representation of this object.
inherited
-
transformToPlatformConstructorArgs(
List args, List< int> indices, Map<String, dynamic> typeMap, Map<String, dynamic> enumMap, Map<String, dynamic> classMap, String platformVar) → List -
实例化参数处理
将 pack 过后的 enum / class 转成 android / ios 平台侧的 enum / class
inherited
-
updateInstance(
dynamic instance) → void -
inherited
-
updateLocalVideoCanvas(
{required VideoRenderMode renderMode, required int backgroundColor}) → Future< 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) → Future< int?> -
@detail api
@author hanchenchen.c
@brief 更新用户用于登录的 Token
Token 有一定的有效期，当 Token 过期时，需调用此方法更新登录的 Token 信息。
调用 login{@link #RTCEngine#login} 方法登录时，如果使用了过期的 Token 将导致登录失败，并会收到 onLoginResult{@link #IRTCEngineEventHandler#onLoginResult} 回调通知，错误码为LOGIN_ERROR_CODE_INVALID_TOKEN。此时需要重新获取 Token，并调用此方法更新 Token。 @param token
更新的动态密钥 @return - 0: 调用成功。 - < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明 @note - 如果 Token 无效导致登录失败，则调用此方法更新 Token 后，SDK 会自动重新登录，而用户不需要自己调用 login{@link #RTCEngine#login} 方法。 - Token 过期时，如果已经成功登录，则不会受到影响。Token 过期的错误会在下一次使用过期 Token 登录时，或因本地网络状况不佳导致断网重新登录时通知给用户。 -
updateScreenCapture(
ScreenMediaType type) → Future< 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} 后调用该方法。
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
destroyRTCEngine(
) → Future - @detail api @author wangzhanqiang @brief 销毁由 createRTCEngine{@link #RTCEngine#createRTCEngine} 所创建的引擎实例，并释放所有相关资源。 @note - 请确保和需要销毁的 RTCEngine{@link #RTCEngine} 实例相关的业务场景全部结束后，才调用此方法 - 该方法在调用之后，会销毁所有和此 RTCEngine{@link #RTCEngine} 实例相关的内存，并且停止与媒体服务器的任何交互 - 调用本方法会启动 SDK 退出逻辑。引擎线程会保留，直到退出逻辑完成。因此，不要在回调线程中直接调用此 API，会导致死锁。同时此方法是耗时操作，不建议在主线程调用本方法，避免主线程阻塞。
-
getSDKVersion(
) → Future< String?> - @detail api @author wangzhanqiang @brief 获取 SDK 当前的版本号。 @return SDK 当前的版本号。
-
setLogConfig(
RTCLogConfig logConfig) → Future< int?> - @detail api @author caofanglu @brief 配置 SDK 本地日志参数，包括日志级别、存储路径、日志文件最大占用的总空间、日志文件名前缀。 @param logConfig 本地日志参数，参看 RTCLogConfig{@link #RTCLogConfig}。 @return - 0：成功。 - –1：失败，本方法必须在创建引擎前调用。 - –2：失败，参数填写错误。 @note 本方法必须在调用 createRTCEngine{@link #RTCEngine#createRTCEngine} 之前调用。