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() → {Object}
- Description:
- Get the audio share mode.
- Source:
Returns:
If the function succeeds, the return value is an object with the following properties:
- err: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- audioShareMode: The mode for audio share
- Type
- Object
(inner) MeetingShare_GetAudioShareMode() → {Object}
- Description:
- Get the audio share mode.
- Source:
Returns:
If the function succeeds, the return value is an object with the following properties:
- err: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- audioShareMode: The mode for audio share
- Type
- Object
(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 AudioShareMode. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- 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 AudioShareMode. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) MeetingShare_SetOnFailedToStartShareCB(onFailedToStartShare) → {Boolean}
- Description:
- Set onFailedToStartShare callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFailedToStartShare |
function |
Returns:
true or false
- Type
- Boolean
(inner) MeetingShare_SetOnFailedToStartShareCB(onFailedToStartShare) → {Boolean}
- Description:
- Set onFailedToStartShare callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFailedToStartShare |
function |
Returns:
true or false
- Type
- Boolean
(inner) MeetingShare_SetOnOptimizingShareForVideoClipStatusChangedCB(onOptimizingShareForVideoClipStatusChanged) → {Boolean}
- Description:
- Set onOptimizingShareForVideoClipStatusChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onOptimizingShareForVideoClipStatusChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) MeetingShare_SetOnOptimizingShareForVideoClipStatusChangedCB(onOptimizingShareForVideoClipStatusChanged) → {Boolean}
- Description:
- Set onOptimizingShareForVideoClipStatusChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onOptimizingShareForVideoClipStatusChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) MeetingShare_SetOnSharingStatusCB(onSharingStatus) → {Boolean}
- Description:
- Set onSharingStatus callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSharingStatus |
function |
Returns:
true or false
- Type
- Boolean
(inner) MeetingShare_SetOnSharingStatusCB(onSharingStatus) → {Boolean}
- Description:
- Set onSharingStatus callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSharingStatus |
function |
Returns:
true or false
- 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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- 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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- 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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- 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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) MeetingShare_StopShare() → {Number}
- Description:
- Stop the current sharing.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) MeetingShare_StopShare() → {Number}
- Description:
- Stop the current sharing.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
Events
onFailedToStartShare
- Description:
- Callback event of failure to start sharing.
- Source:
onFailedToStartShare
- Description:
- Callback event of failure to start sharing.
- Source:
onOptimizingShareForVideoClipStatusChanged
- Description:
- Callback event of the changed optimizing video status.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
shareInfo |
Object | Sharing information with the following properties: - userid: User ID - shareSourceID: Share source ID - status: The values of sharing status ShareStatus - isShowingInFirstView: Display or not on the primary view. Available only for Zoom UI mode - isShowingInSecondView: Display or not on the secondary view. Available only for Zoom UI mode - isCanBeRemoteControl: Enable or disable the remote control - bEnableOptimizingVideoSharing: Enable or disable the optimizing video - contentType: Type of sharing - windowID: Handle of sharing application or white-board. It is invalid unless the value of the contentType is SHARE_TYPE_AS or SHARE_TYPE_WB - monitorID: The ID of screen to be shared. It is invalid unless the value of the contentType is SHARE_TYPE_DS |
onOptimizingShareForVideoClipStatusChanged
- Description:
- Callback event of the changed optimizing video status.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
shareInfo |
Object | Sharing information with the following properties: - userid: User ID - shareSourceID: Share source ID - status: The values of sharing status ShareStatus - isShowingInFirstView: Display or not on the primary view. Available only for Zoom UI mode - isShowingInSecondView: Display or not on the secondary view. Available only for Zoom UI mode - isCanBeRemoteControl: Enable or disable the remote control - bEnableOptimizingVideoSharing: Enable or disable the optimizing video - contentType: Type of sharing - windowID: Handle of sharing application or white-board. It is invalid unless the value of the contentType is SHARE_TYPE_AS or SHARE_TYPE_WB - monitorID: The ID of screen to be shared. It is invalid unless the value of the contentType is SHARE_TYPE_DS |
onSharingStatus
- Description:
- Callback event of the changed sharing status.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
shareInfo |
Object | Sharing information with the following properties: - userid: User ID - shareSourceID: Share source ID - status: The values of sharing status ShareStatus - isShowingInFirstView: Display or not on the primary view. Available only for Zoom UI mode - isShowingInSecondView: Display or not on the secondary view. Available only for Zoom UI mode - isCanBeRemoteControl: Enable or disable the remote control - bEnableOptimizingVideoSharing: Enable or disable the optimizing video - contentType: Type of sharing - windowID: Handle of sharing application or white-board. It is invalid unless the value of the contentType is SHARE_TYPE_AS or SHARE_TYPE_WB - monitorID: The ID of screen to be shared. It is invalid unless the value of the contentType is SHARE_TYPE_DS |
onSharingStatus
- Description:
- Callback event of the changed sharing status.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
shareInfo |
Object | Sharing information with the following properties: - userid: User ID - shareSourceID: Share source ID - status: The values of sharing status ShareStatus - isShowingInFirstView: Display or not on the primary view. Available only for Zoom UI mode - isShowingInSecondView: Display or not on the secondary view. Available only for Zoom UI mode - isCanBeRemoteControl: Enable or disable the remote control - bEnableOptimizingVideoSharing: Enable or disable the optimizing video - contentType: Type of sharing - windowID: Handle of sharing application or white-board. It is invalid unless the value of the contentType is SHARE_TYPE_AS or SHARE_TYPE_WB - monitorID: The ID of screen to be shared. It is invalid unless the value of the contentType is SHARE_TYPE_DS |