RtcEngine

setLogParam

public static int setLogParam(boolean enable, HRTCLogLevel logInfo)

【功能说明】

设置日志参数。需要在创建RTC引擎之前调用。

create

public static synchronized HRTCEngine create(Context context, String domain, String appId, IHRTCEngineEventHandler eventHandler)

【功能说明】

创建RTC引擎实例。

【返回参数】

返回引擎实例对象。

destroy

public static synchronized void destroy()

【功能说明】

销毁RTC引擎。

【请求参数】

无

【返回参数】

无

joinRoom

public abstract int joinRoom(HRTCUserInfo userInfo, String roomId, HRTCMediaType mediaType);

【功能说明】

加入房间。

【注意事项】

leaveRoom

public abstract int leaveRoom()

【功能说明】

离开房间。

【请求参数】

无

【注意事项】

createRenderer

public static SurfaceView createRenderer(Context context)

【功能说明】

创建渲染视图。

【请求参数】

context：上下文。

【返回参数】

创建的渲染视图。

setupLocalView

public abstract int setupLocalView(SurfaceView view, HRTCVideoDisplayMode viewMode);

【功能说明】

设置本地窗口。

switchCamera

public abstract int switchCamera();

【功能说明】

切换摄像头，成功加入房间后才能调用。

【请求参数】

无

muteLocalAudio

public abstract int muteLocalAudio(boolean mute);

【功能说明】

设置是否发送本地音频流。

【请求参数】

mute：true表示不发送，false表示发送。

【注意事项】

成功加入房间发送音频流后才能调用，默认为发送本地音频流。

setSpeakerModel

public abstract int setSpeakerModel(HRTCSpeakerModel speakerModel);

【功能说明】

设置声音播放模式。成功加入房间后才能调用。

【请求参数】

speakerModel：声音播放模式，具体请参见HRTCSpeakerModel。

muteLocalVideo

public abstract int muteLocalVideo(boolean mute);

【功能说明】

设置是否发送本地视频流。成功加入房间后才能调用。

【请求参数】

mute：true表示不发送，false表示发送。

logUpload

public abstract int logUpload();

【功能说明】

上传日志。

【请求参数】

无

【注意事项】

adjustRecordingVolume

public abstract int adjustRecordingVolume(int volume);

【功能说明】

调整录制音量值。

【请求参数】

volume：音量值，取值范围：[0,100]。

adjustPlaybackVolume

public abstract int adjustPlaybackVolume(int volume);

【功能说明】

调整播放音量值。

【请求参数】

volume：音量值，取值范围：[0,100]。

setVideoEncParam

public abstract int setVideoEncParam(int totalBitRate, List <HRTCVideoEncParam> encoderParams);

【功能说明】

设置视频编码参数。

setUserRole

public abstract int setUserRole(HRTCRoleType role);

【功能说明】

设置用户角色，可以在自己所在的房间内切换角色。

【请求参数】

role：用户角色，具体请参见HRTCRoleType。

【注意事项】

setUserRole

public abstract int setUserRole(String roomId, HRTCRoleType role);

【功能说明】

设置用户角色，可以在房间内切换角色。

【注意事项】

startPreview

public abstract int startPreview();

【功能说明】

开始本地预览。

【请求参数】

无。

【注意事项】

加入房间之前进行预览，如果需要加入房间，需要调用stopPreview停止预览后再加入房间。

stopPreview

public abstract int stopPreview();

【功能说明】

停止本地预览。

【请求参数】

无

setExternalAudioFrameOutputEnable

public abstract int setExternalAudioFrameOutputEnable(boolean localEnable,boolean remoteEnable);

【功能说明】

设置音频数据输出使能。

【返回参数】

• 0：成功。
• 非0：失败。

【注意事项】

通过onPlaybackAudioFrame回调音频数据。

setExternalVideoFrameOutputEnable

public abstract int setExternalVideoFrameOutputEnable(boolean localEnable,boolean remoteEnable);

【功能说明】

设置视频数据输出使能。

【返回参数】

• 0：成功。
• 非0：失败。

【注意事项】

设置完视频使能之后，需要调用selectVideoFrameOutput选择特定用户的视频数据。通过onRenderVideoFrame回调视频数据

setExternalDataFrameOutputEnable

public abstract int setExternalDataFrameOutputEnable(boolean localEnable,boolean remoteEnable);

【功能说明】

设置共享数据输出使能。Android平台接口暂不提供本地共享数据的设置。

【返回参数】

• 0：成功。
• 非0：失败。

【注意事项】

设置完视频使能之后，需要调用selectVideoFrameOutput选择特定用户的视频数据。通过onRenderDataFrame回调视频数据

selectVideoFrameOutput

public abstract int selectVideoFrameOutput(String userId);

【功能说明】

选择特定用户的视频数据输出。

【请求参数】

userId：用户ID。

【注意事项】

选择之后也可以通过unSelectVideoFrameOutput方法去除选择，达到不让特定用户数据输出的目的。

unSelectVideoFrameOutput

public abstract int unSelectVideoFrameOutput(String userId);

【功能说明】

去除选择特定用户的视频数据输出。

【请求参数】

userId：用户ID。

startRemoteStreamView

public abstract int startRemoteStreamView(String userId, SurfaceView view, HRTCStreamType streamType);
public abstract int startRemoteStreamView(String userId, SurfaceView view, HRTCStreamType streamType, boolean disableAdjustRes);

【功能说明】

开始选看远端窗口。

【返回参数】

• 0：成功。
• 1：失败。

【注意事项】

选看当前还未选看的用户或者选看用户的的流类型发生了变化时，将会触发onFirstRemoteVideoDecoded回调。

stopRemoteStreamView

public abstract int stopRemoteStreamView(String userId);

【功能说明】

停止选看远端窗口。

【请求参数】

userId：用户ID。

setRemoteViewDisplayMode

public abstract int setRemoteViewDisplayMode(String userId, HRTCVideoDisplayMode viewMode);

【功能说明】

设置远端窗口渲染模式。

startRemoteSubStreamView

public abstract int startRemoteSubStreamView(String userId, SurfaceView view);

【功能说明】

开始选看辅流。

【请求参数】

• userId：用户ID。
• view：窗口视图。

stopRemoteSubStreamView

public abstract int stopRemoteSubStreamView(String userId);

【功能说明】

停止选看辅流。

【请求参数】

userId：用户ID。

setRemoteSubStreamViewRotation

public abstract int setRemoteSubStreamViewRotation(String userId, HRTCRotationType rotation);

【功能说明】

设置辅流角度。

setRemoteSubStreamViewDisplayMode

public abstract int setRemoteSubStreamViewDisplayMode(String userId, HRTCVideoDisplayMode viewMode);

【功能说明】

设置辅流渲染模式。

connectOtherRoom

public abstract int connectOtherRoom(HRTCConnectInfo connectInfo);

【功能说明】

开启跨房，加入其他房间。

【请求参数】

connectInfo：设置开启跨房的房间号和角色，具体请参见HRTCConnectInfo。

【注意事项】

disconnectOtherRoom

public abstract int disconnectOtherRoom(HRTCConnectInfo connectInfo);

【功能说明】

结束跨房，离开其他房间。

【请求参数】

connectInfo：设置跨房的房间号、角色，具体请参见HRTCConnectInfo。

【返回参数】

• 0：成功
• > 0：失败

【注意事项】

该调用只会使得用户离开connectOtherRoom连接的房间，并不会离开本房间。

setRemoteAudioTopNVoice

public abstract int setRemoteAudioTopNVoice(int topNVoice);

【功能说明】

设置在所有可接收的音频流中，接收前N个音量最大的音频流。

【请求参数】

topNVoice：设置接收的音频流数量。

【注意事项】

默认接收所有用户的音频流。互动视频建议设置参数为3。接收前3个音量最大的音频流。

muteRemoteAudio

public abstract int muteRemoteAudio(String userId, boolean mute);

【功能说明】

设置是否接收对应远端用户的音频流。

muteAllRemoteAudio

public abstract int muteAllRemoteAudio(boolean mute);

【功能说明】

设置是否接收所有用户的音频流。

【请求参数】

mute：true表示取消音频流接收。false表示开启音频流接收。

setExternalAudioCapture

public abstract int setExternalAudioCapture(boolean audioEnable,int sampleRate,int 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毫秒间隔来输入视频数据。

setLocalViewMirror

public abstract int setLocalViewMirror(HRTCVideoMirrorType mirrorType);

【功能说明】

设置本地视频的镜像模式。

【请求参数】

mirrorType：镜像模式，是否开启镜像，具体请参见HRTCVideoMirrorType。

【返回参数】

• 0：成功
• > 0：失败

【注意事项】

开启本地镜像后，本地视频窗口看到的是镜像视图，不影响远端看自己的视图。

setVideoEncoderMirror

public abstract int setVideoEncoderMirror(HRTCVideoMirrorType mirrorType);

【功能说明】

设置视频编码镜像模式。

【请求参数】

mirrorType：镜像模式，是否开启镜像，具体请参见HRTCVideoMirrorType。

【返回参数】

• 0：成功
• > 0：失败

【注意事项】

开启镜像后，仅改变编码发送给远端用户的视图，不影响自己看到的本地视频窗口。

enableLocalVideo

public abstract int enableLocalVideo(boolean enabled);

【功能说明】

设置是否开启摄像头采集视频

【请求参数】

enable：true表示开启。false表示关闭。

【注意事项】

默认开启，关闭不会影响视频流发送，不会触发远端流状态变化回调。

setLayoutDirect

public abstract void setLayoutDirect(int layoutDirect);

【功能说明】

设置显示模式，区分横屏和竖屏，用于保证摄像头方向与本地界面方向一致

【请求参数】

layoutDirect：0表示横屏模式，1表示竖屏模式。

【返回参数】

无

startAudioFile

public abstract int startAudioFile(String fullFilePath, int playMode, int cycle, int replace);

【功能说明】

开始播放音频文件。

【请求参数】

• fullFilePath：音频文件的本地全路径，或者远程的HTTP地址。
• playMode：播放模式，0表示播放本地文件，1表示播放远程文件。
• cycle：循环次数，0表示无限循环。
• replace：远端模式下面是否需要和麦克风做混音。

stopAudioFile

public abstract int stopAudioFile();

【功能说明】

停止播放音频文件。

【请求参数】

无

pauseAudioFile

public abstract int pauseAudioFile();

【功能说明】

暂停播放音频文件。

【请求参数】

无

【返回参数】

• 0：表示调用暂停命令成功。
• 非0：表示调用暂停命令失败。

resumeAudioFile

public abstract int resumeAudioFile();

【功能说明】

恢复播放音频文件。

【请求参数】

无

startNetworkTest

public abstract int startNetworkTest(HRTCNetworkTestConfig networkTestConfig);

【功能说明】

启动入会前网络检测。

【请求参数】

networkTestConfig：检测配置信息，具体请参见HRTCNetworkTestConfig。

stopNetworkTest

public abstract int stopNetworkTest();

【功能说明】

停止入会前网络检测。

【请求参数】

无

enableRtcStats

public abstract int enableRtcStats(boolean enabled);

【功能说明】

打点功能开关，可以在初始化前或初始化之后调用。

【请求参数】

enabled：是否打开功能开关，true表示打开，false表示关闭。