Meeting SDK for Windows 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;
64 virtual SDKError Ignore() = 0;
69 virtual SDKError Accept() = 0;
74 virtual SDKError Cancel() = 0;
75};
76
82{
83public:
88 virtual unsigned int GetUserId() = 0;
89
94 virtual AudioStatus GetStatus() = 0;
95
100 virtual AudioType GetAudioType() = 0;
101 virtual ~IUserAudioStatus(){};
102};
103
109{
110public:
116 virtual void onUserAudioStatusChange(IList<IUserAudioStatus* >* lstAudioStatusChange, const zchar_t* strAudioStatusList = nullptr) = 0;
117
122 virtual void onUserActiveAudioChange(IList<unsigned int >* plstActiveAudio) = 0;
123
129
134 virtual void onJoin3rdPartyTelephonyAudio(const zchar_t* audioInfo) = 0;
135
140 virtual void onMuteOnEntryStatusChange(bool bEnabled) = 0;
141
143};
144
150{
151public:
159
165 virtual SDKError JoinVoip() = 0;
166
172 virtual SDKError LeaveVoip() = 0;
173
181 virtual SDKError MuteAudio(unsigned int userid, bool allowUnmuteBySelf = true) = 0;
182
189 virtual SDKError UnMuteAudio(unsigned int userid) = 0;
190
196 virtual bool CanUnMuteBySelf() = 0;
197
203 virtual bool CanEnableMuteOnEntry() = 0;
204
212 virtual SDKError EnableMuteOnEntry(bool bEnable,bool allowUnmuteBySelf) = 0;
213
218 virtual bool IsMuteOnEntryEnabled() = 0;
219
226 virtual SDKError EnablePlayChimeWhenEnterOrExit(bool bEnable) = 0;
227
233 virtual SDKError StopIncomingAudio(bool bStop) = 0;
234
239 virtual bool IsIncomingAudioStopped() = 0;
240
245 virtual bool Is3rdPartyTelephonyAudioOn() = 0;
246
253 virtual SDKError EnablePlayMeetingAudio(bool bEnable) = 0;
254
259 virtual bool IsPlayMeetingAudioEnabled() = 0;
260};
262#endif
Meeting audio controller interface.
virtual SDKError LeaveVoip()=0
Leaves VoIP meeting.
virtual bool IsPlayMeetingAudioEnabled()=0
Determines if play meeting audio is enabled or not.
virtual bool IsIncomingAudioStopped()=0
Determines if the incoming audio is stopped.
virtual SDKError JoinVoip()=0
Joins VoIP meeting.
virtual SDKError MuteAudio(unsigned int userid, bool allowUnmuteBySelf=true)=0
Mutes the assigned user.
virtual bool Is3rdPartyTelephonyAudioOn()=0
Determines if the meeting has third party telephony audio enabled.
virtual bool CanUnMuteBySelf()=0
Determines whether the user can unmute himself.
virtual bool CanEnableMuteOnEntry()=0
Determines whether the host or cohost can enable mute on entry.
virtual SDKError StopIncomingAudio(bool bStop)=0
Stops the incoming audio.
virtual bool IsMuteOnEntryEnabled()=0
Determines if mute on entry is enabled.
virtual SDKError EnableMuteOnEntry(bool bEnable, bool allowUnmuteBySelf)=0
Mutes or unmutes the user after joining the meeting.
virtual SDKError SetEvent(IMeetingAudioCtrlEvent *pEvent)=0
Configures the meeting audio controller callback event handler.
virtual SDKError UnMuteAudio(unsigned int userid)=0
Unmutes the assigned user.
virtual SDKError EnablePlayMeetingAudio(bool bEnable)=0
Enables or disables 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
Ignores the requirement, returns nothing and finally self-destroys.
virtual SDKError Accept()=0
Accepts the requirement, turns on the audio and finally self-destroys.
virtual SDKError Cancel()=0
Ignores the request to enable the audio in the meeting and finally the instance self-destroys.
virtual unsigned int GetReqFromUserId()=0
Gets the user ID who asks to turn on the audio.
User audio status interface.
virtual unsigned int GetUserId()=0
Gets the user ID.
virtual AudioType GetAudioType()=0
Gets the audio type of the user.
virtual AudioStatus GetStatus()=0
Gets the audio status of the user.
AudioStatus
Enumeration of audio status of the user. Here are more detailed structural descriptions.
@ Audio_UnMutedAll_ByHost
@ Audio_Muted_ByHost
@ Audio_MutedAll_ByHost
@ Audio_UnMuted_ByHost
AudioType
Enumeration of 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.