AVChatStateObserverLite.java

浏览该文件的文档.

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

package com.netease.nimlib.sdk.avchat;

import com.netease.nimlib.sdk.avchat.constant.AVChatAudioDevice;
import com.netease.nimlib.sdk.avchat.constant.AVChatNetworkQuality;
import com.netease.nimlib.sdk.avchat.constant.AVChatResCode;
import com.netease.nimlib.sdk.avchat.constant.AVChatType;
import com.netease.nimlib.sdk.avchat.constant.AVChatUserQuitType;
import com.netease.nimlib.sdk.avchat.model.AVChatAudioFrame;
import com.netease.nimlib.sdk.avchat.model.AVChatNetworkStats;
import com.netease.nimlib.sdk.avchat.model.AVChatNotifyOption;
import com.netease.nimlib.sdk.avchat.model.AVChatParameters;
import com.netease.nimlib.sdk.avchat.model.AVChatSessionStats;
import com.netease.nimlib.sdk.avchat.model.AVChatVideoFrame;
import com.netease.nrtc.sdk.common.VideoFilterParameter;
import com.netease.nrtc.sdk.video.VideoFrame;

import java.util.Map;
import java.util.Set;

/**
 * 通话过程中的状态变化监听
 */
public interface AVChatStateObserverLite {


    /**
     * 服务器连接回调
     *
     * @param code      加入服务器结果 {@link AVChatResCode.JoinChannelCode}
     * @param audioFile 如果存在服务器录制,指向语音文件.
     * @param videoFile 如果存在服务器录制,指向视频文件.
     * @param elapsed   从下面三个相关调用处开始计算，到成功加入房间的耗时，单位ms
     * @see AVChatManager#call2(String, AVChatType, AVChatNotifyOption, AVChatCallback)
     * @see AVChatManager#accept2(long, AVChatCallback)
     * @see AVChatManager#joinRoom2(String, AVChatType, AVChatCallback)
     */
    void onJoinedChannel(int code, String audioFile, String videoFile, int elapsed);


    /**
     * 用户加入频道
     *
     * @param account 用户账号
     * @see AVChatManager#call2(String, AVChatType, AVChatNotifyOption, AVChatCallback)
     * @see AVChatManager#accept2(long, AVChatCallback)
     * @see AVChatManager#joinRoom2(String, AVChatType, AVChatCallback)
     */
    void onUserJoined(String account);


    /**
     * 用户离开频道
     *
     * @param account 用户ID
     * @param event   {@link AVChatUserQuitType}
     * @see AVChatManager#hangUp2(long, AVChatCallback)
     * @see AVChatManager#leaveRoom2(String, AVChatCallback)
     */
    void onUserLeave(String account, int event);


    /**
     * 退出频道.
     *
     * @see AVChatManager#hangUp2(long, AVChatCallback)
     * @see AVChatManager#leaveRoom2(String, AVChatCallback)
     */
    void onLeaveChannel();


    /**
     * 双方协议版本不兼容
     *
     * @param status {@link AVChatResCode#ERROR_PROTO_INCOMPATIBLE_LOCAL_LOW} 自己版本过低,  {@link AVChatResCode#ERROR_PROTO_INCOMPATIBLE_REMOTE_LOW} 对方版本过低
     * @see AVChatResCode#ERROR_PROTO_INCOMPATIBLE_REMOTE_LOW
     * @see AVChatResCode#ERROR_PROTO_INCOMPATIBLE_LOCAL_LOW
     */
    void onProtocolIncompatible(int status);


    /**
     * 从服务器断开连接会收到此通知。
     *
     * @param code {@link AVChatResCode#ERROR_DISCONNECT_SERVER_TIMEOUT} 断网超时离开, {@link AVChatResCode#ERROR_DISCONNECT_SERVER_CHANNEL_CLOSED} 房间被关闭
     * @see AVChatResCode#ERROR_DISCONNECT_SERVER_TIMEOUT
     * @see AVChatResCode#ERROR_DISCONNECT_SERVER_CHANNEL_CLOSED
     */
    void onDisconnectServer(int code);


    /**
     * 网络状态发生变化
     *
     * @param account 用户账号
     * @param quality 网络状态等级
     * @param stats   网络状态信息
     * @see AVChatNetworkQuality
     */
    void onNetworkQuality(String account, int quality, AVChatNetworkStats stats);

    /**
     * 会话成功建立.
     */
    void onCallEstablished();


    /**
     * 语音采集设备和视频采集设备事件通知
     *
     * @param code 事件ID
     * @param desc 事件描述
     * @see com.netease.nimlib.sdk.avchat.constant.AVChatDeviceEvent
     */
    void onDeviceEvent(int code, String desc);


    /**
     * 客户端网络类型发生了变化
     *
     * @param netType 当前的网络类型
     * @see com.netease.nimlib.sdk.avchat.constant.AVChatConnectionType
     */
    void onConnectionTypeChanged(int netType);


    /**
     * 用户第一帧视频数据绘制前通知.
     *
     * @param account 用户账号
     */
    void onFirstVideoFrameAvailable(String account);


    /**
     * 第一帧绘制通知
     *
     * @param account 用户账号
     */
    void onFirstVideoFrameRendered(String account);


    /**
     * 用户画面尺寸改变通知
     *
     * @param account 用户账号
     * @param width   视频宽
     * @param height  视频高
     * @param rotate  视频角度
     */
    void onVideoFrameResolutionChanged(String account, int width, int height, int rotate);


    /**
     * 用户视频画面fps更新, 需要设置参数 {@link AVChatParameters#KEY_VIDEO_FPS_REPORTED}.
     *
     * @param account 用户账号
     * @param fps     当前绘制帧率
     * @see AVChatParameters#KEY_VIDEO_FPS_REPORTED
     * @see AVChatManager#setParameter(AVChatParameters.Key, Object)
     */
    void onVideoFpsReported(String account, int fps);


    /**
     * 视频数据外部处理接口, 此接口需要同步执行. 操作运行在视频数据发送线程上,处理速度过慢会导致帧率过低
     *
     * @param frame          待处理数据
     * @param maybeDualInput 如果为 {@code true} 则代表需要外部输入两路数据，
     *                       {@link AVChatVideoFrame#data} 处理后的原始数据，{@link AVChatVideoFrame#dataMirror} 处理后的镜像数据。
     *                       如果为  {@code false} 则代表仅需要外部输入一路数据，仅支持 {@link AVChatVideoFrame#data}。
     *                       在实际使用过程中，用户需要根据自己需求来决定是否真正需要输入镜像数据，一般在使用到水印等外部处理时才会需要真正输入两路数据，其他情况可以忽略此参数。
     * @return 返回true成功
     */
    boolean onVideoFrameFilter(AVChatVideoFrame frame, boolean maybeDualInput);

    /**
     * 视频数据外部处理接口, 此接口需要同步执行. 操作运行在视频数据发送线程上,处理速度过慢会导致帧率过低
     * @param input          待处理数据
     * @param outputFrames   {@link VideoFrame[0]} 处理后的原始数据，{@link VideoFrame[1]} 处理后的镜像数据。
     *                       如果为  {@code false} 则代表仅需要外部输入一路数据，仅支持 {@link VideoFrame[0]}。
     *                       在实际使用过程中，用户需要根据自己需求来决定是否真正需要输入镜像数据，一般在使用到水印等外部处理时才会需要真正输入两路数据，其他情况可以忽略此参数。
     * @param filterParameter 待处理数据的参数
     * @return 返回true成功
     */
    boolean onVideoFrameFilter(final VideoFrame input, VideoFrame[] outputFrames, VideoFilterParameter filterParameter);


    /**
     * 语音数据处理接口, 不要改变数据的长度. 需要设置参数 {@link AVChatParameters#KEY_AUDIO_FRAME_FILTER}.
     *
     * @param frame 语音帧
     * @return 返回false 失败
     * @see AVChatParameters#KEY_AUDIO_FRAME_FILTER
     * @see AVChatManager#setParameter(AVChatParameters.Key, Object)
     */
    boolean onAudioFrameFilter(AVChatAudioFrame frame);


    /**
     * 音频设备变化
     *
     * @param device 语音设备
     * @param set 可选语音设备
     * @param shouldSelect 如果为true，可以弹框选择蓝牙外放、耳机外放选项
     * @see AVChatAudioDevice
     */
    void onAudioDeviceChanged(int device, Set<Integer> set, boolean shouldSelect);


    /**
     * 汇报正在说话的用户。 需要设置参数 {@link AVChatParameters#KEY_AUDIO_REPORT_SPEAKER}.
     *
     * @param speakers    用户账号和声音强度的键值对
     * @param mixedEnergy 除去自己后，所有用户语音混音后的强度
     * @see AVChatParameters#KEY_AUDIO_REPORT_SPEAKER
     * @see AVChatManager#setParameter(AVChatParameters.Key, Object)
     */
    void onReportSpeaker(Map<String, Integer> speakers, int mixedEnergy);

    /**
     * 实时统计信息
     *
     * @param sessionStats 详细的统计信息
     */
    void onSessionStats(AVChatSessionStats sessionStats);

    /**
     * 互动直播相关事件通知
     *
     * @param event {@link AVChatResCode.LiveEventCode}
     */
    void onLiveEvent(int event);
}