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实例,创建实例时可能会出现异常 `RuntimeException` , `UnsatisfiedLinkError` .
`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)` 设置音频场景与模式，必须在 joinChannel 前设置有效。
`abstract int`	`setLocalVideoConfig(NERtcVideoConfig videoConfig)` 设置视频参数（分辨率、摄像头位置等）
`abstract void`	`setParameters(NERtcParameters params)` 设置参数大部分参数需要在`init(Context, String, NERtcCallback, NERtcOption)`前设置才能生效
`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()` 版本号

从类继承的方法 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实例,创建实例时可能会出现异常 RuntimeException , UnsatisfiedLinkError .
    成功创建后不用时需要调用 release() 进行销毁} .
    
    参数:
    
    context - applicationContext
    
    appkey - App Key. https://app.netease.im .
    
    callback - 回调函数，所有接口都在主线程上回调
    
    option - NERtcOption 可选参数，可以为null
    
    抛出:
    
    java.lang.Exception
  - release
```
public abstract void release()
```
    销毁NERtc实例，释放资源
  - joinChannel
```
public abstract int joinChannel(java.lang.String token,
                                java.lang.String channelName,
                                long uid)
```
    加入频道
    
    参数:
    
    token - token, 如果为 null , 则会采用非安全模式.
    
    channelName - 频道名.
    
    uid - 用户id, 不能为 0.
    
    返回:
    
    0 方法调用成功，其他失败
    
    另请参阅:
    
    leaveChannel()
  - leaveChannel
```
public abstract int leaveChannel()
```
    离开频道.
    
    返回:
    
    0 成功，其他失败.
    
    另请参阅:
    
    joinChannel(String, String, long)
  - enableLocalAudio
```
public abstract int enableLocalAudio(boolean enable)
```
    开启/关闭本地语音（采集和发送）
    
    参数:
    
    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 前设置有效。
    
    参数:
    
    profile - 设置采样率，码率，编码模式和声道数 NERtcConstants.AudioProfile
    
    scenario - 设置音频应用场景 NERtcConstants.AudioScenario
    
    返回:
    
    0 方法调用成功，其他失败
  - setLocalVideoConfig
```
public abstract int setLocalVideoConfig(NERtcVideoConfig videoConfig)
```
    设置视频参数（分辨率、摄像头位置等）
    
    参数:
    
    videoConfig - NERtcVideoConfig
    
    返回:
    
    0 方法调用成功，其他调用失败
  - startVideoPreview
```
public abstract int startVideoPreview()
```
    开启视频预览
    
    返回:
    
    0 方法调用成功，其他调用失败
  - stopVideoPreview
```
public abstract int stopVideoPreview()
```
    停止视频预览
    
    返回:
    
    0 方法调用成功，其他调用失败
  - setupLocalVideoCanvas
```
public abstract int setupLocalVideoCanvas(com.netease.lava.api.IVideoRender render)
```
    设置本地预览画布,同一个画布只能设置给一个用户
    
    参数:
    
    render - 视频绘制画布
    
    返回:
    
    0 方法调用成功，其他调用失败
    
    另请参阅:
    
    NERtcVideoView
  - setupRemoteVideoCanvas
```
public abstract int setupRemoteVideoCanvas(com.netease.lava.api.IVideoRender render,
                                           long uid)
```
    设置远端用户预览画布
    
    参数:
    
    render - 视频绘制画布
    
    uid - 用户ID
    
    返回:
    
    0 方法调用成功，其他调用失败
    
    另请参阅:
    
    NERtcVideoView
  - enableLocalVideo
```
public abstract int enableLocalVideo(boolean enable)
```
    开启/关闭本地视频采集以及发送
    
    参数:
    
    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(Context, String, NERtcCallback, NERtcOption)前设置才能生效
    
    参数:
    
    params - 设置参数
    
    抛出:
    
    java.lang.IllegalArgumentException
  - version
```
public static NERtcVersion version()
```
    版本号
    
    返回:
    
    NERtcVersion 版本号
  - checkPermission
```
public static java.util.List<java.lang.String> checkPermission(android.content.Context 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