Meeting interpretation controller interface. More...

#include <meeting_interpretation_interface.h>

Public Member Functions
virtual	~IMeetingInterpretationController ()

virtual void	SetEvent (IMeetingInterpretationControllerEvent *event)=0
	Sets the interpretation controller callback event handler.

virtual bool	IsInterpretationEnabled ()=0
	Determines if interpretation feature is enabled in the meeting.

virtual bool	IsInterpretationStarted ()=0
	Determines if interpretation has been started by host.

virtual bool	IsInterpreter ()=0
	Determines if myself is interpreter.

virtual IInterpretationLanguage *	GetInterpretationLanguageByID (int lanID)=0
	Gets the interpretation language object of specified language ID.

virtual IList< IInterpretationLanguage * > *	GetAllLanguageList ()=0
	Gets the all interpretation language list.

virtual IList< IInterpreter * > *	GetInterpreterList ()=0
	Gets the interpreters list.

virtual SDKError	AddInterpreter (unsigned int userID, int lanID1, int lanID2)=0
	Add someone as a interpreter.

virtual SDKError	RemoveInterpreter (unsigned int userID)=0
	Remove some interpreter.

virtual SDKError	ModifyInterpreter (unsigned int userID, int lanID1, int lanID2)=0
	modify the language of some interpreter.

virtual SDKError	StartInterpretation ()=0
	Starts interpretation.

virtual SDKError	StopInterpretation ()=0
	Stops interpretation.

virtual IList< IInterpretationLanguage * > *	GetAvailableLanguageList ()=0
	Gets the available interpretation language list.

virtual SDKError	JoinLanguageChannel (int lanID)=0
	Joins some language channel.

virtual SDKError	GetJoinedLanguageID (int &lanID)=0
	Gets the language ID which myself is in.

virtual SDKError	TurnOffMajorAudio ()=0
	Turn off the major audio, if you are in some interpreter language channel.

virtual SDKError	TurnOnMajorAudio ()=0
	Turn on the major audio, if you are in some interpreter language channel.

virtual SDKError	IsMajorAudioTurnOff (bool &bOff)=0
	Determines if the major audio is off.

virtual SDKError	GetInterpreterLans (int &lanID1, int &lanID2)=0
	Gets languages if myself is a interpreter.

virtual SDKError	SetInterpreterActiveLan (int activeLanID)=0
	Sets a language channel which myself will be in, if myself is a interpreter.

virtual SDKError	GetInterpreterActiveLan (int &lanID)=0
	Gets the active language ID, if myself is a interpreter.

virtual IList< IInterpretationLanguage * > *	GetInterpreterAvailableLanguages ()=0
	Gets the list of available languages that interpreters can hear.

virtual SDKError	SetInterpreterListenLan (int languageID)=0
	Sets a language that I can hear as an interpreter.

virtual SDKError	GetInterpreterListenLan (int &languageID)=0
	Gets a language that I can hear as an interpreter.

Detailed Description

Meeting interpretation controller interface.

Definition at line 101 of file meeting_interpretation_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingInterpretationController()

virtual IMeetingInterpretationController::~IMeetingInterpretationController ( )

inlinevirtual

Definition at line 104 of file meeting_interpretation_interface.h.

104{}

Member Function Documentation

◆ AddInterpreter()

virtual SDKError IMeetingInterpretationController::AddInterpreter	(	unsigned int	userID,
		int	lanID1,
		int	lanID2 )

pure virtual

Add someone as a interpreter.

Parameters

userID	Specify the user.
lanID1	Specify the language1.
lanID2	Specify the language2.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetAllLanguageList()

virtual IList< IInterpretationLanguage * > * IMeetingInterpretationController::GetAllLanguageList ( )

pure virtual

Gets the all interpretation language list.

Note: Admin (only for host)

Returns: If the function succeeds, it returns a pointer to the IList<IInterpretationLanguage*>. Otherwise, this function fails and returns nullptr.

◆ GetAvailableLanguageList()

virtual IList< IInterpretationLanguage * > * IMeetingInterpretationController::GetAvailableLanguageList ( )

pure virtual

Gets the available interpretation language list.

Note: Listener (for non interpreter)

Returns: If the function succeeds, it returns a pointer to the IList<IInterpretationLanguage*>. Otherwise, this function fails and returns nullptr.

◆ GetInterpretationLanguageByID()

virtual IInterpretationLanguage * IMeetingInterpretationController::GetInterpretationLanguageByID ( int lanID )

pure virtual

Gets the interpretation language object of specified language ID.

Parameters

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

Returns: If the function succeeds, it returns a pointer to the IInterpretationLanguage. Otherwise, this function fails and returns nullptr.

◆ GetInterpreterActiveLan()

virtual SDKError IMeetingInterpretationController::GetInterpreterActiveLan ( int & lanID )

pure virtual

Gets the active language ID, if myself is a interpreter.

Parameters

[out] lanID Specify the active language.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetInterpreterAvailableLanguages()

virtual IList< IInterpretationLanguage * > * IMeetingInterpretationController::GetInterpreterAvailableLanguages ( )

pure virtual

Gets the list of available languages that interpreters can hear.

Returns: If the function succeeds, it returns a pointer to the IList<IInterpretationLanguage*>. Otherwise, this function fails and returns nullptr.

◆ GetInterpreterLans()

virtual SDKError IMeetingInterpretationController::GetInterpreterLans	(	int &	lanID1,
		int &	lanID2 )

pure virtual

Gets languages if myself is a interpreter.

Note: Interpreter (only for interpreter)

Parameters

[out]	lanID1	Specify the language1.
[out]	lanID2	Specify the language2.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetInterpreterList()

virtual IList< IInterpreter * > * IMeetingInterpretationController::GetInterpreterList ( )

pure virtual

Gets the interpreters list.

Returns: If the function succeeds, it returns a pointer to the IList<IInterpreter*>. Otherwise, this function fails and returns nullptr.

◆ GetInterpreterListenLan()

virtual SDKError IMeetingInterpretationController::GetInterpreterListenLan ( int & languageID )

pure virtual

Gets a language that I can hear as an interpreter.

Parameters

lanID Specify the selected language that I can hear as an interpreter.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetJoinedLanguageID()

virtual SDKError IMeetingInterpretationController::GetJoinedLanguageID ( int & lanID )

pure virtual

Gets the language ID which myself is in.

Parameters

[out] lanID indicates the language ID which myself is in.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ IsInterpretationEnabled()

virtual bool IMeetingInterpretationController::IsInterpretationEnabled ( )

pure virtual

Determines if interpretation feature is enabled in the meeting.

◆ IsInterpretationStarted()

virtual bool IMeetingInterpretationController::IsInterpretationStarted ( )

pure virtual

Determines if interpretation has been started by host.

◆ IsInterpreter()

virtual bool IMeetingInterpretationController::IsInterpreter ( )

pure virtual

Determines if myself is interpreter.

◆ IsMajorAudioTurnOff()

virtual SDKError IMeetingInterpretationController::IsMajorAudioTurnOff ( bool & bOff )

pure virtual

Determines if the major audio is off.

Parameters

[out] bOff indicates the major audio off status.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ JoinLanguageChannel()

virtual SDKError IMeetingInterpretationController::JoinLanguageChannel ( int lanID )

pure virtual

Joins some language channel.

Parameters

lanID Specify the language channel. If lanID is -1 means join major meeting.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ ModifyInterpreter()

virtual SDKError IMeetingInterpretationController::ModifyInterpreter	(	unsigned int	userID,
		int	lanID1,
		int	lanID2 )

pure virtual

modify the language of some interpreter.

Parameters

userID	Specify the interpreter.
lanID1	Specify the new language1.
lanID2	Specify the new language2.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ RemoveInterpreter()

virtual SDKError IMeetingInterpretationController::RemoveInterpreter ( unsigned int userID )

pure virtual

Remove some interpreter.

Parameters

userID Specify the interpreter.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SetEvent()

virtual void IMeetingInterpretationController::SetEvent ( IMeetingInterpretationControllerEvent * event )

pure virtual

Sets the interpretation controller callback event handler.

Note: Common (for all)

Parameters

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

◆ SetInterpreterActiveLan()

virtual SDKError IMeetingInterpretationController::SetInterpreterActiveLan ( int activeLanID )

pure virtual

Sets a language channel which myself will be in, if myself is a interpreter.

Parameters

activeLanID Specify the active language.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SetInterpreterListenLan()

virtual SDKError IMeetingInterpretationController::SetInterpreterListenLan ( int languageID )

pure virtual

Sets a language that I can hear as an interpreter.

Parameters

lanID Specify the selected language that I can hear as an interpreter.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ StartInterpretation()

virtual SDKError IMeetingInterpretationController::StartInterpretation ( )

pure virtual

Starts interpretation.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ StopInterpretation()

virtual SDKError IMeetingInterpretationController::StopInterpretation ( )

pure virtual

Stops interpretation.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ TurnOffMajorAudio()

virtual SDKError IMeetingInterpretationController::TurnOffMajorAudio ( )

pure virtual

Turn off the major audio, if you are in some interpreter language channel.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ TurnOnMajorAudio()

virtual SDKError IMeetingInterpretationController::TurnOnMajorAudio ( )

pure virtual

Turn on the major audio, if you are in some interpreter language channel.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingInterpretationController()

Member Function Documentation

◆ AddInterpreter()

◆ GetAllLanguageList()

◆ GetAvailableLanguageList()

◆ GetInterpretationLanguageByID()

◆ GetInterpreterActiveLan()

◆ GetInterpreterAvailableLanguages()

◆ GetInterpreterLans()

◆ GetInterpreterList()

◆ GetInterpreterListenLan()

◆ GetJoinedLanguageID()

◆ IsInterpretationEnabled()

◆ IsInterpretationStarted()

◆ IsInterpreter()

◆ IsMajorAudioTurnOff()

◆ JoinLanguageChannel()

◆ ModifyInterpreter()

◆ RemoveInterpreter()

◆ SetEvent()

◆ SetInterpreterActiveLan()

◆ SetInterpreterListenLan()

◆ StartInterpretation()

◆ StopInterpretation()

◆ TurnOffMajorAudio()

◆ TurnOnMajorAudio()