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

#include <ZoomVideoSDKLiveTranscriptionHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- canStartLiveTranscription
	Determines whether the user can start live transcription.
(ZoomVideoSDKLiveTranscriptionStatus)	- getLiveTranscriptionStatus
	Gets the current live transcription status.
(ZoomVideoSDKError)	- startLiveTranscription
	Starts live transcription. If the session allows multi-language transcription, all users can start live transcription.
(ZoomVideoSDKError)	- stopLiveTranscription
	Stops live transcription. If the session allows multi-language transcription, all users can stop live transcription.
(NSArray< ZoomVideoSDKLiveTranscriptionLanguage * > *_Nullable)	- getAvailableSpokenLanguages
	Gets the list of all available spoken languages in session.
(ZoomVideoSDKError)	- setSpokenLanguage:
	Sets the spoken language of the current user.
(ZoomVideoSDKLiveTranscriptionLanguage *_Nullable)	- getSpokenLanguage
	Gets the spoken language of the current user.
(ZoomVideoSDKError)	- enableReceiveSpokenLanguageContent:
	Enables or disables receiving original and translated content. If you enable this feature, you must start live transcription.
(BOOL)	- isAllowViewFullTranscriptEnable
	Determines whether the view history translation message is available.
(NSArray< ZoomVideoSDKLiveTranscriptionMessageInfo * > *_Nullable)	- getHistoryTranslationMessageList
	Gets the list of all history translation messages in a session.
(BOOL)	- isReceiveSpokenLanguageContentEnabled
	Determines whether the feature to receive original and translated is available.
(NSArray< ZoomVideoSDKLiveTranscriptionLanguage * > *_Nullable)	- getAvailableTranslationLanguages
	Gets the list of all available translation languages in a session.
(ZoomVideoSDKError)	- setTranslationLanguage:
	Sets the translation language of the current user.
(ZoomVideoSDKLiveTranscriptionLanguage *_Nullable)	- getTranslationLanguage
	Gets 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

Determines whether the user can start live transcription.

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

References canStartLiveTranscription.

Referenced by canStartLiveTranscription.

◆ enableReceiveSpokenLanguageContent:

- (ZoomVideoSDKError) enableReceiveSpokenLanguageContent: (BOOL) enable

Enables or disables receiving original and translated content. If you enable this feature, you must start live transcription.

Parameters

enable YES to enable, NO to disable.

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

◆ getAvailableSpokenLanguages

- (NSArray< ZoomVideoSDKLiveTranscriptionLanguage * > *_Nullable) getAvailableSpokenLanguages

Gets the list of all available spoken languages in session.

Returns: If the function succeeds, it returns an NSArray of ZoomVideoSDKLiveTranscriptionLanguage objects. Otherwise, this function fails and returns nil.

References getAvailableSpokenLanguages.

Referenced by getAvailableSpokenLanguages.

◆ getAvailableTranslationLanguages

- (NSArray< ZoomVideoSDKLiveTranscriptionLanguage * > *_Nullable) getAvailableTranslationLanguages

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

Returns: If the function succeeds, it returns an NSArray of ZoomVideoSDKLiveTranscriptionLanguage objects. Otherwise, this function fails and returns nil.

References getAvailableTranslationLanguages.

Referenced by getAvailableTranslationLanguages.

◆ getHistoryTranslationMessageList

- (NSArray< ZoomVideoSDKLiveTranscriptionMessageInfo * > *_Nullable) getHistoryTranslationMessageList

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

Returns: If the function succeeds, it returns an NSArray of ZoomVideoSDKLiveTranscriptionMessageInfo objects. Otherwise, this function fails and returns nil.

References getHistoryTranslationMessageList.

Referenced by getHistoryTranslationMessageList.

◆ getLiveTranscriptionStatus

- (ZoomVideoSDKLiveTranscriptionStatus) getLiveTranscriptionStatus

Gets the current live transcription status.

Returns: The current live transcription status.

References getLiveTranscriptionStatus.

Referenced by getLiveTranscriptionStatus.

◆ getSpokenLanguage

- (ZoomVideoSDKLiveTranscriptionLanguage *_Nullable) getSpokenLanguage

Gets the spoken language of the current user.

Returns: If the function succeeds, it returns the current spoken language. Otherwise, this function fails and returns nil.

References getSpokenLanguage.

Referenced by getSpokenLanguage.

◆ getTranslationLanguage

- (ZoomVideoSDKLiveTranscriptionLanguage *_Nullable) getTranslationLanguage

Gets the translation language of the current user.

Returns: If the function succeeds, it returns the current translation language. Otherwise, this function fails and returns nil.

References getTranslationLanguage.

Referenced by getTranslationLanguage.

◆ isAllowViewFullTranscriptEnable

- (BOOL) isAllowViewFullTranscriptEnable

Determines whether the view history translation message is available.

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

References isAllowViewFullTranscriptEnable.

Referenced by isAllowViewFullTranscriptEnable.

◆ 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:

- (ZoomVideoSDKError) setSpokenLanguage: (NSInteger) languageID

Sets the spoken language of the current user.

Parameters

languageID The spoken language ID.

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

◆ setTranslationLanguage:

- (ZoomVideoSDKError) setTranslationLanguage: (NSInteger) languageID

Sets 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 returns Errors_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

- (ZoomVideoSDKError) startLiveTranscription

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

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

References startLiveTranscription.

Referenced by startLiveTranscription.

◆ stopLiveTranscription

- (ZoomVideoSDKError) stopLiveTranscription

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

Returns: If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.

References stopLiveTranscription.

Referenced by stopLiveTranscription.

Instance Methods

Detailed Description

Method Documentation

◆ canStartLiveTranscription

◆ enableReceiveSpokenLanguageContent:

◆ getAvailableSpokenLanguages

◆ getAvailableTranslationLanguages

◆ getHistoryTranslationMessageList

◆ getLiveTranscriptionStatus

◆ getSpokenLanguage

◆ getTranslationLanguage

◆ isAllowViewFullTranscriptEnable

◆ isReceiveSpokenLanguageContentEnabled

◆ setSpokenLanguage:

◆ setTranslationLanguage:

◆ startLiveTranscription

◆ stopLiveTranscription