文档帮助平台
首页客户端SDK参考 Mac-QT SDK 完整接口介绍 会议批注
会议批注
更新时间：2025-04-06 01:58:21

会议批注

方法总览

方法名称 行为 含义描述
OnAnnotationStartEvent 通知 批注开始
OnAnnotationStopEvent 通知 批注停止
OnWhiteBoardCountChangeEvent 通知 白板数量变更通知
OnSaveAnnotationImageResultEvent 通知 批注图片保存结果
OnZoomScaleRatioUpdateEvent 通知 画布缩放大小变更通知
StartAnnotation 调用 开启批注
StopAnnotation 调用 停止批注
EnableHideAnnotationBar 调用 是否隐藏批注栏;bEnable: 是否隐藏
IsHideAnnotationBar 调用 获取是否隐藏了批注栏
ClearAnnotation 调用 清除批注
SetAnnotationMode 调用 设置批注模式
SetTextColor 调用 设置文本颜色
SetTextSize 调用 设置文本大小
SetPenColor 调用 设置画笔颜色
SetPenSize 调用 设置批注模式
InsertShape 调用 插入形状
Undo 调用 上一步
Redo 调用 下一步
SaveAnnotationImage 调用 保存批注图片
EnableAnnotatorName 调用 开启批注者名称
IsAnnotatorNameEnable 调用 是否开启了显示批注者名称
ZoomIn 调用 画布放大
ZoomOut 调用 画布缩小
ResetZoomScalePercentage 调用 重置画布缩放
GetZoomScalePercentage 调用 获取画布缩放比例
GetWhiteBoardPageDataList 调用 获取画布数据列表
InsertWhiteBoardPage 调用 在指定画布后方插入新画布
DeleteWhiteBoardPage 调用 删除指定画布
SwitchWhiteBoardPage 调用 切换到指定画布
EnableMainSpeakerMode 调用 开启主讲人模式
IsMainSpeakerModeEnable 调用 获取是否开启主讲人模式
ShowAnnotationBar 调用 显示辅流批注栏
IsSelfCanAnnotate 调用 是否能批注
EnableOnlyHostCanAnnote 调用 修改批注权限，是否只有主持人可以进行批注;bEnable: true时仅有主持人可批注，false时所有人可批注
IsOnlyHostCanAnnoteEnable 调用 会中才能调用,是否只有主持人可以进行批注;bEnable: true时仅有主持人可批注，false时所有人可批注;

OnAnnotationStartEvent

通知描述

批注开始

通知定义

void OnAnnotationStartEvent();

参数描述

无参数。

返回值描述

无返回值。

OnAnnotationStopEvent

通知描述

批注停止

通知定义

void OnAnnotationStopEvent();

参数描述

无参数。

返回值描述

无返回值。

OnWhiteBoardCountChangeEvent

通知描述

白板数量变更通知

通知定义

void OnWhiteBoardCountChangeEvent(int nCount);

参数描述

参数 类型 含义
nCount int 无

返回值描述

无返回值。

OnSaveAnnotationImageResultEvent

通知描述

批注图片保存结果

通知定义

void OnSaveAnnotationImageResultEvent(string strPath, int nBizcode, string strMsg);

参数描述

参数 类型 含义
strPath string 无
nBizcode int 无
strMsg string 无

返回值描述

无返回值。

OnZoomScaleRatioUpdateEvent

通知描述

画布缩放大小变更通知

通知定义

void OnZoomScaleRatioUpdateEvent(float fscale);

参数描述

参数 类型 含义
fscale float 无

返回值描述

无返回值。

StartAnnotation

接口描述

开启批注

接口定义

YLSDKERR StartAnnotation();

参数描述

无参数。

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

StopAnnotation

接口描述

停止批注

接口定义

YLSDKERR StopAnnotation();

参数描述

无参数。

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

EnableHideAnnotationBar

接口描述

是否隐藏批注栏

接口定义

YLSDKERR EnableHideAnnotationBar(bool bEnable);

参数描述

参数 类型 含义
bEnable bool 是否隐藏

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

IsHideAnnotationBar

接口描述

获取是否隐藏了批注栏

接口定义

bool IsHideAnnotationBar();

参数描述

无参数。

返回值描述

类型 含义
bool 无

ClearAnnotation

接口描述

清除批注

接口定义

YLSDKERR ClearAnnotation(AnnotationClearType eAnnoClearType);

参数描述

参数 类型 含义
eAnnoClearType AnnotationClearType 无

AnnotationClearType 清除类型枚举枚举

enum AnnotationClearType {
    ANNO_CLEAR_TYPE_ALL = 0,/** < 清除所有批注  */
    ANNO_CLEAR_TYPE_MY_SELF = 1,/** < 清除我的批注  */
    ANNO_CLEAR_TYPE_OTHER = 2,/** < 清除他人批注  */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

SetAnnotationMode

接口描述

设置批注模式

接口定义

YLSDKERR SetAnnotationMode(AnnotationToolMode eAnnotationMode);

参数描述

参数 类型 含义
eAnnotationMode AnnotationToolMode 无

AnnotationToolMode 批注模式

enum AnnotationToolMode {
    ANNO_TOOL_MODE_NONE = 0,/** < 无，恢复正常光标  */
    ANNO_TOOL_MODE_PEN = 1,/** < 画笔  */
    ANNO_TOOL_MODE_LASER_POINTER = 2,/** < 激光笔  */
    ANNO_TOOL_MODE_ERASER = 3,/** < 橡皮擦  */
    ANNO_TOOL_MODE_PICKER = 4,/** < 圈选  */
    ANNO_TOOL_MODE_TEXT = 5,/** < 文本  */
    ANNO_TOOL_MODE_MOVE_BOARD = 6,/** < 移动画布  */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

SetTextColor

接口描述

设置文本颜色

接口定义

YLSDKERR SetTextColor(AnnotationColorType eColorType);

参数描述

参数 类型 含义
eColorType AnnotationColorType 无

AnnotationColorType 工具(笔、文本)颜色类型

enum AnnotationColorType {
    ANNO_COLOR_TYPE_BLACK = 0,/** < 黑  */
    ANNO_COLOR_TYPE_WHITE = 1,/** < 白  */
    ANNO_COLOR_TYPE_PURPLE = 2,/** < 紫  */
    ANNO_COLOR_TYPE_RED = 3,/** < 红  */
    ANNO_COLOR_TYPE_ORANGE = 4,/** < 橘  */
    ANNO_COLOR_TYPE_YELLOW = 5,/** < 黄  */
    ANNO_COLOR_TYPE_INDIGO = 6,/** < 靛  */
    ANNO_COLOR_TYPE_BLUE = 7,/** < 蓝  */
    ANNO_COLOR_TYPE_GREEN = 8,/** < 绿  */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

SetTextSize

接口描述

设置文本大小

接口定义

YLSDKERR SetTextSize(AnnotationTextSize eTextSize);

参数描述

参数 类型 含义
eTextSize AnnotationTextSize 无

AnnotationTextSize 文本大小

enum AnnotationTextSize {
    ANNO_TEXT_SIZE_SMALL = 0,/** < 小字体  */
    ANNO_TEXT_SIZE_MIDDLE = 1,/** < 中字体  */
    ANNO_TEXT_SIZE_BIG = 2,/** < 大字体  */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

SetPenColor

接口描述

设置画笔颜色

接口定义

YLSDKERR SetPenColor(AnnotationColorType eColorType);

参数描述

参数 类型 含义
eColorType AnnotationColorType 无

AnnotationColorType 工具(笔、文本)颜色类型

enum AnnotationColorType {
    ANNO_COLOR_TYPE_BLACK = 0,/** < 黑  */
    ANNO_COLOR_TYPE_WHITE = 1,/** < 白  */
    ANNO_COLOR_TYPE_PURPLE = 2,/** < 紫  */
    ANNO_COLOR_TYPE_RED = 3,/** < 红  */
    ANNO_COLOR_TYPE_ORANGE = 4,/** < 橘  */
    ANNO_COLOR_TYPE_YELLOW = 5,/** < 黄  */
    ANNO_COLOR_TYPE_INDIGO = 6,/** < 靛  */
    ANNO_COLOR_TYPE_BLUE = 7,/** < 蓝  */
    ANNO_COLOR_TYPE_GREEN = 8,/** < 绿  */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

SetPenSize

接口描述

设置批注模式

接口定义

YLSDKERR SetPenSize(AnnotationPenSizeType ePenSize);

参数描述

参数 类型 含义
ePenSize AnnotationPenSizeType 无

AnnotationPenSizeType 画笔大小

enum AnnotationPenSizeType {
    ANNO_PEN_SIZE_TYPE_SMALL = 0,/** < 细线  */
    ANNO_PEN_SIZE_TYPE_MIDDLE = 1,/** < 中线  */
    ANNO_PEN_SIZE_TYPE_BIG = 2,/** < 粗线  */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

InsertShape

接口描述

插入形状

接口定义

YLSDKERR InsertShape(AnnotationShapeType eShapeType);

参数描述

参数 类型 含义
eShapeType AnnotationShapeType 无

AnnotationShapeType 可插入的形状类型

enum AnnotationShapeType {
    ANNO_SHAPE_TYPE_LINE = 0,/** < 线条  */
    ANNO_SHAPE_TYPE_ARROW = 1,/** < 箭头  */
    ANNO_SHAPE_TYPE_DOUBLE_ARROW = 2,/** < 双箭头  */
    ANNO_SHAPE_TYPE_PARABOLA = 3,/** < 抛物线  */
    ANNO_SHAPE_TYPE_CIRCLE = 4,/** < 圆形  */
    ANNO_SHAPE_TYPE_PARALLELOGRAM = 5,/** < 平行四边形形  */
    ANNO_SHAPE_TYPE_SQUARE = 6,/** < 正方形  */
    ANNO_SHAPE_TYPE_RECTANGLE = 7,/** < 长方形  */
    ANNO_SHAPE_TYPE_TRIANGLE = 8,/** < 三角形  */
    ANNO_SHAPE_TYPE_PENTAGRAM = 9,/** < 五角星形  */
    ANNO_SHAPE_TYPE_CLOUD = 10,/** < 云朵形  */
    ANNO_SHAPE_TYPE_HEART = 11,/** < 心形  */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

Undo

接口描述

上一步

接口定义

YLSDKERR Undo();

参数描述

无参数。

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

Redo

接口描述

下一步

接口定义

YLSDKERR Redo();

参数描述

无参数。

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

SaveAnnotationImage

接口描述

保存批注图片

接口定义

YLSDKERR SaveAnnotationImage();

参数描述

无参数。

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

EnableAnnotatorName

接口描述

开启批注者名称

接口定义

YLSDKERR EnableAnnotatorName(bool bEnable);

参数描述

参数 类型 含义
bEnable bool 无

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

IsAnnotatorNameEnable

接口描述

是否开启了显示批注者名称

接口定义

bool IsAnnotatorNameEnable();

参数描述

无参数。

返回值描述

类型 含义
bool 无

ZoomIn

接口描述

画布放大

接口定义

YLSDKERR ZoomIn();

参数描述

无参数。

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

ZoomOut

接口描述

画布缩小

接口定义

YLSDKERR ZoomOut();

参数描述

无参数。

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

ResetZoomScalePercentage

接口描述

重置画布缩放

接口定义

YLSDKERR ResetZoomScalePercentage();

参数描述

无参数。

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

GetZoomScalePercentage

接口描述

获取画布缩放比例

接口定义

int GetZoomScalePercentage();

参数描述

无参数。

返回值描述

类型 含义
int 无

GetWhiteBoardPageDataList

接口描述

获取画布数据列表

接口定义

WhiteBoardPageList GetWhiteBoardPageDataList();

参数描述

无参数。

返回值描述

类型 含义
WhiteBoardPageList 画布信息列表

WhiteBoardPageList 画布信息列表

struct WhiteBoardPageList {
    std::vector<WhiteBoardPageData> whiteBoardPageList;/** < 画布信息列表 */
}

InsertWhiteBoardPage

接口描述

在指定画布后方插入新画布

接口定义

YLSDKERR InsertWhiteBoardPage(WhiteBoardPageId whiteBoardPageId);

参数描述

参数 类型 含义
whiteBoardPageId WhiteBoardPageId 无

WhiteBoardPageId 白板标识信息,userId和objectHandle组合标识画板

struct WhiteBoardPageId {
    int64_t nUserId;/** < 纯透传数据，外部不需要关心含义  */
    int nObjectHandle;/** < 纯透传数据，外部不需要关心含义  */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

DeleteWhiteBoardPage

接口描述

删除指定画布

接口定义

YLSDKERR DeleteWhiteBoardPage(WhiteBoardPageId whiteBoardPageId);

参数描述

参数 类型 含义
whiteBoardPageId WhiteBoardPageId 无

WhiteBoardPageId 白板标识信息,userId和objectHandle组合标识画板

struct WhiteBoardPageId {
    int64_t nUserId;/** < 纯透传数据，外部不需要关心含义  */
    int nObjectHandle;/** < 纯透传数据，外部不需要关心含义  */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

SwitchWhiteBoardPage

接口描述

切换到指定画布

接口定义

YLSDKERR SwitchWhiteBoardPage(WhiteBoardPageId whiteBoardPageId);

参数描述

参数 类型 含义
whiteBoardPageId WhiteBoardPageId 无

WhiteBoardPageId 白板标识信息,userId和objectHandle组合标识画板

struct WhiteBoardPageId {
    int64_t nUserId;/** < 纯透传数据，外部不需要关心含义  */
    int nObjectHandle;/** < 纯透传数据，外部不需要关心含义  */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

EnableMainSpeakerMode

接口描述

开启主讲人模式

接口定义

YLSDKERR EnableMainSpeakerMode(bool bEnable);

参数描述

参数 类型 含义
bEnable bool 无

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

IsMainSpeakerModeEnable

接口描述

获取是否开启主讲人模式

接口定义

bool IsMainSpeakerModeEnable();

参数描述

无参数。

返回值描述

类型 含义
bool 无

ShowAnnotationBar

接口描述

显示辅流批注栏

接口定义

YLSDKERR ShowAnnotationBar();

参数描述

无参数。

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

IsSelfCanAnnotate

接口描述

是否能批注

接口定义

bool IsSelfCanAnnotate();

参数描述

无参数。

返回值描述

类型 含义
bool 无

EnableOnlyHostCanAnnote

接口描述

修改批注权限，是否只有主持人可以进行批注

接口定义

YLSDKERR EnableOnlyHostCanAnnote(bool bEnable);

参数描述

参数 类型 含义
bEnable bool true时仅有主持人可批注，false时所有人可批注

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

IsOnlyHostCanAnnoteEnable

接口描述

会中才能调用,是否只有主持人可以进行批注;bEnable: true时仅有主持人可批注，false时所有人可批注;

接口定义

bool IsOnlyHostCanAnnoteEnable();

参数描述

无参数。

返回值描述

类型 含义
bool 无
本页目录