Meeting interpretation controller interface. More...

#include <meeting_interpretation_interface.h>

Public Member Functions
virtual void	SetEvent (IMeetingInterpretationControllerEvent *event)=0
	Set the interpretation controller callback event handler. More...

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

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

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

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

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

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

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

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

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

virtual SDKError	StartInterpretation ()=0
	Start interpretation. More...

virtual SDKError	StopInterpretation ()=0
	Stop interpretation. More...

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

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

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

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

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

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

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

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

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

Detailed Description

Meeting interpretation controller interface.

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 failed. To get extended error information, see SDKError enum.

◆ GetAllLanguageList()

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

pure virtual

Get the all interpretation language list.

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

◆ GetAvailableLanguageList()

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

pure virtual

Get the available interpretation language list.

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

◆ GetInterpretationLanguageByID()

virtual IInterpretationLanguage* IMeetingInterpretationController::GetInterpretationLanguageByID ( int lanID )

pure virtual

Get 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, the return value is a pointer to the IInterpretationLanguage, Otherwise failed, the return value is NULL.

◆ GetInterpreterActiveLan()

virtual SDKError IMeetingInterpretationController::GetInterpreterActiveLan ( int & lanID )

pure virtual

Get 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 failed. To get extended error information, see SDKError enum.

◆ GetInterpreterLans()

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

pure virtual

Get languages if myself is a interpreter.

Parameters

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

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetInterpreterList()

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

pure virtual

Get the interpreters list.

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

◆ GetJoinedLanguageID()

virtual SDKError IMeetingInterpretationController::GetJoinedLanguageID ( int & lanID )

pure virtual

Get 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 failed. To get extended error information, see SDKError enum.

◆ IsMajorAudioTurnOff()

virtual SDKError IMeetingInterpretationController::IsMajorAudioTurnOff ( bool & bOff )

pure virtual

Determine 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 failed. To get extended error information, see SDKError enum.

◆ JoinLanguageChannel()

virtual SDKError IMeetingInterpretationController::JoinLanguageChannel ( int lanID )

pure virtual

Join some language channel.

Parameters

lanID Specify the language channel.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ 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 failed. To get extended error information, see SDKError enum.

◆ 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 failed. To get extended error information, see SDKError enum.

◆ SetEvent()

virtual void IMeetingInterpretationController::SetEvent ( IMeetingInterpretationControllerEvent * event )

pure virtual

Set the interpretation controller callback event handler.

Parameters

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

◆ SetInterpreterActiveLan()

virtual SDKError IMeetingInterpretationController::SetInterpreterActiveLan ( int activeLanID )

pure virtual

Set 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 failed. To get extended error information, see SDKError enum.

◆ StartInterpretation()

virtual SDKError IMeetingInterpretationController::StartInterpretation ( )

pure virtual

Start interpretation.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ StopInterpretation()

virtual SDKError IMeetingInterpretationController::StopInterpretation ( )

pure virtual

Stop interpretation.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ 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 failed. To get extended error information, see SDKError enum.

◆ 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 failed. To get extended error information, see SDKError enum.

The documentation for this class was generated from the following file:

h/meeting_service_components/meeting_interpretation_interface.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddInterpreter()

◆ GetAllLanguageList()

◆ GetAvailableLanguageList()

◆ GetInterpretationLanguageByID()

◆ GetInterpreterActiveLan()

◆ GetInterpreterLans()

◆ GetInterpreterList()

◆ GetJoinedLanguageID()

◆ IsMajorAudioTurnOff()

◆ JoinLanguageChannel()

◆ ModifyInterpreter()

◆ RemoveInterpreter()

◆ SetEvent()

◆ SetInterpreterActiveLan()

◆ StartInterpretation()

◆ StopInterpretation()

◆ TurnOffMajorAudio()

◆ TurnOnMajorAudio()