Windows SDK API Reference
|
Meeting annotation tool interface. More...
#include <meeting_annotation_interface.h>
Public Member Functions | |
virtual SDKError | SetEvent (IMeetingAnnotationSupportEvent *pEvent)=0 |
Set the callback that annotation status changes. | |
virtual bool | IsAnnotationDisable ()=0 |
Determine whether current meeting supports annotation feature. | |
virtual SDKError | StartAnnotation (SDKViewType viewtype)=0 |
Display annotation toolbar. | |
virtual SDKError | StopAnnotation (SDKViewType viewtype)=0 |
Close the current annotation toolbar. | |
virtual SDKError | SetTool (SDKViewType viewtype, AnnotationToolType type)=0 |
Choose annotation tool. | |
virtual SDKError | Clear (SDKViewType viewtype, AnnotationClearType type)=0 |
Clear present annotations. | |
virtual SDKError | SetColor (SDKViewType viewtype, unsigned long color)=0 |
Set the colors of annotation tools. | |
virtual SDKError | SetLineWidth (SDKViewType viewtype, long lineWidth)=0 |
Set the line width of annotation tools. | |
virtual SDKError | Undo (SDKViewType viewtype)=0 |
Undo the last annotation. | |
virtual SDKError | Redo (SDKViewType viewtype)=0 |
Redo the last-undo annotation. | |
virtual ICustomizedAnnotationController * | GetCustomizedAnnotationController (ICustomizedShareRender *pShareRender=NULL)=0 |
Get the controller of annotation tools used in user custom interface mode. | |
virtual SDKError | DisableViewerAnnotation (SDKViewType viewtype, bool bDisable)=0 |
Disallow/allow participants to annotate when viewing the sharing content. | |
virtual SDKError | IsViewerAnnotationDisabled (SDKViewType viewtype, bool &bDisabled)=0 |
Determine if viewer's privilege of annotation is disabled. | |
virtual SDKError | CanDisableViewerAnnotation (SDKViewType viewtype, bool &bCan)=0 |
Determine if it is able to disallow viewer to annotate. | |
virtual SDKError | CanDoAnnotation (SDKViewType viewtype, bool &bCan)=0 |
Determine if it is able to annotate(Both the presenter and viewer can call the function). | |
virtual bool | IsAnnotationLegalNoticeAvailable ()=0 |
Determine whether the legal notice for annotation is available. | |
virtual const zchar_t * | getAnnotationLegalNoticesPrompt ()=0 |
Get the annotation legal notices prompt. | |
virtual const zchar_t * | getAnnotationLegalNoticesExplained ()=0 |
Get the annotation legal notices explained. | |
Meeting annotation tool interface.
Definition at line 70 of file meeting_annotation_interface.h.
|
pure virtual |
Determine if it is able to disallow viewer to annotate.
[in] | viewtype | SDK_FIRST_VIEW/SDK_SECOND_VIEW |
[out] | bCan | TRUE means able, FALSE not. It validates only when the return value is SDKErr_Success. |
|
pure virtual |
Determine if it is able to annotate(Both the presenter and viewer can call the function).
[in] | viewtype | SDK_FIRST_VIEW/SDK_SECOND_VIEW |
[out] | bCan | TRUE means able, FALSE not. It validates only when the return value is SDKErr_Success. |
|
pure virtual |
Clear present annotations.
viewtype | Specify on which view to clear the annotations. For more details, see SDKViewType enum. |
type | Specify the ways to clear annotations. For the definitions of the tools, see AnnotationClearType enum. |
|
pure virtual |
Disallow/allow participants to annotate when viewing the sharing content.
[in] | viewtype | SDK_FIRST_VIEW/SDK_SECOND_VIEW |
[in] | disable | TRUE means disabled, FALSE not. |
|
pure virtual |
Get the annotation legal notices explained.
|
pure virtual |
Get the annotation legal notices prompt.
|
pure virtual |
Get the controller of annotation tools used in user custom interface mode.
|
pure virtual |
Determine whether current meeting supports annotation feature.
|
pure virtual |
Determine whether the legal notice for annotation is available.
|
pure virtual |
Determine if viewer's privilege of annotation is disabled.
[in] | viewtype | SDK_FIRST_VIEW/SDK_SECOND_VIEW |
[out] | bDisabled | TRUE means disabled, FALSE not. It validates only when the return value is SDKErr_Success. |
|
pure virtual |
Redo the last-undo annotation.
viewtype | Specify on which view to redo the last-undo annotation. For more details, see SDKViewType enum. |
|
pure virtual |
Set the colors of annotation tools.
viewtype | The specified color is used on which view. For more details, see SDKViewType enum. |
color | Specify the color of the annotation tools in RGB format. |
|
pure virtual |
Set the callback that annotation status changes.
pEvent | An object pointer to the the IMeetingAnnotationSupportEvent that receives the annotation status changing callback event. |
|
pure virtual |
Set the line width of annotation tools.
viewtype | The specified line width is used on which view. For more details, see SDKViewType enum. |
lineWidth | Specify the line width to annotate. |
|
pure virtual |
Choose annotation tool.
viewtype | Specify which view to display the toolbar. For more details, see SDKViewType enum. |
type | Specify the annotation tool to be used. For the definitions of the tools, see AnnotationToolType enum. |
|
pure virtual |
Display annotation toolbar.
viewtype | Specify which view to display the toolbar. For more details, see SDKViewType enum. |
left | Specify X-axis coordinate of the upper-left corner for the toolbar. |
top | Specify Y-axis coordinate of the upper-left corner for the toolbar. |
|
pure virtual |
Close the current annotation toolbar.
viewtype | Specify which view to close the toolbar. For more details, see SDKViewType enum. |
|
pure virtual |
Undo the last annotation.
viewtype | Specify on which view to undo the last annotation. For more details, see SDKViewType enum. |