ZOOM Windows SDK  5.2.42037.1112
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 
10 BEGIN_ZOOM_SDK_NAMESPACE
16 {
24 };
30 {
35 };
36 
39 {
40 public:
41  virtual ~IRequestStartAudioHandler(){};
44  virtual unsigned int GetReqFromUserId() = 0;
46  virtual SDKError Ignore() = 0;
48  virtual SDKError Accept() = 0;
50  virtual SDKError Cancel() = 0;
51 };
52 
55 {
56 public:
59  virtual unsigned int GetUserId() = 0;
60 
63  virtual AudioStatus GetStatus() = 0;
64 
67  virtual AudioType GetAudioType() = 0;
68  virtual ~IUserAudioStatus(){};
69 };
70 
74 {
75 public:
79  virtual void onUserAudioStatusChange(IList<IUserAudioStatus* >* lstAudioStatusChange, const wchar_t* strAudioStatusList = NULL) = 0;
80 
83  virtual void onUserActiveAudioChange(IList<unsigned int >* plstActiveAudio) = 0;
84 
87  virtual void onHostRequestStartAudio(IRequestStartAudioHandler* handler_) = 0;
88 };
89 
93 {
94 public:
100  virtual SDKError SetEvent(IMeetingAudioCtrlEvent* pEvent) = 0;
101 
106  virtual SDKError JoinVoip() = 0;
107 
112  virtual SDKError LeaveVoip() = 0;
113 
120  virtual SDKError MuteAudio(unsigned int userid, bool allowUnmuteBySelf = true) = 0;
121 
127  virtual SDKError UnMuteAudio(unsigned int userid) = 0;
128 
132  virtual bool CanUnMuteBySelf() = 0;
133 
139  virtual SDKError EnableMuteOnEntry(bool bEnable) = 0;
140 
146  virtual SDKError EnablePlayChimeWhenEnterOrExit(bool bEnable) = 0;
147 };
148 END_ZOOM_SDK_NAMESPACE
149 #endif
Meeting audio callback event.
Definition: meeting_audio_interface.h:73
virtual SDKError Accept()=0
Instance to accept the requirement, turn on the audio and finally self-destroy.
In VoIP mode.
Definition: meeting_audio_interface.h:32
Muted status.
Definition: meeting_audio_interface.h:18
The host unmutes all.
Definition: meeting_audio_interface.h:23
Process after the user receives the requirement from the host to turn on the audio.
Definition: meeting_audio_interface.h:38
virtual void onHostRequestStartAudio(IRequestStartAudioHandler *handler_)=0
Callback event of the requirement to turn on the audio from the host.
AudioStatus
Define the audio status of the user. Here are more detailed structural descriptions.
Definition: meeting_audio_interface.h:15
virtual SDKError JoinVoip()=0
Join VoIP meeting.
virtual SDKError Ignore()=0
Instance to ignore the requirement, return nothing and finally self-destroy.
virtual SDKError Cancel()=0
Ignore the request to enable the video in the meeting and finally the instance self-destroys.
Definition: zoom_sdk_def.h:288
In telephone mode.
Definition: meeting_audio_interface.h:33
AudioType
Define the audio type of the user. Here are more detailed structural descriptions.
Definition: meeting_audio_interface.h:29
Meeting audio controller interface.
Definition: meeting_audio_interface.h:92
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:29
virtual SDKError LeaveVoip()=0
Leave VoIP meeting.
Unmuted status.
Definition: meeting_audio_interface.h:19
virtual void onUserActiveAudioChange(IList< unsigned int > *plstActiveAudio)=0
The callback event that users whose audio is active changed.
virtual void onUserAudioStatusChange(IList< IUserAudioStatus * > *lstAudioStatusChange, const wchar_t *strAudioStatusList=NULL)=0
User&#39;s audio status changed callback.
virtual SDKError MuteAudio(unsigned int userid, bool allowUnmuteBySelf=true)=0
Mute the assigned user.
User audio status interface.
Definition: meeting_audio_interface.h:54
virtual SDKError EnablePlayChimeWhenEnterOrExit(bool bEnable)=0
User joins or leaves the meeting in silence or no.
virtual bool CanUnMuteBySelf()=0
Check if the user can unmute himself.
virtual SDKError SetEvent(IMeetingAudioCtrlEvent *pEvent)=0
Configure the meeting audio controller callback event handler.
virtual unsigned int GetUserId()=0
Get the user ID.
Muted by the host.
Definition: meeting_audio_interface.h:20
Unknown mode.
Definition: meeting_audio_interface.h:34
Initialization.
Definition: meeting_audio_interface.h:17
virtual AudioType GetAudioType()=0
Get the audio type of the user.
Normal audio type.
Definition: meeting_audio_interface.h:31
Unmuted by the host.
Definition: meeting_audio_interface.h:21
virtual AudioStatus GetStatus()=0
Get the audio status of the user.
The host mutes all.
Definition: meeting_audio_interface.h:22
virtual SDKError EnableMuteOnEntry(bool bEnable)=0
Mute or umute the user after joining the meeting.
virtual unsigned int GetReqFromUserId()=0
Get the user ID who asks to turn on the audio.
virtual SDKError UnMuteAudio(unsigned int userid)=0
Unmute the assigned user.