AVChatManagerLite.java

浏览该文件的文档.

/*
 * Copyright (c) 2014-2018 NetEase, Inc.
 * All right reserved.
 */

package com.netease.nimlib.sdk.avchat;


import android.content.Context;

import com.netease.nimlib.avchat.AVChatManagerImpl;
import com.netease.nimlib.sdk.Observer;
import com.netease.nimlib.sdk.avchat.constant.AVChatAudioEffectMode;
import com.netease.nimlib.sdk.avchat.constant.AVChatChannelProfile;
import com.netease.nimlib.sdk.avchat.constant.AVChatControlCommand;
import com.netease.nimlib.sdk.avchat.constant.AVChatMediaCodecMode;
import com.netease.nimlib.sdk.avchat.constant.AVChatOSCategory;
import com.netease.nimlib.sdk.avchat.constant.AVChatResCode;
import com.netease.nimlib.sdk.avchat.constant.AVChatType;
import com.netease.nimlib.sdk.avchat.constant.AVChatVideoQualityStrategy;
import com.netease.nimlib.sdk.avchat.model.AVChatCalleeAckEvent;
import com.netease.nimlib.sdk.avchat.model.AVChatEngineConfig;
import com.netease.nimlib.sdk.avchat.model.AVChatLiveTaskConfig;
import com.netease.nimlib.sdk.avchat.video.AVChatCameraCapturer;
import com.netease.nimlib.sdk.avchat.model.AVChatChannelInfo;
import com.netease.nimlib.sdk.avchat.model.AVChatCommonEvent;
import com.netease.nimlib.sdk.avchat.model.AVChatControlEvent;
import com.netease.nimlib.sdk.avchat.model.AVChatData;
import com.netease.nimlib.sdk.avchat.video.AVChatExternalVideoCapturer;
import com.netease.nimlib.sdk.avchat.video.AVChatExternalVideoRender;
import com.netease.nimlib.sdk.avchat.model.AVChatNotifyOption;
import com.netease.nimlib.sdk.avchat.model.AVChatOnlineAckEvent;
import com.netease.nimlib.sdk.avchat.model.AVChatParameters;
import com.netease.nimlib.sdk.avchat.model.AVChatServerAddresses;
import com.netease.nimlib.sdk.avchat.video.AVChatSurfaceViewRenderer;
import com.netease.nimlib.sdk.avchat.video.AVChatTextureViewRenderer;
import com.netease.nimlib.sdk.avchat.video.AVChatVideoCapturer;
import com.netease.nimlib.sdk.avchat.video.AVChatVideoCapturerFactory;
import com.netease.nrtc.video.render.IVideoRender;

import java.util.List;


/**
 * <p>音视频通话统一接口，所有接口需主线程调用。</p>
 *
 * <p> 网络通话需要 {@code Android JELLY_BEAN} 及以上的系统版本。通话前请确保已经拥有了所需的各种权限，获取确实权限参考 {@link AVChatManager#checkPermission(Context)}.
 * 目前仅支持同时进行一通会话，如果存在多个网络通话，需要选择挂断优先级低的会话。 如果存在系统电话，或者有系统电话接入，建议挂断网络通话。</p>
 *
 * <p>关于网络通话的呼出和呼入超时的设置，需要生层自己实现响应的定时器，SDK内部的超时已经被废弃，未来会移除。</p>
 *
 * <p>网络通话目前分为两大部分，双人通话和多人通话。</p>
 *
 * <p><b>所有类型音视频通话需要监听会话状态: {@link AVChatManagerLite#observeAVChatState(AVChatStateObserverLite, boolean)}</b></p>
 *
 * <p><b>双人通话，包含了信令相关操作和音视频操作两部分。信令包括了会话的发起，接听，拒绝，挂断等，重要接口有：</b>
 * <ul>
 * <li>{@link AVChatManagerLite#call2(String, AVChatType, AVChatNotifyOption, AVChatCallback)} 发起会话，通知到对方用户。</li>
 * <li>{@link AVChatManagerLite#accept2(long, AVChatCallback)} 接听会话。</li>
 * <li>{@link AVChatManagerLite#hangUp2(long, AVChatCallback)}  挂断会话。 </li>
 * <li>{@link AVChatManagerLite#sendControlCommand(long, byte, AVChatCallback)} 发送控制指令，用户可以定义私有的控制指令。建议通过此接口实现音视频切换。</li>
 * </ul></p>
 *
 * <p><b>双人会话需要额外注册相关监听器：</b>
 * <ul>
 * <li>{@link AVChatManagerLite#observeIncomingCall(Observer, boolean)} 监听来电。</li>
 * <li>{@link AVChatManagerLite#observeCalleeAckNotification(Observer, boolean)} 呼叫发起后，监听对方的接听结果。</li>
 * <li>{@link AVChatManagerLite#observeControlNotification(Observer, boolean)} 所有控制指令的监听接口。 </li>
 * <li>{@link AVChatManagerLite#observeHangUpNotification(Observer, boolean)} 监听对方的挂断通知。</li>
 * <li>{@link AVChatManagerLite#observeOnlineAckNotification(Observer, boolean)} 监听多端登陆时其他端处理。</li>
 * </ul></p>
 *
 * <p><b>多人通话，互动直播属于此模式。 此模式不包含所有的信令操作，需要客户上层自定义实现， 此模式仅仅包含了房间的加入和离开，以及音视频操作。重要接口有:</b>
 * <ul>
 * <li>{@link AVChatManagerLite#createRoom(String, String, AVChatCallback)} 仅仅创建一个多人会话的房间，任何时候都可以调用。</li>
 * <li>{@link AVChatManagerLite#joinRoom2(String, AVChatType, AVChatCallback)} 加入一个已经创建好的多人房间。</li>
 * <li>{@link AVChatManagerLite#leaveRoom2(String, AVChatCallback)} 离开一个已经加入的多人房间。 </li>
 * </ul></p>
 *
 * <p><b>互动直播，多人会议视频通话流程示例:</b>
 * <ol>
 * <li>主播或者管理员创建房间 {@link AVChatManagerLite#createRoom(String, String, AVChatCallback)}。 创建房间仅仅是在服务器预留一个房间名，房间未使用时有效期为30天，使用后的房间在所有用户退出后回收。</li>
 * <li>注册音视频模块监听 {@link AVChatManagerLite#observeAVChatState(AVChatStateObserverLite, boolean)}。</li>
 * <li>开启音视频引擎， {@link AVChatManagerLite#enableRtc()}。 </li>
 * <li>设置通话场景, 如没有特殊需求不用设置 {@link AVChatManagerLite#setChannelProfile(int)} 。</li>
 * <li>设置互动直播模式，设置互动直播推流地址 [仅限互动直播] {@link AVChatParameters#KEY_SESSION_LIVE_MODE}, {@link AVChatParameters#KEY_SESSION_LIVE_URL}。</li>
 * <li>打开视频模块 {@link AVChatManagerLite#enableVideo()}。</li>
 * <li>设置视频采集模块 {@link AVChatManagerLite#setupVideoCapturer(AVChatVideoCapturer)}。</li>
 * <li>设置本地预览画布 {@link AVChatManagerLite#setupLocalVideoRender(IVideoRender, boolean, int)} 。</li>
 * <li>设置视频通话可选参数[可以不设置] {@link AVChatManagerLite#setParameter(AVChatParameters.Key, Object)}, {@link AVChatManager#setParameters(AVChatParameters)}。</li>
 * <li>打开本地视频预览 {@link AVChatManagerLite#startVideoPreview()}。</li>
 * <li>加入房间 {@link AVChatManagerLite#joinRoom2(String, AVChatType, AVChatCallback)}。</li>
 * <li>开始多人会议或者互动直播，以及各种音视频操作。</li>
 * <li>关闭本地预览 {@link AVChatManagerLite#stopVideoPreview()} 。</li>
 * <li>关闭视频模块 {@link AVChatManagerLite#disableVideo()} ()} 。</li>
 * <li>离开会话 {@link AVChatManagerLite#leaveRoom2(String, AVChatCallback)}。</li>
 * <li>关闭音视频引擎, {@link AVChatManagerLite#disableRtc()}。</li>
 * </ol></p>
 *
 * <p><b>双人视频通话流程示例:</b>
 * <ol>
 * <li>注册本地各种监听器 {@link AVChatManagerLite#observeAVChatState(AVChatStateObserverLite, boolean)} 等等。</li>
 * <li>开启音视频引擎， {@link AVChatManagerLite#enableRtc()}。</li>
 * <li>设置通话场景, 如没有特殊需求不用设置 {@link AVChatManagerLite#setChannelProfile(int)} 。</li>
 * <li>打开视频模块 {@link AVChatManagerLite#enableVideo()}。</li>
 * <li>设置视频采集模块 {@link AVChatManagerLite#setupVideoCapturer(AVChatVideoCapturer)}。</li>
 * <li>设置本地预览画布 {@link AVChatManagerLite#setupLocalVideoRender(IVideoRender, boolean, int)}。</li>
 * <li>设置视频通话可选参数[可以不设置] {@link AVChatManagerLite#setParameter(AVChatParameters.Key, Object)}, {@link AVChatManager#setParameters(AVChatParameters)}。</li>
 * <li>打开本地视频预览 {@link AVChatManagerLite#startVideoPreview()}。</li>
 * <li>呼叫或者接听通话 {@link AVChatManagerLite#call2(String, AVChatType, AVChatNotifyOption, AVChatCallback)}, {@link AVChatManager#accept2(long, AVChatCallback)}。</li>
 * <li>等待对方进入开始通话, 各种音视频控制。</li>
 * <li>关闭本地预览 {@link AVChatManagerLite#stopVideoPreview()}。</li>
 * <li>关闭视频模块 {@link AVChatManagerLite#disableVideo()} ()} 。</li>
 * <li>离开挂断会话 {@link AVChatManagerLite#hangUp2(long, AVChatCallback)}。</li>
 * <li>关闭音视频引擎, {@link AVChatManagerLite#disableRtc()}。</li>
 * </ol></p>
 */
public abstract class AVChatManagerLite {

    /**
     * <p>获取基础音视频通话接口</p>
     *
     * <p>基础版本音视频通话。 如果需要使用伴音以及本地录制等功能, 需要使用 {@link AVChatManager} 接口。</p>
     *
     * @return 返回 {@link AVChatManagerLite}
     */
    public static AVChatManagerLite getInstance() {
        return AVChatManagerImpl.InstanceHolder.instance;
    }


    /**
     * <p>激活音视频通话底层引擎</p>
     * <p>在进行音视频通话前需要调用此接口来激活音视频通话引擎,
     * 否则后续所有的接口调用会导致异常。如果方法调用成功, 后续需要调用  {@link AVChatManagerLite#disableRtc()}
     * 来关闭音视频底层引擎, 否则会出现资源泄漏。</p>
     *
     * @return {@code true} 方法s调用成功，{@code false} 方法调用失败
     * @see AVChatManagerLite#disableRtc()
     */
    public abstract boolean enableRtc();

    /**
     * <p>激活音视频通话底层引擎</p>
     * <p>在进行音视频通话前需要调用此接口来激活音视频通话引擎,
     * 否则后续所有的接口调用会导致异常。如果方法调用成功, 后续需要调用  {@link AVChatManagerLite#disableRtc()}
     * 来关闭音视频底层引擎, 否则会出现资源泄漏。</p>
     *
     * @param osType {@link AVChatOSCategory}
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see AVChatManagerLite#disableRtc()
     * @deprecated 推荐使用 {@link AVChatManagerLite#enableRtc(AVChatEngineConfig)}
     */
    @Deprecated
    public abstract boolean enableRtc(int osType);

    /**
     * <p>激活音视频通话底层引擎</p>
     *
     * <p>在进行音视频通话前需要调用此接口来激活音视频通话引擎,
     * 否则后续所有的接口调用会导致异常。如果方法调用成功, 后续需要调用  {@link AVChatManagerLite#disableRtc()}
     * 来关闭音视频底层引擎, 否则会出现资源泄漏。</p>
     *
     * @param serverAddresses 私有化服务器地址
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see AVChatManagerLite#disableRtc()
     * @deprecated 推荐使用 {@link AVChatManagerLite#enableRtc(AVChatEngineConfig)}
     */
    @Deprecated
    public abstract boolean enableRtc(AVChatServerAddresses serverAddresses);

    /**
     * <p>激活音视频通话底层引擎</p>
     *
     * <p>在进行音视频通话前需要调用此接口来激活音视频通话引擎,
     * 否则后续所有的接口调用会导致异常。如果方法调用成功, 后续需要调用  {@link AVChatManagerLite#disableRtc()}
     * 来关闭音视频底层引擎, 否则会出现资源泄漏。</p>
     *
     * @param osType    {@link AVChatOSCategory}
     * @param lowEnergy 是否开启低功耗模式
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see AVChatManagerLite#disableRtc()
     * @deprecated 推荐使用 {@link AVChatManagerLite#enableRtc(AVChatEngineConfig)}
     */
    @Deprecated
    public abstract boolean enableRtc(int osType, boolean lowEnergy);


    /**
     * <p>激活音视频通话底层引擎</p>
     *
     * <p>在进行音视频通话前需要调用此接口来激活音视频通话引擎,
     * 否则后续所有的接口调用会导致异常。如果方法调用成功, 后续需要调用  {@link AVChatManagerLite#disableRtc()}
     * 来关闭音视频底层引擎, 否则会出现资源泄漏。</p>
     *
     * @param osType    {@link AVChatOSCategory}
     * @param lowEnergy 是否开启低功耗模式
     * @param address   私有化服务器地址
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see AVChatManagerLite#disableRtc()
     * @deprecated 推荐使用 {@link AVChatManagerLite#enableRtc(AVChatEngineConfig)}
     */
    @Deprecated
    public abstract boolean enableRtc(int osType, boolean lowEnergy, AVChatServerAddresses address);


    /**
     * <p>激活音视频通话底层引擎</p>
     *
     * <p>在进行音视频通话前需要调用此接口来激活音视频通话引擎,
     * 否则后续所有的接口调用会导致异常。如果方法调用成功, 后续需要调用  {@link AVChatManagerLite#disableRtc()}
     * 来关闭音视频底层引擎, 否则会出现资源泄漏。</p>
     *
     * @param config 启动引擎相关的配置，例如:osType 、lowEnergy 、serverAddresses 、encryptType 、encryptKey <br/>
     *               参考 ：{@link AVChatEngineConfig.Builder}
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see AVChatManagerLite#disableRtc()
     */
    public abstract boolean enableRtc(AVChatEngineConfig config);


    /**
     * <p>关闭音视频通话底层引擎</p>
     *
     * <p>在通话结束后需要调用此接口关闭音视频通话引擎来释放资源。
     * 关闭音视频引擎后后续所有的其他调用都会失败或者异常。</p>
     *
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see AVChatManagerLite#enableRtc()
     */
    public abstract boolean disableRtc();


    /**
     * <p>激活视频模块</p>
     *
     * <p>如果你通话过程中有视频相关内容, 那必须在视频相关接口调用前先激活视频模块。
     * 通话结束前需要调用  {@link AVChatManagerLite#disableVideo()} 来关闭视频模块。
     * 在通话过程中, 通过此接口可以实现引擎的音视频通话模式切换,
     * 信令层可以通过使用 {@link AVChatManagerLite#sendControlCommand(long, byte, AVChatCallback)} 来通知
     * 对方目前的会话模式切换。 默认情况下视频模块是处于非激活状态。</p>
     *
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see AVChatManagerLite#disableVideo()
     */
    public abstract boolean enableVideo();


    /**
     * <p>关闭视频模块</p>
     *
     * <p>关闭视频相关模块。 在通过过程中调用会让引擎切换到语音模式, 如果信令层需要通知对方，则通过
     * {@link AVChatManagerLite#sendControlCommand(long, byte, AVChatCallback)} 实现。</p>
     *
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see AVChatManagerLite#enableVideo()
     */
    public abstract boolean disableVideo();


    /**
     * <p>信令层发起双人通话</p>
     *
     * <p>在信令层发起呼叫, 成功调用此接口后对方会收到相应的会话通知。 在呼叫过程中需要上层实现定时器, 当超过一定时间对方未接听时
     * 需要 {@link AVChatManagerLite#hangUp2(long, AVChatCallback)} 挂断会话。</p>
     *
     * <p><b>在发起会话时有几个比较重要可选字段:</b>
     * <ul>
     * <li>{@link AVChatNotifyOption#extendMessage}  附加信息字段, 接听会话的用户会收到此字段。 </li>
     * <li>{@link AVChatNotifyOption#forceKeepCalling}  持续呼叫,如果对方不在线也会继续呼叫, 否则会直接返回失败。</li>
     * </ul>
     * </p>
     *
     * <p><b>在调用信令层发起通话接口前需要先调用以下接口:</b>
     * <ol>
     * <li>开启音视频引擎  {@link AVChatManagerLite#enableRtc()}</li>
     * <li>可选, 激活视频模块 {@link AVChatManagerLite#enableVideo()}</li>
     * <li>可选, 设置本地预览画布，{@link AVChatManagerLite#setupLocalVideoRender(IVideoRender, boolean, int)}</li>
     * <li>可选, 开启视频预览，{@link AVChatManagerLite#startVideoPreview()}</li>
     * <li>可选, 通话相关参数设置 {@link AVChatManagerLite#setParameters(AVChatParameters)},</li>
     * </ol>
     * </p>
     *
     * @param account      对方用户账号
     * @param callType     通话类型：语音、视频
     * @param notifyOption 可选通知参数
     * @param callback     回调函数，返回 {@link AVChatData}
     * @see AVChatManagerLite#accept2(long, AVChatCallback)
     * @see AVChatManagerLite#hangUp2(long, AVChatCallback)
     */
    public abstract void call2(String account,
                               AVChatType callType,
                               AVChatNotifyOption notifyOption,
                               AVChatCallback<AVChatData> callback);

    /**
     * <p>信令层接听双人通话</p>
     *
     * <p>在程序启动时需要注册 {@link AVChatManagerLite#observeIncomingCall(Observer, boolean)}, 这样在有其他用户
     * 呼叫时将会收到来电通知, 收到来电通知后一般会有相应的界面展示, 如果需要接听电话那个需要调用此接口, 如果需要拒绝通话请调用
     * {@link AVChatManagerLite#hangUp2(long, AVChatCallback)}。</p>
     *
     * <p>在成功接听会话后, 引擎就会自动去连接预先分配好的媒体服务器。 连接媒体服务器的结果将会在
     * {@link AVChatStateObserverLite#onJoinedChannel(int, String, String, int)} 中进行通知。</p>
     *
     *
     * <p><b>在调用信令层接听会话接口前需要先调用以下接口:</b>
     * <ol>
     * <li>开启音视频引擎  {@link AVChatManagerLite#enableRtc()}</li>
     * <li>可选, 激活视频模块 {@link AVChatManagerLite#enableVideo()}</li>
     * <li>可选, 设置本地预览画布，{@link AVChatManagerLite#setupLocalVideoRender(IVideoRender, boolean, int)}</li>
     * <li>可选, 开启视频预览，{@link AVChatManagerLite#startVideoPreview()}</li>
     * <li>可选, 通话相关参数设置 {@link AVChatManagerLite#setParameters(AVChatParameters)}</li>
     * </ol>
     * </p>
     *
     * @param chatId   会话ID
     * @param callback 回调函数，返回接听后，本地音视频设备启动是否成功。
     *                 回调onSuccess表示成功；回调onFailed表示失败，错误码-1表示初始化引擎失败，需要重试。
     *                 注意：由于音视频引擎析构需要时间，请尽可能保持上一次通话挂断到本次电话接听时间间隔在2秒以上，否则有可能在接听时出现初始化引擎失败（code = -1）
     * @see AVChatManagerLite#call2(String, AVChatType, AVChatNotifyOption, AVChatCallback)
     * @see AVChatManagerLite#hangUp2(long, AVChatCallback)
     */
    public abstract void accept2(long chatId, AVChatCallback<Void> callback);


    /**
     * <p>信令层挂断或者拒绝通话请求</p>
     *
     * <p>在程序启动时需要注册 {@link AVChatManagerLite#observeIncomingCall(Observer, boolean)}, 这样在有其他用户
     * 呼叫时将会收到来电通知, 收到来电通知后一般会有相应的界面展示, 如果需要拒绝电话调用此接口, 如果需要接听通话请调用
     * {@link AVChatManagerLite#accept2(long, AVChatCallback)}。</p>
     *
     * <p>如果在通话过程中调用此接口,则会直接挂断通话, 同时对方会收到你挂断通知信令。</p>
     *
     * <p><b>此接口仅仅是信令层的挂断,如果需要销毁引擎释放资源需要调用以下接口:</b>
     * <ol>
     * <li>可选, 关闭视频预览 {@link AVChatManagerLite#stopVideoPreview()} ()}</li>
     * <li>可选, 关闭视频模块 {@link AVChatManagerLite#disableVideo()}}</li>
     * <li>释放通话资源 {@link AVChatManagerLite#disableRtc()}</li>
     * </ol>
     * </p>
     *
     * @param chatId   会话ID。发起通话和被叫通知都有会话ID通知,挂断时需要制定会话ID，如果在呼叫过程中还没有返回会话ID, 则传入0能够挂断正在呼叫的会话。
     * @param callback 回调函数
     * @see AVChatManagerLite#call2(String, AVChatType, AVChatNotifyOption, AVChatCallback)
     * @see AVChatManagerLite#accept2(long, AVChatCallback)
     */
    public abstract void hangUp2(long chatId, AVChatCallback<Void> callback);


    /**
     * <p>创建多人通话房间</p>
     *
     * <p>如果你需要使用多人会议和互动直播相关功能, 需要通过此接口创建一个多人房间,
     * 然后通过 {@link AVChatManagerLite#joinRoom2(String, AVChatType, AVChatCallback)} 来加入房间。
     * 房间创建成功后会一直保留, 尽量即时使用, 目前有效期为一个月, 超过有效期后再次加入房间会失败。
     * 如果一个房间已经被创建, 那么再次创建时会返回失败, 提示房间已经存在。</p>
     *
     * <p>房间创建时机不受音视频通话流程限制, 你可以在任意时间预定自己的多人会议房间。创建成功后即可通知所有会议参与者加入此房间,
     * 你将会在 {@link AVChatStateObserverLite#onUserJoined(String)} 中陆续收到不同的用户加入会议。</p>
     *
     * @param roomName     房间名
     * @param extraMessage 自定义的扩展消息, 其它加入房间的用户都会收到
     * @param callback     创建房间回调接口
     * @see AVChatResCode#ERROR_CREATE_ROOM_ALREADY_EXIST
     * @see AVChatManagerLite#createRoom(String, String, AVChatCallback)
     * @see AVChatManagerLite#joinRoom2(String, AVChatType, AVChatCallback)
     * @see AVChatManagerLite#leaveRoom2(String, AVChatCallback)
     */
    public abstract void createRoom(String roomName,
                                    String extraMessage,
                                    AVChatCallback<AVChatChannelInfo> callback);


    /**
     * <p>创建多人通话房间并设置直播推流相关的参数</p>
     *
     * <p>如果你需要使用多人会议和互动直播相关功能, 需要通过此接口创建一个多人房间,
     * 然后通过 {@link AVChatManagerLite#joinRoom2(String, AVChatType, AVChatCallback)} 来加入房间。
     * 房间创建成功后会一直保留, 尽量即时使用, 目前有效期为一个月, 超过有效期后再次加入房间会失败。
     * 如果一个房间已经被创建, 那么再次创建时会返回失败, 提示房间已经存在。</p>
     *
     * <p>房间创建时机不受音视频通话流程限制, 你可以在任意时间预定自己的多人会议房间。创建成功后即可通知所有会议参与者加入此房间,
     * 你将会在 {@link AVChatStateObserverLite#onUserJoined(String)} 中陆续收到不同的用户加入会议。</p>
     *
     * @param roomName       房间名
     * @param extraMessage   自定义的扩展消息, 其它加入房间的用户都会收到
     * @param liveConfigList 直播推流相关的配置，可以同时配置多种Config，推多路不同的流，如果不需要推流，填 null 即可 。<br/>
     *                       注意： 设置这个参数跟自己是否推流无关 ， 如果需要推流，请打开{@link AVChatParameters#KEY_SESSION_LIVE_MODE} 开关
     * @param callback       创建房间回调接口
     * @see AVChatLiveTaskConfig
     * @see AVChatParameters#KEY_SESSION_LIVE_MODE
     * @see AVChatResCode#ERROR_CREATE_ROOM_ALREADY_EXIST
     * @see AVChatManagerLite#createRoom(String, String, List, AVChatCallback)
     * @see AVChatManagerLite#joinRoom2(String, AVChatType, AVChatCallback)
     * @see AVChatManagerLite#leaveRoom2(String, AVChatCallback)
     */
    public abstract void createRoom(String roomName,
                                    String extraMessage,
                                    List<AVChatLiveTaskConfig> liveConfigList,
                                    AVChatCallback<AVChatChannelInfo> callback);


    /**
     * <p>加入已经预先创建的多人会议房间</p>
     *
     * <p><b>加入一个多人会议房间前需要调用以下接口:</b>
     * <ol>
     * <li>开启音视频引擎  {@link AVChatManagerLite#enableRtc()}</li>
     * <li>可选, 激活视频模块 {@link AVChatManagerLite#enableVideo()}</li>
     * <li>可选, 设置本地预览画布，{@link AVChatManagerLite#setupLocalVideoRender(IVideoRender, boolean, int)}</li>
     * <li>可选, 开启视频预览，{@link AVChatManagerLite#startVideoPreview()}</li>
     * <li>可选, 通话相关参数设置 {@link AVChatManagerLite#setParameters(AVChatParameters)}</li>
     * </ol>
     * </p>
     *
     * <p>当你成功加入会议后, 你会收到 {@link AVChatStateObserverLite#onUserJoined(String)} 来通知目前会议室内已经存在的用户。
     * 在离开房间时需要调用 {@link AVChatManagerLite#leaveRoom2(String, AVChatCallback)}。</p>
     *
     * <p><b>多人会议的加入其他用户是不会收到信令层的通知,只能通过媒体层的通知来获取用户加入 {@link AVChatStateObserverLite#onUserJoined(String)}。 </b></p>
     *
     * <p><b>如果你的产品加入多人会议是为了进行互动直播, 那么你还需要额外设置以下参数 {@link AVChatManagerLite#setParameter(AVChatParameters.Key, Object)}:</b>
     * <ul>
     * <li>打开互动直播模式, {@link AVChatParameters#KEY_SESSION_LIVE_MODE}</li>
     * <li>如果你是主播, 还需要设置推流地址 {@link AVChatParameters#KEY_SESSION_LIVE_URL}</li>
     * </ul>
     * </p>
     *
     * @param roomName 房间名
     * @param callType 房间通话类型
     * @param callback 加入房间回调接口
     * @see AVChatManagerLite#createRoom(String, String, AVChatCallback)
     * @see AVChatManagerLite#leaveRoom2(String, AVChatCallback)
     */
    public abstract void joinRoom2(String roomName,
                                   final AVChatType callType,
                                   AVChatCallback<AVChatData> callback);

    /**
     * <p>离开加入的多人会议房间</p>
     *
     * <p><b>此接口仅仅是离开多人会话房间,如果需要销毁引擎释放资源需要调用以下接口:</b>
     * <ol>
     * <li>可选, 关闭视频预览 {@link AVChatManagerLite#stopVideoPreview()} ()}</li>
     * <li>可选, 关闭视频模块 {@link AVChatManagerLite#disableVideo()}}</li>
     * <li>释放通话资源 {@link AVChatManagerLite#disableRtc()}</li>
     * </ol>
     * </p>
     *
     * <p><b>多人会议的离开其他用户是不会收到信令层的通知,只能通过媒体层的通知来获取用户离开 {@link AVChatStateObserverLite#onUserLeave(String, int)}。</b></p>
     *
     * @param roomName 房间名
     * @param callback 离开房间的回调接口
     * @see AVChatManagerLite#createRoom(String, String, AVChatCallback)
     * @see AVChatManagerLite#joinRoom2(String, AVChatType, AVChatCallback)
     */
    public abstract void leaveRoom2(String roomName,
                                    AVChatCallback<Void> callback);


    /**
     * <p>通用信令消息发送</p>
     *
     * <p>在通话过程中, 你可以发送信令消息通知到房间内的其他用户。
     * 当用户注册了 {@link AVChatManagerLite#observeControlNotification(Observer, boolean)} 监听器后都会
     * 收到你发送的信令消息。</p>
     *
     * <p>SDK内部定义了一些通用信令,参考 {@link AVChatControlCommand}, 通过这些信令能够实现 正忙发送, 音视频通话模式切换等常用功能。
     * 如果你需要实现属于自己的信令, 可以在 {@link AVChatControlCommand#NOTIFY_CUSTOM_BASE} 基础上去定义自己的信令。</p>
     *
     * <p><b>信令的发送和接收仅仅是消息的透传, 它不会影响SDK内部任何逻辑。如果你需要对接收到的指令进行响应, 请调用相关其他引擎接口。</b></p>
     *
     * @param chatId         会话ID
     * @param controlCommand 控制命令值
     * @param callback       回调函数
     * @see AVChatControlCommand
     */
    public abstract void sendControlCommand(long chatId,
                                            byte controlCommand,
                                            AVChatCallback<Void> callback);


    /**
     * <p>获取当前会话ID</p>
     *
     * <p>每通会话都会有一个唯一的ID, 同时SDK仅同时允许一通会话进行。 如果当前有会话正在进行，通过此接口能获取到其会话ID。
     * 在 {@link AVChatManagerLite#call2(String, AVChatType, AVChatNotifyOption, AVChatCallback)}
     * {@link AVChatManagerLite#accept2(long, AVChatCallback)} 接口成功回调时会告知用户当前会话ID。</p>
     *
     * @return 返回当前正在进行的会话ID
     */
    public abstract long getCurrentChatId();


    /**
     * 通过account 获取 uid
     *
     * @return account 对应的uid ，或者 null (不在频道中)
     */
    public abstract Long getUidByAccount(String account);

    /**
     * <p>语音通话模式设置</p>
     *
     * <p>在通话前可以设置本次通话的语音模式, 目前支持两种种语音模式。
     * <ul>
     * <li>{@link AVChatChannelProfile#CHANNEL_PROFILE_DEFAULT} 默认语音通话模式</li>
     * <li>{@link AVChatChannelProfile#CHANNEL_PROFILE_HIGH_QUALITY_MUSIC} 高清音乐模式</li>
     * </ul>
     * </p>
     * <p>
     * 注意：高清音乐模式仅限耳机场景下使用 ， 其他场景可能导致音频质量不佳
     *
     * @param profile 通话场景.
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see AVChatChannelProfile
     */
    public abstract boolean setChannelProfile(int profile);


    /**
     * <p>视频质量调整策略设置</p>
     *
     * <p>目前视频调整支持三种模式:
     * <ul>
     * <li>清晰优先。 在此模式下会优先保证视频的清晰度, 网络不稳定时会优先降低帧率来保证视频的清晰度</li>
     * <li>流畅优先。 在此模式下会优先保证视频的流畅度, 网络不稳定是会优先降低视频分辨率来保证视频的流程度</li>
     * <li>录屏模式。 在此模式下会保持分辨率不变, 初始码率较低，IP帧比例增大</li>
     * </ul>
     * </p>
     *
     * @param strategy 策略类型 {@link AVChatVideoQualityStrategy}
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see AVChatVideoQualityStrategy
     */
    public abstract boolean setVideoQualityStrategy(int strategy);


    /**
     * <p>设置视频数据源</p>
     *
     * <p>在进行视频通话时需要设置一个可用的视频数据源，该方法需要在{@link AVChatManager#startVideoPreview()}前调用。
     * 目前SDK支持多种视频数据源：
     * <ul>
     * <li>摄像头数据源。通过手机摄像头采集视频画面，可以使用{@link AVChatVideoCapturerFactory#createCameraPolicyCapturer(boolean)}创建一个摄像头数据源。</li>
     * <li>外部数据源。 可以自定义视频数据源，仅需实现{@link AVChatExternalVideoCapturer}。</li>
     * </ul>
     * </p>
     *
     * @param videoCapturer 视频数据源
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see AVChatCameraCapturer
     * @see AVChatVideoCapturerFactory#createCameraPolicyCapturer(boolean)
     * @see AVChatExternalVideoCapturer
     */
    public abstract boolean setupVideoCapturer(AVChatVideoCapturer videoCapturer);


    /**
     * <p>开启本地视频预览</p>
     *
     * <p>开启视频预览前需要调用 {@link AVChatManager#enableVideo()} 打开视频模块，同时设置视频数据源 {@link AVChatManagerLite#setupVideoCapturer(AVChatVideoCapturer)}。
     * 如果需要绘制视频内容需要调用 {@link AVChatManager#setupLocalVideoRender(IVideoRender, boolean, int)} 设置本地预览画布。</p>
     *
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     */
    public abstract boolean startVideoPreview();


    /**
     * <p>关闭本地视频预览</p>
     *
     * <p>在视频通话时，可以随时调用视频画面预览。调用此方法后，视频本地预览和视频数据发送都会停止。</p>
     *
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     */
    public abstract boolean stopVideoPreview();


    /**
     * 设置参数。
     * 参数类型参考 {@link AVChatParameters.Key#type()}。
     * 参数可设置时机参考 {@link AVChatParameters.Key#runtime()}，支持 {@code runtime} 代表通话过程中可操作，不支持则仅能通话前操作。
     * 参数是否可设置参考 {@link AVChatParameters.Key#writable()}, 支持 {@code writable} 代表能够设置参数值，不支持则仅能获取参数值。
     *
     * @param params 设置参数
     * @throws IllegalArgumentException 参数值非法或者参数不支持运行时设置
     * @see AVChatParameters
     * @see AVChatParameters.Key
     * @see AVChatMediaCodecMode
     * @see AVChatAudioEffectMode
     */
    public abstract void setParameters(AVChatParameters params) throws IllegalArgumentException;

    /**
     * 设置参数。
     * 参数类型参考 {@link AVChatParameters.Key#type()}。
     * 参数可设置时机参考 {@link AVChatParameters.Key#runtime()}，支持 {@code runtime} 代表通话过程中可操作，不支持则仅能通话前操作。
     * 参数是否可设置参考 {@link AVChatParameters.Key#writable()}, 支持 {@code writable} 代表能够设置参数值，不支持则仅能获取参数值。
     *
     * @param key   参数Key
     * @param value 参数值
     * @param <T>   参数数据类型
     * @throws IllegalArgumentException 参数值非法或者参数不支持运行时设置
     * @see AVChatParameters
     * @see AVChatParameters.Key
     * @see AVChatMediaCodecMode
     * @see AVChatAudioEffectMode
     */
    public abstract <T> void setParameter(AVChatParameters.Key<T> key, T value) throws IllegalArgumentException;

    /**
     * 获取参数。
     * 参数类型参考 {@link AVChatParameters.Key#type()}。
     * 参数可设置时机参考 {@link AVChatParameters.Key#runtime()}，支持 {@code runtime} 代表通话过程中可操作，不支持则仅能通话前操作。
     * 参数是否可设置参考 {@link AVChatParameters.Key#writable()}, 支持 {@code writable} 代表能够设置参数值，不支持则仅能获取参数值。
     *
     * @param params 需要获取的参数, <code>null</code>则是取所有参数
     * @return 获取参数
     * @see AVChatParameters
     * @see AVChatParameters.Key
     * @see AVChatMediaCodecMode
     * @see AVChatAudioEffectMode
     */
    public abstract AVChatParameters getParameters(AVChatParameters params);

    /**
     * 获取参数。
     * 参数类型参考 {@link AVChatParameters.Key#type()}。
     * 参数可设置时机参考 {@link AVChatParameters.Key#runtime()}，支持 {@code runtime} 代表通话过程中可操作，不支持则仅能通话前操作。
     * 参数是否可设置参考 {@link AVChatParameters.Key#writable()}, 支持 {@code writable} 代表能够设置参数值，不支持则仅能获取参数值。
     *
     * @param key 参数Key
     * @param <T> 参数类型
     * @return 参数值
     * @see AVChatParameters
     * @see AVChatParameters.Key
     * @see AVChatMediaCodecMode
     * @see AVChatAudioEffectMode
     */
    public abstract <T> T getParameter(AVChatParameters.Key<T> key);


    /**
     * 本地语音是否静音.
     *
     * @return @return {@code true} 本地语音静音，{@code false} 本地语音未静音
     * @see #muteLocalAudio(boolean)
     */
    public abstract boolean isLocalAudioMuted();

    /**
     * 是否发送本地视频流数据.
     *
     * @return {@code true} 本地视频暂停，{@code false} 本地视频未暂停
     */
    public abstract boolean isLocalVideoMuted();

    /**
     * 开/关本地音频.
     *
     * @param muted {@code true} 静音本地语音，{@code false} 取消本地语音静音
     */
    public abstract void muteLocalAudio(boolean muted);


    /**
     * 开/关本地视频流的发送.
     *
     * @param muted {@code true} 不发送本地视频流，{@code false} 发送本地视频流
     * @deprecated 使用 {@link AVChatManager#publishVideo()} ()} 、{@link AVChatManager#unpublishVideo()}
     */
    @Deprecated
    public abstract void muteLocalVideo(boolean muted);

    /**
     * 是否使用扬声器
     *
     * @param enable {@code true} 打开扬声器，{@code false} 关闭扬声器
     */
    public abstract void setSpeaker(boolean enable);


    /**
     * 扬声器是否打开
     *
     * @return {@code true} 扬声器已打开，{@code false} 扬声器未打开
     */
    public abstract boolean speakerEnabled();


    /**
     * 设置麦克风是否静音
     *
     * @param mute 麦克风是否静音
     */
    public abstract void setMicrophoneMute(boolean mute);


    /**
     * 检查麦克风是否静音
     *
     * @return 麦克风是否静音
     */
    public abstract boolean isMicrophoneMute();


    /**
     * 设置是否允许播放远端用户数据.
     *
     * @param account 用户账号
     * @param muted   {@code true} 不解码播放远端语音流，{@code false} 解码播放远端语音流
     */
    public abstract void muteRemoteAudio(String account, boolean muted);

    /**
     * 设置是否允许播放远端用户数据.
     *
     * @param muted {@code true} 不解码播放远端语音流，{@code false} 解码播放远端语音流
     */
    public abstract void muteAllRemoteAudio(boolean muted);

    /**
     * 设置音频输出设备
     * 可选设备列表来自此回调 {@link AVChatStateObserverLite#onAudioDeviceChanged}
     *
     * @param audioDevice {@link com.netease.nimlib.sdk.avchat.constant.AVChatAudioDevice}
     */
    public abstract void selectAudioDevice(int audioDevice);

    /**
     * 设置是否允许播放远端用户数据.
     *
     * @param account 用户账号
     * @param muted   {@code true} 不解码绘制远端视频流，{@code false} 解码绘制远端视频流
     * @deprecated 使用 {@link AVChatManager#unsubscribeVideo(String account)} 、{@link AVChatManager#subscribeVideo(String account, int videoType)}
     */
    @Deprecated
    public abstract void muteRemoteVideo(String account, boolean muted);


    /**
     * 当前是否关闭用户语音数据播放.
     *
     * @param account 用户账号
     * @return {@code true} 解码播放远端语音流，{@code false} 不解码播放远端语音流
     */
    public abstract boolean isRemoteAudioMuted(String account);

    /**
     * 当前是否关闭用户语音数据播放.
     *
     * @return {@code true} 解码播放远端语音流，{@code false} 不解码播放远端语音流
     */
    public abstract boolean isAllRemoteAudioMuted();

    /**
     * 当前是否关闭用户视频数据播放.
     *
     * @param account 用户账号
     * @return {@code true} 解码绘制远端视频流，{@code false} 不解码绘制远端视频流
     */
    public abstract boolean isRemoteVideoMuted(String account);

    /**
     * 设置本地用户视频画布。
     * <br>如果需要预览，设置自己视频画面的画布需要在call或者joinRoom的onSuccess回调中调用.</br>
     * <br>如果不需要预览，设置自己视频画面的画布需要在 <code>AVChatStateObserver#onCallEstablished</code> 后调用.</br>
     *
     * @param render      画布. {@link AVChatSurfaceViewRenderer}, {@link AVChatExternalVideoRender}, {@link AVChatTextureViewRenderer}
     * @param mirror      绘制是否镜像, 设置画布为 {@link AVChatSurfaceViewRenderer} 时有效
     * @param scalingType 绘制模式, 设置画布为 {@link AVChatSurfaceViewRenderer} 时有效
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see com.netease.nimlib.sdk.avchat.constant.AVChatVideoScalingType
     */
    public abstract boolean setupLocalVideoRender(IVideoRender render, boolean mirror, int scalingType);

    /**
     * 设置远端用户视频画布。
     * <br>设置远端用户视频画面的画布需要在 <code>AVChatStateObserver#onUserJoined</code> 后调用.</br>
     *
     * @param account     用户账号
     * @param render      画布,  {@link AVChatSurfaceViewRenderer}, {@link AVChatExternalVideoRender}, {@link AVChatTextureViewRenderer}
     * @param mirror      绘制是否镜像, 设置画布为 {@link AVChatSurfaceViewRenderer} 时有效
     * @param scalingType 绘制模式, 设置画布为 {@link AVChatSurfaceViewRenderer} 时有效
     * @return {@code true} 方法调用成功，{@code false} 方法调用失败
     * @see com.netease.nimlib.sdk.avchat.constant.AVChatVideoScalingType
     */
    public abstract boolean setupRemoteVideoRender(String account, IVideoRender render, boolean mirror, int scalingType);


    /**
     * 注册/注销网络来电.
     * 当收到对方来电请求时，会通知上层通话信息。
     * 用户可以选择 {@link AVChatManager#accept2(long, AVChatCallback)} 来接听电话，
     * 或者 {@link AVChatManager#hangUp2(long, AVChatCallback)}  来挂断电话。 通常在收到来电请求时，上层需要维持
     * 一个超时器，当超过一定时间没有操作时直接调用 {@link AVChatManager#hangUp2(long, AVChatCallback)} 来挂断。
     * <p>
     * 当用户当前有电话在进行时，如果收到来电请求，需要选择是接听当前电话和是继续原来的通话。如果接听当前来电，则需要
     * {@link AVChatManager#hangUp2(long, AVChatCallback)} 原来进行的电话，然后 {@link AVChatManager#accept2(long, AVChatCallback)}
     * 当前来电。 如果选择继续原来的通话，挂断当前来电，最好能够先发送一个正忙的指令给对方 {@link AVChatManager#sendControlCommand(long, byte, AVChatCallback)}，
     * 然后在再挂断 {@link AVChatManager#hangUp2(long, AVChatCallback)} 当前通话。
     *
     * @param observer 观察者，参数为被叫通话的基本信息
     * @param register {@code true} 注册监听，{@code false} 注销监听
     */
    public abstract void observeIncomingCall(Observer<AVChatData> observer, boolean register);

    /**
     * 注册/注销网络通话状态通知
     * 网络通话开始后，所有的通话状态通过 {@link AVChatStateObserverLite} 进行通知。
     *
     * @param observer 观察者，参数为通话状态回调
     * @param register {@code true} 注册监听，{@code false} 注销监听
     */
    public abstract void observeAVChatState(AVChatStateObserverLite observer, boolean register);

    /**
     * 注册/注销网络通话被叫方的响应（接听、拒绝、忙）
     *
     * @param observer 观察者， 参数为接收到的网络通话的通知消息
     * @param register {@code true} 注册监听，{@code false} 注销监听
     */
    public abstract void observeCalleeAckNotification(Observer<AVChatCalleeAckEvent> observer, boolean register);

    /**
     * 注册/注销同时在线的其他端对主叫方的响应
     *
     * @param observer 观察者，参数为同时在线的其他端响应主叫方的同步通知
     * @param register {@code true} 注册监听，{@code false} 注销监听
     */
    public abstract void observeOnlineAckNotification(Observer<AVChatOnlineAckEvent> observer, boolean register);

    /**
     * 注册/注销网络通话对方挂断的通知
     *
     * @param observer 观察者， 参数为接收到的网络通话的挂断消息
     * @param register {@code true} 注册监听，{@code false} 注销监听
     */
    public abstract void observeHangUpNotification(Observer<AVChatCommonEvent> observer, boolean register);


    /**
     * 注册/注销网络通话控制消息（音视频模式切换通知）
     * <p>
     * 会话相关的控制指令通知，用户可以自定义私有的控制指令。
     *
     * @param observer 观察者， 参数为接收到的网络通话控制消息
     * @param register {@code true} 注册监听，{@code false} 注销监听
     */
    public abstract void observeControlNotification(Observer<AVChatControlEvent> observer, boolean register);

    /**
     * 当前通话打分
     *
     * @param rate        0~5分
     * @param description 通话描述信息
     */
    public abstract void rate(int rate, String description);

}