@zoom/react-native-videosdk
    Preparing search index...

    Type Alias ZoomVideoSdkShareHelperType

    Share control interface.

    type ZoomVideoSdkShareHelperType = {
        disableViewerAnnotation: (disable: boolean) => Promise<Errors>;
        enableShareDeviceAudio: (enable: boolean) => Promise<Errors>;
        isAnnotationFeatureSupport: () => Promise<boolean>;
        isOtherSharing: () => Promise<boolean>;
        isScreenSharingOut: () => Promise<boolean>;
        isShareLocked: () => Promise<boolean>;
        isSharingOut: () => Promise<boolean>;
        isViewerAnnotationDisabled: () => Promise<boolean>;
        lockShare: (lock: boolean) => Promise<Errors>;
        pauseShare: () => Promise<Errors>;
        resumeShare: () => Promise<Errors>;
        shareScreen: () => void;
        startShareCamera: () => Promise<Errors>;
        stopShare: () => Promise<Errors>;
    }

    Implemented by

    Index

    Properties

    disableViewerAnnotation enableShareDeviceAudio isAnnotationFeatureSupport isOtherSharing isScreenSharingOut isShareLocked isSharingOut isViewerAnnotationDisabled lockShare pauseShare resumeShare shareScreen startShareCamera stopShare

    Properties

    disableViewerAnnotation: (disable: boolean) => Promise<Errors>

    Disable viewer annotation.

    enableShareDeviceAudio: (enable: boolean) => Promise<Errors>

    Enble share audio when screen sharing.

    isAnnotationFeatureSupport: () => Promise<boolean>

    Determine whether annotation feature is supported.

    isOtherSharing: () => Promise<boolean>

    Determine whether other user is sharing.

    isScreenSharingOut: () => Promise<boolean>

    Determine whether the current user is sharing the screen.

    isShareLocked: () => Promise<boolean>

    Determine whether sharing the view or screen is locked.

    isSharingOut: () => Promise<boolean>

    Determine whether the current user is sharing.

    isViewerAnnotationDisabled: () => Promise<boolean>

    Determine whether viewer annotation is disabled.

    lockShare: (lock: boolean) => Promise<Errors>

    Lock sharing the view or screen. Only the host can call this method.

    pauseShare: () => Promise<Errors>

    Pause screen share.

    resumeShare: () => Promise<Errors>

    Resume screen share.

    shareScreen: () => void

    Start sharing the screen.

    startShareCamera: () => Promise<Errors>

    iOS only: 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. To share camera view on Android, add CameraView component directly in the screen.

    stopShare: () => Promise<Errors>

    Stop view or screen share.

    Settings

    Member Visibility

    On This Page

    Properties