Package us.zoom.sdk

Interface InMeetingLiveTranscriptionController

public interface InMeetingLiveTranscriptionController
Live Transcription Controller In Meeting.

  • Method Details

    • addListener

      void addListener(InMeetingLiveTranscriptionController.InMeetingLiveTranscriptionListener listener)
      Register a listener to listen for the callback of live transcription event.
      Parameters:
      listener - The listener instance.

    • removeListener

      void removeListener(InMeetingLiveTranscriptionController.InMeetingLiveTranscriptionListener listener)
      Unregister the listener.
      Parameters:
      listener - The listener instance.

    • canDisableCaptions

      boolean canDisableCaptions()
      Query if the user can disable captions.
      Returns:
      TRUE means that the host can disable captions.

    • enableCaptions

      MobileRTCSDKError enableCaptions(boolean enable)
      Enable or disable captions.
      Parameters:
      enable - TRUE means that captions are enabled; FALSE means that captions are disabled.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function returns a calling error. For more details, see MobileRTCSDKError.

    • isCaptionsEnabled

      boolean isCaptionsEnabled()
      Query if the captions enabled.
      Returns:
      TRUE means that captions are enabled.

    • isMeetingSupportCC

      boolean isMeetingSupportCC()
      Query if the current meeting is supported closed caption.
      Returns:
      TRUE means that the current meeting is supported close caption.

    • canBeAssignedToSendCC

      boolean canBeAssignedToSendCC(long userid)
      Query if the user is can be assigned to send closed caption.
      Parameters:
      userid - the user id.
      Returns:
      TRUE means that the user can be assigned to send closed caption.

    • assignCCPrivilege

      MobileRTCSDKError assignCCPrivilege(long userid)
      Assign the user privilege to send closed caption.
      Parameters:
      userid - the user id.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.

    • withdrawCCPrivilege

      MobileRTCSDKError withdrawCCPrivilege(long userid)
      WithDraw the user privilege to send closed caption.
      Parameters:
      userid - the user id.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.

    • canAssignOthersToSendCC

      boolean canAssignOthersToSendCC()
      Query if the current user can assign the privilege of send closed caption to others.
      Returns:
      TRUE means that the user can assign others privilege to send closed caption.

    • isLiveTranscriptionFeatureEnabled

      boolean isLiveTranscriptionFeatureEnabled()
      Query if it is enabled to support live transcription feature.
      Returns:
      TRUE means that the live transcription feature is enabled.

    • getLiveTranscriptionStatus

      InMeetingLiveTranscriptionController.MobileRTCLiveTranscriptionStatus getLiveTranscriptionStatus()
      Return the current live transcription status.
      Returns:
      the live transcription status. For more details, see InMeetingLiveTranscriptionController.MobileRTCLiveTranscriptionStatus.

    • canStartLiveTranscription

      boolean canStartLiveTranscription()
      Query if meeting participants can start live transcription.
      Returns:
      TRUE means that the participant can start live transcription.

    • startLiveTranscription

      MobileRTCSDKError startLiveTranscription()
      Start live transcription. If the meeting allows multi-language transcription,all users can start live transcription. Otherwise only the host can start it.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.

    • stopLiveTranscription

      MobileRTCSDKError stopLiveTranscription()
      Stop live transcription If the meeting allows multi-language transcription,all users can stop live transcription. Otherwise only the host can stop it.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.

    • enableRequestLiveTranscription

      MobileRTCSDKError enableRequestLiveTranscription(boolean enable)
      Enable or disable the ability for attendees to request live transcriptions. If the meeting allows multi-language transcription,the return value is SDKERR_WRONG_USAGE.
      Parameters:
      enable - TRUE means that enable the request live transcription; FALSE means that disable the request live transcription.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.

    • isRequestToStartLiveTranscriptionEnabled

      boolean isRequestToStartLiveTranscriptionEnabled()
      Determine whether the request to start live transcription is enabled., If the return value is true, it is enabled, if false, disabled. If the meeting allows multi-language transcription,the return value is false.
      Returns:
      TRUE means that it is enabled to request to start live transcription.

    • requestToStartLiveTranscription

      MobileRTCSDKError requestToStartLiveTranscription(boolean requestAnonymous)
      Request the host to start live transcription If the meeting allows multi-language transcription,the return value is SDKERR_WRONG_USAGE.
      Parameters:
      requestAnonymous - True indicates the user anonymous request.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.

    • getClosedCaptionUrlFor3rdParty

      String getClosedCaptionUrlFor3rdParty()
      Get the third party closed caption url. Only host can get the url.
      Returns:
      the third party closed caption url. null means failed.

    • enableMeetingManualCaption

      MobileRTCSDKError enableMeetingManualCaption(boolean bEnable)
      Enable or disable manual captions for the meeting.
      Parameters:
      bEnable - true means enable manual input CC for meeting, otherwise false.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.

    • isMeetingManualCaptionEnabled

      boolean isMeetingManualCaptionEnabled()
      Determine whether manually added closed captions is enabled for the meeting.
      Returns:
      true means enable manual input CC for meeting, otherwise false.

    • getAvailableMeetingSpokenLanguages

      List<InMeetingLiveTranscriptionController.InMeetingLiveTranscriptionLanguage> getAvailableMeetingSpokenLanguages()
      Get the list of all available spoken languages in a meeting.
      Returns:
      If the function succeeds, the return value is the list of the available spoken languages in a meeting. Otherwise failed, the return value is NULL.

    • setMeetingSpokenLanguage

      @Deprecated MobileRTCSDKError setMeetingSpokenLanguage(int languageID)
      Deprecated.
      use setMeetingSpokenLanguage(int languageID, boolean isForAll) instead. Set the spoken language of the current user.
      Parameters:
      languageID - The spoken language id.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.

    • setMeetingSpokenLanguage

      MobileRTCSDKError setMeetingSpokenLanguage(int languageID, boolean isForAll)
      Set the current user's spoken language.
      Parameters:
      languageID - The spoken language ID.
      isForAll - True means set spoken language for all users. False means set the language only for myself.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise fails, returns calling error. For more details, see MobileRTCSDKError.

    • getMeetingSpokenLanguage

      InMeetingLiveTranscriptionController.InMeetingLiveTranscriptionLanguage getMeetingSpokenLanguage()
      Get the spoken language of the current user.
      Returns:
      the speaking language of the current user

    • getAvailableTranslationLanguages

      List<InMeetingLiveTranscriptionController.InMeetingLiveTranscriptionLanguage> getAvailableTranslationLanguages()
      Get the list of all available translation languages in a meeting.
      Returns:
      If the function succeeds, the return value is the list of all available translation languages in a meeting. Otherwise failed, the return value is NULL.

    • setTranslationLanguage

      MobileRTCSDKError 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. You can receive closed captions if the host sets manual captions to true for the meeting.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed, returns calling error. For more details, see MobileRTCSDKError.

    • getTranslationLanguage

      InMeetingLiveTranscriptionController.InMeetingLiveTranscriptionLanguage getTranslationLanguage()
      Get the translation language of the current user.
      Returns:
      the translation language of the current user.

    • isMultiLanguageTranscriptionEnabled

      boolean isMultiLanguageTranscriptionEnabled()
      Determine whether the multi-language transcription feature is enabled.
      Returns:
      true means the multi-language transcription feature enabled.

    • isTextLiveTranslationEnabled

      boolean isTextLiveTranslationEnabled()
      Determine whether the translated captions feature is enabled.
      Returns:
      true means the translated captions feature enabled.

    • enableReceiveSpokenLanguageContent

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

    • isReceiveSpokenLanguageContentEnabled

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

    • isSupportRequestCaptions

      boolean isSupportRequestCaptions()
      Determine whether users can request to start captions.
      Returns:
      True indicates users can request to start captions. Otherwise False.

    • isSupportTranslationWhenRequestToStartCaptions

      boolean isSupportTranslationWhenRequestToStartCaptions()
      Determine whether support translation when users request to start captions.
      Returns:
      True indicates translation is available when users request to start captions. Otherwise False.

    • requestToStartCaptions

      MobileRTCSDKError requestToStartCaptions(boolean enableTranslation)
      Request the host to start captions. If the host approves your request, you receive the callback InMeetingLiveTranscriptionController.InMeetingLiveTranscriptionListener.onStartCaptionsRequestApproved(),and you should start captions or translation there.
      Parameters:
      enableTranslation - True indicates to enable translation at the same time.
      Returns:
      If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise fails. For more details, see MobileRTCSDKError.