Meeting interpretation controller interface. More...

#include <meeting_sign_interpretation_interface.h>

Public Member Functions
virtual	~IMeetingSignInterpretationController ()

virtual void	SetEvent (IMeetingSignInterpretationControllerEvent *event)=0
	Set the interpretation controller callback event handler.

virtual bool	IsSignInterpretationEnabled ()=0
	Determine if sign interpretation feature is enabled in the meeting.

virtual SignInterpretationStatus	GetSignInterpretationStatus ()=0
	Get sign interpretation status of current meeting.

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 IList< ISignInterpretationLanguageInfo * > *	GetAvailableSignLanguageInfoList ()=0
	Get the available sign interpretation language list.

virtual IList< ISignInterpretationLanguageInfo * > *	GetAllSupportedSignLanguageInfoList ()=0
	Get all supported sign interpretation language list.

virtual IList< ISignInterpreter * > *	GetSignInterpreterList ()=0
	Get the sign interpreters list.

virtual SDKError	AddSignInterpreter (unsigned int userID, const zchar_t *signLanguageId)=0
	Add someone as a sign interpreter.

virtual SDKError	RemoveSignInterpreter (unsigned int userID)=0
	Remove someone from the list of sign interpreters.

virtual SDKError	ModifySignInterpreterLanguage (unsigned int userID, const zchar_t *signLanguageId)=0
	Modify the language of a sign interpreter.

virtual SDKError	CanStartSignInterpretation ()=0
	Determine if I can start the sign interpretation in the meeting.

virtual SDKError	StartSignInterpretation ()=0
	Start sign interpretation.

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	CanSignLanguageInterpreterTalk (unsigned int userID, bool &canTalk)=0
	Determine if the sign language interpreter be allowed to talk.

virtual const zchar_t *	GetSignInterpreterAssignedLanID ()=0
	Get sign language id if myself is a sign interpreter.

virtual SDKError	JoinSignLanguageChannel (const zchar_t *signLanguageId)=0
	Join a sign language channel if myself is not a sign interpreter.

virtual SDKError	LeaveSignLanguageChannel ()=0
	Off sign language if myself is not a sign interpreter..

Detailed Description

Meeting interpretation controller interface.

Definition at line 124 of file meeting_sign_interpretation_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingSignInterpretationController()

virtual IMeetingSignInterpretationController::~IMeetingSignInterpretationController ( )

inlinevirtual

Definition at line 127 of file meeting_sign_interpretation_interface.h.

127{}

Member Function Documentation

◆ AddSignInterpreter()

virtual SDKError IMeetingSignInterpretationController::AddSignInterpreter	(	unsigned int	userID,
		const zchar_t *	signLanguageId )

pure virtual

Add someone as a sign interpreter.

Parameters

userID	Specify the user.
signLanguageId	Specify the sign language.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ CanSignLanguageInterpreterTalk()

virtual SDKError IMeetingSignInterpretationController::CanSignLanguageInterpreterTalk	(	unsigned int	userID,
		bool &	canTalk )

pure virtual

Determine if the sign language interpreter be allowed to talk.

Parameters

[out] canTalk indicates if allow to talk.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ CanStartSignInterpretation()

virtual SDKError IMeetingSignInterpretationController::CanStartSignInterpretation ( )

pure virtual

Determine if I can start the sign interpretation in the meeting.

Returns: If it can start the sign interpretation, the return value is SDKErr_Success. Otherwise failed.

◆ GetAllSupportedSignLanguageInfoList()

virtual IList< ISignInterpretationLanguageInfo * > * IMeetingSignInterpretationController::GetAllSupportedSignLanguageInfoList ( )

pure virtual

Get all supported sign interpretation language list.

Note: Admin (only for host)

Returns: If the function succeeds, the return value is a pointer to the IList<ISignInterpretationLanguageInfo*>, Otherwise failed, the return value is nullptr.

◆ GetAvailableSignLanguageInfoList()

virtual IList< ISignInterpretationLanguageInfo * > * IMeetingSignInterpretationController::GetAvailableSignLanguageInfoList ( )

pure virtual

Get the available sign interpretation language list.

Returns: If the function succeeds, the return value is a pointer to the IList<ISignInterpretationLanguageInfo*>, Otherwise failed, the return value is nullptr.

◆ GetSignInterpretationLanguageInfoByID()

virtual ISignInterpretationLanguageInfo * IMeetingSignInterpretationController::GetSignInterpretationLanguageInfoByID ( const zchar_t * signLanguageId )

pure virtual

Get the sign interpretation language object of specified sign language ID.

Parameters

signLanguageId Specify the sign language ID for which you want to get the information.

Returns: If the function succeeds, the return value is a pointer to the IInterpretationLanguage, Otherwise failed, the return value is nullptr.

◆ GetSignInterpretationStatus()

virtual SignInterpretationStatus IMeetingSignInterpretationController::GetSignInterpretationStatus ( )

pure virtual

Get sign interpretation status of current meeting.

Returns: If the function succeeds, the return value is the sign interpretation status of current meeting. Otherwise failed.

◆ GetSignInterpreterAssignedLanID()

virtual const zchar_t * IMeetingSignInterpretationController::GetSignInterpreterAssignedLanID ( )

pure virtual

Get sign language id if myself is a sign interpreter.

Note: Interpreter (only for interpreter)

Returns: If the function succeeds, the return value is the current assigned sign language id. Otherwise returns an empty string of length ZERO(0)

◆ GetSignInterpreterList()

virtual IList< ISignInterpreter * > * IMeetingSignInterpretationController::GetSignInterpreterList ( )

pure virtual

Get the sign interpreters list.

Returns: If the function succeeds, the return value is a pointer to the IList<ISignInterpreter*>, Otherwise failed, the return value is nullptr.

◆ IsSignInterpretationEnabled()

virtual bool IMeetingSignInterpretationController::IsSignInterpretationEnabled ( )

pure virtual

Determine if sign interpretation feature is enabled in the meeting.

◆ IsSignInterpreter()

virtual bool IMeetingSignInterpretationController::IsSignInterpreter ( )

pure virtual

Determine if myself is interpreter.

◆ JoinSignLanguageChannel()

virtual SDKError IMeetingSignInterpretationController::JoinSignLanguageChannel ( const zchar_t * signLanguageId )

pure virtual

Join a sign language channel if myself is not a sign interpreter.

Note: Listener (for non interpreter)

Parameters

signLanguageId Specify the sign language channel ID.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

Note: Valid only for Zoom style user interface mode.

◆ LeaveSignLanguageChannel()

virtual SDKError IMeetingSignInterpretationController::LeaveSignLanguageChannel ( )

pure virtual

Off sign language if myself is not a sign interpreter..

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

Note: Valid only for Zoom style user interface mode.

◆ ModifySignInterpreterLanguage()

virtual SDKError IMeetingSignInterpretationController::ModifySignInterpreterLanguage	(	unsigned int	userID,
		const zchar_t *	signLanguageId )

pure virtual

Modify the language of a sign interpreter.

Parameters

userID	Specify the interpreter.
signLanguageId	Specify the new sign language.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ RemoveSignInterpreter()

virtual SDKError IMeetingSignInterpretationController::RemoveSignInterpreter ( unsigned int userID )

pure virtual

Remove someone from the list of sign interpreters.

Parameters

userID Specify the user.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ RequestSignLanguageInterpreterToTalk()

virtual SDKError IMeetingSignInterpretationController::RequestSignLanguageInterpreterToTalk	(	unsigned int	userID,
		bool	allowToTalk )

pure virtual

Host allow sign language interpreter to talk.

Parameters

userID	Specify the sign language interpreter.
allowToTalk	true indicates to allow to talk. Otherwise, false.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ SetEvent()

virtual void IMeetingSignInterpretationController::SetEvent ( IMeetingSignInterpretationControllerEvent * event )

pure virtual

Set the interpretation controller callback event handler.

Note: Common (for all)

Parameters

event A pointer to the IMeetingInterpretationControllerEvent that receives the interpretation event. .

◆ StartSignInterpretation()

virtual SDKError IMeetingSignInterpretationController::StartSignInterpretation ( )

pure virtual

Start sign interpretation.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

◆ StopSignInterpretation()

virtual SDKError IMeetingSignInterpretationController::StopSignInterpretation ( )

pure virtual

Stop sign interpretation.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingSignInterpretationController()

Member Function Documentation

◆ AddSignInterpreter()

◆ CanSignLanguageInterpreterTalk()

◆ CanStartSignInterpretation()

◆ GetAllSupportedSignLanguageInfoList()

◆ GetAvailableSignLanguageInfoList()

◆ GetSignInterpretationLanguageInfoByID()

◆ GetSignInterpretationStatus()

◆ GetSignInterpreterAssignedLanID()

◆ GetSignInterpreterList()

◆ IsSignInterpretationEnabled()

◆ IsSignInterpreter()

◆ JoinSignLanguageChannel()

◆ LeaveSignLanguageChannel()

◆ ModifySignInterpreterLanguage()

◆ RemoveSignInterpreter()

◆ RequestSignLanguageInterpreterToTalk()

◆ SetEvent()

◆ StartSignInterpretation()

◆ StopSignInterpretation()