zoom_meeting_share

Zoom Meeting Share
Description:
  • Zoom Meeting Share
Source:
Parameters:
Name Type Description
onSharingStatus function Callback event of the changed sharing status.
onFailedToStartShare function Callback event of failed to start sharing.
onOptimizingShareForVideoClipStatusChanged function Designated for the optimize video status have changed.
Returns:
Type
ZoomMeetingShare
Description:
  • Zoom Meeting Share
Source:
Parameters:
Name Type Description
onSharingStatus function Callback event of the changed sharing status.
onFailedToStartShare function Callback event of failed to start sharing.
onOptimizingShareForVideoClipStatusChanged function Designated for the optimize video status have changed.
Returns:
Type
ZoomMeetingShare

Methods

(inner) MeetingShare_GetAudioShareMode() → {Number}

Description:
  • Get the audio share mode.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_GetAudioShareMode() → {Number}

Description:
  • Get the audio share mode.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_GetWhiteboardLegalNoticesExplained() → {String}

Description:
  • Get the white board legal notices explained.
Source:
Returns:
Type
String

(inner) MeetingShare_GetWhiteboardLegalNoticesExplained() → {String}

Description:
  • Get the white board legal notices explained.
Source:
Returns:
Type
String

(inner) MeetingShare_GetWhiteboardLegalNoticesPrompt() → {String}

Description:
  • Get the white board legal notices prompt.
Source:
Returns:
Type
String

(inner) MeetingShare_GetWhiteboardLegalNoticesPrompt() → {String}

Description:
  • Get the white board legal notices prompt.
Source:
Returns:
Type
String

(inner) MeetingShare_IsWhiteboardLegalNoticeAvailable() → {Boolean}

Description:
  • Determine whether the legal notice for white board is available.
Source:
Returns:
True indicates the legal notice for white board is available. Otherwise False.
Type
Boolean

(inner) MeetingShare_IsWhiteboardLegalNoticeAvailable() → {Boolean}

Description:
  • Determine whether the legal notice for white board is available.
Source:
Returns:
True indicates the legal notice for white board is available. Otherwise False.
Type
Boolean

(inner) MeetingShare_SetAudioShareMode(mode) → {Number}

Description:
  • Set the audio share mode before or during sharing.
Source:
Parameters:
Name Type Description
mode Number The mode for audio share, see AudioShareMode enum.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_SetAudioShareMode(mode) → {Number}

Description:
  • Set the audio share mode before or during sharing.
Source:
Parameters:
Name Type Description
mode Number The mode for audio share, see AudioShareMode enum.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_SetOnFailedToStartShareCB(onFailedToStartShare) → {Boolean}

Description:
  • Set callback event of failed to start sharing.
Source:
Parameters:
Name Type Description
onFailedToStartShare function
Returns:
Type
Boolean

(inner) MeetingShare_SetOnFailedToStartShareCB(onFailedToStartShare) → {Boolean}

Description:
  • Set callback event of failed to start sharing.
Source:
Parameters:
Name Type Description
onFailedToStartShare function
Returns:
Type
Boolean

(inner) MeetingShare_SetOnOptimizingShareForVideoClipStatusChangedCB(onOptimizingShareForVideoClipStatusChanged) → {Boolean}

Description:
  • Set callback designated for the optimize video status have changed.
Source:
Parameters:
Name Type Description
onOptimizingShareForVideoClipStatusChanged function
Returns:
Type
Boolean

(inner) MeetingShare_SetOnOptimizingShareForVideoClipStatusChangedCB(onOptimizingShareForVideoClipStatusChanged) → {Boolean}

Description:
  • Set callback designated for the optimize video status have changed.
Source:
Parameters:
Name Type Description
onOptimizingShareForVideoClipStatusChanged function
Returns:
Type
Boolean

(inner) MeetingShare_SetOnSharingStatusCB(onSharingStatus) → {Boolean}

Description:
  • Set callback function of notification of the changed sharing status.
Source:
Parameters:
Name Type Description
onSharingStatus function
Returns:
Type
Boolean

(inner) MeetingShare_SetOnSharingStatusCB(onSharingStatus) → {Boolean}

Description:
  • Set callback function of notification of the changed sharing status.
Source:
Parameters:
Name Type Description
onSharingStatus function
Returns:
Type
Boolean

(inner) MeetingShare_StartAppShare(zn_hShare_app) → {Number}

Description:
  • Share the specified application.
Source:
Parameters:
Name Type Description
zn_hShare_app String (require hexadecimal) Specify the window handle of the application to be shared. If the hwndSharedApp can't be shared, the return value is the SDKERR_INVALID_PARAMETER error code. If the hwndSharedApp is NULL, the primary monitor will be shared.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_StartAppShare(zn_hShare_app) → {Number}

Description:
  • Share the specified application.
Source:
Parameters:
Name Type Description
zn_hShare_app String (require hexadecimal) Specify the window handle of the application to be shared. If the hwndSharedApp can't be shared, the return value is the SDKERR_INVALID_PARAMETER error code. If the hwndSharedApp is NULL, the primary monitor will be shared.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_StartMonitorShare(zn_monitorID) → {Number}

Description:
  • Share the specified monitor.
Source:
Parameters:
Name Type Description
zn_monitorID String Specify the monitor ID to be shared. You may get the value via EnumDisplayMonitors System API. If the monitorID is NULL, the primary monitor will be shared
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_StartMonitorShare(zn_monitorID) → {Number}

Description:
  • Share the specified monitor.
Source:
Parameters:
Name Type Description
zn_monitorID String Specify the monitor ID to be shared. You may get the value via EnumDisplayMonitors System API. If the monitorID is NULL, the primary monitor will be shared
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_StopShare() → {Number}

Description:
  • Stop the current sharing.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_StopShare() → {Number}

Description:
  • Stop the current sharing.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

Events

onFailedToStartShare

Description:
  • Callback event of failed to start sharing.
Source:

onFailedToStartShare

Description:
  • Callback event of failed to start sharing.
Source:

onOptimizingShareForVideoClipStatusChanged

Description:
  • Designated for the optimize video status have changed.
Source:
Parameters:
Name Type Description
shareInfo Object The share source info that has changed.

onOptimizingShareForVideoClipStatusChanged

Description:
  • Designated for the optimize video status have changed.
Source:
Parameters:
Name Type Description
shareInfo Object The share source info that has changed.

onSharingStatus

Description:
  • Callback event of the changed sharing status. The userId changes according to the status value. When the status value is the Sharing_Self_Send_Begin or Sharing_Self_Send_End, the userId is the user own ID. Otherwise, the value of userId is the sharer ID.
Source:
Parameters:
Name Type Description
shareInfo Object Sharing information. contains userid, shareSourceID, status (defined in: ShareStatus), isShowingInFirstView, isShowingInSecondView, isCanBeRemoteControl, contentType, windowID, monitorID

onSharingStatus

Description:
  • Callback event of the changed sharing status. The userId changes according to the status value. When the status value is the Sharing_Self_Send_Begin or Sharing_Self_Send_End, the userId is the user own ID. Otherwise, the value of userId is the sharer ID.
Source:
Parameters:
Name Type Description
shareInfo Object Sharing information. contains userid, shareSourceID, status (defined in: ShareStatus), isShowingInFirstView, isShowingInSecondView, isCanBeRemoteControl, contentType, windowID, monitorID
Zoom Meeting Share
Description:
  • Zoom Meeting Share
Source:
Parameters:
Name Type Description
onSharingStatus function Callback event of the changed sharing status.
onFailedToStartShare function Callback event of failed to start sharing.
onOptimizingShareForVideoClipStatusChanged function Designated for the optimize video status have changed.
Returns:
Type
ZoomMeetingShare
Description:
  • Zoom Meeting Share
Source:
Parameters:
Name Type Description
onSharingStatus function Callback event of the changed sharing status.
onFailedToStartShare function Callback event of failed to start sharing.
onOptimizingShareForVideoClipStatusChanged function Designated for the optimize video status have changed.
Returns:
Type
ZoomMeetingShare

Methods

(inner) MeetingShare_GetAudioShareMode() → {Number}

Description:
  • Get the audio share mode.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_GetAudioShareMode() → {Number}

Description:
  • Get the audio share mode.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_GetWhiteboardLegalNoticesExplained() → {String}

Description:
  • Get the white board legal notices explained.
Source:
Returns:
Type
String

(inner) MeetingShare_GetWhiteboardLegalNoticesExplained() → {String}

Description:
  • Get the white board legal notices explained.
Source:
Returns:
Type
String

(inner) MeetingShare_GetWhiteboardLegalNoticesPrompt() → {String}

Description:
  • Get the white board legal notices prompt.
Source:
Returns:
Type
String

(inner) MeetingShare_GetWhiteboardLegalNoticesPrompt() → {String}

Description:
  • Get the white board legal notices prompt.
Source:
Returns:
Type
String

(inner) MeetingShare_IsWhiteboardLegalNoticeAvailable() → {Boolean}

Description:
  • Determine whether the legal notice for white board is available.
Source:
Returns:
True indicates the legal notice for white board is available. Otherwise False.
Type
Boolean

(inner) MeetingShare_IsWhiteboardLegalNoticeAvailable() → {Boolean}

Description:
  • Determine whether the legal notice for white board is available.
Source:
Returns:
True indicates the legal notice for white board is available. Otherwise False.
Type
Boolean

(inner) MeetingShare_SetAudioShareMode(mode) → {Number}

Description:
  • Set the audio share mode before or during sharing.
Source:
Parameters:
Name Type Description
mode Number The mode for audio share, see AudioShareMode enum.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_SetAudioShareMode(mode) → {Number}

Description:
  • Set the audio share mode before or during sharing.
Source:
Parameters:
Name Type Description
mode Number The mode for audio share, see AudioShareMode enum.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_SetOnFailedToStartShareCB(onFailedToStartShare) → {Boolean}

Description:
  • Set callback event of failed to start sharing.
Source:
Parameters:
Name Type Description
onFailedToStartShare function
Returns:
Type
Boolean

(inner) MeetingShare_SetOnFailedToStartShareCB(onFailedToStartShare) → {Boolean}

Description:
  • Set callback event of failed to start sharing.
Source:
Parameters:
Name Type Description
onFailedToStartShare function
Returns:
Type
Boolean

(inner) MeetingShare_SetOnOptimizingShareForVideoClipStatusChangedCB(onOptimizingShareForVideoClipStatusChanged) → {Boolean}

Description:
  • Set callback designated for the optimize video status have changed.
Source:
Parameters:
Name Type Description
onOptimizingShareForVideoClipStatusChanged function
Returns:
Type
Boolean

(inner) MeetingShare_SetOnOptimizingShareForVideoClipStatusChangedCB(onOptimizingShareForVideoClipStatusChanged) → {Boolean}

Description:
  • Set callback designated for the optimize video status have changed.
Source:
Parameters:
Name Type Description
onOptimizingShareForVideoClipStatusChanged function
Returns:
Type
Boolean

(inner) MeetingShare_SetOnSharingStatusCB(onSharingStatus) → {Boolean}

Description:
  • Set callback function of notification of the changed sharing status.
Source:
Parameters:
Name Type Description
onSharingStatus function
Returns:
Type
Boolean

(inner) MeetingShare_SetOnSharingStatusCB(onSharingStatus) → {Boolean}

Description:
  • Set callback function of notification of the changed sharing status.
Source:
Parameters:
Name Type Description
onSharingStatus function
Returns:
Type
Boolean

(inner) MeetingShare_StartAppShare(zn_hShare_app) → {Number}

Description:
  • Share the specified application.
Source:
Parameters:
Name Type Description
zn_hShare_app String (require hexadecimal) Specify the window handle of the application to be shared. If the hwndSharedApp can't be shared, the return value is the SDKERR_INVALID_PARAMETER error code. If the hwndSharedApp is NULL, the primary monitor will be shared.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_StartAppShare(zn_hShare_app) → {Number}

Description:
  • Share the specified application.
Source:
Parameters:
Name Type Description
zn_hShare_app String (require hexadecimal) Specify the window handle of the application to be shared. If the hwndSharedApp can't be shared, the return value is the SDKERR_INVALID_PARAMETER error code. If the hwndSharedApp is NULL, the primary monitor will be shared.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_StartMonitorShare(zn_monitorID) → {Number}

Description:
  • Share the specified monitor.
Source:
Parameters:
Name Type Description
zn_monitorID String Specify the monitor ID to be shared. You may get the value via EnumDisplayMonitors System API. If the monitorID is NULL, the primary monitor will be shared
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_StartMonitorShare(zn_monitorID) → {Number}

Description:
  • Share the specified monitor.
Source:
Parameters:
Name Type Description
zn_monitorID String Specify the monitor ID to be shared. You may get the value via EnumDisplayMonitors System API. If the monitorID is NULL, the primary monitor will be shared
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_StopShare() → {Number}

Description:
  • Stop the current sharing.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingShare_StopShare() → {Number}

Description:
  • Stop the current sharing.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

Events

onFailedToStartShare

Description:
  • Callback event of failed to start sharing.
Source:

onFailedToStartShare

Description:
  • Callback event of failed to start sharing.
Source:

onOptimizingShareForVideoClipStatusChanged

Description:
  • Designated for the optimize video status have changed.
Source:
Parameters:
Name Type Description
shareInfo Object The share source info that has changed.

onOptimizingShareForVideoClipStatusChanged

Description:
  • Designated for the optimize video status have changed.
Source:
Parameters:
Name Type Description
shareInfo Object The share source info that has changed.

onSharingStatus

Description:
  • Callback event of the changed sharing status. The userId changes according to the status value. When the status value is the Sharing_Self_Send_Begin or Sharing_Self_Send_End, the userId is the user own ID. Otherwise, the value of userId is the sharer ID.
Source:
Parameters:
Name Type Description
shareInfo Object Sharing information. contains userid, shareSourceID, status (defined in: ShareStatus), isShowingInFirstView, isShowingInSecondView, isCanBeRemoteControl, contentType, windowID, monitorID

onSharingStatus

Description:
  • Callback event of the changed sharing status. The userId changes according to the status value. When the status value is the Sharing_Self_Send_Begin or Sharing_Self_Send_End, the userId is the user own ID. Otherwise, the value of userId is the sharer ID.
Source:
Parameters:
Name Type Description
shareInfo Object Sharing information. contains userid, shareSourceID, status (defined in: ShareStatus), isShowingInFirstView, isShowingInSecondView, isCanBeRemoteControl, contentType, windowID, monitorID