NERtc Android SDK
V4.6.20
|
Public 成员函数 | |
abstract void | init (Context context, String appkey, NERtcCallback callback, NERtcOption option) throws Exception |
abstract void | release () |
abstract int | joinChannel (String token, String channelName, long uid) |
abstract int | leaveChannel () |
abstract int | enableLocalAudio (boolean enable) |
abstract int | subscribeRemoteAudioStream (long uid, boolean subscribe) |
abstract int | subscribeAllRemoteAudioStreams (boolean subscribe) |
abstract int | setAudioProfile (int profile, int scenario) |
abstract int | setLocalVideoConfig (NERtcVideoConfig videoConfig) |
abstract int | setLocalVideoConfig (NERtcVideoConfig videoConfig, NERtcVideoStreamType streamType) |
abstract int | setCameraCaptureConfig (NERtcCameraCaptureConfig captureConfig) |
abstract int | setCameraCaptureConfig (NERtcCameraCaptureConfig captureConfig, NERtcVideoStreamType streamType) |
abstract int | startVideoPreview () |
abstract int | startVideoPreview (NERtcVideoStreamType streamType) |
abstract int | stopVideoPreview () |
abstract int | stopVideoPreview (NERtcVideoStreamType streamType) |
abstract int | setupLocalVideoCanvas (IVideoRender render) |
abstract int | setupRemoteVideoCanvas (IVideoRender render, long uid) |
abstract int | enableLocalVideo (boolean enable) |
abstract int | enableLocalVideo (NERtcVideoStreamType streamType, boolean enable) |
abstract int | subscribeRemoteVideoStream (long uid, NERtcRemoteVideoStreamType streamType, boolean subscribe) |
abstract void | setParameters (NERtcParameters params) throws IllegalArgumentException |
静态 Public 成员函数 | |
static NERtc | getInstance () |
static NERtcVersion | version () |
static List< String > | checkPermission (Context context) |
|
static |
音视频通话相关的多媒体设备权限检查。
context | 上下文。 |
|
abstract |
开启/关闭本地音频采集和发送。
当 App 加入房间时,语音功能默认为开启状态。
该方法不影响接收或播放远端音频流,enableLocalAudio(false) 适用于只下行不上行音频流的场景。
成功调用该方法后,房间内其他用户触发 onUserAudioStart 或 onUserAudioStop 回调。
enable | 是否开启本地语音。
|
|
abstract |
是否开启本地视频采集。
注意:
enable | 是否启用本地视频采集: |
|
abstract |
开启或关闭本地视频的采集与发送。
通过主流或辅流视频通道进行本地视频流的采集与发送。
参数名称 | 类型 | 描述 |
---|---|---|
streamType | video.NERtcVideoStreamType | 视频通道类型:
|
enable | boolean | 是否开启本地视频采集与发送:
|
|
static |
|
abstract |
创建 NERtc 实例并初始化 NERTC SDK 服务。
context | 传入的 RTC engine context 对象。 |
appkey | 应用的 App Key。在 云信控制台 创建应用后,可以查看对应的 App Key。 |
callback | 回调函数,所有接口均在主线程上回调, 可继承简易实现AbsNERtcCallbackEx, 或自行选择实现NERtcCallback、NERtcCallbackEx |
option | 其他可选配置,详细信息请参考 NERtcOption 。可设置为 null。 |
|
abstract |
加入音视频房间。
加入音视频房间时,如果指定房间尚未创建,云信服务器内部会自动创建一个同名房间。
成功调用该方加入房间后,本地会触发 onJoinChannel 回调,远端会触发 onUserJoined 回调。
token | 安全认证签名(NERTC Token)。可设置为:
|
channelName | 房间名称,设置相同房间名称的用户会进入同一个通话房间。
|
uid | 用户的唯一标识 id,房间内每个用户的 uid 必须是唯一的。 uid 可选,默认为 0。如果不指定(即设为 0),SDK 会自动分配一个随机 uid,并在 onJoinChannel 回调方法中返回,App 层必须记住该返回值并维护,SDK 不对该返回值进行维护。 |
|
abstract |
离开房间,即挂断或退出通话。
结束通话时,必须调用 leaveChannel 结束通话,否则无法开始下一次通话。
成功调用该方法离开房间后,本地会触发 onLeaveChannel 回调,远端会触发 onUserLeave 回调。
|
abstract |
销毁 NERtc 实例,释放资源。
该方法释放 NERTC SDK 使用的所有资源。有些 App 只在用户需要时才进行实时音视频通信,完成音视频通话后,则将资源释放出来用于其他操作,该方法适用于此类情况。
leaveChannel
、并收到 onUserLeave
回调后调用。或收到 onDisconnect
回调、重连失败时调用此接口销毁实例,并释放资源。release
方法后,您将无法再使用 SDK 的其它方法和回调。如需再次使用实时音视频通话功能,您必须等待 release
方法执行结束后,重新创建一个新的 NERtc 实例。 init
初始化引擎失败,需要等待 release
同步返回后再次初始化引擎,否则重复初始化引擎,SDK 会抛出 RuntimeException。
|
abstract |
设置音频编码属性。
profile | 设置采样率、码率、编码模式和声道数。详细信息请参考 NERtcConstants.AudioProfile。 |
scenario | 设置音频应用场景。详细信息请参考 NERtcConstants.AudioScenario。 |
|
abstract |
设置本地摄像头的采集偏好等配置。
在视频通话或直播中,SDK 自动控制摄像头的输出参数。默认情况下,SDK 根据用户的 setLocalVideoConfig 配置匹配最合适的分辨率进行采集。但是在部分业务场景中,如果采集画面质量无法满足实际需求,可以调用该接口调整摄像头的采集配置。
captureConfig | 摄像头采集配置,详细信息请参考 video.NERtcCameraCaptureConfig。 |
|
abstract |
设置本地摄像头的采集配置。
通过此接口可以设置本地摄像头采集的视频宽度、高度、旋转角度等。
参数名称 | 类型 | 描述 |
---|---|---|
captureConfig | video.NERtcCameraCaptureConfig | 本地摄像头采集配置。 |
streamType | video.NERtcVideoStreamType | 视频通道类型:
|
|
abstract |
设置视频编码属性。
width
和 height
进行自定义设置摄像头采集视频的编码分辨率。详细信息请参考设置视频属性。 videoConfig | 视频编码属性配置,详细信息请参考 video.NERtcVideoConfig。 |
|
abstract |
设置视频编码属性。
通过此接口可以设置视频主流或辅流的编码分辨率、裁剪模式、码率、帧率、带宽受限时的视频编码降级偏好、编码的镜像模式、编码的方向模式参数。
参数名称 | 类型 | 描述 |
---|---|---|
streamType | video.NERtcVideoConfig | 视频通道类型:
|
videoConfig | boolean | 视频编码属性配置。 |
|
abstract |
设置音视频通话的相关参数。
注意:
params | 音视频通话的相关参数。 |
|
abstract |
设置本地视图。
该方法设置本地视频显示信息。只影响本地用户看到的视频画面,不影响远端。 App 通过调用此接口绑定本地视频流的显示视窗(view)。
在 App 开发中,通常在初始化后调用该方法进行本地视频设置,然后再加入房间。
render | 视频画布。详细信息请参考 video.NERtcVideoView。 |
|
abstract |
设置远端用户视图。
该方法绑定远端用户和显示视图,并设置远端用户视图在本地显示时的渲染模式和镜像模式,只影响本地用户看到的视频画面。
注意:
render | 视频画布。详细信息请参考 video.NERtcVideoView。 |
uid | 远端用户 ID。 |
|
abstract |
开启视频预览。
|
abstract |
开启视频预览。
通过本接口可以实现在加入房间前启动本地视频预览,支持预览本地摄像头或外部输入视频。
参数名称 | 类型 | 描述 |
---|---|---|
streamType | video.NERtcVideoStreamType | 视频通道类型:
|
|
abstract |
|
abstract |
停止视频预览。
通过本接口可以实现在预览本地视频后关闭预览。
参数名称 | 类型 | 描述 |
---|---|---|
streamType | video.NERtcVideoStreamType | 视频通道类型:
|
|
abstract |
取消或恢复订阅所有远端用户音频流。
subscribe | 是否取消订阅所有远端用户的音频流。
|
|
abstract |
取消或恢复订阅指定远端用户音频流。
加入房间时,默认订阅所有远端用户的音频流,您可以通过此方法取消或恢复订阅指定远端用户的音频流。
注意:该方法需要在加入房间后调用。
uid | 指定用户的 ID。 |
subscribe | 是否订阅指定音频流。
|
|
abstract |
订阅或取消订阅指定远端用户的视频流。
uid | 指定用户的用户 ID。 |
streamType | 订阅的视频流类型,详细信息请参考 video.NERtcRemoteVideoStreamType。 |
subscribe | 是否订阅远端用户的视频流。
|
|
static |
查询 SDK 版本号。
该方法在加入房间前后都能调用。