Package us.zoom.sdk

Interface ZoomVideoSDKLiveTranscriptionHelper

public interface ZoomVideoSDKLiveTranscriptionHelper
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 See ZoomVideoSDK.getLiveTranscriptionHelper()

  • Method Details

    • canStartLiveTranscription

      boolean canStartLiveTranscription()
      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.
      Returns:
      true indicates the user can start live transcription, otherwise this function returns false.

    • getLiveTranscriptionStatus

      ZoomVideoSDKLiveTranscriptionHelper.ZoomVideoSDKLiveTranscriptionStatus getLiveTranscriptionStatus()
      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.
      Returns:
      the current live transcription status. For more details, see ZoomVideoSDKLiveTranscriptionHelper.ZoomVideoSDKLiveTranscriptionStatus.

    • startLiveTranscription

      int startLiveTranscription()
      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 ZoomVideoSDKDelegate.onLiveTranscriptionMsgInfoReceived(us.zoom.sdk.ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionMessageInfo) callback, or - error sent in ZoomVideoSDKDelegate.onLiveTranscriptionMsgError(us.zoom.sdk.ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage, us.zoom.sdk.ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage) callback.
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise, this function returns an error. To get extended error information, see ZoomVideoSDKErrors.

    • stopLiveTranscription

      int stopLiveTranscription()
      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.
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise, this function returns an error. To get extended error information, see ZoomVideoSDKErrors.

    • getAvailableSpokenLanguages

      List<ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage> getAvailableSpokenLanguages()
      Get a list of all available spoken languages during the session.
      Returns:
      a list of the available spoken languages during a session. If none are available, the return value is null. For more details, see ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage.

    • setSpokenLanguage

      int setSpokenLanguage(int languageID)
      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.
      Parameters:
      languageID - The spoken language ID.
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise, this function returns an error. To get extended error information, see ZoomVideoSDKErrors.

    • getSpokenLanguage

      ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage getSpokenLanguage()
      Get the spoken language of the current user.
      Returns:
      the spoken language of the current user. For more details, see ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage.

    • getAvailableTranslationLanguages

      List<ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage> 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. If live transcription is not enabled, the return value is null. For more details, see ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage.

    • setTranslationLanguage

      int setTranslationLanguage(int languageID)
      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.
      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 Errors_Success. Otherwise, this function returns an error. To get extended error information, see ZoomVideoSDKErrors.

    • getTranslationLanguage

      ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage getTranslationLanguage()
      Get the translation language of the current user.
      Returns:
      the translation language of the current user. For more details, see ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionLanguage.

    • enableReceiveSpokenLanguageContent

      int enableReceiveSpokenLanguageContent(boolean bEnable)
      Enable or disable to receive original and translated content.If you enable this feature, you must start live transcription.
      Parameters:
      bEnable - true means enable, otherwise false.
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise it fails. To get extended error information, see ZoomVideoSDKErrors

    • isReceiveSpokenLanguageContentEnabled

      boolean isReceiveSpokenLanguageContentEnabled()
      Determine whether the feature to receive original and translated is available.
      Returns:
      True indicates that the feature to receive original and translated is available. Otherwise False.

    • isAllowViewHistoryTranslationMessageEnabled

      boolean isAllowViewHistoryTranslationMessageEnabled()
      Determine whether the view history translation message is available.
      Returns:
      True indicates that the view history transcription message is available. Otherwise False.

    • getHistoryTranslationMessageList

      List<ZoomVideoSDKLiveTranscriptionHelper.ILiveTranscriptionMessageInfo> 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. Otherwise it fails, and the return value is NULL.