IZoomVideoSDKVoiceInterpretationHelper Class Reference

Voice interpretation helper interface. More...

#include <zoom_video_sdk_voice_interpretation_helper_interface.h>

Public Member Functions
virtual	~IZoomVideoSDKVoiceInterpretationHelper ()
virtual bool	isVoiceInterpretationEnabled ()=0
	Query whether voice interpretation capability is enabled in current session.
virtual bool	isVoiceInterpretationReady ()=0
	Query whether voice interpretation is ready for use.
virtual ZoomVideoSDKErrors	startVoiceInterpretation ()=0
	Start voice interpretation.
virtual ZoomVideoSDKErrors	stopVoiceInterpretation ()=0
	Stop voice interpretation.
virtual bool	isVoiceInterpretationStarted ()=0
	Query whether voice interpretation has been started.
virtual IZoomVideoSDKVoiceInterpretationLanguage *	getMySpeakingLanguage ()=0
	Get current speaking language for local user.
virtual IVideoSDKVector< IZoomVideoSDKVoiceInterpretationLanguage * > *	getMySpeakingLanguageList ()=0
	Get available speaking language list.
virtual ZoomVideoSDKErrors	setMySpeakingLanguage (IZoomVideoSDKVoiceInterpretationLanguage *language)=0
	Set speaking language for local user.
virtual IZoomVideoSDKVoiceInterpretationLanguage *	getTranslatedLanguage ()=0
	Get current translated language for local user.
virtual IVideoSDKVector< IZoomVideoSDKVoiceInterpretationLanguage * > *	getTranslatedLanguagesList ()=0
	Get available translated language list.
virtual ZoomVideoSDKErrors	setTranslatedLanguage (IZoomVideoSDKVoiceInterpretationLanguage *language)=0
	Set translated language for local user.
virtual float	getAudioBalanceForOriginalAndTranslatedVoice ()=0
	Get audio balance between original and translated voice.
virtual ZoomVideoSDKErrors	setAudioBalanceForOriginalAndTranslatedVoice (float balance)=0
	Set audio balance between original and translated voice.
virtual IZoomVideoSDKVoiceInterpretationVoiceInfo *	getTranslatedVoiceStyle ()=0
	Get current translated voice style.
virtual IVideoSDKVector< IZoomVideoSDKVoiceInterpretationVoiceInfo * > *	getTranslatedVoiceStyleList ()=0
	Get available translated voice style list.
virtual ZoomVideoSDKErrors	setTranslatedVoiceStyle (IZoomVideoSDKVoiceInterpretationVoiceInfo *voiceInfo)=0
	Set translated voice style.

Detailed Description

Voice interpretation helper interface.

Definition at line 68 of file zoom_video_sdk_voice_interpretation_helper_interface.h.

Constructor & Destructor Documentation

~IZoomVideoSDKVoiceInterpretationHelper()

virtual IZoomVideoSDKVoiceInterpretationHelper::~IZoomVideoSDKVoiceInterpretationHelper ( )

inlinevirtual

Definition at line 71 of file zoom_video_sdk_voice_interpretation_helper_interface.h.

{}

Member Function Documentation

getAudioBalanceForOriginalAndTranslatedVoice()

virtual float IZoomVideoSDKVoiceInterpretationHelper::getAudioBalanceForOriginalAndTranslatedVoice ( )

pure virtual

Get audio balance between original and translated voice.

Returns

Audio balance in range [0.0, 1.0]. 0.0 means original only, 1.0 means translated only.

getMySpeakingLanguage()

virtual IZoomVideoSDKVoiceInterpretationLanguage * IZoomVideoSDKVoiceInterpretationHelper::getMySpeakingLanguage ( )

pure virtual

Get current speaking language for local user.

Returns

The current speaking language. Returns nullptr if unavailable.

getMySpeakingLanguageList()

virtual IVideoSDKVector< IZoomVideoSDKVoiceInterpretationLanguage * > * IZoomVideoSDKVoiceInterpretationHelper::getMySpeakingLanguageList ( )

pure virtual

Get available speaking language list.

Returns

The speaking language list. Returns nullptr if unavailable.

getTranslatedLanguage()

virtual IZoomVideoSDKVoiceInterpretationLanguage * IZoomVideoSDKVoiceInterpretationHelper::getTranslatedLanguage ( )

pure virtual

Get current translated language for local user.

Returns

The current translated language. Returns nullptr if unavailable.

getTranslatedLanguagesList()

virtual IVideoSDKVector< IZoomVideoSDKVoiceInterpretationLanguage * > * IZoomVideoSDKVoiceInterpretationHelper::getTranslatedLanguagesList ( )

pure virtual

Get available translated language list.

Returns

The translated language list. Returns nullptr if unavailable.

getTranslatedVoiceStyle()

virtual IZoomVideoSDKVoiceInterpretationVoiceInfo * IZoomVideoSDKVoiceInterpretationHelper::getTranslatedVoiceStyle ( )

pure virtual

Get current translated voice style.

Returns

The current voice style. Returns nullptr if unavailable.

getTranslatedVoiceStyleList()

virtual IVideoSDKVector< IZoomVideoSDKVoiceInterpretationVoiceInfo * > * IZoomVideoSDKVoiceInterpretationHelper::getTranslatedVoiceStyleList ( )

pure virtual

Get available translated voice style list.

Returns

The translated voice style list. Returns nullptr if unavailable.

isVoiceInterpretationEnabled()

virtual bool IZoomVideoSDKVoiceInterpretationHelper::isVoiceInterpretationEnabled ( )

pure virtual

Query whether voice interpretation capability is enabled in current session.

Returns

true if enabled. Otherwise, false.

isVoiceInterpretationReady()

virtual bool IZoomVideoSDKVoiceInterpretationHelper::isVoiceInterpretationReady ( )

pure virtual

Query whether voice interpretation is ready for use.

Returns

true if ready. Otherwise, false.

isVoiceInterpretationStarted()

virtual bool IZoomVideoSDKVoiceInterpretationHelper::isVoiceInterpretationStarted ( )

pure virtual

Query whether voice interpretation has been started.

Returns

true if started. Otherwise, false.

setAudioBalanceForOriginalAndTranslatedVoice()

virtual ZoomVideoSDKErrors IZoomVideoSDKVoiceInterpretationHelper::setAudioBalanceForOriginalAndTranslatedVoice ( float balance )

pure virtual

Set audio balance between original and translated voice.

Parameters

balance

Audio balance in range [0.0, 1.0]. 0.0 means original only, 1.0 means translated only.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

setMySpeakingLanguage()

virtual ZoomVideoSDKErrors IZoomVideoSDKVoiceInterpretationHelper::setMySpeakingLanguage ( IZoomVideoSDKVoiceInterpretationLanguage * language )

pure virtual

Set speaking language for local user.

Parameters

language

The target speaking language.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

setTranslatedLanguage()

virtual ZoomVideoSDKErrors IZoomVideoSDKVoiceInterpretationHelper::setTranslatedLanguage ( IZoomVideoSDKVoiceInterpretationLanguage * language )

pure virtual

Set translated language for local user.

Parameters

language

The target translated language.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

setTranslatedVoiceStyle()

virtual ZoomVideoSDKErrors IZoomVideoSDKVoiceInterpretationHelper::setTranslatedVoiceStyle ( IZoomVideoSDKVoiceInterpretationVoiceInfo * voiceInfo )

pure virtual

Set translated voice style.

Parameters

voiceInfo

The target voice style.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

startVoiceInterpretation()

virtual ZoomVideoSDKErrors IZoomVideoSDKVoiceInterpretationHelper::startVoiceInterpretation ( )

pure virtual

Start voice interpretation.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

stopVoiceInterpretation()

virtual ZoomVideoSDKErrors IZoomVideoSDKVoiceInterpretationHelper::stopVoiceInterpretation ( )

pure virtual

Stop voice interpretation.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.