Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
meeting_sign_interpretation_interface.h
Go to the documentation of this file.
1
6#ifndef _MEETING_SIGN_INTERPRETATION_INTERFACE_H_
7#define _MEETING_SIGN_INTERPRETATION_INTERFACE_H_
8#include "zoom_sdk_def.h"
9
11
22
26{
27public:
29 virtual const zchar_t* GetSignLanguageID() = 0;
30 virtual const zchar_t* GetSignLanguageName() = 0;
31};
32
36{
37public:
38 virtual ~ISignInterpreter() {}
39 virtual unsigned int GetUserID() = 0;
40 virtual const zchar_t* GetSignLanguageID() = 0;
41 virtual bool IsAvailable() = 0;
42};
43
46{
47public:
50 virtual SDKError Ignore() = 0;
52 virtual SDKError Accept() = 0;
54 virtual SDKError Cancel() = 0;
55};
56
89
93{
94public:
96
97 //Common (for all)
101
103 virtual bool IsSignInterpretationEnabled() = 0;
104
109
111 virtual bool IsSignInterpreter() = 0;
112
117
122
123 //Admin (only for host)
128
132
137 virtual SDKError AddSignInterpreter(unsigned int userID, const zchar_t* signLanguageId) = 0;
138
142 virtual SDKError RemoveSignInterpreter(unsigned int userID) = 0;
143
148 virtual SDKError ModifySignInterpreterLanguage(unsigned int userID, const zchar_t* signLanguageId) = 0;
149
154
158
162
167 virtual SDKError RequestSignLanguageInterpreterToTalk(unsigned int userID, bool allowToTalk) = 0;
168
172 virtual SDKError CanSignLanguageInterpreterTalk(unsigned int userID, bool& canTalk) = 0;
173
174 //Interpreter (only for interpreter)
178
179 //Listener (for non interpreter)
184 virtual SDKError JoinSignLanguageChannel(const zchar_t* signLanguageId) = 0;
185
190};
192#endif
virtual void OnSignInterpreterListChanged()=0
Sign interpreter list changed callback. When an interpreter leave the meeting, preset interpreter joi...
virtual void OnSignInterpreterLanguageChanged()=0
Sign interpreter languages changed callback. when a sign interpreter's languages changed,...
virtual void OnRequestSignInterpreterToTalk(IRequestSignInterpreterToTalkHandler *handler)=0
Callback event of the requirement to unmute the audio.
virtual void OnTalkPrivilegeChanged(bool hasPrivilege)=0
Callback event for the user talk privilege changed. When the interpreter role or host changed,...
virtual void OnSignInterpreterRoleChanged()=0
Interpreters role changed callback. when myself role changed(participant <-> interpreter),...
virtual void OnAvailableSignLanguageListUpdated(IList< ISignInterpretationLanguageInfo * > *pAvailableSignLanguageList)=0
Available sign languages changed callback. When the available sign languages in a meeting change,...
virtual void OnSignInterpretationStatusChanged(SignInterpretationStatus status)=0
Sign interpretation status change callback. This function is used to inform the user sign interpretat...
Meeting interpretation controller interface.
virtual SDKError ModifySignInterpreterLanguage(unsigned int userID, const zchar_t *signLanguageId)=0
Modify the language of a sign interpreter.
virtual IList< ISignInterpretationLanguageInfo * > * GetAvailableSignLanguageInfoList()=0
Get the available sign interpretation language list.
virtual SDKError AddSignInterpreter(unsigned int userID, const zchar_t *signLanguageId)=0
Add someone as a sign interpreter.
virtual bool IsSignInterpreter()=0
Determine if myself is interpreter.
virtual ISignInterpretationLanguageInfo * GetSignInterpretationLanguageInfoByID(const zchar_t *signLanguageId)=0
Get the sign interpretation language object of specified sign language ID.
virtual void SetEvent(IMeetingSignInterpretationControllerEvent *event)=0
Set the interpretation controller callback event handler.
virtual IList< ISignInterpretationLanguageInfo * > * GetAllSupportedSignLanguageInfoList()=0
Get all supported sign interpretation language list.
virtual SignInterpretationStatus GetSignInterpretationStatus()=0
Get sign interpretation status of current meeting.
virtual SDKError StopSignInterpretation()=0
Stop sign interpretation.
virtual SDKError RequestSignLanguageInterpreterToTalk(unsigned int userID, bool allowToTalk)=0
Host allow sign language interpreter to talk.
virtual SDKError JoinSignLanguageChannel(const zchar_t *signLanguageId)=0
Join a sign language channel if myself is not a sign interpreter.
virtual const zchar_t * GetSignInterpreterAssignedLanID()=0
Get sign language id if myself is a sign interpreter.
virtual SDKError CanSignLanguageInterpreterTalk(unsigned int userID, bool &canTalk)=0
Determine if the sign language interpreter be allowed to talk.
virtual bool IsSignInterpretationEnabled()=0
Determine if sign interpretation feature is enabled in the meeting.
virtual SDKError StartSignInterpretation()=0
Start sign interpretation.
virtual SDKError CanStartSignInterpretation()=0
Determine if I can start the sign interpretation in the meeting.
virtual SDKError RemoveSignInterpreter(unsigned int userID)=0
Remove someone from the list of sign interpreters.
virtual SDKError LeaveSignLanguageChannel()=0
Off sign language if myself is not a sign interpreter..
virtual IList< ISignInterpreter * > * GetSignInterpreterList()=0
Get the sign interpreters list.
Process after the sign interpreter receives the requirement from the host to allow to talk.
virtual SDKError Accept()=0
Instance to accept the requirement, unmute the audio and finally self-destroy.
virtual SDKError Cancel()=0
Ignore the request to unmute the audio in the meeting and finally the instance self-destroys.
virtual SDKError Ignore()=0
Instance to ignore the requirement, return nothing and finally self-destroy.
sign interpretation language interface.
virtual const zchar_t * GetSignLanguageName()=0
virtual const zchar_t * GetSignLanguageID()=0
virtual const zchar_t * GetSignLanguageID()=0
virtual unsigned int GetUserID()=0
virtual bool IsAvailable()=0
SignInterpretationStatus
Status of sign interpretation. Here are more detailed structural descriptions.
@ SignInterpretationStatus_Initial
The initial status.
@ SignInterpretationStatus_Stopped
sign interpretation stopped.
@ SignInterpretationStatus_Started
sign interpretation stared.
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.