HRtcEngine
本章节介绍了Android SDK的HRtcEngine接口详情。
接口 |
描述 |
---|---|
设置日志参数 |
|
创建RTC引擎实例 |
|
销毁RTC引擎 |
|
加入房间 |
|
离开房间 |
|
创建渲染视图 |
|
设置本地窗口显示模式 |
|
设置本地窗口 |
|
切换摄像头 |
|
设置是否发送本地音频流 |
|
设置声音播放模式 |
|
设置是否发送本地视频流 |
|
上传日志 |
|
调整录制音量 |
|
调整播放音量 |
|
设置视频编码参数 |
|
开启并设置小流编码参数 |
|
设置默认订阅的视频流类型 |
|
设置当前订阅的视频流类型 |
|
设置订阅视频流的分辨率自适应 |
|
设置用户角色 |
|
开始本地预览 |
|
停止本地预览 |
|
设置音频数据输出使能 |
|
设置视频数据输出使能 |
|
设置共享数据输出使能 |
|
选择特定用户的视频数据输出 |
|
去除选择特定用户的视频数据输出 |
|
开始订阅远端视频流 |
|
停止订阅远端视频流 |
|
设置远端窗口视图 |
|
设置远端窗口渲染模式 |
|
开始订阅辅流 |
|
停止订阅辅流 |
|
设置辅流角度 |
|
设置辅流渲染模式 |
|
开启跨房,加入其他房间 |
|
结束跨房,离开其他房间 |
|
设置在所有可接收的音频流中,接收前N个音量最大的音频流 |
|
设置是否接收对应远端用户的音频流 |
|
设置是否接收所有远端用户的音频流 |
|
设置是否接收对应远端用户的视频流 |
|
设置是否接收所有远端用户的视频流 |
|
设置是否开启外部音频采集 |
|
设置是否开启外部视频采集 |
|
输入外部音频数据 |
|
输入外部视频数据 |
|
更新鉴权签名 |
|
设置本地视频镜像模式 |
|
设置视频编码镜像模式 |
|
设置是否开启音频采集 |
|
设置是否开启摄像头采集视频 |
|
设置显示模式,区分横屏还是竖屏,用于保证摄像头方向与本地界面方向一致 |
|
开始播放音频文件 |
|
停止播放音频文件 |
|
暂停播放音频文件 |
|
恢复播放音频文件 |
|
开启会前网络探测 |
|
停止会前网络检测 |
|
打点功能开关 |
|
设置音量值上报回调函数onUserVolumeStats回调周期 |
|
设置是否默认接收所有远端用户视频流 |
|
设置视频编码分辨率比例模式 |
setLogParam
public static int setLogParam(boolean enable, HRTCLogInfo logInfo)
【功能说明】
设置日志参数。需要在创建RTC引擎之前调用。
- enable:true表示打印日志文件。false表示不打印日志文件。
- logInfo:日志文件设置,具体请参见HRTCLogInfo。
- 0:成功。
- >0:失败。
create
public static synchronized HRTCEngine create(Context context, String domain, String appId, IHRTCEngineEventHandler eventHandler)
【功能说明】
创建RTC引擎实例。
- context:上下文。
- domain:域名。
- appId:应用ID。
- eventHandler:引擎事件句柄,用于加入房间、离开房间等事件回调,具体请参见IHRTCEngineEventHandler。
【返回参数】
返回引擎实例对象。
joinRoom
public abstract int joinRoom(HRTCUserInfo userInfo, String roomId, HRTCMediaType mediaType);
【功能说明】
加入房间。
- userInfo:用户信息,具体请参见HRTCUserInfo。
- roomId:房间ID。
- mediaType:媒体类型,具体请参见HRTCMediaType。
- 0:成功。
- 1:失败。
- 2:上下文为空。
【注意事项】
- onConnectionStateChange:连接状态发送改变。
- onJoinRoomSuccess:加入房间成功时回调。
- onJoinRoomFailure: 加入房间失败时回调。
- onUserJoined:加入房间成功后,通知房间内已加入用户的回调,包括自己。
leaveRoom
public abstract int leaveRoom()
【功能说明】
离开房间。
【请求参数】
无
- 0:成功。
- >0:失败。
【注意事项】
- onLeaveRoom:离开房间回调。
- onConnectionStateChange:连接状态改变回调。
createRenderer
public static SurfaceView createRenderer(Context context)
【功能说明】
创建渲染视图。
【请求参数】
context:上下文。
【返回参数】
创建的渲染视图。
setLocalViewDisplayMode
public abstract int setLocalViewDisplayMode(HRTCVideoDisplayMode viewMode);
【功能说明】
设置本地窗口显示模式。
【请求参数】
viewMode:显示模式,具体请参见HRTCVideoDisplayMode。
【返回参数】
- 0:成功。
- >0:失败。
setupLocalView
public abstract int setupLocalView(SurfaceView view); public abstract int setupLocalView(SurfaceView view, HRTCVideoDisplayMode viewMode);
【功能说明】
设置本地窗口。
- view:窗口视图。
- viewMode:显示模式,具体请参见HRTCVideoDisplayMode。
- 0:成功。
- >0:失败。
muteLocalAudio
public abstract int muteLocalAudio(boolean mute);
【功能说明】
设置是否发送本地音频流。
【请求参数】
mute:true表示不发送,false表示发送。
- 0:成功。
- >0:失败。
【注意事项】
成功加入房间发送音频流后才能调用,默认为发送本地音频流。
setSpeakerModel
public abstract int setSpeakerModel(HRTCSpeakerModel speakerModel);
【功能说明】
设置声音播放模式。成功加入房间后才能调用。
【请求参数】
speakerModel:声音播放模式,具体请参见HRTCSpeakerModel。
- 0:成功。
- >0:失败。
muteLocalVideo
public abstract int muteLocalVideo(boolean mute);
【功能说明】
设置是否发送本地视频流。成功加入房间后才能调用。
【请求参数】
mute:true表示不发送,false表示发送。
- 0:成功。
- >0:失败。
logUpload
public abstract int logUpload();
【功能说明】
上传日志。
【请求参数】
无
- 0:成功。
- >0:失败。
【注意事项】
- onLogUploadResult:日志上传结果回调。
- onLogUploadProgress:日志上传进度回调。
adjustRecordingVolume
public abstract int adjustRecordingVolume(int volume);
【功能说明】
调整录制音量值。
【请求参数】
volume:音量值,取值范围:[0,100],默认音量值为10, 此接口不会影响系统音量。
- 0:成功。
- >0:失败。
adjustPlaybackVolume
public abstract int adjustPlaybackVolume(int volume);
【功能说明】
调整播放音量值。
【请求参数】
volume:音量值,取值范围:[0,100],默认音量值为10, 此接口不会影响系统音量。
- 0:成功。
- >0:失败。
setVideoEncParam
public abstract int setVideoEncParam(int totalBitRate, List<HRTCVideoEncParam> encoderParams); public abstract int setVideoEncParam(HRTCVideoEncParam encoderParam);
【功能说明】
设置视频编码参数。
- totalBitRate:视频最大码率。
- encoderParams:视频编码参数列表,具体请参见HRTCVideoEncParam。
- encoderParam:视频编码参数,具体请参见HRTCVideoEncParam。
- 0:成功。
- >0:失败。
enableSmallVideoStream
public abstract int enableSmallVideoStream(boolean enable, HRTCVideoEncParam encoderParam);
【功能说明】
大小流模式设置是否开启小流,并设置编码参数。小流选择性开启。
- enable:是否开启小流。
- encoderParam:视频编码参数。包括流类型、宽、高、码率、帧率等。具体请参见HRTCVideoEncParam。
- 0:方法调用成功。
- >0:方法调用失败。具体请参见HRTCErrorCode。
setPriorRemoteVideoStreamType
public abstract int setPriorRemoteVideoStreamType(HRTCVideoStreamType type);
【功能说明】
大小流模式,设置所有订阅的远端视频流类型。默认订阅大流。
【请求参数】
type:订阅的视频流类型,分为大流和小流,具体请参见HRTCVideoStreamType。
- 0:方法调用成功。
- >0:方法调用失败。具体请参见HRTCErrorCode。
setRemoteVideoStreamType
public abstract int setRemoteVideoStreamType(String userId, HRTCVideoStreamType type);
【功能说明】
大小流模式,设置指定订阅的远端视频流类型。
【请求参数】
- userId:远端用户唯一标识。
- type:订阅的视频流类型,分为大流和小流,具体请参见HRTCVideoStreamType。
- 0:方法调用成功。
- >0:方法调用失败。具体请参见HRTCErrorCode。
setRemoteVideoAdjustResolution
public abstract int setRemoteVideoAdjustResolution(boolean enable);
【功能说明】
设置是否开启远端流分辨率自适应。默认开启自适应。
【请求参数】
enable:是否开启分辨率自适应。默认开启。
- 0:方法调用成功。
- >0:方法调用失败。具体请参见HRTCErrorCode。
setUserRole
public abstract int setUserRole(HRTCRoleType role); public abstract int setUserRole(String roomId, HRTCRoleType role);
【功能说明】
设置用户角色,可以在本房间内切换角色,也可以跨房间切换角色。
- roomId:设置角色切换的房间号。当不带roomId参数时,仅在本房间内切换角色。
- role:用户角色,具体请参见HRTCRoleType。
- 0:成功。
- >0:失败。
【注意事项】
- 切换成功将触发onUserRoleChanged回调。
- 切换失败将触发onError回调,返回错误码“HRTC_ERR_CODE_USER_ROLE_CHANGE_FAIL”。
startPreview
public abstract int startPreview();
【功能说明】
开始本地预览。
【请求参数】
无。
- 0:成功。
- >0:失败。
【注意事项】
- 该接口限制在房间外调用,在房间内设置不生效,需要调用stopPreview关闭预览,否则将一直处于预览状态。
- 在房间内预览:可调用setupLocalView设置有效view开启预览,设置为0表示关闭预览,不需要调用stopPreview。
- 在房间外预览:先调用setupLocalView设置有效view,再调用startPreview开启预览;关闭时,先调用setupLocalView设置为0,再调用stopPreview关闭预览。
【注意事项】
如果调用了startPreview,需调用stopPreview关闭预览,否则将一直处于预览状态。该接口限制在房间外调用,在房间内设置不生效。
setExternalAudioFrameOutputEnable
public abstract int setExternalAudioFrameOutputEnable(boolean localEnable,boolean remoteEnable);
【功能说明】
设置音频数据输出使能。
- localEnable:true表示输出本地音频数据,false表示不输出本地音频数据。
- remoteEnable:true表示输出远端音频数据,false表示不输出远端音频数据。
【返回参数】
- 0:成功。
- >0:失败。
【注意事项】
通过onPlaybackAudioFrame回调音频数据。
setExternalVideoFrameOutputEnable
public abstract int setExternalVideoFrameOutputEnable(boolean localEnable,boolean remoteEnable);
【功能说明】
设置视频数据输出使能。
- localEnable:true表示输出本地视频数据,false表示不输出本地视频数据。
- remoteEnable:true表示输出远端视频数据,false表示不输出远端视频数据。
【返回参数】
- 0:成功。
- >0:失败。
【注意事项】
设置完视频使能之后,需要调用selectVideoFrameOutput选择特定用户的视频数据。通过onRenderVideoFrame回调视频数据。
setExternalDataFrameOutputEnable
public abstract int setExternalDataFrameOutputEnable(boolean localEnable,boolean remoteEnable);
【功能说明】
设置共享数据输出使能。Android平台接口暂不提供本地共享数据的设置。
- localEnable:true表示输出本地共享数据,false表示不输出本地共享数据。
- remoteEnable:true表示输出远端共享数据,false表示不输出远端共享数据。
【返回参数】
- 0:成功。
- >0:失败。
【注意事项】
设置完视频使能之后,需要调用selectVideoFrameOutput选择特定用户的视频数据。通过onRenderDataFrame回调视频数据。
selectVideoFrameOutput
public abstract int selectVideoFrameOutput(String userId);
【功能说明】
选择特定用户的视频数据输出。
【请求参数】
userId:用户ID。
- 0:成功。
- >0:失败。
【注意事项】
选择之后也可以通过unSelectVideoFrameOutput方法去除选择,达到不让特定用户数据输出的目的。
unSelectVideoFrameOutput
public abstract int unSelectVideoFrameOutput(String userId);
【功能说明】
去除选择特定用户的视频数据输出。
【请求参数】
userId:用户ID。
- 0:成功。
- >0:失败。
startRemoteStreamView
public abstract int startRemoteStreamView(String userId, SurfaceView view, HRTCStreamType streamType); public abstract int startRemoteStreamView(String userId, SurfaceView view, HRTCStreamType streamType, boolean disableAdjustRes);
【功能说明】
开始订阅远端视频流,并设置远端窗口。
- userId:用户ID。
- view:远端窗口视图。
- streamType:流类型,具体请参见HRTCStreamType。
- disableAdjustRes:禁用分辨率自适应的标志。
【返回参数】
- 0:成功。
- >0:失败。
stopRemoteStreamView
public abstract int stopRemoteStreamView(String userId);
【功能说明】
停止订阅远端视频流,并关闭远端窗口。
【请求参数】
userId:用户ID。
- 0:成功。
- >0:失败。
setupRemoteView
public abstract int setupRemoteView(String userId, SurfaceView view);
【功能说明】
设置远端流视图,该接口不影响收流。
【请求参数】
- userId:远端用户的唯一标识。
- view:远端窗口视图,view为null时,解除窗口绑定。
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。
setRemoteViewDisplayMode
public abstract int setRemoteViewDisplayMode(String userId, HRTCVideoDisplayMode viewMode);
【功能说明】
设置远端窗口渲染模式。
- userId:用户ID。
- viewMode:渲染模式,具体请参见HRTCVideoDisplayMode。
- 0:成功。
- >0:失败。
startRemoteSubStreamView
public abstract int startRemoteSubStreamView(String userId, SurfaceView view);
【功能说明】
开始订阅辅流。
【请求参数】
- userId:用户ID。
- view:窗口视图。
- 0:成功。
- >0:失败。
stopRemoteSubStreamView
public abstract int stopRemoteSubStreamView(String userId);
【功能说明】
停止订阅辅流。
【请求参数】
userId:用户ID。
- 0:成功。
- >0:失败。
setRemoteSubStreamViewRotation
public abstract int setRemoteSubStreamViewRotation(String userId, HRTCRotationType rotation);
【功能说明】
设置辅流角度。
- userId:用户ID。
- rotation:辅流角度,具体请参见HRTCRotationType。
- 0:成功。
- >0:失败。
setRemoteSubStreamViewDisplayMode
public abstract int setRemoteSubStreamViewDisplayMode(String userId, HRTCVideoDisplayMode viewMode);
【功能说明】
设置辅流渲染模式。
- userId:用户ID。
- viewMode:渲染模式,具体请参见HRTCVideoDisplayMode。
- 0:成功。
- >0:失败。
connectOtherRoom
public abstract int connectOtherRoom(HRTCConnectInfo connectInfo);
【功能说明】
开启跨房,加入其他房间。
【请求参数】
connectInfo:设置开启跨房的房间号和角色,具体请参见HRTCConnectInfo。
- 0:成功。
- > 0:失败。
【注意事项】
- 开启跨房前,需要保证该用户在本房间内为joiner角色。开启跨房后,该用户在本房间不允许再切换角色。
- 开启跨房,需要以player角色加入其他房间,即请求参数connectInfo.role需要设置为HRTC_ROLE_TYPE_PLAYER。
disconnectOtherRoom
public abstract int disconnectOtherRoom(HRTCConnectInfo connectInfo);
【功能说明】
结束跨房,离开其他房间。
【请求参数】
connectInfo:设置跨房的房间号和角色,具体请参见HRTCConnectInfo。
【返回参数】
- 0:成功。
- > 0:失败。
【注意事项】
该调用仅使用户离开connectOtherRoom连接的房间,并不会离开本房间。
setRemoteAudioTopNVoice
public abstract int setRemoteAudioTopNVoice(int topNVoice);
【功能说明】
设置在所有可接收的音频流中,接收前N个音量最大的音频流。
【请求参数】
topNVoice:设置接收的音频流数量。
- 0:成功。
- > 0:失败。
【注意事项】
默认接收所有用户的音频流。互动视频建议参数设置为3,接收前3个音量最大的音频流。
muteRemoteAudio
public abstract int muteRemoteAudio(String userId, boolean mute);
【功能说明】
设置是否接收对应远端用户的音频流。
- userId:用户ID。
- mute:true表示取消音频流接收,false表示开启音频流接收。
- 0:成功。
- > 0:失败。
muteAllRemoteAudio
public abstract int muteAllRemoteAudio(boolean mute);
【功能说明】
设置是否接收所有远端用户的音频流。
【请求参数】
mute:true表示取消音频流接收,false表示开启音频流接收。
- 0:成功。
- > 0:失败。
- 取消所有音频流接收,同时也会取消接收新加入用户的音频流。
- 开启所有音频流接收,同时也会开启接收新加入用户的音频流。
- 默认开启所有音频流接收。
muteRemoteVideo
public abstract int muteRemoteVideo(String userId, boolean mute);
【功能说明】
开启、关闭指定远端用户的视频流。
【请求参数】
- userId:远端用户的userId,唯一标识。
- mute:true表示关闭接收,false表示开启接收。
【返回参数】
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。
muteAllRemoteVideo
public abstract int muteAllRemoteVideo(boolean mute);
【功能说明】
批量开启、关闭当前所有远端用户的视频流。
【请求参数】
mute:true表示关闭接收,false表示开启接收, 默认开启接收。
【返回参数】
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。
【注意事项】
- 调用setDefaultMuteAllRemoteVideoStreams设置为true时,调用muteAllRemoteVideo不论参数是true还是false,新加入用户都不会接收视频流,可通过muteRemoteVideo传入此用户userId和false来接收此用户视频流。
- 调用setDefaultMuteAllRemoteVideoStreams设置为false时,调用muteAllRemoteVideo参数为true时,新加入用户不接收视频流,为false时,新加入用户自动接收视频流。
setExternalAudioCapture
public abstract int setExternalAudioCapture(boolean audioEnable,int sampleRate,int channels);
【功能说明】
设置是否开启外部音频采集。需要在加入房间前调用。
- audioEnable:true表示音频使用外部采集,false表示音频不使用外部采集。
- sampleRate:采样率,当前支持8k、16k、44.1k、48k等采样率。
- channels:频道数,当前只支持单声道。
【返回参数】
- 0:成功。
- > 0:失败。
【注意事项】
如果使用外部输入音频数据,需要在加入房间后,按照一定时间间隔调用pushExternalAudioFrame接口输入音频数据。
setExternalVideoCapture
public abstract int setExternalVideoCapture(boolean videoEnable);
【功能说明】
设置是否开启视频外部采集。需要在加入房间前调用。
【请求参数】
videoEnable:true表示视频使用外部采集,false表示视频不使用外部采集。
【返回参数】
- 0:成功。
- > 0:失败。
【注意事项】
如果使用外部输入视频数据,需要在加入房间后,按照一定时间间隔调用pushExternalVideoFrame接口输入视频数据。
pushExternalAudioFrame
public abstract int pushExternalAudioFrame(byte[] audioData);
【功能说明】
输入外部音频数据。
【请求参数】
audioData:音频数据。
返回参数】
- 0:成功。
- > 0:失败。
【注意事项】
需要按照一定的时间间隔进行输入,例如,每次输入10ms的数据。
pushExternalVideoFrame
public abstract int pushExternalVideoFrame(HRTCVideoFrame videoFrame);
【功能说明】
输入外部视频数据。
【请求参数】
videoFrame:视频数据,具体请参见HRTCVideoFrame。
【返回参数】
- 0:成功。
- > 0:失败。
【注意事项】
需要按照一定的时间间隔进行输入,例如,视频原本为15帧/秒,则需要间隔1000/15毫秒间隔输入视频数据。
renewSignature
public abstract int renewSignature(String signature, long ctime);
【功能说明】
鉴权签名过期,收到onSignatureExpired回调后更新鉴权签名。
【请求参数】
- signature:鉴权签名字符串。
- ctime:过期时间,单位:秒。
【返回参数】
- 0:成功。
- > 0:失败。
setLocalViewMirror
public abstract int setLocalViewMirror(HRTCVideoMirrorType mirrorType);
【功能说明】
设置本地视频的镜像模式。
【请求参数】
mirrorType:镜像模式,是否开启镜像,具体请参见HRTCVideoMirrorType。
【返回参数】
- 0:成功。
- > 0:失败。
【注意事项】
开启本地镜像后,本地视频窗口看到的是镜像视图,但不影响远端查看自己的视图。
setVideoEncoderMirror
public abstract int setVideoEncoderMirror(HRTCVideoMirrorType mirrorType);
【功能说明】
设置视频编码镜像模式。
【请求参数】
mirrorType:镜像模式,是否开启镜像,具体请参见HRTCVideoMirrorType。
【返回参数】
- 0:成功。
- > 0:失败。
【注意事项】
开启镜像后,仅改变编码发送给远端用户的视图,不影响自己看到的本地视频窗口。
enableLocalAudio
public abstract int enableLocalAudio(boolean enabled);
【功能说明】
设置是否开启音频采集。
【请求参数】
enabled:true表示开启,false表示关闭。
【返回参数】
- 0:成功。
- > 0:失败。
【注意事项】
默认开启,远端用户选看该用户时,远端用户会触发onRemoteAudioStateChanged远端视频流状态变化回调。
enableLocalVideo
public abstract int enableLocalVideo(boolean enabled);
【功能说明】
设置是否开启摄像头采集视频。
【请求参数】
enabled:true表示开启,false表示关闭。
【返回参数】
- 0:成功。
- > 0:失败。
【注意事项】
默认开启,远端用户选看该用户时,远端用户会触发onRemoteVideoStateChanged远端视频流状态变化回调。
setLayoutDirect
public abstract void setLayoutDirect(int layoutDirect);
【功能说明】
设置显示模式,区分横屏和竖屏,用于保证摄像头方向与本地界面方向一致。
【请求参数】
layoutDirect:0表示横屏模式,1表示竖屏模式。
【返回参数】
无
startAudioFile
public abstract int startAudioFile(String fullFilePath, int playMode, int cycle, int replace);
【功能说明】
开始播放音频文件。当前仅支持本端播放。
【请求参数】
- fullFilePath:音频文件的本地全路径。
- playMode:播放模式,0表示本端播放,当前只支持0 。
- cycle:循环次数,0表示无限循环。
- replace:预留参数。
- 0:表示调用播放命令成功。
- > 0:表示调用播放命令失败。
stopAudioFile
public abstract int stopAudioFile();
【功能说明】
停止播放音频文件。
【请求参数】
无
- 0:表示调用停止命令成功。
- > 0:表示调用停止命令失败。
pauseAudioFile
public abstract int pauseAudioFile();
【功能说明】
暂停播放音频文件。
【请求参数】
无
【返回参数】
- 0:表示调用暂停命令成功。
- > 0:表示调用暂停命令失败。
resumeAudioFile
public abstract int resumeAudioFile();
【功能说明】
恢复播放音频文件。
【请求参数】
无
- 0:表示调用恢复播放命令成功。
- > 0:表示调用恢复播放命令失败。
startNetworkTest
public abstract int startNetworkTest(HRTCNetworkTestConfig networkTestConfig);
【功能说明】
启动入会前网络检测。
【请求参数】
networkTestConfig:检测配置信息,具体请参见HRTCNetworkTestConfig。
- 0:表示调用启动命令成功。
- > 0:表示调用启动命令失败。
stopNetworkTest
public abstract int stopNetworkTest();
【功能说明】
停止入会前网络检测。
【请求参数】
无
- 0:表示调用停止命令成功。
- > 0:表示调用停止命令失败。
enableRtcStats
public abstract int enableRtcStats(boolean enabled);
【功能说明】
打点功能开关,可以在初始化前或初始化之后调用。默认开启。
【请求参数】
enabled:是否打开打点功能开关,true表示打开,false表示关闭。
- 0:表示调用命令成功。
- > 0:表示调用命令失败。
enableUserVolumeNotify
public abstract int enableUserVolumeNotify(int interval);
【功能说明】
设置音量值上报回调函数(onUserVolumeStats)的回调周期。
【请求参数】
interval:音量值上报周期,默认关闭音量回调。
- 0:关闭音量回调。
- [100,10000]:有效值范围,单位:毫秒。
【返回参数】
- 0:方法调用成功。
- > 0:方法调用失败。
setDefaultMuteAllRemoteVideoStreams
public abstract int setDefaultMuteAllRemoteVideoStreams(boolean mute);
【功能说明】
设置是否默认自动接收新用户视频流。在入会前调用。
【请求参数】
- mute:true表示关闭自动接收,false表示开启自动接收。 默认关闭自动接收。
【返回参数】
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。
【注意事项】
- 调用setDefaultMuteAllRemoteVideoStreams设置为true时,调用muteAllRemoteVideo不论参数是true还是false,新加入用户都不会接收视频流,可通过muteRemoteVideo传入此用户userId和false接收此用户视频流。
- 调用setDefaultMuteAllRemoteVideoStreams设置为false时,调用muteAllRemoteVideo参数为true时,新加入用户不接收视频流,为false时,新加入用户自动接收视频流。
setVideoEncodeResolutionMode
- (int)setVideoEncodeResolutionMode:(HWRtcVideoEncodeResolutionMode)mode;
【功能说明】
设置视频编码分辨率比例模式 。
【请求参数】
- mode:视频模式,具体请参见 HWRtcVideoEncodeResolutionMode。
【返回参数】
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见客户端错误码。
