RTSManager.java

浏览该文件的文档.

package com.netease.nimlib.sdk.rts;

import com.netease.nimlib.rts.RTSManagerImpl;
import com.netease.nimlib.sdk.Observer;
import com.netease.nimlib.sdk.rts.constant.RTSTimeOutEvent;
import com.netease.nimlib.sdk.rts.constant.RTSTunnelType;
import com.netease.nimlib.sdk.rts.model.RTSCalleeAckEvent;
import com.netease.nimlib.sdk.rts.model.RTSCommonEvent;
import com.netease.nimlib.sdk.rts.model.RTSControlEvent;
import com.netease.nimlib.sdk.rts.model.RTSData;
import com.netease.nimlib.sdk.rts.model.RTSNetworkProxy;
import com.netease.nimlib.sdk.rts.model.RTSNotifyOption;
import com.netease.nimlib.sdk.rts.model.RTSOnlineAckEvent;
import com.netease.nimlib.sdk.rts.model.RTSOptions;
import com.netease.nimlib.sdk.rts.model.RTSTunData;

import java.util.List;

/**
 * 双人白板通话
 */
public abstract class RTSManager {

    /**
     * 获取抽象类具体实现对象
     *
     * @return RTSManager对象
     */
    public static RTSManager getInstance() {
        return RTSManagerImpl.InstanceHolder.instance;
    }

    /**
     * 设置网络代理,需要在发起会话前设置
     *
     * @param proxy 代理信息
     */
    public abstract void setNetworkProxy(RTSNetworkProxy proxy);


    /**
     * 获取已经设置的网络代理
     */
    public abstract RTSNetworkProxy getNetworkProxy();

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

    /**
     * (发送方)发起会话， 调用此接口对方会收到相应的会话请求通知
     *
     * @param account      对方帐号
     * @param tunTypes     通道类型集合：AUDIO、DATA
     * @param options      可选参数: 是否录制通道数据
     * @param notifyOption 可选参数: 推送相关参数控制
     * @param callback     回调函数，返回RTSData
     * @return Session ID，若返回null，表示发起失败，注意：音频通道同时只能有一个会话开启。
     * 回调onFailed错误码：
     * 200:成功
     * 414:参数错误
     * 509:通道失效
     * 11001:无可送达的被叫方,主叫方可直接挂断
     * 501:数据库失败
     * 514:服务不可用
     */
    public abstract String start(String account, List<RTSTunnelType> tunTypes, RTSOptions options,
                                 RTSNotifyOption notifyOption, RTSCallback<RTSData> callback);

    /**
     * (接收方)接受会话
     *
     * @param sessionId 会话ID
     * @param options   可选参数：是否录制通道数据
     * @param callback  回调函数，返回本地通道初始化是否成功
     * @return 是否成功调用，若返回false，表示接受失败，注意：音频通道同时只能有一个会话开启。
     * 回调onFailed错误码：
     * -1：接受失败，本地正在使用语音通道。
     */
    public abstract boolean accept(String sessionId, RTSOptions options, RTSCallback<Boolean> callback);

    /**
     * (接受方)拒绝会话或者结束会话
     *
     * @param sessionId 会话ID
     * @param callback  回调函数
     * @return 是否成功调用
     */
    public abstract boolean close(String sessionId, RTSCallback<Void> callback);

    /**
     * 发送控制指令
     *
     * @param sessionId 会话ID
     * @param data      控制指令内容
     * @param callback  回调函数
     * @return 是否调用成功
     */
    public abstract boolean sendControlCommand(String sessionId, String data, RTSCallback<Void> callback);

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

    /**
     * 注册/注销监听收到的会话请求
     * 建议在APP启动时就添加此监听
     *
     * @param observer 观察者，参数为会话的信息
     * @param register true为注册，false为注销
     */
    public abstract void observeIncomingSession(Observer<RTSData> observer, boolean register);

    /**
     * 注册/注销发起会话后，被叫方的响应（接听、拒绝、忙）
     *
     * @param sessionId 会话ID
     * @param observer  观察者， 参数为被叫方的响应
     * @param register  true为注册，false为注销
     * @return 是否成功调用
     */
    public abstract boolean observeCalleeAckNotification(String sessionId, Observer<RTSCalleeAckEvent> observer, boolean
            register);

    /**
     * 注册/注销同时在线的其他端对主叫方的响应
     *
     * @param sessionId 会话ID
     * @param observer  观察者，参数为同时在线的其他端响应主叫方的同步通知
     * @param register  true为注册，false为注销
     * @return 是否成功调用
     */
    public abstract boolean observeOnlineAckNotification(String sessionId, Observer<RTSOnlineAckEvent> observer, boolean
            register);

    /**
     * 注册/注销会话对方挂断的通知
     *
     * @param sessionId 会话ID
     * @param observer  观察者， 参数为对方挂断信息
     * @param register  true为注册，false为注销
     * @return 是否成功调用
     */
    public abstract boolean observeHangUpNotification(String sessionId, Observer<RTSCommonEvent> observer, boolean
            register);

    /**
     * 注册/注销通道状态变化的通知
     *
     * @param sessionId 会话ID
     * @param observer  观察者，参数为通话会话（通道)状态回调（例如是否连接上服务器，通道是否有成员加入等）
     * @param register  true为注册，false为注销
     * @return 是否成功调用
     */
    public abstract boolean observeChannelState(String sessionId, RTSChannelStateObserver observer, boolean register);

    /**
     * 注册/注销会话控制消息
     *
     * @param sessionId 会话ID
     * @param observer  观察者， 参数为接收到的会话控制消息
     * @param register  true为注册，false为注销
     * @return 是否成功调用
     */
    public abstract boolean observeControlNotification(String sessionId, Observer<RTSControlEvent> observer, boolean
            register);

    /**
     * 注册/注销到来的会话或者自己发起的会话（自己或者对方无响应）超时的通知，默认超时时间为40秒
     *
     * @param sessionId 会话ID
     * @param observer  观察者，参数为超时事件详细信息
     * @param register  true为注册，false为注销
     * @return 是否成功调用
     */
    public abstract boolean observeTimeoutNotification(String sessionId, Observer<RTSTimeOutEvent> observer, boolean
            register);

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

    /**
     * 向指定会话的某个通道中的某个用户发送数据，也可以广播给所有用户（在RTSTunData中，对方帐号填null）
     *
     * @param data 要发送的数据信息，其中toAccount表示目标用户（填null，表示广播给所有用户）
     * @return 参数是否有效
     */
    public abstract boolean sendData(RTSTunData data);

    /**
     * 注册/注销对方从某个通道发来的数据
     *
     * @param sessionId 会话ID
     * @param observer  观察者，参数为收到的数据信息
     * @param register  true为注册，false为注销
     */
    public abstract boolean observeReceiveData(String sessionId, Observer<RTSTunData> observer, boolean register);

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

    /**
     * 静音开关
     * @param sessionId 会话ID
     * @param mute 是否静音
     */
    public abstract void setMute(String sessionId, boolean mute);

    /**
     * 是否静音
     * @param sessionId 会话ID
     * @return
     */
    public abstract boolean isMuted(String sessionId);

    /**
     * 扬声器开关
     * @param sessionId 会话ID
     * @param enable 是否打开
     */
    public abstract void setSpeaker(String sessionId, boolean enable);

    /**
     * 是否打开扬声器
     * @param sessionId 会话ID
     * @return
     */
    public abstract boolean isSpeakerOn(String sessionId);
}