Provides methods for controlling and interacting with live transcription. More...

#include <ZoomVideoSDKLiveTranscriptionHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- canStartLiveTranscription
	Query if the user can start live transcription.

(ZoomVideoSDKLiveTranscriptionStatus)	- getLiveTranscriptionStatus
	Get the current live transcription status.

(ZoomVideoSDKError)	- startLiveTranscription
	Start live transcription.If the session allows multi-language transcription, all users can start live transcription.

(ZoomVideoSDKError)	- stopLiveTranscription
	Stop live transcription.If the session allows multi-language transcription,all user can stop live transcription.

(NSArray< ZoomVideoSDKLiveTranscriptionLanguage * > *_Nullable)	- getAvailableSpokenLanguages
	Get the list of all available spoken languages in session.

(ZoomVideoSDKError)	- setSpokenLanguage:
	Set the spoken language of the current user.

(ZoomVideoSDKLiveTranscriptionLanguage *_Nullable)	- getSpokenLanguage
	Get the spoken language of the current user.

(ZoomVideoSDKError)	- enableReceiveSpokenLanguageContent:
	Enable or disable to receive original and translated content. If you enable this feature, you must start live transcription.

(BOOL)	- isAllowViewFullTranscriptEnable
	Determine whether the view history translation message is available.

(NSArray< ZoomVideoSDKLiveTranscriptionMessageInfo * > *_Nullable)	- getHistoryTranslationMessageList
	Get the list of all history translation messages in a session.

(BOOL)	- isReceiveSpokenLanguageContentEnabled
	Determine whether the feature to receive original and translated is available.

(NSArray< ZoomVideoSDKLiveTranscriptionLanguage * > *_Nullable)	- getAvailableTranslationLanguages
	Get the list of all available translation languages in a session.

(ZoomVideoSDKError)	- setTranslationLanguage:
	Set the translation language of the current user.

(ZoomVideoSDKLiveTranscriptionLanguage *_Nullable)	- getTranslationLanguage
	Get the translation language of the current user.

Detailed Description

Provides methods for controlling and interacting with live transcription.

Definition at line 62 of file ZoomVideoSDKLiveTranscriptionHelper.h.

Method Documentation

◆ canStartLiveTranscription

- (BOOL) canStartLiveTranscription

Query if the user can start live transcription.

◆ enableReceiveSpokenLanguageContent:

- (ZoomVideoSDKError) enableReceiveSpokenLanguageContent: (BOOL) enable

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

Returns: If the function succeeds, the return value is ZoomVideoSDKError.

◆ getAvailableSpokenLanguages

- (NSArray< ZoomVideoSDKLiveTranscriptionLanguage * > *_Nullable) getAvailableSpokenLanguages

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 NULL.

◆ getAvailableTranslationLanguages

- (NSArray< ZoomVideoSDKLiveTranscriptionLanguage * > *_Nullable) getAvailableTranslationLanguages

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 NULL.

◆ getHistoryTranslationMessageList

- (NSArray< ZoomVideoSDKLiveTranscriptionMessageInfo * > *_Nullable) getHistoryTranslationMessageList

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.

◆ getLiveTranscriptionStatus

- (ZoomVideoSDKLiveTranscriptionStatus) getLiveTranscriptionStatus

Get the current live transcription status.

Returns: the current live transcription status.

◆ getSpokenLanguage

- (ZoomVideoSDKLiveTranscriptionLanguage *_Nullable) getSpokenLanguage

Get the spoken language of the current user.

Returns: If the function succeeds, return the current spoken language.

◆ getTranslationLanguage

- (ZoomVideoSDKLiveTranscriptionLanguage *_Nullable) getTranslationLanguage

Get the translation language of the current user.

Returns: If the function succeeds, return the current translation language.

◆ isAllowViewFullTranscriptEnable

- (BOOL) isAllowViewFullTranscriptEnable

Determine whether the view history translation message is available.

Returns: YES indicates that the view history transcription message is available. Otherwise False.

◆ isReceiveSpokenLanguageContentEnabled

- (BOOL) isReceiveSpokenLanguageContentEnabled

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

Returns: YES indicates that the feature to receive original and translated is available. Otherwise False.

◆ setSpokenLanguage:

- (ZoomVideoSDKError) setSpokenLanguage: (NSInteger) languageID

Set the spoken language of the current user.

Parameters

languageID The spoken language ID.

Returns: If the function succeeds, the return value is Success. Otherwise failed.

◆ setTranslationLanguage:

- (ZoomVideoSDKError) setTranslationLanguage: (NSInteger) languageID

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 Success. Otherwise failed. To get extended error information,.

◆ startLiveTranscription

- (ZoomVideoSDKError) startLiveTranscription

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

◆ stopLiveTranscription

- (ZoomVideoSDKError) stopLiveTranscription

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

Instance Methods