NERtc

java.lang.Object
- com.netease.lava.nertc.sdk.NERtc

直接已知子类:: NERtcEx

public abstract class NERtc
extends java.lang.Object

构造器概要

构造器
构造器和说明

NERtc()

构造器
构造器和说明
`NERtc()`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`static java.util.List<java.lang.String>`	`checkPermission(android.content.Context context)` 音视频通话相关的多媒体设备权限检查。
`abstract int`	`enableLocalAudio(boolean enable)` 开启/关闭本地音频采集。
`abstract int`	`enableLocalVideo(boolean enable)` 是否开启本地视频采集。
`static NERtc`	`getInstance()` 获取 NERtc 实例。
`abstract void`	`init(android.content.Context context, java.lang.String appkey, NERtcCallback callback, NERtcOption option)` 创建 NERtc 实例并初始化 NERTC SDK 服务。
`abstract int`	`joinChannel(java.lang.String token, java.lang.String channelName, long uid)` 加入音视频房间。
`abstract int`	`leaveChannel()` 离开房间，即挂断或退出通话。
`abstract void`	`release()` 销毁 NERtc 实例，释放资源。
`abstract int`	`setAudioProfile(int profile, int scenario)` 设置音频编码属性。
`abstract int`	`setLocalVideoConfig(NERtcVideoConfig videoConfig)` 设置视频编码属性。
`abstract void`	`setParameters(NERtcParameters params)` 设置音视频通话的相关参数。
`abstract int`	`setupLocalVideoCanvas(com.netease.lava.api.IVideoRender render)` 设置本地视图。
`abstract int`	`setupRemoteVideoCanvas(com.netease.lava.api.IVideoRender render, long uid)` 设置远端用户视图。
`abstract int`	`startVideoPreview()` 开启视频预览。
`abstract int`	`stopVideoPreview()` 停止视频预览。
`abstract int`	`subscribeAllRemoteAudioStreams(boolean subscribe)` 取消或恢复订阅所有远端用户音频流。
`abstract int`	`subscribeRemoteAudioStream(long uid, boolean subscribe)` 取消或恢复订阅指定远端用户音频流。
`abstract int`	`subscribeRemoteVideoStream(long uid, NERtcRemoteVideoStreamType streamType, boolean subscribe)` 订阅或取消订阅指定远端用户的视频流。
`static NERtcVersion`	`version()` 查询 SDK 版本号。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - NERtc
```
public NERtc()
```
- 方法详细资料
  - getInstance
```
public static NERtc getInstance()
```
    获取 NERtc 实例。
    
    返回:
    
    NERtc 实例
  - init
```
public abstract void init(android.content.Context context,
                          java.lang.String appkey,
                          NERtcCallback callback,
                          NERtcOption option)
                   throws java.lang.Exception
```
    创建 NERtc 实例并初始化 NERTC SDK 服务。
    - 请确保在调用其他 API 前先调用该方法创建并初始化 NERtc 实例。
    - 使用同一个 App Key 的 App 才能进入同一个房间进行通话或直播。
    - 一个 App Key 只能用于创建一个 NERtc 实例。如需更换 App Key，必须先调用 release() 方法销毁当前实例，再调用本方法重新创建实例。
    - 若不再使用 NERtc 实例，需要 release() 调用进行销毁。
    - 创建实例时，如果参数设置错误，可能会出现异常 RuntimeException、UnsatisfiedLinkError。
    参数:
    
    context - 传入的 RTC engine context 对象。
    
    appkey - 应用的 App Key。在云信控制台创建应用后，可以查看对应的 App Key。
    
    callback - 回调函数，所有接口均在主线程上回调。
    
    option - 其他可选配置，详细信息请参考 NERtcOption 。可设置为 null。
    
    抛出:
    
    java.lang.Exception
  - release
```
public abstract void release()
```
    销毁 NERtc 实例，释放资源。
    该方法释放 NERTC SDK 使用的所有资源。有些 App 只在用户需要时才进行实时音视频通信，不需要时则将资源释放出来用于其他操作，该方法适用于此类情况。
    调用 release 方法后，您将无法再使用 SDK 的其它方法和回调。如需再次使用实时音视频通话功能，您必须重新创建一个新的 NERtc 实例。
    注意：如需在销毁后再次创建 NERtc 实例，需要等待 release() 方法执行结束后再创建实例。
  - joinChannel
```
public abstract int joinChannel(java.lang.String token,
                                java.lang.String channelName,
                                long uid)
```
    加入音视频房间。
    加入音视频房间时，如果指定房间尚未创建，云信服务器内部会自动创建一个同名房间。
    参数:
    token - 安全认证签名（NERTC Token）。可设置为：
    null。非安全模式下可设置为 null。安全性不高，建议在产品正式上线前联系对应商务经理转为安全模式。
    
    已获取的NERTC Token。安全模式下必须设置为获取到的 Token 。若未传入正确的 Token 将无法进入房间。推荐使用安全模式。
    channelName - 房间名称，设置相同房间名称的用户会进入同一个通话房间。
    字符串格式，长度为 1~64 字节。
    支持以下89个字符：a-z, A-Z, 0-9, space, !#$%&()+-:;≤.,>? @[]^_{|}~”
    uid - 用户的唯一标识 id，房间内每个用户的 uid 必须是唯一的。不可设置为 0 或负数。
    
    返回:
    
    0 方法调用成功，其他失败
    
    另请参阅:
    
    leaveChannel()
  - leaveChannel
```
public abstract int leaveChannel()
```
    离开房间，即挂断或退出通话。
    结束通话时，必须调用 leaveChannel 结束通话，否则无法开始下一次通话。
    
    成功调用该方法离开房间后，本地会触发 onLeaveChannel 回调，远端会触发 onUserLeave 回调。
    
    返回:
    
    0 成功，其他失败.
    
    另请参阅:
    
    joinChannel(String, String, long)
  - enableLocalAudio
```
public abstract int enableLocalAudio(boolean enable)
```
    开启/关闭本地音频采集。
    当 App 加入房间时，语音功能默认为开启状态。
    
    该方法不影响接收或播放远端音频流，enableLocalAudio(false) 适用于只下行不上行音频流的场景。
    
    注意：
    - 该方法与 muteLocalAudioStream 的区别在于，enableLocalAudio 用于开启本地语音采集及处理；muteLocalAudioStream 用于停止或继续发送本地音频流。
    - 该方法设置内部引擎为启用状态，在 leaveChannel 后仍然有效。
    参数:
    enable - 是否开启本地语音。
    true:（默认）重新开启本地语音，即开启本地语音采集。
    
    false: 关闭本地语音，即停止本地语音采集。
    返回:
    
    0 方法调用成功，其他失败
  - subscribeRemoteAudioStream
```
public abstract int subscribeRemoteAudioStream(long uid,
                                               boolean subscribe)
```
    取消或恢复订阅指定远端用户音频流。
    加入房间时，默认订阅所有远端用户的音频流，您可以通过此方法取消或恢复订阅指定远端用户的音频流。
    注意：该方法需要在加入房间后调用。
    参数:
    
    uid - 指定用户的 ID。
    subscribe - 是否订阅指定音频流。
    true:（默认）订阅音频流。
    
    false: 取消订阅音频流。
    返回:
    
    0 方法调用成功，其他失败
  - subscribeAllRemoteAudioStreams
```
public abstract int subscribeAllRemoteAudioStreams(boolean subscribe)
```
    取消或恢复订阅所有远端用户音频流。
    加入房间时，默认订阅所有远端用户的音频流，您可以通过此方法取消或恢复订阅所有远端用户的音频流。
    注意：
    - 该方法需要在加入房间后调用。
    - 对后续加入的用户也同样生效。
    参数:
    
    subscribe - 是否取消订阅所有远端用户的音频流。
    true:（默认）订阅音频流。
    false: 取消订阅音频流。
  返回:
  
  0 方法调用成功，其他失败
- setAudioProfile
```
public abstract int setAudioProfile(int profile,
                                    int scenario)
```
  设置音频编码属性。
  注意：该方法需要在 joinChannel 之前设置，joinChannel 后设置不生效。
  
  参数:
  
  profile - 设置采样率、码率、编码模式和声道数。详细信息请参考 NERtcConstants.AudioProfile。
  
  scenario - 设置音频应用场景。详细信息请参考 NERtcConstants.AudioScenario。
  
  返回:
  
  0 方法调用成功，其他失败
- setLocalVideoConfig
```
public abstract int setLocalVideoConfig(NERtcVideoConfig videoConfig)
```
  设置视频编码属性。
  注意：
  - 可以在加入房间前或加入房间后调用。
  - 设置成功后，下一次开启本端视频时生效。
  - 每个属性对应一套视频参数，例如分辨率、帧率、码率等。所有设置的参数均为理想情况下的最大值。
    当视频引擎因网络环境等原因无法达到设置的分辨率、帧率或码率的最大值时，会取最接近最大值的那个值。
  参数:
  
  videoConfig - 视频编码属性配置，详细信息请参考 NERtcVideoConfig。
  
  返回:
  
  0 方法调用成功，其他调用失败
- startVideoPreview
```
public abstract int startVideoPreview()
```
  开启视频预览。
  - 该方法用于在进入房间前启动本地视频预览。调用该 API 前，必须调用 setupLocalVideoCanvas 设置视频画布。
  - 启用本地视频预览后，在进入频道前，必须先调用 stopVideoPreview 关闭本地预览。
  返回:
  
  0 方法调用成功，其他调用失败
- stopVideoPreview
```
public abstract int stopVideoPreview()
```
  停止视频预览。
  注意：该方法需要在加入房间前调用。
  
  返回:
  
  0 方法调用成功，其他调用失败
- setupLocalVideoCanvas
```
public abstract int setupLocalVideoCanvas(com.netease.lava.api.IVideoRender render)
```
  设置本地视图。
  该方法设置本地视频显示信息。只影响本地用户看到的视频画面，不影响远端。 App 通过调用此接口绑定本地视频流的显示视窗（view）。
  在 App 开发中，通常在初始化后调用该方法进行本地视频设置，然后再加入房间。
  
  参数:
  
  render - 视频画布。详细信息请参考 NERtcVideoView。
  
  返回:
  
  0 方法调用成功，其他调用失败
  
  另请参阅:
  
  NERtcVideoView
- setupRemoteVideoCanvas
```
public abstract int setupRemoteVideoCanvas(com.netease.lava.api.IVideoRender render,
                                           long uid)
```
  设置远端用户视图。
  该方法绑定远端用户和显示视图，并设置远端用户视图在本地显示时的渲染模式和镜像模式，只影响本地用户看到的视频画面。
  注意：
  - 如果 App 无法事先知道对方的用户 ID，可以在 APP 收到 onUserJoined 事件时设置。
  - 解除某个用户的绑定视图可以把 render 设置为空。
  - 退出房间后，SDK 会清除远程用户和视图的绑定关系。
  参数:
  
  render - 视频画布。详细信息请参考 NERtcVideoView。
  
  uid - 远端用户 ID。
  
  返回:
  
  0 方法调用成功，其他调用失败
  
  另请参阅:
  
  NERtcVideoView
- enableLocalVideo
```
public abstract int enableLocalVideo(boolean enable)
```
  是否开启本地视频采集。
  注意：
  - 该方法在加入房间前和加入房间后均可调用。
  - 成功启用或禁用本地视频采集后，远端会触发 onUserVideoStop 或 onUserVideoStart 回调。
  参数:
  enable - 是否启用本地视频采集：
  - true：（默认）开启本地视频采集。
  - false：关闭本地摄像头设备。关闭后，远端用户会接收不到本地用户的视频流；但本地用户依然可以接收远端用户的视频流。
  返回:
  
  0 方法调用成功，其他调用失败
- subscribeRemoteVideoStream
```
public abstract int subscribeRemoteVideoStream(long uid,
                                               NERtcRemoteVideoStreamType streamType,
                                               boolean subscribe)
```
  订阅或取消订阅指定远端用户的视频流。
  用户加入房间之后，默认不订阅远端用户的视频流，如果希望看到指定远端用户的视频，可以在监听到对方加入房间或发布视频流之后，通过此方法订阅该用户的视频流。
  该方法需要在加入房间后调用。
  参数:
  
  uid - 指定用户的用户 ID。
  
  streamType - 订阅的视频流类型，详细信息请参考 NERtcRemoteVideoStreamType。
  subscribe - 是否取消订阅本地视频流。
  - true：（默认）订阅指定视频流。
  - false：不订阅指定视频流。
  返回:
  
  0 方法调用成功，其他调用失败
- setParameters
```
public abstract void setParameters(NERtcParameters params)
                            throws java.lang.IllegalArgumentException
```
  设置音视频通话的相关参数。
  注意：
  - 请在调用 init 初始化之前调用此方法。
  - 此方法提供技术预览或特别定制功能，若您需要使用此接口，请咨询技术支持获取帮助。
  参数:
  
  params - 音视频通话的相关参数。
  
  抛出:
  
  java.lang.IllegalArgumentException
- version
```
public static NERtcVersion version()
```
  查询 SDK 版本号。
  该方法在加入房间前后都能调用。
  
  返回:
  
  NERtcVersion 版本号
- checkPermission
```
public static java.util.List<java.lang.String> checkPermission(android.content.Context context)
```
  音视频通话相关的多媒体设备权限检查。
  
  参数:
  
  context - 上下文。
  
  返回:
  
  返回缺失的权限。

类 NERtc

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

NERtc

方法详细资料

getInstance

init

release

joinChannel

leaveChannel

enableLocalAudio

subscribeRemoteAudioStream

subscribeAllRemoteAudioStreams

setAudioProfile

setLocalVideoConfig

startVideoPreview

stopVideoPreview

setupLocalVideoCanvas

setupRemoteVideoCanvas

enableLocalVideo

subscribeRemoteVideoStream

setParameters

version

checkPermission