NIMSDK-AOS  9.16.0
Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
com.netease.nimlib.sdk.rts.RTSManager类 参考abstract

双人白板通话 更多...

Public 成员函数

abstract void setNetworkProxy (RTSNetworkProxy proxy)
 设置网络代理,需要在发起会话前设置 更多...
 
abstract RTSNetworkProxy getNetworkProxy ()
 获取已经设置的网络代理 更多...
 
abstract String start (String account, List< RTSTunnelType > tunTypes, RTSOptions options, RTSNotifyOption notifyOption, RTSCallback< RTSData > callback)
 **************************** 控制请求接口 ******************************* 更多...
 
abstract boolean accept (String sessionId, RTSOptions options, RTSCallback< Boolean > callback)
 (接收方)接受会话 更多...
 
abstract boolean close (String sessionId, RTSCallback< Void > callback)
 (接受方)拒绝会话或者结束会话 更多...
 
abstract boolean sendControlCommand (String sessionId, String data, RTSCallback< Void > callback)
 发送控制指令 更多...
 
abstract void observeIncomingSession (Observer< RTSData > observer, boolean register)
 ****************************** 通知接口 ********************************** 更多...
 
abstract boolean observeCalleeAckNotification (String sessionId, Observer< RTSCalleeAckEvent > observer, boolean register)
 注册/注销发起会话后，被叫方的响应（接听、拒绝、忙） 更多...
 
abstract boolean observeOnlineAckNotification (String sessionId, Observer< RTSOnlineAckEvent > observer, boolean register)
 注册/注销同时在线的其他端对主叫方的响应 更多...
 
abstract boolean observeHangUpNotification (String sessionId, Observer< RTSCommonEvent > observer, boolean register)
 注册/注销会话对方挂断的通知 更多...
 
abstract boolean observeChannelState (String sessionId, RTSChannelStateObserver observer, boolean register)
 注册/注销通道状态变化的通知 更多...
 
abstract boolean observeControlNotification (String sessionId, Observer< RTSControlEvent > observer, boolean register)
 注册/注销会话控制消息 更多...
 
abstract boolean observeTimeoutNotification (String sessionId, Observer< RTSTimeOutEvent > observer, boolean register)
 注册/注销到来的会话或者自己发起的会话（自己或者对方无响应）超时的通知，默认超时时间为40秒 更多...
 
abstract boolean sendData (RTSTunData data)
 **************************** 数据通道收发 ******************************* 更多...
 
abstract boolean observeReceiveData (String sessionId, Observer< RTSTunData > observer, boolean register)
 注册/注销对方从某个通道发来的数据 更多...
 
abstract void setMute (String sessionId, boolean mute)
 **************************** 音频控制 ******************************* 更多...
 
abstract boolean isMuted (String sessionId)
 是否静音 更多...
 
abstract void setSpeaker (String sessionId, boolean enable)
 扬声器开关 更多...
 
abstract boolean isSpeakerOn (String sessionId)
 是否打开扬声器 更多...
 

静态 Public 成员函数

static RTSManager getInstance ()
 获取抽象类具体实现对象 更多...
 

详细描述

双人白板通话

在文件 RTSManager.java 第 22 行定义.

成员函数说明

◆ accept()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.accept ( String  sessionId,
RTSOptions  options,
RTSCallback< Boolean >  callback 
)
abstract

(接收方)接受会话

参数
sessionId会话ID
options可选参数：是否录制通道数据
callback回调函数，返回本地通道初始化是否成功
返回
是否成功调用，若返回false，表示接受失败，注意：音频通道同时只能有一个会话开启。 回调onFailed错误码： -1：接受失败，本地正在使用语音通道。

◆ close()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.close ( String  sessionId,
RTSCallback< Void >  callback 
)
abstract

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

参数
sessionId会话ID
callback回调函数
返回
是否成功调用

◆ getInstance()

static RTSManager com.netease.nimlib.sdk.rts.RTSManager.getInstance ( )
static

获取抽象类具体实现对象

返回
RTSManager对象

在文件 RTSManager.java 第 29 行定义.

◆ getNetworkProxy()

abstract RTSNetworkProxy com.netease.nimlib.sdk.rts.RTSManager.getNetworkProxy ( )
abstract

获取已经设置的网络代理

◆ isMuted()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.isMuted ( String  sessionId)
abstract

是否静音

参数
sessionId会话ID
返回

◆ isSpeakerOn()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.isSpeakerOn ( String  sessionId)
abstract

是否打开扬声器

参数
sessionId会话ID
返回

◆ observeCalleeAckNotification()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.observeCalleeAckNotification ( String  sessionId,
Observer< RTSCalleeAckEvent >  observer,
boolean  register 
)
abstract

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

参数
sessionId会话ID
observer观察者， 参数为被叫方的响应
registertrue为注册，false为注销
返回
是否成功调用

◆ observeChannelState()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.observeChannelState ( String  sessionId,
RTSChannelStateObserver  observer,
boolean  register 
)
abstract

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

参数
sessionId会话ID
observer观察者，参数为通话会话（通道)状态回调（例如是否连接上服务器，通道是否有成员加入等）
registertrue为注册，false为注销
返回
是否成功调用

◆ observeControlNotification()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.observeControlNotification ( String  sessionId,
Observer< RTSControlEvent >  observer,
boolean  register 
)
abstract

注册/注销会话控制消息

参数
sessionId会话ID
observer观察者， 参数为接收到的会话控制消息
registertrue为注册，false为注销
返回
是否成功调用

◆ observeHangUpNotification()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.observeHangUpNotification ( String  sessionId,
Observer< RTSCommonEvent >  observer,
boolean  register 
)
abstract

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

参数
sessionId会话ID
observer观察者， 参数为对方挂断信息
registertrue为注册，false为注销
返回
是否成功调用

◆ observeIncomingSession()

abstract void com.netease.nimlib.sdk.rts.RTSManager.observeIncomingSession ( Observer< RTSData >  observer,
boolean  register 
)
abstract

****************************** 通知接口 **********************************

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

参数
observer观察者，参数为会话的信息
registertrue为注册，false为注销

◆ observeOnlineAckNotification()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.observeOnlineAckNotification ( String  sessionId,
Observer< RTSOnlineAckEvent >  observer,
boolean  register 
)
abstract

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

参数
sessionId会话ID
observer观察者，参数为同时在线的其他端响应主叫方的同步通知
registertrue为注册，false为注销
返回
是否成功调用

◆ observeReceiveData()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.observeReceiveData ( String  sessionId,
Observer< RTSTunData >  observer,
boolean  register 
)
abstract

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

参数
sessionId会话ID
observer观察者，参数为收到的数据信息
registertrue为注册，false为注销

◆ observeTimeoutNotification()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.observeTimeoutNotification ( String  sessionId,
Observer< RTSTimeOutEvent >  observer,
boolean  register 
)
abstract

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

参数
sessionId会话ID
observer观察者，参数为超时事件详细信息
registertrue为注册，false为注销
返回
是否成功调用

◆ sendControlCommand()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.sendControlCommand ( String  sessionId,
String  data,
RTSCallback< Void >  callback 
)
abstract

发送控制指令

参数
sessionId会话ID
data控制指令内容
callback回调函数
返回
是否调用成功

◆ sendData()

abstract boolean com.netease.nimlib.sdk.rts.RTSManager.sendData ( RTSTunData  data)
abstract

**************************** 数据通道收发 *******************************

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

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

◆ setMute()

abstract void com.netease.nimlib.sdk.rts.RTSManager.setMute ( String  sessionId,
boolean  mute 
)
abstract

**************************** 音频控制 *******************************

静音开关

参数
sessionId会话ID
mute是否静音

◆ setNetworkProxy()

abstract void com.netease.nimlib.sdk.rts.RTSManager.setNetworkProxy ( RTSNetworkProxy  proxy)
abstract

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

参数
proxy代理信息

◆ setSpeaker()

abstract void com.netease.nimlib.sdk.rts.RTSManager.setSpeaker ( String  sessionId,
boolean  enable 
)
abstract

扬声器开关

参数
sessionId会话ID
enable是否打开

◆ start()

abstract String com.netease.nimlib.sdk.rts.RTSManager.start ( String  account,
List< RTSTunnelType >  tunTypes,
RTSOptions  options,
RTSNotifyOption  notifyOption,
RTSCallback< RTSData >  callback 
)
abstract

**************************** 控制请求接口 *******************************

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

参数
account对方帐号
tunTypes通道类型集合：AUDIO、DATA
options可选参数: 是否录制通道数据
notifyOption可选参数: 推送相关参数控制
callback回调函数，返回RTSData
返回
Session ID，若返回null，表示发起失败，注意：音频通道同时只能有一个会话开启。 回调onFailed错误码： 200:成功 414:参数错误 509:通道失效 11001:无可送达的被叫方,主叫方可直接挂断 501:数据库失败 514:服务不可用
该类的文档由以下文件生成:
生成于 2024年 四月 16日 星期二 14:41:43 , 为 NIMSDK-AOS使用   doxygen 1.8.13