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

#include <ZMVideoSDKLiveTranscriptionHelper.h>

Inherits NSObject.

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

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

(ZMVideoSDKErrors)	- startLiveTranscription
	Start live transcription.

(ZMVideoSDKErrors)	- stopLiveTranscription
	Stop live transcription.

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

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

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

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

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

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

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

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

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

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

Detailed Description

Provides methods for controlling and interacting with live transcription.

Definition at line 72 of file ZMVideoSDKLiveTranscriptionHelper.h.

Method Documentation

◆ canStartLiveTranscription

- (BOOL) canStartLiveTranscription

Query if the user can start live transcription.

◆ enableReceiveSpokenLanguageContent:

- (ZMVideoSDKErrors) 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 ZMVideoSDKErrors_Success. Otherwise not.

◆ getAvailableSpokenLanguages

- (NSArray< ZMVideoSDKLiveTranscriptionLanguage * > *_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.

◆ getAvailableTranslationLanguages

- (NSArray< ZMVideoSDKLiveTranscriptionLanguage * > *_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.

◆ getHistoryTranslationMessageList

- (NSArray< ZMVideoSDKLiveTranscriptionMessageInfo * > *_Nullable) getHistoryTranslationMessageList

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

Returns: If the function succeeds, the return value is a array of all history translation messages in a session. Otherwise it fails, and the return value is nil.

◆ getLiveTranscriptionStatus

- (ZMVideoSDKLiveTranscriptionStatus) getLiveTranscriptionStatus

Get the current live transcription status.

Returns: If the function succeeds, the return value is the current live transcription status.

◆ getSpokenLanguage

- (ZMVideoSDKLiveTranscriptionLanguage *_Nullable) getSpokenLanguage

Get the spoken language of the current user.

◆ getTranslationLanguage

- (ZMVideoSDKLiveTranscriptionLanguage *_Nullable) getTranslationLanguage

Get the translation language of the current user.

◆ isAllowViewHistoryTranslationMessageEnabled

- (BOOL) isAllowViewHistoryTranslationMessageEnabled

Determine whether the view history translation message is available.

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

◆ 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 NO.

◆ setSpokenLanguage:

- (ZMVideoSDKErrors) setSpokenLanguage: (int) languageID

Set the spoken language of the current user.

Parameters

languageID The spoken language ID.

Returns: If the function succeeds, it will return ZMVideoSDKErrors_Success.

◆ setTranslationLanguage:

- (ZMVideoSDKErrors) setTranslationLanguage: (int) 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, it will return ZMVideoSDKErrors_Success.

◆ startLiveTranscription

- (ZMVideoSDKErrors) startLiveTranscription

Start live transcription.

Returns: If the function succeeds, it will return ZMVideoSDKErrors_Success, otherwise failed.

Note: If the session allows multi-language transcription, all user can start live transcription. Otherwise only the host can start it.

◆ stopLiveTranscription

- (ZMVideoSDKErrors) stopLiveTranscription

Stop live transcription.

Returns: If the function succeeds, it will return ZMVideoSDKErrors_Success, otherwise failed.

Note: If the session allows multi-language transcription, all user can stop live transcription. Otherwise only the host can stop it.

Instance Methods