Package us.zoom.sdk

Interface ZoomVideoSDKShareHelper

public interface ZoomVideoSDKShareHelper
Share control interface.

  • Method Details

    • startShareView

      int startShareView(android.view.View view)
      Share a selected view.
      Parameters:
      view - the view to be shared.
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors.

    • startShareScreen

      int startShareScreen(android.content.Intent data)
      Share a selected screen through Intent.
      Parameters:
      data - the intent data for retriving the MediaProjection obtained from a succesful screen capture request. see: https://developer.android.com/reference/android/media/projection/MediaProjectionManager.html
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors.

    • startShareCamera

      int startShareCamera(ZoomVideoSDKCameraShareView view)
      Share the select camera. Query the select camera using ZoomVideoSDKVideoHelper.getCameraList(). The presenter can use pauseShare() to enable viewer annotation. If the camera is paused, the presenter can use resumeShare() to resume. Notice: The user should start video before starting to share a camera, otherwise the SDK returns error ZoomVideoSDKErrors.Errors_Session_Share_Camera_Video_Not_Start.
      Parameters:
      view - the share view to show the camera for the presenter.
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors.

    • stopShare

      int stopShare()
      Stop view or screen share.
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors.

    • isSharingOut

      boolean isSharingOut()
      Determine whether the current user is sharing.
      Returns:
      true indicates the current user is sharing, otherwise false.

    • isScreenSharingOut

      boolean isScreenSharingOut()
      Determine whether the current user is sharing the screen.
      Returns:
      true indicates the current user is sharing the screen, otherwise false.

    • isOtherSharing

      boolean isOtherSharing()
      Determine whether other user is sharing.
      Returns:
      true indicates another user is sharing, otherwise false.

    • lockShare

      int lockShare(boolean lock)
      Lock sharing the view or screen. Only the host can call this method.
      Parameters:
      lock - true to lock sharing.
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors.

    • isShareLocked

      boolean isShareLocked()
      Determine whether sharing the view or screen is locked.
      Returns:
      true indicates that sharing is locked, otherwise false.

    • startSharingExternalSource

      int startSharingExternalSource(ZoomVideoSDKShareSource source, ZoomVideoSDKShareAudioSource pAudioSource, boolean bPlaying)
      Share a external source
      Parameters:
      source - external share source, see ZoomVideoSDKShareSource
      pAudioSource - external audio source,ses ZoomVideoSDKShareAudioSource
      bPlaying - true means audio raw data is played locally at the same time, false not.
      Returns:
      If the function succeeds, the return value is ZoomVideoSDKErrors.Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors

    • isAnnotationFeatureSupport

      boolean isAnnotationFeatureSupport()
      Whether annotation feature is supported or not.
      Returns:
      true means enable, otherwise false.

    • disableViewerAnnotation

      int disableViewerAnnotation(boolean disable)
      Disable or enable viewer’s annotation by the share owner. Only the share owner can call this function.
      Parameters:
      disable - true means disable, false means enable.
      Returns:
      If the function succeeds, the return value is ZoomVideoSDKErrors.Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors.

    • isViewerAnnotationDisabled

      boolean isViewerAnnotationDisabled()
      Whether annotation on current sharing is disabled or not.
      Returns:
      true means disable, false means enable.

    • createAnnotationHelper

      ZoomVideoSDKAnnotationHelper createAnnotationHelper(ZoomVideoSDKVideoView view)
      create annotation helper base on shared view. The view passed in this function should be subscribed share view. And if the share view aspect mode is full fill, the annotate not supported.

      When the share owner not support the feature of annotate, the others should not do annotate in that case.

      Parameters:
      view - shared view. Pass the nil will return the helper for self sharing.
      Returns:
      an annotation controller.

    • destroyAnnotationHelper

      int destroyAnnotationHelper(ZoomVideoSDKAnnotationHelper helper)
      destroy annotation helper.
      Parameters:
      helper - the annotation helper.
      Returns:
      If the function succeeds, the return value is ZoomVideoSDKErrors.Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors.

    • enableShareDeviceAudio

      int enableShareDeviceAudio(boolean enable)
      Enable or disable the device sound when sharing. The SDK does not support sharing device audio, for example, when you've enabled virtual speaker. This feature need Build.VERSION.SDK_INT (greater than or equal to 29) and has RECORD_AUDIO Permission.
      Parameters:
      enable - true to enable. false to disable.
      Returns:
      If the function succeeds, the return value is ZoomVideoSDKErrors.Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors

    • isShareDeviceAudioEnabled

      boolean isShareDeviceAudioEnabled()
      Determine if the SDK has enabled share device sound.
      Returns:
      true if enabled, otherwise false.

    • enablePlaySharingAudioRawdata

      int enablePlaySharingAudioRawdata(boolean bPlaying)
      Enable or disable local playback of shared audio raw data.
      Parameters:
      bPlaying - true to play shared audio raw data, false not to play it.
      Returns:
      true means play shared audio raw data, false not.

    • pauseShare

      int pauseShare()
      Pause share. For camera share, the presenter can pause the share to support annotation.
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors.

    • resumeShare

      int resumeShare()
      Resume share. For camera share, the presenter can restart the camera share.
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors.

    • enableMultiShare

      int enableMultiShare(boolean enable)
      Enable or disable participants can share simultaneously. warning: When you switch multi share from enable to disable, all sharing will be stopped when session has two or more user is sharing.
      Parameters:
      enable - True to enable. False to disable.
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors.

    • isMultiShareEnabled

      boolean isMultiShareEnabled()
      Determine whether multi share is enabled or not.
      Returns:
      true enabled, false not enabled.

    • startShareWithPreprocessing

      int startShareWithPreprocessing(ZoomVideoSDKSharePreprocessParam param, IZoomVideoSDKSharePreprocessor preprocessor)
      Start share preprocessing.
      Parameters:
      param - The share preprocessing parameters, see ZoomVideoSDKSharePreprocessParam.
      preprocessor - Object that handles preprocessing events.
      Returns:
      If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors.