Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
meeting_audio_interface.h
Go to the documentation of this file.
1
6#ifndef _MEETING_AUDIO_INTERFACE_H_
7#define _MEETING_AUDIO_INTERFACE_H_
8#include "zoom_sdk_def.h"
9
36
39{
40public:
45 virtual unsigned int GetReqFromUserId() = 0;
47 virtual SDKError Ignore() = 0;
49 virtual SDKError Accept() = 0;
51 virtual SDKError Cancel() = 0;
52};
53
56{
57public:
60 virtual unsigned int GetUserId() = 0;
61
64 virtual AudioStatus GetStatus() = 0;
65
68 virtual AudioType GetAudioType() = 0;
69 virtual ~IUserAudioStatus(){};
70};
71
75{
76public:
80 virtual void onUserAudioStatusChange(IList<IUserAudioStatus* >* lstAudioStatusChange, const zchar_t* strAudioStatusList = nullptr) = 0;
81
84 virtual void onUserActiveAudioChange(IList<unsigned int >* plstActiveAudio) = 0;
85
89
92 virtual void onJoin3rdPartyTelephonyAudio(const zchar_t* audioInfo) = 0;
93
96 virtual void onMuteOnEntryStatusChange(bool bEnabled) = 0;
97
99};
100
104{
105public:
112
117 virtual SDKError JoinVoip() = 0;
118
123 virtual SDKError LeaveVoip() = 0;
124
131 virtual SDKError MuteAudio(unsigned int userid, bool allowUnmuteBySelf = true) = 0;
132
138 virtual SDKError UnMuteAudio(unsigned int userid) = 0;
139
143 virtual bool CanUnMuteBySelf() = 0;
144
148 virtual bool CanEnableMuteOnEntry() = 0;
149
155 virtual SDKError EnableMuteOnEntry(bool bEnable,bool allowUnmuteBySelf) = 0;
156
159 virtual bool IsMuteOnEntryEnabled() = 0;
160
166 virtual SDKError EnablePlayChimeWhenEnterOrExit(bool bEnable) = 0;
167
171 virtual SDKError StopIncomingAudio(bool bStop) = 0;
172
175 virtual bool IsIncomingAudioStopped() = 0;
176
179 virtual bool Is3rdPartyTelephonyAudioOn() = 0;
180
186 virtual SDKError EnablePlayMeetingAudio(bool bEnable) = 0;
187
190 virtual bool IsPlayMeetingAudioEnabled() = 0;
191};
193#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
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
The host unmutes all.
@ Audio_Muted_ByHost
Muted by the host.
@ Audio_None
Initialization.
@ Audio_MutedAll_ByHost
The host mutes all.
@ Audio_UnMuted_ByHost
Unmuted by the host.
@ Audio_UnMuted
Unmuted status.
@ Audio_Muted
Muted status.
AudioType
Define the audio type of the user. Here are more detailed structural descriptions.
@ AUDIOTYPE_NONE
Normal audio type.
@ AUDIOTYPE_UNKNOWN
Unknown mode.
@ AUDIOTYPE_VOIP
In VoIP mode.
@ AUDIOTYPE_PHONE
In telephone mode.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
SDK error types. Here are more detailed structural descriptions.