Windows SDK API Reference
Loading...
Searching...
No Matches
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
16{
24};
30{
35};
36
39{
40public:
44 virtual unsigned int GetReqFromUserId() = 0;
46 virtual SDKError Ignore() = 0;
48 virtual SDKError Accept() = 0;
50 virtual SDKError Cancel() = 0;
51};
52
55{
56public:
59 virtual unsigned int GetUserId() = 0;
60
63 virtual AudioStatus GetStatus() = 0;
64
67 virtual AudioType GetAudioType() = 0;
68 virtual ~IUserAudioStatus(){};
69};
70
74{
75public:
79 virtual void onUserAudioStatusChange(IList<IUserAudioStatus* >* lstAudioStatusChange, const wchar_t* strAudioStatusList = NULL) = 0;
80
83 virtual void onUserActiveAudioChange(IList<unsigned int >* plstActiveAudio) = 0;
84
88
90};
91
95{
96public:
103
108 virtual SDKError JoinVoip() = 0;
109
114 virtual SDKError LeaveVoip() = 0;
115
122 virtual SDKError MuteAudio(unsigned int userid, bool allowUnmuteBySelf = true) = 0;
123
129 virtual SDKError UnMuteAudio(unsigned int userid) = 0;
130
134 virtual bool CanUnMuteBySelf() = 0;
135
141 virtual SDKError EnableMuteOnEntry(bool bEnable,bool allowUnmuteBySelf) = 0;
142
148 virtual SDKError EnablePlayChimeWhenEnterOrExit(bool bEnable) = 0;
149};
151#endif
Meeting audio controller interface.
virtual SDKError LeaveVoip()=0
Leave VoIP meeting.
virtual SDKError JoinVoip()=0
Join VoIP meeting.
virtual SDKError MuteAudio(unsigned int userid, bool allowUnmuteBySelf=true)=0
Mute the assigned user.
virtual bool CanUnMuteBySelf()=0
Check if the user can unmute himself.
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 EnablePlayChimeWhenEnterOrExit(bool bEnable)=0
User joins or leaves the meeting in silence or no.
Meeting audio callback event.
virtual void onUserActiveAudioChange(IList< unsigned int > *plstActiveAudio)=0
The callback event that users whose audio is active changed.
virtual void onHostRequestStartAudio(IRequestStartAudioHandler *handler_)=0
Callback event of the requirement to turn on the audio from the host.
virtual void onUserAudioStatusChange(IList< IUserAudioStatus * > *lstAudioStatusChange, const wchar_t *strAudioStatusList=NULL)=0
User's audio status changed callback.
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_VOIP
In VoIP mode.
@ AUDIOTYPE_PHONE
In telephone mode.
@ AUDIOTYPE_UNKNOW
Unknown mode.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
Definition: zoom_sdk_def.h:21
#define BEGIN_ZOOM_SDK_NAMESPACE
Definition: zoom_sdk_def.h:20
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:30