Zoom Meeting Whiteboard
- Description:
- Zoom Meeting Whiteboard
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWhiteboardStatusChanged |
function | Whiteboard status changed callback. Use this function to inform the user that the whiteboard has been started or stopped, and all users in the meeting can get the event. |
onWhiteboardSettingsChanged |
function | Callback to demote attendees to panelist. |
Returns:
- Type
- ZoomMeetingWhiteboard
- Description:
- Zoom Meeting Whiteboard
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWhiteboardStatusChanged |
function | Whiteboard status changed callback. Use this function to inform the user that the whiteboard has been started or stopped, and all users in the meeting can get the event. |
onWhiteboardSettingsChanged |
function | Callback to demote attendees to panelist. |
Returns:
- Type
- ZoomMeetingWhiteboard
Methods
(inner) CanStartShareWhiteboard() → {Object}
- Description:
- Determine whether the current meeting can start sharing the whiteboard.
- Source:
Returns:
True indicates you can start sharing the whiteboard.
- Type
- Object
(inner) CanStartShareWhiteboard() → {Object}
- Description:
- Determine whether the current meeting can start sharing the whiteboard.
- Source:
Returns:
True indicates you can start sharing the whiteboard.
- Type
- Object
(inner) EnableParticipantsCreateWithoutHost(bEnable) → {Number}
- Description:
- Enable the participants to create a new whiteboard without the host in the meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Number | TRUE indicates to enable. FALSE not. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) EnableParticipantsCreateWithoutHost(bEnable) → {Number}
- Description:
- Enable the participants to create a new whiteboard without the host in the meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Number | TRUE indicates to enable. FALSE not. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) GetWhiteboardCreateOption() → {Object}
- Description:
- Get the option for who can initiate a new whiteboard.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Object
(inner) GetWhiteboardCreateOption() → {Object}
- Description:
- Get the option for who can initiate a new whiteboard.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Object
(inner) GetWhiteboardShareOption() → {Object}
- Description:
- Get the option for who can share a whiteboard.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Object
(inner) GetWhiteboardShareOption() → {Object}
- Description:
- Get the option for who can share a whiteboard.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Object
(inner) IsOtherSharingWhiteboard() → {Boolean}
- Description:
- Query if other user is sharing whiteboard.
- Source:
Returns:
True means other user is sharing. False means not.
- Type
- Boolean
(inner) IsOtherSharingWhiteboard() → {Boolean}
- Description:
- Query if other user is sharing whiteboard.
- Source:
Returns:
True means other user is sharing. False means not.
- Type
- Boolean
(inner) IsParticipantsCreateWithoutHostEnabled() → {Boolean}
- Description:
- Determine whether enable the participants create a new whiteboard without the host in the meeting.
- Source:
Returns:
True indicates that they have these permission.
- Type
- Boolean
(inner) IsParticipantsCreateWithoutHostEnabled() → {Boolean}
- Description:
- Determine whether enable the participants create a new whiteboard without the host in the meeting.
- Source:
Returns:
True indicates that they have these permission.
- Type
- Boolean
(inner) IsSharingWhiteboardOut() → {Boolean}
- Description:
- Query if the current user is sharing whiteboard successfully.
- Source:
Returns:
True means the current user is sharing successfully. False means not.
- Type
- Boolean
(inner) IsSharingWhiteboardOut() → {Boolean}
- Description:
- Query if the current user is sharing whiteboard successfully.
- Source:
Returns:
True means the current user is sharing successfully. False means not.
- Type
- Boolean
(inner) IsSupportWhiteBoard() → {Boolean}
- Description:
- Determine whether the current meeting supports the whiteboard or not.
- Source:
Returns:
True indicates to support.
- Type
- Boolean
(inner) IsSupportWhiteBoard() → {Boolean}
- Description:
- Determine whether the current meeting supports the whiteboard or not.
- Source:
Returns:
True indicates to support.
- Type
- Boolean
(inner) SetDashboardViewSize(width, height) → {Number}
- Description:
- Set the dashboard web view window size.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
width |
Number | Specify the width of the window. |
height |
Number | Specify the height of the window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetDashboardViewSize(width, height) → {Number}
- Description:
- Set the dashboard web view window size.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
width |
Number | Specify the width of the window. |
height |
Number | Specify the height of the window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetOnWhiteboardSettingsChangedCB(onWhiteboardSettingsChanged) → {Boolean}
- Description:
- Set callback event of whiteboard setting type changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWhiteboardSettingsChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOnWhiteboardSettingsChangedCB(onWhiteboardSettingsChanged) → {Boolean}
- Description:
- Set callback event of whiteboard setting type changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWhiteboardSettingsChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOnWhiteboardStatusChangedCB(onWhiteboardStatusChanged) → {Boolean}
- Description:
- Set callback to inform the user that the whiteboard has been started or stopped.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWhiteboardStatusChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOnWhiteboardStatusChangedCB(onWhiteboardStatusChanged) → {Boolean}
- Description:
- Set callback to inform the user that the whiteboard has been started or stopped.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWhiteboardStatusChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOwnerWindow(windowID) → {Number}
- Description:
- Set the whiteboard web view and dashboard web view owner window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
windowID |
String | Specify the owner window. If windowID is nullptr, the owner window will be desktop window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetOwnerWindow(windowID) → {Number}
- Description:
- Set the whiteboard web view and dashboard web view owner window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
windowID |
String | Specify the owner window. If windowID is nullptr, the owner window will be desktop window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetWhiteboardCreateOption(option) → {Number}
- Description:
- Set the option for who can initiate a new whiteboard.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
option |
Number | Setting option for who can initiate a new whiteboard, see SDKWhiteboardCreateOption enum. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetWhiteboardCreateOption(option) → {Number}
- Description:
- Set the option for who can initiate a new whiteboard.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
option |
Number | Setting option for who can initiate a new whiteboard, see SDKWhiteboardCreateOption enum. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetWhiteboardShareOption(option) → {Number}
- Description:
- Set the option for who can share a whiteboard.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
option |
Number | New setting for who can share a whiteboard, see SDKWhiteboardShareOption enum. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetWhiteboardShareOption(option) → {Number}
- Description:
- Set the option for who can share a whiteboard.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
option |
Number | New setting for who can share a whiteboard, see SDKWhiteboardShareOption enum. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetWhiteboardViewPos(x, y) → {Number}
- Description:
- Set the whiteboard web view window position.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
x |
Number | The horizontal coordinate value. |
y |
Number | The vertical coordinate value. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetWhiteboardViewPos(x, y) → {Number}
- Description:
- Set the whiteboard web view window position.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
x |
Number | The horizontal coordinate value. |
y |
Number | The vertical coordinate value. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetWhiteboardViewSize(width, height) → {Number}
- Description:
- Set the whiteboard web view window size.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
width |
Number | Specify the width of the window. |
height |
Number | Specify the height of the window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetWhiteboardViewSize(width, height) → {Number}
- Description:
- Set the whiteboard web view window size.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
width |
Number | Specify the width of the window. |
height |
Number | Specify the height of the window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) ShowDashboardView(x, y) → {Number}
- Description:
- Show the dashboard web view window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
x |
Number | The horizontal coordinate value. |
y |
Number | The vertical coordinate value. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) ShowDashboardView(x, y) → {Number}
- Description:
- Show the dashboard web view window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
x |
Number | The horizontal coordinate value. |
y |
Number | The vertical coordinate value. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
Events
onWhiteboardSettingsChanged
- Description:
- Attendee will receive this callback if his audio status changes.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
shareOption |
Number | Who can share their whiteboard. For more details, see SDKWhiteboardShareOption enum. |
createOption |
Boolean | Who can create a new whiteboard. For more details, see SDKWhiteboardCreateOption enum. |
bEnable |
Boolean | Whether enable the participants create whiteboard without host in the meeting. |
onWhiteboardSettingsChanged
- Description:
- Attendee will receive this callback if his audio status changes.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
shareOption |
Number | Who can share their whiteboard. For more details, see SDKWhiteboardShareOption enum. |
createOption |
Boolean | Who can create a new whiteboard. For more details, see SDKWhiteboardCreateOption enum. |
bEnable |
Boolean | Whether enable the participants create whiteboard without host in the meeting. |
onWhiteboardStatusChanged
- Description:
- Whiteboard status changed callback. Use this function to inform the user that the whiteboard has been started or stopped, and all users in the meeting can get the event.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
status |
Number | Specify current whiteboard status. For more details, see SDKWhiteboardStatus enum. |
onWhiteboardStatusChanged
- Description:
- Whiteboard status changed callback. Use this function to inform the user that the whiteboard has been started or stopped, and all users in the meeting can get the event.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
status |
Number | Specify current whiteboard status. For more details, see SDKWhiteboardStatus enum. |