RTSManager2.java

浏览该文件的文档.

package com.netease.nimlib.sdk.rts;

import com.netease.nimlib.rts.RTSManager2Impl;
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 RTSManager2 {

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

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


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

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

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

    /**
     * 通过会话名预定一个会话房间
     *
     * @param sessionId 会话ID
     * @param extraMessage 附加信息，后续加入会话的用户都会收到此信息
     * @param callback     回调. <code>200</code> 创建成功, <code>417</code> 房间已经被预定。
     */
    public abstract void createSession(String sessionId, String extraMessage, RTSCallback<Void> callback);


    /**
     * 通过会话名加入一个已经成功预定的房间
     *
     * @param sessionId 会话ID
     * @param enableServerRecord 是否服务器录制
     * @param callback    回调
     *
     * @return
     */
    public abstract boolean joinSession(String sessionId, boolean enableServerRecord,  RTSCallback<RTSData> callback);


    /**
     * 离开多人通话的房间
     *
     * @param sessionId Session ID
     * @param callback    回调
     *
     */
    public abstract boolean leaveSession(String sessionId, RTSCallback<Void> callback);


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

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

    /**
     * 注册/注销会话控制消息
     *
     * @param sessionId 会话ID
     * @param observer  观察者， 参数为接收到的会话控制消息
     * @param register  true为注册，false为注销
     */
    public abstract void observeControlNotification(String sessionId, Observer<RTSControlEvent> 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 void observeReceiveData(String sessionId, Observer<RTSTunData> observer, boolean register);
}