Windows SDK API Reference
Loading...
Searching...
No Matches
IMeetingInterpretationController Class Referenceabstract

Meeting interpretation controller interface. More...

#include <meeting_interpretation_interface.h>

Public Member Functions

virtual ~IMeetingInterpretationController ()
 
virtual void SetEvent (IMeetingInterpretationControllerEvent *event)=0
 Set the interpretation controller callback event handler.
 
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 IInterpretationLanguageGetInterpretationLanguageByID (int lanID)=0
 Get the interpretation language object of specified language ID.
 
virtual IList< IInterpretationLanguage * > * GetAllLanguageList ()=0
 Get the all interpretation language list.
 
virtual IList< IInterpreter * > * GetInterpreterList ()=0
 Get 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
 Start interpretation.
 
virtual SDKError StopInterpretation ()=0
 Stop interpretation.
 
virtual IList< IInterpretationLanguage * > * GetAvailableLanguageList ()=0
 Get the available interpretation language list.
 
virtual SDKError JoinLanguageChannel (int lanID)=0
 Join some language channel.
 
virtual SDKError GetJoinedLanguageID (int &lanID)=0
 Get 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
 Determine if the major audio is off.
 
virtual SDKError GetInterpreterLans (int &lanID1, int &lanID2)=0
 Get languages if myself is a interpreter.
 
virtual SDKError SetInterpreterActiveLan (int activeLanID)=0
 Set a language channel which myself will be in, if myself is a interpreter.
 
virtual SDKError GetInterpreterActiveLan (int &lanID)=0
 Get the active language ID, if myself is a interpreter.
 
virtual IList< IInterpretationLanguage * > * GetInterpreterAvailableLanguages ()=0
 Get the list of available languages that interpreters can hear.
 
virtual SDKError SetInterpreterListenLan (int languageID)=0
 Set a language that I can hear as an interpreter.
 
virtual SDKError GetInterpreterListenLan (int &languageID)=0
 Get a language that I can hear as an interpreter.
 

Detailed Description

Meeting interpretation controller interface.

Definition at line 77 of file meeting_interpretation_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingInterpretationController()

virtual IMeetingInterpretationController::~IMeetingInterpretationController ( )
inlinevirtual

Definition at line 80 of file meeting_interpretation_interface.h.

80{}

Member Function Documentation

◆ AddInterpreter()

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

Add someone as a interpreter.

Parameters
userIDSpecify the user.
lanID1Specify the language1.
lanID2Specify 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
lanIDSpecify 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]lanIDSpecify the active language.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetInterpreterAvailableLanguages()

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

Get the list of available languages that interpreters can hear.

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

◆ GetInterpreterLans()

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

Get languages if myself is a interpreter.

Parameters
[out]lanID1Specify the language1.
[out]lanID2Specify 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.

◆ GetInterpreterListenLan()

virtual SDKError IMeetingInterpretationController::GetInterpreterListenLan ( int & languageID)
pure virtual

Get a language that I can hear as an interpreter.

Parameters
lanIDSpecify the selected language that I can hear as an interpreter.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetJoinedLanguageID()

virtual SDKError IMeetingInterpretationController::GetJoinedLanguageID ( int & lanID)
pure virtual

Get the language ID which myself is in.

Parameters
[out]lanIDindicates 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.

◆ IsInterpretationEnabled()

virtual bool IMeetingInterpretationController::IsInterpretationEnabled ( )
pure virtual

Determine if interpretation feature is enabled in the meeting.

◆ IsInterpretationStarted()

virtual bool IMeetingInterpretationController::IsInterpretationStarted ( )
pure virtual

Determine if interpretation has been started by host.

◆ IsInterpreter()

virtual bool IMeetingInterpretationController::IsInterpreter ( )
pure virtual

Determine if myself is interpreter.

◆ IsMajorAudioTurnOff()

virtual SDKError IMeetingInterpretationController::IsMajorAudioTurnOff ( bool & bOff)
pure virtual

Determine if the major audio is off.

Parameters
[out]bOffindicates 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
lanIDSpecify the language channel. If lanID is -1 means join major meeting.
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
userIDSpecify the interpreter.
lanID1Specify the new language1.
lanID2Specify 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
userIDSpecify 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
eventA 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
activeLanIDSpecify the active language.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetInterpreterListenLan()

virtual SDKError IMeetingInterpretationController::SetInterpreterListenLan ( int languageID)
pure virtual

Set a language that I can hear as an interpreter.

Parameters
lanIDSpecify the selected language that I can hear as an interpreter.
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.