IMeetingAudioHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IMEETINGAUDIOHELPER_H
#define ZRC_IMEETINGAUDIOHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum AskUnmuteAudioByHostType
{
    AskUnmuteAudioByHostTypeUnmuteAudio = 0,    
    AskUnmuteAudioByHostTypeSpotlight,          
    AskUnmuteAudioByHostTypeViewOnlyTalk,       
};
 
struct AudioTroubleShootingStatus
{
    bool    isRecording = false;
    int32_t totalDuration = 0;
    int32_t timeLeft = 0;
};
 
struct FarEndAudioDeviceInfo
{
    std::string deviceID;                   
    std::string deviceName;                 
    int32_t     volume = 0;                 
    bool        volumeCanAdjust = false;    
    bool        isSelected = false;         
};
 
struct FarEndAudioControllingUserDeviceInfo
{
    int32_t                            userID = 0;            
    bool                               muteState = false;     
    FarEndAudioDeviceInfo              selectedMicrophone;    
    FarEndAudioDeviceInfo              selectedSpeaker;       
    std::vector<FarEndAudioDeviceInfo> microphones;           
    std::vector<FarEndAudioDeviceInfo> speakers;              
};
 
class IMeetingAudioHelperSink
{
public:
    virtual ~IMeetingAudioHelperSink() {}
 
    virtual void OnUpdateMyAudioStatus(const AudioStatus& audioStatus) = 0;
 
    virtual void OnMuteUserAudioNotification(int32_t userID, const AudioStatus& audioStatus) = 0;
 
    virtual void OnMuteOnEntryNotification(bool isMuteOnEntry) = 0;
 
    virtual void OnAskUnmuteAudioByHostNotification(bool show, AskUnmuteAudioByHostType type) = 0;
 
    virtual void OnAllowAttendeesUnmuteThemselvesNotification(bool canAttendeesUnmuteThemselves) = 0;
 
    virtual void OnEnablePlayJoinOrLeaveChimeNotification(bool enable) = 0;
 
    virtual void OnUpdateAudioTroubleShootingStatus(const AudioTroubleShootingStatus& status) = 0;
 
    // ==========================================================================
    // FEAC Requester Sinks
    // ==========================================================================
    virtual void OnFEACApproveNotification(int32_t farEndUserID, const std::string& farEndUserName) = 0;
    virtual void OnFEACDeclineNotification(int32_t farEndUserID, const std::string& farEndUserName) = 0;
    virtual void OnFEACTakeOverNotification(int32_t farEndUserID, const std::string& farEndUserName, int32_t controllingUserID, const std::string& controllingUserName) = 0;
    virtual void OnFEACMicListChangedNotification(int32_t farEndUserID, const std::vector<FarEndAudioDeviceInfo>& micList) = 0;
    virtual void OnFEACSpeakerListChangedNotification(int32_t farEndUserID, const std::vector<FarEndAudioDeviceInfo>& speakerList) = 0;
    virtual void OnFEACMuteStateChangedNotification(int32_t farEndUserID, bool muteState) = 0;
    virtual void OnFEACUnmuteDisabledByHostNotification(int32_t farEndUserID) = 0;
 
    // ==========================================================================
    // FEAC Be Requested Sinks
    // ==========================================================================
    virtual void OnFEACRequestNotification(int32_t requesterUserID, const std::string& requesterUserName) = 0;
    virtual void OnFEACGiveUpNotification(int32_t requesterUserID, const std::string& requesterUserName) = 0;
    virtual void OnFEACApproveControlRequestNotification(int32_t requesterUserID) = 0;
    virtual void OnFEACDeclineControlRequestNotification(int32_t requesterUserID) = 0;
};
 
class IMeetingAudioHelper
{
public:
    virtual ~IMeetingAudioHelper() {}
 
    virtual ZRCSDKError RegisterSink(IMeetingAudioHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IMeetingAudioHelperSink* pSink) = 0;
 
    virtual ZRCSDKError UpdateMyAudioStatus(bool mute) = 0;
 
    virtual ZRCSDKError MuteUserAudio(int32_t userID, bool mute) = 0;
 
    virtual ZRCSDKError MuteAllAudios(bool mute) = 0;
 
    virtual ZRCSDKError MuteOnEntry(bool mute) = 0;
 
    virtual ZRCSDKError AnswerUnmuteAudioByHostRequest(bool accepted) = 0;
 
    virtual ZRCSDKError AllowAttendeesUnmuteThemselves(bool allow) = 0;
 
    virtual ZRCSDKError EnablePlayJoinOrLeaveChime(bool enable) = 0;
 
    virtual ZRCSDKError IsMeetingAudioTroubleShootingAvailable(bool& isAvailable) = 0;
 
    virtual ZRCSDKError EnableMeetingAudioTroubleShooting(bool enable) = 0;
 
    // ==========================================================================
    // FEAC Requester Commands
    // ==========================================================================
    virtual ZRCSDKError RequestFarEndAudioControl(int32_t farEndUserID) = 0;
    virtual ZRCSDKError GiveUpFarEndAudioControl(int32_t farEndUserID) = 0;
    virtual ZRCSDKError BeginControlFarEndAudio(int32_t farEndUserID) = 0;
    virtual ZRCSDKError EndControlFarEndAudio(int32_t farEndUserID) = 0;
    virtual ZRCSDKError SelectFarEndAudioMicrophone(int32_t farEndUserID, const std::string& deviceID) = 0;
    virtual ZRCSDKError SelectFarEndAudioSpeaker(int32_t farEndUserID, const std::string& deviceID) = 0;
    virtual ZRCSDKError AdjustFarEndAudioSelectedMicrophoneVolume(int32_t farEndUserID, int32_t volume) = 0;
    virtual ZRCSDKError AdjustFarEndAudioSelectedSpeakerVolume(int32_t farEndUserID, int32_t volume) = 0;
    virtual ZRCSDKError MuteFarEndAudioMicrophone(int32_t farEndUserID, bool mute) = 0;
 
    // ==========================================================================
    // FEAC Be Requested Sinks
    // ==========================================================================
    virtual ZRCSDKError ApproveFarEndAudioControlRequest(int32_t requesterUserID) = 0;
    virtual ZRCSDKError DeclineFarEndAudioControlRequest(int32_t requesterUserID) = 0;
 
    virtual ZRCSDKError GetFarEndAudioControllingUserDeviceInfo(FarEndAudioControllingUserDeviceInfo& deviceInfo, int32_t userID) = 0;
    virtual ZRCSDKError GetAllFarEndAudioControllingUserDeviceInfo(std::vector<FarEndAudioControllingUserDeviceInfo>& deviceInfoList) = 0;
};
 
NS_ZRCSDK_END
 
#endif    //ZRC_IMEETINGAUDIOHELPER_H