ZOOM Windows SDK  5.2.42037.1112
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 
10 BEGIN_ZOOM_SDK_NAMESPACE
14 {
15 public:
16  virtual ~IInterpretationLanguage() {}
17  virtual int GetLanguageID() = 0;
18  virtual const wchar_t* GetLanguageAbbreviations() = 0;
19  virtual const wchar_t* GetLanguageName() = 0;
20 };
21 
25 {
26 public:
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 {
38 public:
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 };
69 
73 {
74 public:
76 
77  //Common (for all)
78 
81  virtual void SetEvent(IMeetingInterpretationControllerEvent * event) = 0;
82 
84  virtual bool IsInterpretationEnabled() = 0;
85 
87  virtual bool IsInterpretationStarted() = 0;
88 
90  virtual bool IsInterpreter() = 0;
91 
96 
97  //Admin (only for host)
98 
102 
106 
112  virtual SDKError AddInterpreter(unsigned int userID, int lanID1, int lanID2) = 0;
113 
117  virtual SDKError RemoveInterpreter(unsigned int userID) = 0;
118 
124  virtual SDKError ModifyInterpreter(unsigned int userID, int lanID1, int lanID2) = 0;
125 
128  virtual SDKError StartInterpretation() = 0;
129 
132  virtual SDKError StopInterpretation() = 0;
133 
134  //Listener (for non interpreter)
135 
139 
143  virtual SDKError JoinLanguageChannel(int lanID) = 0;
144 
148  virtual SDKError GetJoinedLanguageID(int& lanID) = 0;
149 
152  virtual SDKError TurnOffMajorAudio() = 0;
153 
156  virtual SDKError TurnOnMajorAudio() = 0;
157 
161  virtual SDKError IsMajorAudioTurnOff(bool& bOff) = 0;
162 
163  //Interpreter (only for interpreter)
164 
169  virtual SDKError GetInterpreterLans(int& lanID1, int& lanID2) = 0;
170 
174  virtual SDKError SetInterpreterActiveLan(int activeLanID) = 0;
175 
179  virtual SDKError GetInterpreterActiveLan(int& lanID) = 0;
180 };
181 END_ZOOM_SDK_NAMESPACE
182 #endif
virtual IList< IInterpretationLanguage * > * GetAvailableLanguageList()=0
Get the available interpretation language list.
virtual SDKError TurnOnMajorAudio()=0
Turn on the major audio, if you are in some interpreter language channel.
virtual SDKError JoinLanguageChannel(int lanID)=0
Join some language channel.
virtual void OnInterpreterLanguageChanged(int lanID1, int lanID2)=0
interpreter languages changed callback. when a interpreter&#39;s languages changed, and only the interpre...
virtual IList< IInterpretationLanguage * > * GetAllLanguageList()=0
Get the all interpretation language list.
virtual SDKError StopInterpretation()=0
Stop interpretation.
virtual SDKError AddInterpreter(unsigned int userID, int lanID1, int lanID2)=0
Add someone as a interpreter.
Definition: zoom_sdk_def.h:288
interpreter interface.
Definition: meeting_interpretation_interface.h:24
virtual SDKError GetInterpreterLans(int &lanID1, int &lanID2)=0
Get languages if myself is a interpreter.
virtual void OnInterpretationStart()=0
interpretation start callback. This function is used to inform the user interpretation has been start...
interpretation language interface.
Definition: meeting_interpretation_interface.h:13
virtual bool IsInterpreter()=0
Determine if myself is interpreter.
virtual void SetEvent(IMeetingInterpretationControllerEvent *event)=0
Set the interpretation controller callback event handler.
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:29
virtual void OnInterpreterListChanged()=0
interpreter list changed callback. when some interpreter leave meeting or preset interpreter join mee...
virtual SDKError GetInterpreterActiveLan(int &lanID)=0
Get the active language ID, if myself is a interpreter.
Meeting interpretation controller interface.
Definition: meeting_interpretation_interface.h:72
virtual void OnInterpreterRoleChanged(unsigned int userID, bool isInterpreter)=0
interpreter role changed callback. when a user&#39;s role changed(participant <-> interpreter), and all users in meeting can get the event.
virtual SDKError StartInterpretation()=0
Start interpretation.
Meeting interpretation callback event.
Definition: meeting_interpretation_interface.h:36
virtual bool IsInterpretationEnabled()=0
Determine if interpretation feature is enabled in the meeting.
virtual SDKError RemoveInterpreter(unsigned int userID)=0
Remove some interpreter.
virtual void OnInterpretationStop()=0
interpretation stop callback. This function is used to inform the user interpretation has been stoppe...
virtual bool IsInterpretationStarted()=0
Determine if interpretation has been started by host.
virtual IList< IInterpreter * > * GetInterpreterList()=0
Get the interpreters list.
virtual SDKError SetInterpreterActiveLan(int activeLanID)=0
Set a language channel which myself will be in, if myself is a interpreter.
virtual SDKError IsMajorAudioTurnOff(bool &bOff)=0
Determine if the major audio is off.
virtual SDKError ModifyInterpreter(unsigned int userID, int lanID1, int lanID2)=0
modify the language of some interpreter.
virtual void OnInterpreterActiveLanguageChanged(unsigned int userID, int activeLanID)=0
interpreter active language changed callback. when a interpreter&#39;s active language changed...
virtual SDKError TurnOffMajorAudio()=0
Turn off the major audio, if you are in some interpreter language channel.
virtual SDKError GetJoinedLanguageID(int &lanID)=0
Get the language ID which myself is in.
virtual void OnAvailableLanguageListUpdated(IList< IInterpretationLanguage *> *pAvailableLanguageList)=0
available languages changed callback. when available languages in meeting are changed, all non interpreter users in meeting can get the event.
virtual IInterpretationLanguage * GetInterpretationLanguageByID(int lanID)=0
Get the interpretation language object of specified language ID.