Zoom Annotation Ctrl
- Description:
- Zoom Annotation Ctrl
- Source:
Returns:
- Type
- ZoomAnnotationCtrl
- Description:
- Zoom Annotation Ctrl
- Source:
Returns:
- Type
- ZoomAnnotationCtrl
Methods
(inner) Annotation_Clear(viewtype, clearType) → {Number}
- Description:
- Clear present annotations.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | Specify on which view to clear the annotations SDKViewType. |
clearType |
String | Specify the ways to clear annotations ZoomAnnotationClearType. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_Clear(viewtype, clearType) → {Number}
- Description:
- Clear present annotations.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | Specify on which view to clear the annotations SDKViewType. |
clearType |
String | Specify the ways to clear annotations ZoomAnnotationClearType. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_GetAnnotationLegalNoticesExplained() → {String}
- Description:
- Get the annotation legal notices explained.
- Source:
Returns:
The annotation legal notices explained.
- Type
- String
(inner) Annotation_GetAnnotationLegalNoticesExplained() → {String}
- Description:
- Get the annotation legal notices explained.
- Source:
Returns:
The annotation legal notices explained.
- Type
- String
(inner) Annotation_GetAnnotationLegalNoticesPrompt() → {String}
- Description:
- Get the annotation legal notices prompt.
- Source:
Returns:
The annotation legal notices prompt.
- Type
- String
(inner) Annotation_GetAnnotationLegalNoticesPrompt() → {String}
- Description:
- Get the annotation legal notices prompt.
- Source:
Returns:
The annotation legal notices prompt.
- Type
- String
(inner) Annotation_IsAnnotationDisable() → {Boolean}
- Description:
- Determine whether current meeting supports annotation feature.
- Source:
Returns:
true not support, false support.
- Type
- Boolean
(inner) Annotation_IsAnnotationDisable() → {Boolean}
- Description:
- Determine whether current meeting supports annotation feature.
- Source:
Returns:
true not support, false support.
- Type
- Boolean
(inner) Annotation_IsAnnotationLegalNoticeAvailable() → {Boolean}
- Description:
- Determine whether the legal notice for annotation is available.
- Source:
Returns:
True indicates the legal notice for annotation transcript is available. Otherwise False.
- Type
- Boolean
(inner) Annotation_IsAnnotationLegalNoticeAvailable() → {Boolean}
- Description:
- Determine whether the legal notice for annotation is available.
- Source:
Returns:
True indicates the legal notice for annotation transcript is available. Otherwise False.
- Type
- Boolean
(inner) Annotation_Redo(viewtype) → {Number}
- Description:
- Redo the last-undo annotation.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | Specify on which view to redo the last-undo annotation SDKViewType. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_Redo(viewtype) → {Number}
- Description:
- Redo the last-undo annotation.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | Specify on which view to redo the last-undo annotation SDKViewType. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_SetColor(viewtype, color) → {Number}
- Description:
- Set the colors of annotation tools.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | The specified color is used on which view SDKViewType. |
color |
String | Specify the color of the annotation tools in RGB format. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_SetColor(viewtype, color) → {Number}
- Description:
- Set the colors of annotation tools.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | The specified color is used on which view SDKViewType. |
color |
String | Specify the color of the annotation tools in RGB format. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_SetLineWidth(viewtype, lineWidth) → {Number}
- Description:
- Set the line width of annotation tools.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | The specified line width is used on which view SDKViewType. |
lineWidth |
String | Specify the line width to annotate. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_SetLineWidth(viewtype, lineWidth) → {Number}
- Description:
- Set the line width of annotation tools.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | The specified line width is used on which view SDKViewType. |
lineWidth |
String | Specify the line width to annotate. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_SetTool(viewtype, toolType) → {Number}
- Description:
- Choose annotation tool.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | Specify which view to display the toolbar SDKViewType. |
toolType |
String | Specify the annotation tool to be used ZoomAnnotationToolType. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_SetTool(viewtype, toolType) → {Number}
- Description:
- Choose annotation tool.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | Specify which view to display the toolbar SDKViewType. |
toolType |
String | Specify the annotation tool to be used ZoomAnnotationToolType. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_StartAnnotation(viewtype, left, top) → {Number}
- Description:
- Display annotation toolbar.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | Specify which view to display the toolbar SDKViewType. |
left |
String | Specify X-axis coordinate of the upper-left corner for the toolbar. |
top |
String | Specify Y-axis coordinate of the upper-left corner for the toolbar. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_StartAnnotation(viewtype, left, top) → {Number}
- Description:
- Display annotation toolbar.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | Specify which view to display the toolbar SDKViewType. |
left |
String | Specify X-axis coordinate of the upper-left corner for the toolbar. |
top |
String | Specify Y-axis coordinate of the upper-left corner for the toolbar. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_StopAnnotation(viewtype) → {Number}
- Description:
- Close the current annotation toolbar.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | Specify which view to close the toolbar SDKViewType. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_StopAnnotation(viewtype) → {Number}
- Description:
- Close the current annotation toolbar.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | Specify which view to close the toolbar SDKViewType. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_Undo(viewtype) → {Number}
- Description:
- Undo the last annotation.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | Specify on which view to undo the last annotation SDKViewType. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Annotation_Undo(viewtype) → {Number}
- Description:
- Undo the last annotation.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype |
Number | Specify on which view to undo the last annotation SDKViewType. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number