Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
meeting_interpretation_interface.h
Go to the documentation of this file.
1
6#ifndef _MEETING_INTERPRETATION_INTERFACE_H_
7#define _MEETING_INTERPRETATION_INTERFACE_H_
8#include "zoom_sdk_def.h"
9
14{
15public:
17 virtual int GetLanguageID() = 0;
18 virtual const zchar_t* GetLanguageAbbreviations() = 0;
19 virtual const zchar_t* GetLanguageName() = 0;
20};
21
25{
26public:
27 virtual ~IInterpreter() {}
28 virtual unsigned int GetUserID() = 0;
29 virtual int GetLanguageID1() = 0;
30 virtual int GetLanguageID2() = 0;
31 virtual bool IsAvailable() = 0;
32};
33
37{
38public:
40
42 virtual void OnInterpretationStart() = 0;
43
45 virtual void OnInterpretationStop() = 0;
46
48 virtual void OnInterpreterListChanged() = 0;
49
53 virtual void OnInterpreterRoleChanged(unsigned int userID, bool isInterpreter) = 0;
54
58 virtual void OnInterpreterActiveLanguageChanged(unsigned int userID, int activeLanID) = 0;
59
63 virtual void OnInterpreterLanguageChanged(int lanID1, int lanID2) = 0;
64
67 virtual void OnAvailableLanguageListUpdated(IList<IInterpretationLanguage*>* pAvailableLanguageList) = 0;
68
73};
74
78{
79public:
81
82 //Common (for all)
83
87
89 virtual bool IsInterpretationEnabled() = 0;
90
92 virtual bool IsInterpretationStarted() = 0;
93
95 virtual bool IsInterpreter() = 0;
96
101
102 //Admin (only for host)
103
107
111
117 virtual SDKError AddInterpreter(unsigned int userID, int lanID1, int lanID2) = 0;
118
122 virtual SDKError RemoveInterpreter(unsigned int userID) = 0;
123
129 virtual SDKError ModifyInterpreter(unsigned int userID, int lanID1, int lanID2) = 0;
130
134
138
139 //Listener (for non interpreter)
140
144
148 virtual SDKError JoinLanguageChannel(int lanID) = 0;
149
153 virtual SDKError GetJoinedLanguageID(int& lanID) = 0;
154
158
162
166 virtual SDKError IsMajorAudioTurnOff(bool& bOff) = 0;
167
168 //Interpreter (only for interpreter)
169
174 virtual SDKError GetInterpreterLans(int& lanID1, int& lanID2) = 0;
175
179 virtual SDKError SetInterpreterActiveLan(int activeLanID) = 0;
180
184 virtual SDKError GetInterpreterActiveLan(int& lanID) = 0;
185
189
193 virtual SDKError SetInterpreterListenLan(int languageID) = 0;
194
198 virtual SDKError GetInterpreterListenLan(int& languageID) = 0;
199};
201#endif
interpretation language interface.
virtual int GetLanguageID()=0
virtual const zchar_t * GetLanguageName()=0
virtual const zchar_t * GetLanguageAbbreviations()=0
interpreter interface.
virtual int GetLanguageID2()=0
virtual unsigned int GetUserID()=0
virtual int GetLanguageID1()=0
virtual bool IsAvailable()=0
virtual void OnInterpretationStop()=0
interpretation stop callback. This function is used to inform the user interpretation has been stoppe...
virtual void OnInterpreterActiveLanguageChanged(unsigned int userID, int activeLanID)=0
interpreter active language changed callback. when a interpreter's active language changed,...
virtual void OnInterpreterLanguagesUpdated(IList< IInterpretationLanguage * > *availableLanguages)=0
Callback to indicate that the list of available languages that interpreters can hear has changed....
virtual void OnInterpreterLanguageChanged(int lanID1, int lanID2)=0
interpreter languages changed callback. when a interpreter's languages changed, and only the interpre...
virtual void OnInterpretationStart()=0
interpretation start callback. This function is used to inform the user interpretation has been start...
virtual void OnInterpreterListChanged()=0
interpreter list changed callback. when some interpreter leave meeting or preset interpreter join mee...
virtual void OnInterpreterRoleChanged(unsigned int userID, bool isInterpreter)=0
interpreter role changed callback. when a user's role changed(participant <-> interpreter),...
virtual void OnAvailableLanguageListUpdated(IList< IInterpretationLanguage * > *pAvailableLanguageList)=0
available languages changed callback. when available languages in meeting are changed,...
Meeting interpretation controller interface.
virtual IList< IInterpretationLanguage * > * GetAllLanguageList()=0
Get the all interpretation language list.
virtual void SetEvent(IMeetingInterpretationControllerEvent *event)=0
Set the interpretation controller callback event handler.
virtual SDKError SetInterpreterListenLan(int languageID)=0
Set a language that I can hear as an interpreter.
virtual SDKError StopInterpretation()=0
Stop interpretation.
virtual SDKError TurnOnMajorAudio()=0
Turn on the major audio, if you are in some interpreter language channel.
virtual IList< IInterpretationLanguage * > * GetInterpreterAvailableLanguages()=0
Get the list of available languages that interpreters can hear.
virtual SDKError IsMajorAudioTurnOff(bool &bOff)=0
Determine if the major audio is off.
virtual IList< IInterpreter * > * GetInterpreterList()=0
Get the interpreters list.
virtual SDKError GetInterpreterListenLan(int &languageID)=0
Get a language that I can hear as an interpreter.
virtual SDKError JoinLanguageChannel(int lanID)=0
Join some language channel.
virtual bool IsInterpretationEnabled()=0
Determine if interpretation feature is enabled in the meeting.
virtual SDKError ModifyInterpreter(unsigned int userID, int lanID1, int lanID2)=0
modify the language of some interpreter.
virtual SDKError GetInterpreterActiveLan(int &lanID)=0
Get the active language ID, if myself is a interpreter.
virtual SDKError SetInterpreterActiveLan(int activeLanID)=0
Set a language channel which myself will be in, if myself is a interpreter.
virtual SDKError GetInterpreterLans(int &lanID1, int &lanID2)=0
Get languages if myself is a interpreter.
virtual SDKError TurnOffMajorAudio()=0
Turn off the major audio, if you are in some interpreter language channel.
virtual SDKError AddInterpreter(unsigned int userID, int lanID1, int lanID2)=0
Add someone as a interpreter.
virtual IInterpretationLanguage * GetInterpretationLanguageByID(int lanID)=0
Get the interpretation language object of specified language ID.
virtual bool IsInterpretationStarted()=0
Determine if interpretation has been started by host.
virtual SDKError GetJoinedLanguageID(int &lanID)=0
Get the language ID which myself is in.
virtual IList< IInterpretationLanguage * > * GetAvailableLanguageList()=0
Get the available interpretation language list.
virtual SDKError RemoveInterpreter(unsigned int userID)=0
Remove some interpreter.
virtual bool IsInterpreter()=0
Determine if myself is interpreter.
virtual SDKError StartInterpretation()=0
Start interpretation.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
wchar_t zchar_t
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.