ZoomVideoSdkLiveTranscriptionHelper class

Live transcription interface.
Zoom Video SDK supports live transcription (an additional add-on service) which automatically transcribes the audio and speech from the session and provides subtitles for the participants. Contact Video SDK Sales for details: https://explore.zoom.us/docs/en-us/video-sdk.html#sf_form

Inheritance
  • Object
  • PlatformInterface
  • ZoomVideoSdkLiveTranscriptionHelper

Properties

hashCode → int
The hash code for this object.
no setterinherited
methodChannel → MethodChannel
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

canStartLiveTranscription() → Future<bool>
Determine whether the user can start live transcription. The live transcription service is an add-on, so make sure you have it enabled or this method will always return false.
Return true indicates the user can start live transcription, otherwise this function returns false.
enableReceiveSpokenLanguageContent(bool enable) → Future<String>
Enable or disable to receive original and translated content.If you enable this feature, you must start live transcription.
enable true means enable, otherwise false.
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
getAvailableSpokenLanguages() → Future<List<ZoomVideoSdkLiveTranscriptionLanguage>?>
Get a list of all available spoken languages during the session.
Return a list of the available spoken languages during a session. If none are available, the return value is null.
getAvailableTranslationLanguages() → Future<List<ZoomVideoSdkLiveTranscriptionLanguage>?>
Get the list of all available translation languages in a session.
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
getHistoryTranslationMessageList() → Future<List<ZoomVideoSdkLiveTranscriptionMessageInfo>?>
Get the list of all history translation messages in a session.
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 NULL.
getLiveTranscriptionStatus() → Future<String>
Get the current live transcription status to see if it has started or stopped. The default status is stop, and it will be changed to start when the startLiveTranscription method is called successfully.
Return the current live transcription status.
getSpokenLanguage() → Future<ZoomVideoSdkLiveTranscriptionLanguage>
Get the spoken language of the current user.
Return the spoken language of the current user.
getTranslationLanguage() → Future<ZoomVideoSdkLiveTranscriptionLanguage>
Get the translation language of the current user.
Return the translation language of the current user.
isAllowViewHistoryTranslationMessageEnabled() → Future<bool>
Determine whether the view history translation message is available.
Return True indicates that the view history transcription message is available. Otherwise False.
isReceiveSpokenLanguageContentEnabled() → Future<bool>
Determine whether the feature to receive original and translated is available.
Return True indicates that the feature to receive original and translated is available. Otherwise False.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setSpokenLanguage(num languageID) → Future<String>
Set the spoken language of the current user. This allows captions to be captured accurately from the current user's selected spoken language. You can retrieve a list of available spoken languages by calling getAvailableSpokenLanguages() above and set with its languageID. The default spoken language is English.
languageID The spoken language ID.
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
setTranslationLanguage(num languageID) → Future<String>
Set the translation language of the current user. This allows captions to be generated and translated into the current user's selected translation language. You can retrieve a list of available translation languages by calling getAvailableTranslationLanguages() above and set with its languageID. The default translation language is English.
languageID The translation language ID. If the language id is set to -1, live translation will be disabled.
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
startLiveTranscription() → Future<String>
Start live transcription. Users can start live transcription if the session allows multi-language transcription. When live transcription has successfully started, you will begin to receive the following:
- translated message sent in onLiveTranscriptionMsgReceived callback
- error sent in onLiveTranscriptionMsgError callback.
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
stopLiveTranscription() → Future<String>
Stop live transcription. Users can stop live transcription (if it has already begun) if the session allows multi-language transcription. When live transcription has successfully stopped, the transcription service and its callback will no longer be available.
Return ZoomVideoSDKError_Success if the function succeeds. Otherwise, this function returns an error.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited