com.netease.nimlib.sdk.rts

类 RTSManager

java.lang.Object

com.netease.nimlib.sdk.rts.RTSManager

public abstract class RTSManager
extends java.lang.Object

双人白板通话

构造器概要

构造器

构造器和说明
RTSManager()

方法概要

限定符和类型	方法和说明
abstract boolean	accept(java.lang.String sessionId, RTSOptions options, RTSCallback<java.lang.Boolean> callback) (接收方)接受会话
abstract boolean	close(java.lang.String sessionId, RTSCallback<java.lang.Void> callback) (接受方)拒绝会话或者结束会话
static RTSManager	getInstance() 获取抽象类具体实现对象
abstract RTSNetworkProxy	getNetworkProxy() 获取已经设置的网络代理
abstract boolean	isMuted(java.lang.String sessionId) 是否静音
abstract boolean	isSpeakerOn(java.lang.String sessionId) 是否打开扬声器
abstract boolean	observeCalleeAckNotification(java.lang.String sessionId, Observer<RTSCalleeAckEvent> observer, boolean register) 注册/注销发起会话后，被叫方的响应（接听、拒绝、忙）
abstract boolean	observeChannelState(java.lang.String sessionId, RTSChannelStateObserver observer, boolean register) 注册/注销通道状态变化的通知
abstract boolean	observeControlNotification(java.lang.String sessionId, Observer<RTSControlEvent> observer, boolean register) 注册/注销会话控制消息
abstract boolean	observeHangUpNotification(java.lang.String sessionId, Observer<RTSCommonEvent> observer, boolean register) 注册/注销会话对方挂断的通知
abstract void	observeIncomingSession(Observer<RTSData> observer, boolean register) 注册/注销监听收到的会话请求 建议在APP启动时就添加此监听
abstract boolean	observeOnlineAckNotification(java.lang.String sessionId, Observer<RTSOnlineAckEvent> observer, boolean register) 注册/注销同时在线的其他端对主叫方的响应
abstract boolean	observeReceiveData(java.lang.String sessionId, Observer<RTSTunData> observer, boolean register) 注册/注销对方从某个通道发来的数据
abstract boolean	observeTimeoutNotification(java.lang.String sessionId, Observer<RTSTimeOutEvent> observer, boolean register) 注册/注销到来的会话或者自己发起的会话（自己或者对方无响应）超时的通知，默认超时时间为40秒
abstract boolean	sendControlCommand(java.lang.String sessionId, java.lang.String data, RTSCallback<java.lang.Void> callback) 发送控制指令
abstract boolean	sendData(RTSTunData data) 向指定会话的某个通道中的某个用户发送数据，也可以广播给所有用户（在RTSTunData中，对方帐号填null）
abstract void	setMute(java.lang.String sessionId, boolean mute) 静音开关
abstract void	setNetworkProxy(RTSNetworkProxy proxy) 设置网络代理,需要在发起会话前设置
abstract void	setSpeaker(java.lang.String sessionId, boolean enable) 扬声器开关
abstract java.lang.String	start(java.lang.String account, java.util.List<RTSTunnelType> tunTypes, RTSOptions options, RTSNotifyOption notifyOption, RTSCallback<RTSData> callback) (发送方)发起会话， 调用此接口对方会收到相应的会话请求通知

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

RTSManager

public RTSManager()

方法详细资料

getInstance

public static RTSManager getInstance()

获取抽象类具体实现对象

返回:

RTSManager对象

setNetworkProxy

public abstract void setNetworkProxy(RTSNetworkProxy proxy)

设置网络代理,需要在发起会话前设置

参数:

proxy - 代理信息

getNetworkProxy

public abstract RTSNetworkProxy getNetworkProxy()

获取已经设置的网络代理

start

public abstract java.lang.String start(java.lang.String account,
                                       java.util.List<RTSTunnelType> tunTypes,
                                       RTSOptions options,
                                       RTSNotifyOption notifyOption,
                                       RTSCallback<RTSData> callback)

(发送方)发起会话， 调用此接口对方会收到相应的会话请求通知

参数:

account - 对方帐号

tunTypes - 通道类型集合：AUDIO、DATA

options - 可选参数: 是否录制通道数据

notifyOption - 可选参数: 推送相关参数控制

callback - 回调函数，返回RTSData

返回:

Session ID，若返回null，表示发起失败，注意：音频通道同时只能有一个会话开启。 回调onFailed错误码： 200:成功 414:参数错误 509:通道失效 11001:无可送达的被叫方,主叫方可直接挂断 501:数据库失败 514:服务不可用

accept

public abstract boolean accept(java.lang.String sessionId,
                               RTSOptions options,
                               RTSCallback<java.lang.Boolean> callback)

(接收方)接受会话

参数:

sessionId - 会话ID

options - 可选参数：是否录制通道数据

callback - 回调函数，返回本地通道初始化是否成功

返回:

是否成功调用，若返回false，表示接受失败，注意：音频通道同时只能有一个会话开启。 回调onFailed错误码： -1：接受失败，本地正在使用语音通道。

close

public abstract boolean close(java.lang.String sessionId,
                              RTSCallback<java.lang.Void> callback)

(接受方)拒绝会话或者结束会话

参数:

sessionId - 会话ID

callback - 回调函数

返回:

是否成功调用

sendControlCommand

public abstract boolean sendControlCommand(java.lang.String sessionId,
                                           java.lang.String data,
                                           RTSCallback<java.lang.Void> callback)

发送控制指令

参数:

sessionId - 会话ID

data - 控制指令内容

callback - 回调函数

返回:

是否调用成功

observeIncomingSession

public abstract void observeIncomingSession(Observer<RTSData> observer,
                                            boolean register)

注册/注销监听收到的会话请求 建议在APP启动时就添加此监听

参数:

observer - 观察者，参数为会话的信息

register - true为注册，false为注销

observeCalleeAckNotification

public abstract boolean observeCalleeAckNotification(java.lang.String sessionId,
                                                     Observer<RTSCalleeAckEvent> observer,
                                                     boolean register)

注册/注销发起会话后，被叫方的响应（接听、拒绝、忙）

参数:

sessionId - 会话ID

observer - 观察者， 参数为被叫方的响应

register - true为注册，false为注销

返回:

是否成功调用

observeOnlineAckNotification

public abstract boolean observeOnlineAckNotification(java.lang.String sessionId,
                                                     Observer<RTSOnlineAckEvent> observer,
                                                     boolean register)

注册/注销同时在线的其他端对主叫方的响应

参数:

sessionId - 会话ID

observer - 观察者，参数为同时在线的其他端响应主叫方的同步通知

register - true为注册，false为注销

返回:

是否成功调用

observeHangUpNotification

public abstract boolean observeHangUpNotification(java.lang.String sessionId,
                                                  Observer<RTSCommonEvent> observer,
                                                  boolean register)

注册/注销会话对方挂断的通知

参数:

sessionId - 会话ID

observer - 观察者， 参数为对方挂断信息

register - true为注册，false为注销

返回:

是否成功调用

observeChannelState

public abstract boolean observeChannelState(java.lang.String sessionId,
                                            RTSChannelStateObserver observer,
                                            boolean register)

注册/注销通道状态变化的通知

参数:

sessionId - 会话ID

observer - 观察者，参数为通话会话（通道)状态回调（例如是否连接上服务器，通道是否有成员加入等）

register - true为注册，false为注销

返回:

是否成功调用

observeControlNotification

public abstract boolean observeControlNotification(java.lang.String sessionId,
                                                   Observer<RTSControlEvent> observer,
                                                   boolean register)

注册/注销会话控制消息

参数:

sessionId - 会话ID

observer - 观察者， 参数为接收到的会话控制消息

register - true为注册，false为注销

返回:

是否成功调用

observeTimeoutNotification

public abstract boolean observeTimeoutNotification(java.lang.String sessionId,
                                                   Observer<RTSTimeOutEvent> observer,
                                                   boolean register)

注册/注销到来的会话或者自己发起的会话（自己或者对方无响应）超时的通知，默认超时时间为40秒

参数:

sessionId - 会话ID

observer - 观察者，参数为超时事件详细信息

register - true为注册，false为注销

返回:

是否成功调用

sendData

public abstract boolean sendData(RTSTunData data)

向指定会话的某个通道中的某个用户发送数据，也可以广播给所有用户（在RTSTunData中，对方帐号填null）

参数:

data - 要发送的数据信息，其中toAccount表示目标用户（填null，表示广播给所有用户）

返回:

参数是否有效

observeReceiveData

public abstract boolean observeReceiveData(java.lang.String sessionId,
                                           Observer<RTSTunData> observer,
                                           boolean register)

注册/注销对方从某个通道发来的数据

参数:

sessionId - 会话ID

observer - 观察者，参数为收到的数据信息

register - true为注册，false为注销

setMute

public abstract void setMute(java.lang.String sessionId,
                             boolean mute)

静音开关

参数:

sessionId - 会话ID

mute - 是否静音

isMuted

public abstract boolean isMuted(java.lang.String sessionId)

是否静音

参数:

sessionId - 会话ID

返回:

setSpeaker

public abstract void setSpeaker(java.lang.String sessionId,
                                boolean enable)

扬声器开关

参数:

sessionId - 会话ID

enable - 是否打开

isSpeakerOn

public abstract boolean isSpeakerOn(java.lang.String sessionId)

是否打开扬声器

参数:

sessionId - 会话ID

返回: