ZMVideoSDKLiveTranscriptionHelper Class Reference

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
	Gets the current live transcription status.
(ZMVideoSDKErrors)	- startLiveTranscription
	Starts live transcription.
(ZMVideoSDKErrors)	- stopLiveTranscription
	Stops live transcription.
(NSArray< ZMVideoSDKLiveTranscriptionLanguage * > *_Nullable)	- getAvailableSpokenLanguages
	Gets the available spoken language list in session.
(ZMVideoSDKErrors)	- setSpokenLanguage:
	Sets the current user's spoken language.
(ZMVideoSDKLiveTranscriptionLanguage *_Nullable)	- getSpokenLanguage
	Gets the current user's spoken language.
(NSArray< ZMVideoSDKLiveTranscriptionLanguage * > *_Nullable)	- getAvailableTranslationLanguages
	Gets the list of all available translation languages in a session.
(ZMVideoSDKErrors)	- setTranslationLanguage:
	Sets the current user's translation language.
(ZMVideoSDKLiveTranscriptionLanguage *_Nullable)	- getTranslationLanguage
	Gets the current user's translation language.
(ZMVideoSDKErrors)	- enableReceiveSpokenLanguageContent:
	Enables or disables to receive original and translated content. If enabled, start live transcription.
(BOOL)	- isReceiveSpokenLanguageContentEnabled
	Determines whether the feature to receive original and translated is available.
(BOOL)	- isAllowViewHistoryTranslationMessageEnabled
	Determines whether the view history translation message is available.
(NSArray< ZMVideoSDKLiveTranscriptionMessageInfo * > *_Nullable)	- getHistoryTranslationMessageList
	Gets 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.

Returns

YES if the user can start live transcription. Otherwise, NO.

References canStartLiveTranscription.

Referenced by canStartLiveTranscription.

enableReceiveSpokenLanguageContent:

- (ZMVideoSDKErrors) enableReceiveSpokenLanguageContent:

(BOOL)

enable

Enables or disables to receive original and translated content. If enabled, start live transcription.

Parameters

enable

Set to YES to receive both spoken language content, NO to disable.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

getAvailableSpokenLanguages

- (NSArray< ZMVideoSDKLiveTranscriptionLanguage * > *_Nullable) getAvailableSpokenLanguages

Gets the available spoken language list in session.

Returns

If the function succeeds, it returns the available spoken language list in a session. Otherwise, this function fails and returns nil.

References getAvailableSpokenLanguages.

Referenced by getAvailableSpokenLanguages.

getAvailableTranslationLanguages

- (NSArray< ZMVideoSDKLiveTranscriptionLanguage * > *_Nullable) getAvailableTranslationLanguages

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

Returns

If the function succeeds, it returns the list of all available translation languages in a session. Otherwise, this function fails and returns nil.

References getAvailableTranslationLanguages.

Referenced by getAvailableTranslationLanguages.

getHistoryTranslationMessageList

- (NSArray< ZMVideoSDKLiveTranscriptionMessageInfo * > *_Nullable) getHistoryTranslationMessageList

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

Returns

If the function succeeds, it returns a array of all history translation messages in a session. Otherwise it fails, and it returns nil.

References getHistoryTranslationMessageList.

Referenced by getHistoryTranslationMessageList.

getLiveTranscriptionStatus

- (ZMVideoSDKLiveTranscriptionStatus) getLiveTranscriptionStatus

Gets the current live transcription status.

Returns

The current live transcription status.

References getLiveTranscriptionStatus.

Referenced by getLiveTranscriptionStatus.

getSpokenLanguage

- (ZMVideoSDKLiveTranscriptionLanguage *_Nullable) getSpokenLanguage

Gets the current user's spoken language.

Returns

The current's spoken language user. Otherwise, this function fails and returns nil.

References getSpokenLanguage.

Referenced by getSpokenLanguage.

getTranslationLanguage

- (ZMVideoSDKLiveTranscriptionLanguage *_Nullable) getTranslationLanguage

Gets the current user's translation language.

Returns

The current's translation language user. Otherwise, this function fails and returns nil.

References getTranslationLanguage.

Referenced by getTranslationLanguage.

isAllowViewHistoryTranslationMessageEnabled

- (BOOL) isAllowViewHistoryTranslationMessageEnabled

Determines whether the view history translation message is available.

Returns

YES if the view history transcription message is available. Otherwise, NO.

References isAllowViewHistoryTranslationMessageEnabled.

Referenced by isAllowViewHistoryTranslationMessageEnabled.

isReceiveSpokenLanguageContentEnabled

- (BOOL) isReceiveSpokenLanguageContentEnabled

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

Returns

YES if the feature to receive original and translated is available. Otherwise, NO.

References isReceiveSpokenLanguageContentEnabled.

Referenced by isReceiveSpokenLanguageContentEnabled.

setSpokenLanguage:

- (ZMVideoSDKErrors) setSpokenLanguage:

(int)

languageID

Sets the current user's spoken language.

Parameters

languageID

The spoken language ID.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

setTranslationLanguage:

- (ZMVideoSDKErrors) setTranslationLanguage:

(int)

languageID

Sets the current user's translation language.

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 returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

startLiveTranscription

- (ZMVideoSDKErrors) startLiveTranscription

Starts live transcription.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

Note

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

References startLiveTranscription.

Referenced by startLiveTranscription.

stopLiveTranscription

- (ZMVideoSDKErrors) stopLiveTranscription

Stops live transcription.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

Note

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

References stopLiveTranscription.

Referenced by stopLiveTranscription.