Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
meeting_audio_interface.h
Go to the documentation of this file.
1
5#ifndef _MEETING_AUDIO_INTERFACE_H_
6#define _MEETING_AUDIO_INTERFACE_H_
7#include "zoom_sdk_def.h"
8
51{
52public:
59 virtual unsigned int GetReqFromUserId() = 0;
63 virtual SDKError Ignore() = 0;
67 virtual SDKError Accept() = 0;
71 virtual SDKError Cancel() = 0;
72};
73
79{
80public:
85 virtual unsigned int GetUserId() = 0;
86
91 virtual AudioStatus GetStatus() = 0;
92
97 virtual AudioType GetAudioType() = 0;
98 virtual ~IUserAudioStatus(){};
99};
100
106{
107public:
113 virtual void onUserAudioStatusChange(IList<IUserAudioStatus* >* lstAudioStatusChange, const zchar_t* strAudioStatusList = nullptr) = 0;
114
119 virtual void onUserActiveAudioChange(IList<unsigned int >* plstActiveAudio) = 0;
120
126
131 virtual void onJoin3rdPartyTelephonyAudio(const zchar_t* audioInfo) = 0;
132
137 virtual void onMuteOnEntryStatusChange(bool bEnabled) = 0;
138
140};
141
147{
148public:
156
162 virtual SDKError JoinVoip() = 0;
163
169 virtual SDKError LeaveVoip() = 0;
170
178 virtual SDKError MuteAudio(unsigned int userid, bool allowUnmuteBySelf = true) = 0;
179
186 virtual SDKError UnMuteAudio(unsigned int userid) = 0;
187
193 virtual bool CanUnMuteBySelf() = 0;
194
200 virtual bool CanEnableMuteOnEntry() = 0;
201
208 virtual SDKError EnableMuteOnEntry(bool bEnable,bool allowUnmuteBySelf) = 0;
209
214 virtual bool IsMuteOnEntryEnabled() = 0;
215
222 virtual SDKError EnablePlayChimeWhenEnterOrExit(bool bEnable) = 0;
223
228 virtual SDKError StopIncomingAudio(bool bStop) = 0;
229
234 virtual bool IsIncomingAudioStopped() = 0;
235
240 virtual bool Is3rdPartyTelephonyAudioOn() = 0;
241
248 virtual SDKError EnablePlayMeetingAudio(bool bEnable) = 0;
249
254 virtual bool IsPlayMeetingAudioEnabled() = 0;
255};
257#endif
Meeting audio controller interface.
virtual SDKError LeaveVoip()=0
Leave VoIP meeting.
virtual bool IsPlayMeetingAudioEnabled()=0
Determine if play meeting audio is enabled or not.
virtual bool IsIncomingAudioStopped()=0
Determine if the incoming audio is stopped.
virtual SDKError JoinVoip()=0
Join VoIP meeting.
virtual SDKError MuteAudio(unsigned int userid, bool allowUnmuteBySelf=true)=0
Mute the assigned user.
virtual bool Is3rdPartyTelephonyAudioOn()=0
Determine if the meeting has third party telephony audio enabled.
virtual bool CanUnMuteBySelf()=0
Check if the user can unmute himself.
virtual bool CanEnableMuteOnEntry()=0
Check if the host or cohost can enable mute on entry.
virtual SDKError StopIncomingAudio(bool bStop)=0
Stop the incoming audio.
virtual bool IsMuteOnEntryEnabled()=0
Determine if mute on entry is enabled.
virtual SDKError EnableMuteOnEntry(bool bEnable, bool allowUnmuteBySelf)=0
Mute or umute the user after joining the meeting.
virtual SDKError SetEvent(IMeetingAudioCtrlEvent *pEvent)=0
Configure the meeting audio controller callback event handler.
virtual SDKError UnMuteAudio(unsigned int userid)=0
Unmute the assigned user.
virtual SDKError EnablePlayMeetingAudio(bool bEnable)=0
Enable or disable SDK to play meeting audio.
virtual SDKError EnablePlayChimeWhenEnterOrExit(bool bEnable)=0
User joins or leaves the meeting in silence or no.
Meeting audio callback event.
virtual void onUserAudioStatusChange(IList< IUserAudioStatus * > *lstAudioStatusChange, const zchar_t *strAudioStatusList=nullptr)=0
User's audio status changed callback.
virtual void onMuteOnEntryStatusChange(bool bEnabled)=0
Callback event for the mute on entry status change.
virtual void onUserActiveAudioChange(IList< unsigned int > *plstActiveAudio)=0
The callback event that users whose audio is active changed.
virtual void onJoin3rdPartyTelephonyAudio(const zchar_t *audioInfo)=0
Callback event that requests to join third party telephony audio.
virtual void onHostRequestStartAudio(IRequestStartAudioHandler *handler_)=0
Callback event of the requirement to turn on the audio from the host.
Process after the user receives the requirement from the host to turn on the audio.
virtual SDKError Ignore()=0
Instance to ignore the requirement, return nothing and finally self-destroy.
virtual SDKError Accept()=0
Instance to accept the requirement, turn on the audio and finally self-destroy.
virtual SDKError Cancel()=0
Ignore the request to enable the video in the meeting and finally the instance self-destroys.
virtual unsigned int GetReqFromUserId()=0
Get the user ID who asks to turn on the audio.
User audio status interface.
virtual unsigned int GetUserId()=0
Get the user ID.
virtual AudioType GetAudioType()=0
Get the audio type of the user.
virtual AudioStatus GetStatus()=0
Get the audio status of the user.
AudioStatus
Define the audio status of the user. Here are more detailed structural descriptions.
@ Audio_UnMutedAll_ByHost
@ Audio_Muted_ByHost
@ Audio_MutedAll_ByHost
@ Audio_UnMuted_ByHost
AudioType
Define the audio type of the user. Here are more detailed structural descriptions.
@ AUDIOTYPE_UNKNOWN
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
Enumeration of common errors of SDK.