AVChatStateObserver.java

浏览该文件的文档.

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

package com.netease.nimlib.sdk.avchat;


import com.netease.nimlib.sdk.avchat.constant.AVChatAudioEffectEvent;
import com.netease.nrtc.sdk.NRtcConstants;

/**
 * {@inheritDoc}
 */
public interface AVChatStateObserver extends AVChatStateObserverLite {


    /**
     * 截取用户图像后的结果通知。
     *
     * @param account 被截图用户的账号
     * @param success 截图是否成功
     * @param file    截图成功后只想图像存储路径
     * @see AVChatManager#takeSnapshot(String)
     */
    void onTakeSnapshotResult(String account, boolean success, String file);


    /**
     * 用户音视频数据录制开始
     *
     * @param account  用户账号
     * @param fileDir 录制文件目录路径，当发生视频清晰度等情况变化时会存在多个MP4文件
     * @see AVChatManager#startAVRecording(String)
     * @see AVChatManager#stopAVRecording(String)
     */
    void onAVRecordingStart(String account, String fileDir);

    /**
     * 语音录制开始
     *
     * @param fileDir 录制语音文件目录路径
     * @see AVChatManager#startAudioRecording()
     * @see AVChatManager#stopAudioMixing()
     */
    void onAudioRecordingStart(String fileDir);


    /**
     * 用户音视频数据录制结束
     *
     * @param account  用户账号
     * @param filePath 录制文件路径，当发生视频清晰度等情况变化时会存在多个MP4文件
     * @see AVChatManager#startAVRecording(String)
     * @see AVChatManager#stopAVRecording(String)
     */
    void onAVRecordingCompletion(String account, String filePath);

    /**
     * 语音录制结束。
     *
     * @param filePath 录制语音文件路径
     * @see AVChatManager#startAudioRecording()
     * @see AVChatManager#stopAudioMixing()
     */
    void onAudioRecordingCompletion(String filePath);

    /**
     * 存储空间不足警告，存储空间低于20M时开始出现警告，出现警告时请及时关闭所有的录制服务，当存储空间低于10M时会自动关闭所有的录制功能
     *
     * @param availableSize 可用空间
     * @see AVChatManager#startAVRecording(String)
     * @see AVChatManager#startAudioRecording()
     */
    void onLowStorageSpaceWarning(long availableSize);

    /**
     * 汇报混音进度
     *
     * @param progressMs 混音当前播放位置（单位毫秒, 未知情况为-1
     * @param durationMs 混音文件时长（单位毫秒, 未知情况为-1
     */
    void onAudioMixingProgressUpdated(long progressMs, long durationMs);

    /**
     * 伴音事件通知
     *
     * @param event 事件类型
     * @see com.netease.nimlib.sdk.avchat.constant.AVChatAudioMixingEvent#MIXING_ERROR
     * @see com.netease.nimlib.sdk.avchat.constant.AVChatAudioMixingEvent#MIXING_FINISHED
     * @see com.netease.nimlib.sdk.avchat.constant.AVChatAudioMixingEvent#MIXING_STARTED
     * @see AVChatManager#startAudioMixing(String, boolean, boolean, int, float)
     * @see AVChatManager#stopAudioMixing()
     */
    void onAudioMixingEvent(int event);

    /**
     * 音效预加载结果回调
     *
     * @param effectId 音效id
     * @param result   预加载结果 :
     * @see AVChatAudioEffectEvent#AUDIO_EFFECT_PRELOAD_SUCCESS
     * @see AVChatAudioEffectEvent#AUDIO_EFFECT_PRELOAD_COUNT_LIMIT
     * @see AVChatAudioEffectEvent#AUDIO_EFFECT_PRELOAD_TOO_LONG
     * @see AVChatAudioEffectEvent#AUDIO_EFFECT_PRELOAD_FAILED
     */
    void onAudioEffectPreload(int effectId, int result);


    /**
     * 音效播放事件回调
     *
     * @param effectId 音效id
     * @param event    事件类型：
     * @see AVChatAudioEffectEvent#AUDIO_EFFECT_PLAY_COMPLETE
     */
    void onAudioEffectPlayEvent(int effectId, int event);


    /**
     * 发布视频流回调
     *
     * @param result 0为发布成功，非0为失败
     */
    void onPublishVideoResult(int result);


    /**
     * 停止发布视频流回调
     *
     * @param result 0为停止发布成功，非0为失败
     */
    void onUnpublishVideoResult(int result);


    /**
     * 订阅视频流回调
     *
     * @param account   用户account
     * @param videoType 订阅的流类型，参考:<br/>
     *                  {@link NRtcConstants.Subscribe#VIDEO_TYPE_HIGH_RES}: 大流<br/>
     *                  {@link NRtcConstants.Subscribe#VIDEO_TYPE_LOW_RES}: 小流<br/>
     * @param result    0表示订阅成功，非0表示失败
     */
    void onSubscribeVideoResult(String account, int videoType, int result);


    /**
     * 取消订阅视频流回调
     *
     * @param videoType 取消订阅的流类型，参考:<br/>
     *                  {@link NRtcConstants.Subscribe#VIDEO_TYPE_HIGH_RES}: 大流<br/>
     *                  {@link NRtcConstants.Subscribe#VIDEO_TYPE_LOW_RES}: 小流<br/>
     * @param account   用户account
     * @param result    0表示取消订阅成功，非0表示失败
     */
    void onUnsubscribeVideoResult(String account, int videoType, int result);


    /**
     * 当远端用户开始发布视频流时回调
     *
     * @param account    用户Account
     * @param videoTypes 当前用户发布的所有流类型，参考：<br/>
     *                   {@link NRtcConstants.Subscribe#VIDEO_TYPE_HIGH_RES}: 大流<br/>
     *                   {@link NRtcConstants.Subscribe#VIDEO_TYPE_LOW_RES}: 小流<br/>
     */
    void onRemotePublishVideo(String account, int[] videoTypes);


    /**
     * 当远端用户停止发布视频流时回调
     *
     * @param account 用户Account
     */
    void onRemoteUnpublishVideo(String account);


    /**
     * 取消订阅所有的活跃音频流时回调
     *
     * @param result 0表示取消订阅成功，非0表示失败
     */
    void onUnsubscribeAudioResult(int result);


    /**
     * 订阅所有的活跃音频流时回调
     *
     * @param result 0表示订阅成功，非0表示失败
     */
    void onSubscribeAudioResult(int result);

}