/*
 * Module:   TRTCCloudCallback @ TXLiteAVSDK
 *
 * Function: 腾讯云视频通话功能的回调接口类，若想从C++代码中获取到TRTC SDK的回调，请继承此类并调用 ITRTCCloud::addCallback(TRTCCloudCallback* callback)设置观察者
 *
 */

#ifndef __TRTCCLOUDCALLBACK_H__
#define __TRTCCLOUDCALLBACK_H__

#include "TRTCTypeDef.h"
#include "ITXDeviceManager.h"
#include "TXLiteAVCode.h"

namespace trtc {

/// @defgroup TRTCCloudCallback_cplusplus TRTCCloudCallback
/// 腾讯云视频通话功能的回调接口类
/// @{
/**
 * 腾讯云视频通话功能的回调接口类
 */
class ITRTCCloudCallback
{
public:
    virtual ~ITRTCCloudCallback() {}

    /////////////////////////////////////////////////////////////////////////////////
    //
    //                      （一）错误事件和警告事件
    //
    /////////////////////////////////////////////////////////////////////////////////
    /// @name 错误事件和警告事件
    /// @{
    /**
     * 1.1 错误回调：SDK 不可恢复的错误，一定要监听，并分情况给用户适当的界面提示。
     *
     * @param errCode 	错误码
     * @param errMsg 	错误信息
     * @param extraInfo 扩展信息字段，个别错误码可能会带额外的信息帮助定位问题
     */
    virtual void onError(TXLiteAVError errCode, const char* errMsg, void* extraInfo) = 0;

    /**
     * 1.2 警告回调：用于告知您一些非严重性问题，例如出现了卡顿或者可恢复的解码失败。
     *
     * @param warningCode 警告码
     * @param warningMsg 警告信息
     * @param extraInfo 扩展信息字段，个别警告码可能会带额外的信息帮助定位问题
     */
    virtual void onWarning(TXLiteAVWarning warningCode, const char* warningMsg, void* extraInfo) = 0;
    /// @}

    /////////////////////////////////////////////////////////////////////////////////
    //
    //                      （二）房间事件回调
    //
    /////////////////////////////////////////////////////////////////////////////////
    /// @name 房间事件回调
    /// @{
    /**
     * 2.1 已加入房间的回调
     *
     * 调用 TRTCCloud 中的 enterRoom() 接口执行进房操作后，会收到来自 SDK 的 onEnterRoom(result) 回调：
     *
     * - 如果加入成功，result 会是一个正数（result > 0），代表加入房间的时间消耗，单位是毫秒（ms）。
     * - 如果加入失败，result 会是一个负数（result < 0），代表进房失败的错误码。
     * 进房失败的错误码含义请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。
     *
     * @note 在 Ver6.6 之前的版本，只有进房成功会抛出 onEnterRoom(result) 回调，进房失败由 onError() 回调抛出。
     *       在 Ver6.6 及之后改为：进房成功返回正的 result，进房失败返回负的 result，同时进房失败也会有 onError() 回调抛出。
     *
     * @param result result > 0 时为进房耗时（ms），result < 0 时为进房错误码。
     */
    virtual void onEnterRoom(int result) = 0;

    /**
     * 2.2 离开房间的事件回调
     *
     * 调用 TRTCCloud 中的 exitRoom() 接口会执行退出房间的相关逻辑，例如释放音视频设备资源和编解码器资源等。
     * 待资源释放完毕，SDK 会通过 onExitRoom() 回调通知到您。
     *
     * 如果您要再次调用 enterRoom() 或者切换到其他的音视频 SDK，请等待 onExitRoom() 回调到来后再执行相关操作。
     * 否则可能会遇到例如摄像头、麦克风设备被强占等各种异常问题。
     *
     * @param reason 离开房间原因，0：主动调用 exitRoom 退房；1：被服务器踢出当前房间；2：当前房间整个被解散。
     */
    virtual void onExitRoom(int reason) = 0;

    /**
     * 2.3 切换角色的事件回调
     *
     * 调用 TRTCCloud 中的 switchRole() 接口会切换主播和观众的角色，该操作会伴随一个线路切换的过程，
     * 待 SDK 切换完成后，会抛出 onSwitchRole() 事件回调。
     *
     * @param errCode 错误码，ERR_NULL 代表切换成功，其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。
     * @param errMsg  错误信息。
     */
    virtual void onSwitchRole(TXLiteAVError errCode, const char* errMsg) {}

    /**
     * 2.4 请求跨房通话（主播 PK）的结果回调
     *
     * 调用 TRTCCloud 中的 connectOtherRoom() 接口会将两个不同房间中的主播拉通视频通话，也就是所谓的“主播PK”功能。
     * 调用者会收到 onConnectOtherRoom() 回调来获知跨房通话是否成功，
     * 如果成功，两个房间中的所有用户都会收到 PK 主播的 onUserVideoAvailable() 回调。
     *
     * @param userId 要 PK 的目标主播 userId。
     * @param errCode 错误码，ERR_NULL 代表切换成功，其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。
     * @param errMsg  错误信息。
     */
    virtual void onConnectOtherRoom(const char* userId, TXLiteAVError errCode, const char* errMsg) {}

    /**
     * 2.5 结束跨房通话（主播 PK）的结果回调
     */
    virtual void onDisconnectOtherRoom(TXLiteAVError errCode, const char* errMsg) {}

    /**
     * 2.6 切换房间 (switchRoom) 的结果回调
     */
    virtual void onSwitchRoom(TXLiteAVError errCode, const char* errMsg) {}
    /// @}

    /////////////////////////////////////////////////////////////////////////////////
    //
    //                      （三）成员事件回调
    //
    /////////////////////////////////////////////////////////////////////////////////
    /// @name 成员事件回调
    /// @{
    /**
     * 3.1 有用户加入当前房间
     *
     * 出于性能方面的考虑，在两种不同的应用场景下，该通知的行为会有差别：
     * - 通话场景（TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall）：该场景下用户没有角色的区别，任何用户进入房间都会触发该通知。
     * - 直播场景（TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom）：该场景不限制观众的数量，如果任何用户进出都抛出回调会引起很大的性能损耗，所以该场景下只有主播进入房间时才会触发该通知，观众进入房间不会触发该通知。
     *
     *
     * @note 注意 onRemoteUserEnterRoom 和 onRemoteUserLeaveRoom 只适用于维护当前房间里的“成员列表”，如果需要显示远程画面，建议使用监听 onUserVideoAvailable() 事件回调。
     *
     * @param userId 用户标识
     */
    virtual void onRemoteUserEnterRoom(const char* userId) {}

    /**
     * 3.2 有用户离开当前房间
     *
     * 与 onRemoteUserEnterRoom 相对应，在两种不同的应用场景下，该通知的行为会有差别：
     * - 通话场景（TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall）：该场景下用户没有角色的区别，任何用户的离开都会触发该通知。
     * - 直播场景（TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom）：只有主播离开房间时才会触发该通知，观众离开房间不会触发该通知。
     *
     * @param userId 用户标识
     * @param reason 离开原因，0表示用户主动退出房间，1表示用户超时退出，2表示被踢出房间。
     */
    virtual void onRemoteUserLeaveRoom(const char* userId, int reason) {}

    /**
     * 3.3 用户是否开启摄像头视频
     *
     * 当您收到 onUserVideoAvailable(userId, YES) 通知时，表示该路画面已经有可用的视频数据帧到达。
     * 此时，您需要调用 startRemoteView(userId) 接口加载该用户的远程画面。
     * 然后，您还会收到名为 onFirstVideoFrame(userId) 的首帧画面渲染回调。
     *
     * 当您收到 onUserVideoAvailable(userId, NO) 通知时，表示该路远程画面已被关闭，
     * 可能由于该用户调用了 muteLocalVideo() 或 stopLocalPreview()。
     *
     * @param userId 用户标识
     * @param available 画面是否开启
     */
    virtual void onUserVideoAvailable(const char* userId, bool available) {}

    /**
     * 3.4 用户是否开启屏幕分享
     *
     * @param userId 用户标识
     * @param available 屏幕分享是否开启
     */
    virtual void onUserSubStreamAvailable(const char* userId, bool available) {}

    /**
     * 3.5 用户是否开启音频上行
     *
     * @param userId 用户标识
     * @param available 声音是否开启
     */
    virtual void onUserAudioAvailable(const char* userId, bool available) {}

    /**
     * 3.6 开始渲染本地或远程用户的首帧画面
     *
     * 如果 userId 为 null，表示开始渲染本地采集的摄像头画面，需要您先调用 startLocalPreview 触发。
     * 如果 userId 不为 null，表示开始渲染远程用户的首帧画面，需要您先调用 startRemoteView 触发。
     *
     * @note 只有当您调用 startLocalPreview()、startRemoteView() 或 startRemoteSubStreamView() 之后，才会触发该回调。
     *
     * @param userId 本地或远程用户 ID，如果 userId == null 代表本地，userId != null 代表远程。
     * @param streamType 视频流类型：摄像头或屏幕分享。
     * @param width  画面宽度
     * @param height 画面高度
     */
    virtual void onFirstVideoFrame(const char* userId, const TRTCVideoStreamType streamType, const int width, const int height) {}

    /**
     * 3.7 开始播放远程用户的首帧音频（本地声音暂不通知）
     *
     * @param userId 远程用户 ID。
     */
    virtual void onFirstAudioFrame(const char* userId) {}

    /**
     * 3.8 首帧本地视频数据已经被送出
     *
     * SDK 会在 enterRoom() 并 startLocalPreview() 成功后开始摄像头采集，并将采集到的画面进行编码。
     * 当 SDK 成功向云端送出第一帧视频数据后，会抛出这个回调事件。
     *
     * @param streamType 视频流类型，主画面、小画面或辅流画面（屏幕分享）
     */
    virtual void onSendFirstLocalVideoFrame(const TRTCVideoStreamType streamType) {}

    /**
     * 3.9 首帧本地音频数据已经被送出
     *
     * SDK 会在 enterRoom() 并 startLocalAudio() 成功后开始麦克风采集，并将采集到的声音进行编码。
     * 当 SDK 成功向云端送出第一帧音频数据后，会抛出这个回调事件。
     */
    virtual void onSendFirstLocalAudioFrame() {}
    /// @}

    /////////////////////////////////////////////////////////////////////////////////
    //
    //                      （四）统计和质量回调
    //
    /////////////////////////////////////////////////////////////////////////////////
    /// @name 统计和质量回调
    /// @{
    /**
     * 4.1 网络质量：该回调每2秒触发一次，统计当前网络的上行和下行质量
     *
     * @note userId == null 代表自己当前的视频质量
     *
     * @param localQuality 上行网络质量
     * @param remoteQuality 下行网络质量
     * @param remoteQualityCount 下行网络质量的数组大小
     */
    virtual void onNetworkQuality(TRTCQualityInfo localQuality, TRTCQualityInfo* remoteQuality, uint32_t remoteQualityCount) {}

    /**
     * 4.2 技术指标统计回调
     *
     * 如果您是熟悉音视频领域相关术语，可以通过这个回调获取 SDK 的所有技术指标。
     * 如果您是首次开发音视频相关项目，可以只关注 onNetworkQuality 回调。
     *
     * @param statis 统计数据，包括本地和远程的
     * @note 每2秒回调一次
     */
    virtual void onStatistics(const TRTCStatistics& statis) {}
    /// @}


    /////////////////////////////////////////////////////////////////////////////////
    //
    //                      （五）服务器事件回调
    //
    /////////////////////////////////////////////////////////////////////////////////

    /// @name 服务器事件回调
    /// @{
    /**
     * 5.1 SDK 跟服务器的连接断开
     */
    virtual void onConnectionLost() {}

    /**
     * 5.2 SDK 尝试重新连接到服务器
     */
    virtual void onTryToReconnect() {}

    /**
     * 5.3 SDK 跟服务器的连接恢复
     */
    virtual void onConnectionRecovery() {}

    /**
     * 5.4 服务器测速的回调，SDK 对多个服务器 IP 做测速，每个 IP 的测速结果通过这个回调通知
     *
     * @param currentResult 当前完成的测速结果
     * @param finishedCount 已完成测速的服务器数量
     * @param totalCount 需要测速的服务器总数量
     */
    virtual void onSpeedTest(const TRTCSpeedTestResult& currentResult, uint32_t finishedCount, uint32_t totalCount) {}
    /// @}

    /////////////////////////////////////////////////////////////////////////////////
    //
    //                      （六）硬件设备事件回调
    //
    /////////////////////////////////////////////////////////////////////////////////
    /// @name 硬件设备事件回调
    /// @{
    /**
     * 6.1 摄像头准备就绪
     */
    virtual void onCameraDidReady() {}

    /**
     * 6.2 麦克风准备就绪
     */
    virtual void onMicDidReady() {}

    /**
     * 6.3 用于提示音量大小的回调,包括每个 userId 的音量和远端总音量
     *
     * 您可以通过调用 TRTCCloud 中的 enableAudioVolumeEvaluation 接口来开关这个回调或者设置它的触发间隔。
     * 需要注意的是，调用 enableAudioVolumeEvaluation 开启音量回调后，无论频道内是否有人说话，都会按设置的时间间隔调用这个回调，
     * 如果没有人说话，则 userVolumes 为空，totalVolume 为0。
     *
     * @param userVolumes 所有正在说话的房间成员的音量，取值范围0 - 100。
     * @param userVolumesCount 房间成员数量
     * @param totalVolume 所有远端成员的总音量, 取值范围0 - 100。
     * @note userId 为 null 时表示自己的音量，userVolumes 内仅包含正在说话（音量不为0）的用户音量信息。
     */
    virtual void onUserVoiceVolume(TRTCVolumeInfo* userVolumes, uint32_t userVolumesCount, uint32_t totalVolume) {}

#if TARGET_PLATFORM_DESKTOP
    /**
     * 6.4 本地设备通断回调
     *
     * @param deviceId 设备 ID
     * @param type 设备类型
     * @param state 事件类型
     */
    virtual void onDeviceChange(const char* deviceId, TRTCDeviceType type, TRTCDeviceState state) {}

    /**
     * 6.5 麦克风测试音量回调
     *
     * 麦克风测试接口 startMicDeviceTest 会触发这个回调
     *
     * @param volume 音量值，取值范围0 - 100
     */
    virtual void onTestMicVolume(uint32_t volume) {}

    /**
     * 6.6 扬声器测试音量回调
     *
     * 扬声器测试接口 startSpeakerDeviceTest 会触发这个回调
     *
     * @param volume 音量值，取值范围0 - 100
     */
    virtual void onTestSpeakerVolume(uint32_t volume) {}

    /**
     * 6.7 当前音频采集设备音量变化通知
     *
     * @note 使用 enableAudioVolumeEvaluation（interval>0）开启，（interval==0）关闭
     *
     * @param volume 音量值，取值范围0 - 100
     * @param muted  当前采集音频设备是否被静音，true：静音；false：取消静音
     */
    virtual void onAudioDeviceCaptureVolumeChanged(uint32_t volume, bool muted) {}

    /**
     * 6.8 当前音频播放设备音量变化通知
     *
     * @note 使用 enableAudioVolumeEvaluation（interval>0）开启，（interval==0）关闭
     *
     * @param volume 音量值，取值范围0 - 100
     * @param muted  当前音频播放设备是否被静音，true：静音；false：取消静音
     */
    virtual void onAudioDevicePlayoutVolumeChanged(uint32_t volume, bool muted) {}
#endif
    /// @}

    /////////////////////////////////////////////////////////////////////////////////
    //
    //                      （七）自定义消息的接收回调
    //
    /////////////////////////////////////////////////////////////////////////////////
    /// @name 自定义消息的接收回调
    /// @{
    /**
     * 7.1 收到自定义消息回调
     *
     * 当房间中的某个用户使用 sendCustomCmdMsg 发送自定义消息时，房间中的其它用户可以通过 onRecvCustomCmdMsg 接口接收消息
     *
     * @param userId 用户标识
     * @param cmdID 命令 ID
     * @param seq   消息序号
     * @param message 消息数据
     * @param messageSize 消息数据大小
     */
    virtual void onRecvCustomCmdMsg(const char* userId, int32_t cmdID, uint32_t seq, const uint8_t* message, uint32_t messageSize) {}

    /**
     * 7.2 自定义消息丢失回调
     *
     * 实时音视频使用 UDP 通道，即使设置了可靠传输（reliable）也无法确保100@%不丢失，只是丢消息概率极低，能满足常规可靠性要求。
     * 在发送端设置了可靠传输（reliable）后，SDK 都会通过此回调通知过去时间段内（通常为5s）传输途中丢失的自定义消息数量统计信息。
     *
     * @note  只有在发送端设置了可靠传输（reliable），接收方才能收到消息的丢失回调
     * @param userId 用户标识
     * @param cmdID 命令 ID
     * @param errCode 错误码
     * @param missed 丢失的消息数量
     */
    virtual void onMissCustomCmdMsg(const char* userId, int32_t cmdID, int32_t errCode, int32_t missed) {}

    /**
     * 7.3 收到 SEI 消息的回调
     *
     * 当房间中的某个用户使用 sendSEIMsg 发送数据时，房间中的其它用户可以通过 onRecvSEIMsg 接口接收数据。
     *
     * @param userId   用户标识
     * @param message  数据
     * @param messageSize 数据大小
     */
    virtual void onRecvSEIMsg(const char* userId, const uint8_t* message, uint32_t messageSize) {};
    /// @}

    /////////////////////////////////////////////////////////////////////////////////
    //
    //                      （八）CDN 旁路转推回调
    //
    /////////////////////////////////////////////////////////////////////////////////
    /// @name CDN 旁路转推回调
    /// @{
    /**
     * 8.1 开始向腾讯云的直播 CDN 推流的回调，对应于 TRTCCloud 中的 startPublishing() 接口
     *
     * @param err 0表示成功，其余值表示失败
     * @param errMsg 具体错误原因
     */
    virtual void onStartPublishing(int err, const char *errMsg) {};

    /**
     * 8.2 停止向腾讯云的直播 CDN 推流的回调，对应于 TRTCCloud 中的 stopPublishing() 接口
     *
     * @param err 0表示成功，其余值表示失败
     * @param errMsg 具体错误原因
     */
    virtual void onStopPublishing(int err, const char *errMsg) {};

    /**
     * 8.3 启动旁路推流到 CDN 完成的回调
     *
     * 对应于 TRTCCloud 中的 startPublishCDNStream() 接口
     *
     * @note Start 回调如果成功，只能说明转推请求已经成功告知给腾讯云，如果目标 CDN 有异常，还是有可能会转推失败。
     */
    virtual void onStartPublishCDNStream(int errCode, const char* errMsg) {};

    /**
     * 8.4 停止旁路推流到 CDN 完成的回调
     *
     * 对应于 TRTCCloud 中的 stopPublishCDNStream() 接口
     *
     */
    virtual void onStopPublishCDNStream(int errCode, const char* errMsg) {};

    /**
     * 8.5 设置云端的混流转码参数的回调，对应于 TRTCCloud 中的 setMixTranscodingConfig() 接口
     *
     * @param errCode 0表示成功，其余值表示失败
     * @param errMsg 具体错误原因
     */
    virtual void onSetMixTranscodingConfig(int errCode, const char* errMsg) {};
    /// @}

    /////////////////////////////////////////////////////////////////////////////////
    //
    //                      （九）屏幕分享回调
    //
    //
    /////////////////////////////////////////////////////////////////////////////////
    /// @name 屏幕分享回调
    /// @{
#ifdef _WIN32
    /**
     * 9.1 当屏幕分享窗口被遮挡无法正常捕获时，SDK 会通过此回调通知，可在此回调里通知用户移开遮挡窗口
     * 目前只支持Windows平台
     */
    virtual void onScreenCaptureCovered() {};
#endif
    /**
     * 9.2 当屏幕分享开始时，SDK 会通过此回调通知
     */
    virtual void onScreenCaptureStarted() {};

    /**
     * 9.3 当屏幕分享暂停时，SDK 会通过此回调通知
     *
     * @param reason 停止原因，0：表示用户主动暂停；1：表示设置屏幕分享参数导致的暂停；2：表示屏幕分享窗口被最小化导致的暂停；3：表示屏幕分享窗口被隐藏导致的暂停
     */
    virtual void onScreenCapturePaused(int reason) {};

    /**
     * 9.4 当屏幕分享恢复时，SDK 会通过此回调通知
     *
     * @param reason 停止原因，0：表示用户主动恢复，1：表示屏幕分享参数设置完毕后自动恢复；2：表示屏幕分享窗口从最小化被恢复；3：表示屏幕分享窗口从隐藏被恢复
     */
    virtual void onScreenCaptureResumed(int reason) {};

    /**
     * 9.5 当屏幕分享停止时，SDK 会通过此回调通知
     *
     * @param reason 停止原因，0：表示用户主动停止；1：表示屏幕分享窗口被关闭
     */
    virtual void onScreenCaptureStoped(int reason) {};
    /// @}

    
    /////////////////////////////////////////////////////////////////////////////////
    //
    //                      （十）截图回调
    //
    /////////////////////////////////////////////////////////////////////////////////
    /// @name 截图回调
    /// @{
    /**
     * 10.1 截图完成时回调
     * 
     * @param userId 用户 ID，空字符串表示截取本地画面
     * @param type   视频流类型
     * @param data   截图数据，为 nullptr 表示截图失败
     * @param length 截图数据长度，对于BGRA32而言，length = width * height * 4
     * @param width  截图画面的宽度
     * @param height 截图画面的高度
     * @param format 截图数据格式，目前只支持 TRTCVideoPixelFormat_BGRA32
     */
    virtual void onSnapshotComplete(const char* userId, TRTCVideoStreamType type, char* data,
                                    uint32_t length, uint32_t width, uint32_t height,
                                    TRTCVideoPixelFormat format) {
    }
    /// @}

    /////////////////////////////////////////////////////////////////////////////////
    //
    //                      （十一）Windows 专有废弃方法
    //
    /////////////////////////////////////////////////////////////////////////////////
    /// @name Windows 专有废弃方法
    /// @{
#ifdef _WIN32
    /**
     * 11.1 废弃接口：有主播加入当前房间
     *
     * 该回调接口可以被看作是 onRemoteUserEnterRoom 的废弃版本，不推荐使用。请使用 onUserVideoAvailable 或 onRemoteUserEnterRoom 进行替代。
     *
     * @note 该接口已被废弃，不推荐使用
     *
     * @param userId 用户标识
     */
    virtual __declspec(deprecated("use onRemoteUserEnterRoom instead"))
        void onUserEnter(const char* userId) {}

    /**
     * 11.2 废弃接口：有主播离开当前房间
     *
     * 该回调接口可以被看作是 onRemoteUserLeaveRoom 的废弃版本，不推荐使用。请使用 onUserVideoAvailable 或 onRemoteUserLeaveRoom 进行替代。
     *
     * @note 该接口已被废弃，不推荐使用
     *
     * @param userId 用户标识
     * @param reason 离开原因。
     */
    virtual __declspec(deprecated("use onRemoteUserLeaveRoom instead"))
        void onUserExit(const char* userId, int reason) {}

    /**
     * 11.3 废弃接口：播放音效结束回调
     *
     * @param effectId 音效id
     * @param code 0表示播放正常结束；其他表示异常结束
     */
    virtual __declspec(deprecated("use ITXAudioEffectManager.startPlayMusic instead"))
        void onAudioEffectFinished(int effectId, int code) {};

    /**
     * 11.4 废弃接口：开始播放背景音乐
     *
     * @param errCode 错误码
     */
    virtual __declspec(deprecated("use ITXAudioEffectManager.ITXMusicPlayObserver instead"))
        void onPlayBGMBegin(TXLiteAVError errCode) {}

    /**
     * 11.5 废弃接口：播放背景音乐的进度
     *
     * @param progressMS 已播放时间
     * @param durationMS 总时间
     */
    virtual __declspec(deprecated("use ITXAudioEffectManager.ITXMusicPlayObserver instead"))
        void onPlayBGMProgress(uint32_t progressMS, uint32_t durationMS) {}

    /**
     * 11.6 废弃接口：播放背景音乐结束
     *
     * @param errCode 错误码
     */
    virtual __declspec(deprecated("use ITXAudioEffectManager.ITXMusicPlayObserver instead"))
        void onPlayBGMComplete(TXLiteAVError errCode) {}
#endif  // _WIN32
    /// @}
};

/////////////////////////////////////////////////////////////////////////////////
//
//                      （十二）自定义视频渲染回调
//
/////////////////////////////////////////////////////////////////////////////////

/// 自定义视频渲染回调
class ITRTCVideoRenderCallback
{
public:
    virtual ~ITRTCVideoRenderCallback() {}
    /**
     * 12.1 自定义视频渲染回调
     *
     * 可以通过 setLocalVideoRenderCallback 和 setRemoteVideoRenderCallback 接口设置自定义渲染回调
     *
     * @param userId     用户标识
     * @param streamType    流类型：即摄像头还是屏幕分享
     * @param frame      视频帧数据
     *
     * @note - 在iOS和Mac平台上回调的视频帧为TRTCVideoBufferType_Buffer类型
     */
    virtual void onRenderVideoFrame(const char* userId, TRTCVideoStreamType streamType, TRTCVideoFrame* frame) {}
};

/////////////////////////////////////////////////////////////////////////////////
//
//                      （十三）音频数据回调
//
/////////////////////////////////////////////////////////////////////////////////

/// 音频数据回调
class ITRTCAudioFrameCallback
{
public:
    virtual ~ITRTCAudioFrameCallback() {}
    /**
     * 13.1 本地麦克风采集到的音频数据回调
     *
     * @param frame      音频数据
     * @note - 请不要在此回调函数中做任何耗时操作，建议直接拷贝到另一线程进行处理，否则会导致各种声音问题。
     * @note - 此接口回调出的音频数据支持修改。
     * @note - 此接口回调出的音频时间帧长固定为0.02s。
              由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。
              以SDK默认的音频录制格式48000采样率、单声道、16采样点位宽为例，字节帧长为【48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
     * @note - 此接口回调出的音频数据包含背景音、音效、混响等前处理效果。
     */
    virtual void onCapturedAudioFrame(TRTCAudioFrame *frame) {};

#if TARGET_PLATFORM_PHONE
    /**
     * 13.2 本地采集并经过音频模块前处理后的音频数据回调
     *
     * @param frame      音频数据
     * @note - 请不要在此回调函数中做任何耗时操作，建议直接拷贝到另一线程进行处理，否则会导致各种声音问题。
     * @note - 此接口回调出的音频数据包含背景音、音效、混响等前处理效果，延迟较高。
     * @note - 此接口回调出的音频数据支持修改。
     * @note - 此接口回调出的音频时间帧长固定为0.02s。
               由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。
               以SDK默认的音频录制格式48000采样率、单声道、16采样点位宽为例，字节帧长为【48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
     */
    virtual void onLocalProcessedAudioFrame(TRTCAudioFrame *frame) {};
#endif

    /**
     * 13.3 混音前的每一路远程用户的音频数据（例如您要对某一路的语音进行文字转换，必须要使用这里的原始数据，而不是混音之后的数据）
     *
     * @param frame      音频数据
     * @param userId     用户标识
     * @note - 请不要在此回调函数中做任何耗时操作，建议直接拷贝到另一线程进行处理，否则会导致各种声音问题。
     *       - 此接口回调出的音频数据是只读的，不支持修改。
     */
    virtual void onPlayAudioFrame(TRTCAudioFrame *frame, const char* userId) {};

    /**
     * 13.4 各路音频数据混合后送入喇叭播放的音频数据
     *
     * @param frame      音频数据
     * @note - 请不要在此回调函数中做任何耗时操作，建议直接拷贝到另一线程进行处理，否则会导致各种声音问题。
     * @note - 此接口回调出的音频数据支持修改。
     * @note - 此接口回调出的音频时间帧长固定为0.02s。
               由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。
               以SDK默认的音频播放格式48000采样率、双声道、16采样点位宽为例，字节帧长为【48000 × 0.02s × 2 × 16bit = 30720bit = 3840字节】。
     * @note - 此接口回调出的音频数据是各路音频播放数据的混合,不包含耳返的音频数据。
     */
    virtual void onMixedPlayAudioFrame(TRTCAudioFrame *frame) {};
};

/////////////////////////////////////////////////////////////////////////////////
//
//                      （十四）Log 信息回调
//
/////////////////////////////////////////////////////////////////////////////////

/// 日志相关回调
class ITRTCLogCallback
{
public:
    virtual ~ITRTCLogCallback() {}
    /**
     * 14.1 有日志打印时的回调
     *
     * @param log 日志内容
     * @param level 日志等级 参见 TRTCLogLevel
     * @param module 暂无具体意义，目前为固定值 TXLiteAVSDK
     */
    virtual void onLog(const char* log, TRTCLogLevel level, const char* module) {}
};

/// @}
}

#endif /* __TRTCENGINECALLBACK_H__ */