IZoomVideoSDKLiveTranscriptionHelper Class Reference

live transcription helper interface. More...

#include <zoom_video_sdk_livetranscription_helper_interface.h>

Public Member Functions
virtual bool	canStartLiveTranscription ()=0
	Query if the user can start live transcription.
virtual ZoomVideoSDKErrors	getLiveTranscriptionStatus (ZoomVideoSDKLiveTranscriptionStatus &status)=0
	Get the current live transcription status.
virtual ZoomVideoSDKErrors	startLiveTranscription ()=0
	Start live transcription.
virtual ZoomVideoSDKErrors	stopLiveTranscription ()=0
	Stop live transcription.
virtual IVideoSDKVector< ILiveTranscriptionLanguage * > *	getAvailableSpokenLanguages ()=0
	Get the list of all available spoken languages in session.
virtual ZoomVideoSDKErrors	setSpokenLanguage (int languageID)=0
	Set the spoken language of the current user.
virtual ILiveTranscriptionLanguage *	getSpokenLanguage ()=0
	Get the spoken language of the current user.
virtual IVideoSDKVector< ILiveTranscriptionLanguage * > *	getAvailableTranslationLanguages ()=0
	Get the list of all available translation languages in a session.
virtual ZoomVideoSDKErrors	setTranslationLanguage (int languageID)=0
	Set the translation language of the current user.
virtual ILiveTranscriptionLanguage *	getTranslationLanguage ()=0
	Get the translation language of the current user.
virtual ZoomVideoSDKErrors	enableReceiveSpokenLanguageContent (bool bEnable)=0
	Enable or disable to receive original and translated content.If you enable this feature,you must start live transcription.
virtual bool	isReceiveSpokenLanguageContentEnabled ()=0
	Determines whether the feature to receive original and translated is available.
virtual bool	isAllowViewHistoryTranslationMessageEnabled ()=0
	Determines whether the view history translation message is available.
virtual IVideoSDKVector< ILiveTranscriptionMessageInfo * > *	getHistoryTranslationMessageList ()=0
	Get the list of all history translation messages in a session.

Detailed Description

live transcription helper interface.

Definition at line 108 of file zoom_video_sdk_livetranscription_helper_interface.h.

Member Function Documentation

canStartLiveTranscription()

virtual bool IZoomVideoSDKLiveTranscriptionHelper::canStartLiveTranscription ( )

pure virtual

Query if the user can start live transcription.

Returns

true if the user can start live transcription. Otherwise, false.

enableReceiveSpokenLanguageContent()

virtual ZoomVideoSDKErrors IZoomVideoSDKLiveTranscriptionHelper::enableReceiveSpokenLanguageContent ( bool bEnable )

pure virtual

Enable or disable to receive original and translated content.If you enable this feature,you must start live transcription.

Parameters

bEnable

true to enable the temporal de-noise of video or false to disable it.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors. Otherwise it fails.

getAvailableSpokenLanguages()

virtual IVideoSDKVector< ILiveTranscriptionLanguage * > * IZoomVideoSDKLiveTranscriptionHelper::getAvailableSpokenLanguages ( )

pure virtual

Get the list of all available spoken languages in session.

Returns

If the function succeeds, the return value is the list of the available spoken languages in a session. Otherwise failed, the return value is nullptr.

getAvailableTranslationLanguages()

virtual IVideoSDKVector< ILiveTranscriptionLanguage * > * IZoomVideoSDKLiveTranscriptionHelper::getAvailableTranslationLanguages ( )

pure virtual

Get the list of all available translation languages in a session.

Returns

If the function succeeds, the return value is the list of all available translation languages in a session. Otherwise failed, the return value is nullptr.

getHistoryTranslationMessageList()

virtual IVideoSDKVector< ILiveTranscriptionMessageInfo * > * IZoomVideoSDKLiveTranscriptionHelper::getHistoryTranslationMessageList ( )

pure virtual

Get the list of all history translation messages in a session.

Returns

If the function succeeds, the return value is a list of all history translation messages in a session. Otherwise it fails, and the return value is nullptr.

getLiveTranscriptionStatus()

virtual ZoomVideoSDKErrors IZoomVideoSDKLiveTranscriptionHelper::getLiveTranscriptionStatus ( ZoomVideoSDKLiveTranscriptionStatus & status )

pure virtual

Get the current live transcription status.

Parameters

[out]

status

The current live transcription status.

Returns

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

getSpokenLanguage()

virtual ILiveTranscriptionLanguage * IZoomVideoSDKLiveTranscriptionHelper::getSpokenLanguage ( )

pure virtual

Get the spoken language of the current user.

Returns

The spoken language of the current user.

getTranslationLanguage()

virtual ILiveTranscriptionLanguage * IZoomVideoSDKLiveTranscriptionHelper::getTranslationLanguage ( )

pure virtual

Get the translation language of the current user.

Returns

The translation language of the current user.

isAllowViewHistoryTranslationMessageEnabled()

virtual bool IZoomVideoSDKLiveTranscriptionHelper::isAllowViewHistoryTranslationMessageEnabled ( )

pure virtual

Determines whether the view history translation message is available.

Returns

true if the view history translation message is available. Otherwise, false.

isReceiveSpokenLanguageContentEnabled()

virtual bool IZoomVideoSDKLiveTranscriptionHelper::isReceiveSpokenLanguageContentEnabled ( )

pure virtual

Determines whether the feature to receive original and translated is available.

Returns

true if the feature to receive original and translated is available. Otherwise, false.

setSpokenLanguage()

virtual ZoomVideoSDKErrors IZoomVideoSDKLiveTranscriptionHelper::setSpokenLanguage ( int languageID )

pure virtual

Set the spoken language of the current user.

Parameters

languageID

The spoken language ID.

Returns

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

setTranslationLanguage()

virtual ZoomVideoSDKErrors IZoomVideoSDKLiveTranscriptionHelper::setTranslationLanguage ( int languageID )

pure virtual

Set the translation language of the current user.

Parameters

languageID

The translation language ID. If the language id is set to -1, live translation will be disabled.

Returns

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

Note

If you call this method before calling startLiveTranscription(), it will trigger the onLiveTranscriptionStatus callback when the translation status changes. If translation is already enabled, calling this method again will not trigger the onLiveTranscriptionStatus callback.

startLiveTranscription()

virtual ZoomVideoSDKErrors IZoomVideoSDKLiveTranscriptionHelper::startLiveTranscription ( )

pure virtual

Start live transcription.

Note

If the session allows multi-language transcription,all users can start live transcription.

Returns

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

stopLiveTranscription()

virtual ZoomVideoSDKErrors IZoomVideoSDKLiveTranscriptionHelper::stopLiveTranscription ( )

pure virtual

Stop live transcription.

Note

If the session allows multi-language transcription,all users can stop live transcription.

Returns

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