会议组件接口参考...2016/06/24 · espace desktop v200r001c50 产品概述目录...

通信平台云

会议组件接口参考

文档版本 02

发布日期 2015-12-14

华为技术有限公司

文档版本 01 (2009-04-10) 华为专有和保密信息

版权所有 © 华为技术有限公司

i

版权所有 © 华为技术有限公司 2014。保留一切权利。

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传

播。

商标声明

和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务

或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或默示

的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本

文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

华为技术有限公司

地址：深圳市龙岗区坂田华为总部办公楼邮编：518129

网址： http://enterprise.huawei.com

客户服务邮箱： [email protected]

客户服务电话： 4008229999

http://enterprise.huawei.com/

eSpace Desktop V200R001C50

产品概述前言



iii

前言

目的

本手册详细描述了通信平台云会议组件对外提供的接口、数据结构、返回码和缩略语，

供 ISV 二次开发人员参考。

产品版本

产品名称版本

通信平台云 V100R001C00

读者对象

本文档（本指南）主要适用于以下工程师：

ISV 二次开发设计架构师

ISV 二次开发软件工程师

符号约定

在本文中可能出现下列标志，它们所代表的含义如下。

符号说明

表示有过度或中度潜在危险，如果不能避免，会导致人员

死亡或严重伤害。

表示有低度潜在危险，如果不能避免，可能导致人员轻微

或中等伤害。

表示有潜在风险，如果忽视这些文本，可能导致设备损坏、

数据丢失、设备性能降低或不可预知的结果。


产品概述前言



iv

符号说明

表示能帮助您解决某个问题或节省您的时间。

表示是正文的附加信息，是对正文的强调和补充。

修改记录

修改记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内

容。

文档版本 01 (2013-03-20)

文档版本 02 (2014-03-20)


产品概述目录



v

目录

前言 ................................................................................................................................................ iii

1 系统概述 ....................................................................................................................................... 2-9

1.1 产品简介 ...................................................................................................................................................... 2-9

1.2 本书约定 ...................................................................................................................................................... 2-9

2 Andriod Java 方法 .................................................................................................................... 2-10

2.1 TupConf JAR 包类说明 ........................................................................................................................... 2-10

2.2 HME-Audio JAR 包类说明 ........................................................................................................................ 2-10

2.3 HME-Video JAR 包说明 ............................................................................................................................ 2-11

2.3.1 CreateLocalRenderer ............................................................................................................. 2-11

2.3.2 CreateRenderer ......................................................................................................................... 2-12

2.3.3 getIndexOfSurface ................................................................................................................. 2-13

2.3.4 setSurfaceNull .................................................................................................................................... 2-13

2.4 Conference 类说明 ..................................................................................................................................... 2-14

2.4.1 initSDK ............................................................................................................................................ 2-14

2.4.2 initIsv ............................................................................................................................................ 2-15

2.4.3 exitSDK ............................................................................................................................................ 2-15

2.4.4 setDpi .............................................................................................................................................. 2-16

2.4.5 setLogLevel..................................................................................................................................... 2-16

2.4.6 setPath ............................................................................................................................................ 2-17

2.4.7 setCaneraName ................................................................................................................................. 2-18

3 Android ConfInstance 类说明 ................................................................................................ 3-19

3.1 会议控制（Conference Control） ............................................................................................................ 3-19

3.1.1 Conf_New .......................................................................................................................................... 3-19

3.1.2 Conf_Release ..................................................................................................................................... 3-19

3.1.3 Conf_Join ........................................................................................................................................... 3-20

3.1.4 Conf_Terminate ................................................................................................................................. 3-22

3.1.5 Conf_Leave ........................................................................................................................................ 3-23

3.1.6 Conf_HeartBeat ................................................................................................................................. 3-24

3.1.7 Conf_Mute ......................................................................................................................................... 3-24

3.1.8 Conf_LoadComponent ....................................................................................................................... 3-25

3.2 用户管理 (Visitor) .................................................................................................................................... 3-25

3.2.1 Conf_User_Kickout ........................................................................................................................... 3-25


产品概述目录



vi

3.2.2 Conf_User_SetRole ........................................................................................................................... 3-27

3.3 桌面/应用程序共享（Desktop or Application Share） ............................................................................ 3-29

3.3.1 As_SetOwner ..................................................................................................................................... 3-29

3.3.2 As_Start .............................................................................................................................................. 3-30

3.3.3 As_Stop .............................................................................................................................................. 3-30

3.3.4 As_SetPrivilege .................................................................................................................................. 3-31

3.3.5 As_InputMsg ...................................................................................................................................... 3-33

3.3.6 As_ViewCreate .................................................................................................................................. 3-34

3.3.7 As_ViewDestroy ................................................................................................................................ 3-34

3.3.8 As_ViewUpdate ................................................................................................................................. 3-34

3.3.9 As_ViewUpdateData .......................................................................................................................... 3-35

3.4 文档共享（Document Share） ................................................................................................................. 3-35

3.4.1 Ds_Open ............................................................................................................................................ 3-35

3.4.2 Ds_Close ............................................................................................................................................ 3-38

3.4.3 Ds_SetCurrentPage ............................................................................................................................ 3-39

3.5 白板（White Board） ............................................................................................................................... 3-41

3.5.1 Wb_NewDoc ...................................................................................................................................... 3-41

3.5.2 Wb_SetCurrentPage ........................................................................................................................... 3-42

3.5.3 Wb_NewPage..................................................................................................................................... 3-43

3.6 标注（Annotation） .................................................................................................................................. 3-44

3.6.1 Annot_CreateStart .............................................................................................................................. 3-44

3.6.2 Annot_CreateDrawingUpdate ............................................................................................................ 3-46

3.6.3 Annot_CreateCustomerUpdate .......................................................................................................... 3-46

3.6.4 Annot_CreateDone ............................................................................................................................. 3-47

3.6.5 Annot_HittestPoint ............................................................................................................................. 3-48

3.6.6 Annot_Delete ..................................................................................................................................... 3-49

3.7 视频（Video） .......................................................................................................................................... 3-50

3.7.1 Video_GetDeviceCount ..................................................................................................................... 3-50

3.7.2 Video_GetDeviceInfo ........................................................................................................................ 3-51

3.7.3 Video_Open ....................................................................................................................................... 3-52

3.7.4 Video_Close ....................................................................................................................................... 3-53

3.7.5 Video_Pause ....................................................................................................................................... 3-54

3.7.6 Video_Resume ................................................................................................................................... 3-56

3.7.7 Video_SetParam ................................................................................................................................. 3-57

3.7.8 Video_GetParam ................................................................................................................................ 3-58

3.7.9 Video_Attach ..................................................................................................................................... 3-59

3.7.10 Video_Detach ................................................................................................................................... 3-60

3.7.11 Video_SetCaptureRotate .................................................................................................................. 3-60

3.7.12 Video_SetEncodeMaxResolution ..................................................................................................... 3-61

3.8 音频（Audio） .......................................................................................................................................... 3-61

3.8.1 Audio_SetParam ................................................................................................................................ 3-61


产品概述目录



vii

3.8.2 Audio_OpenMic ................................................................................................................................. 3-63

3.8.3 Audio_CloseMic ................................................................................................................................ 3-65

3.8.4 Audio_MuteMic ................................................................................................................................. 3-66

3.8.5 Audio_UnMuteMic ............................................................................................................................ 3-67

3.8.6 Audio_OpenSpeaker .......................................................................................................................... 3-68

3.8.7 Audio_CloseSpeaker .......................................................................................................................... 3-69

3.8.8 Audio_MuteSpeaker........................................................................................................................... 3-69

3.8.9 Audio_UnMuteSpeaker ...................................................................................................................... 3-69

3.9 即时消息（Instant Message） .................................................................................................................. 3-70

3.9.1 Chat_SendMsgEx .............................................................................................................................. 3-70

4 返回码 ............................................................................................................................................ 72

5 回调消息 Java 类 .......................................................................................................................... 84

说明 ...................................................................................................................................................................... 84

回调消息通过 IConferenceUI 接口回调，回调函数如下 ........................................................................ 84

5.1 会议管理 ....................................................................................................................................................... 84

5.2 人员管理 ....................................................................................................................................................... 85

5.3 视频模块 ....................................................................................................................................................... 86

5.4 音频模块 ....................................................................................................................................................... 86

5.5 桌面/应用程序共享 ...................................................................................................................................... 87

5.6 文档共享 ....................................................................................................................................................... 88

5.7 白板 ............................................................................................................................................................... 90

5.8 即时消息 ....................................................................................................................................................... 91

6 回调类说明 .................................................................................................................................... 92

6.1 会议控制 ....................................................................................................................................................... 92

6.1.1 ConfExtendParamMsg .......................................................................................................................... 92

6.1.2 ConfExtendUserDataMsg ..................................................................................................................... 92

6.1.3 ConfExtendUserInfoMsg ...................................................................................................................... 92

6.2 屏幕共享 ....................................................................................................................................................... 93

6.2.1 ConfExtendAsChannelMsg .................................................................................................................. 93

6.2.2 ConfExtendAsMouseMsg ..................................................................................................................... 93

6.2.3 ConfExtendAsParamMsg ...................................................................................................................... 93

6.2.4 ConfExtendAsPrivilegeMsg ................................................................................................................. 94

6.2.5 ConfExtendAsScreenSizeMsg .............................................................................................................. 94

6.2.6 ConfExtendAsSessionMsg .................................................................................................................... 94

6.3 白板共享 ....................................................................................................................................................... 94

6.3.1 ConfExtendDsNewDocMsg .................................................................................................................. 94

6.3.2 ConfExtendFlowControlMsg ................................................................................................................ 94

6.4 文件 ............................................................................................................................................................... 95

6.4.1 ConfExtendFtFileInfoMsg .................................................................................................................... 95


产品概述目录



viii

6.5 音频 ............................................................................................................................................................... 95

6.5.1 ConfExtendMaxVoiceMsg .................................................................................................................... 95

6.6 视频 ............................................................................................................................................................... 96

6.6.1 ConfExtendVideoDeviceInfoMsg ......................................................................................................... 96

6.6.2 ConfExtendVideoParamMsg................................................................................................................. 96


产品概述错误!未找到引用源。错误!未找到引用源。



9

1 系统概述

1.1 产品简介

eSpace Meeting 系统采用终端组件与 UI 分离、终端组件与 OS 分离以及异步编程的思想，

使得终端组件具有跨平台、方便被多种应用集成等特性。本手册详细介绍了 eSpace

Meeting 终端组件对外接口，供第三方应用开发人员使用。

1.2 本书约定

本手册中在参数说明部分，用（IN）表示是输入参数，（OUT）表示输出参数，

（IN&OUT）表示既是输入参数，又是输出参数。

本手册中所涉及到的“会议句柄”都是由函数 tup_conf_new 返回，用于标识会议。


产品概述 2 Andriod Java 方法



10

2 Andriod Java 方法

2.1 TupConf JAR 包类说明

类名称(com.huawei.meeting) 功能说明

Conference 会议组件 JNI 类，该类为单实例类，主要用于初始化基本信息

ConfInstance 代表一个会议类，已封装 XML 调用，可直接使用

ConfGLView 会议组件桌面/应用程序共享、文档共享、白板的渲染类

ConfMsg 会议组件回调消息枚举类，枚举值同 Windows/iOS 平台

ConfExtendXXX 回调数据结构类，不同回调消息不同类

ConfOper 会议组件操作枚举类，用于 confHandleMsg 函数

IConferenceUI 回调接口，应用层需要实现并注册到 ConfInstance 类中

ConfDefines 会议组件常量定义类

ConfInfo 会议组件内部使用，不用关心

2.2 HME-Audio JAR 包类说明

HME 音频引擎的 jar 包中只有一个类：

AudioDeviceAndroidService，这个类主要用来启动服务。

服务的启动需要在加载音频组件之前调用，且必须在主线程调用

在 java 层使用 HME 提供的 jar 包启动服务

示例：

Intent intent = new Intent(context, AudioDeviceAndroidService.class);

context.startService(intent);

在引擎结束之后，服务停止，同样需要在主线程





11

示例：

Intent intent = new Intent(this, AudioDeviceAndroidService.class);

stopService(intent);

2.3 HME-Video JAR 包说明

类名称

(com.huawei.hme_video_conf) 功能说明

ViERenderer 使用到的类，用于在窗口上进行显示视频的功能

2.3.1 CreateLocalRenderer

1. 接口描述

创建一个本地 Render，用于显示本地视频。

2. 接口定义

static SurfaceView CreateLocalRenderer(Context context);

3. 参数说明

名称类型说明

context Context Activity 对象指针

4. 返回值

SurfaceView：返回一个视图窗口，用于显示视频。

5. 使用示例

private SurfaceView svLocalSurfaceView = null;

private LinearLayout mLlLocalSurface = null;

mLlLocalSurface = (LinearLayout) findViewById(R.id.LocalView);

svLocalSurfaceView = ViERenderer.CreateLocalRenderer(this);

//删除本地 Render

mLlLocalSurface.removeView(svLocalSurfaceView);

//显示本地 Render





12

mLlLocalSurface.addView(svLocalSurfaceView);

//本地 render 资源释放

ViERenderer.FreeLocalRenderResource();

本地视频的 render 创建请使用 CreateLocalRenderer 接口。只有把视频框架与视频视图绑定在一起

后，才会开始采集数据。

2.3.2 CreateRenderer

接口描述

创建一个远端 Render，用于显示远端视频。

接口定义

static SurfaceView CreateRenderer(Context context)；

参数说明

名称类型说明

context Context Activity 对象指针

返回值

SurfaceView：返回一个视图窗口，用于显示视频。

使用示例

private SurfaceView remoteSurfaceView = null;

private LinearLayout mLlRemoteSurface = null;

mLlRemoteSurface = (LinearLayout) findViewById(R.id.RemoteView);

remoteSurfaceView = ViERenderer.CreateRenderer(this, useOpenGLES2);

//获取 render 句柄的索引，通过 JNI 传输句柄索引, 把窗口句柄索引传下去

int indexOfSurface = ViERenderer.getIndexOfSurface(remoteSurfaceView);

conf.VideoAttach(indexOfSurface);

//添加远端 render

mLlRemoteSurface.addView(remoteSurfaceView);

//删除远端 Render

mLlRemoteSurface.removeView(remoteSurfaceView);

说明





13

//远端 render 资源释放,使用索引方式传递句柄时序调用此方法释放资源

ViERenderer.setSurfaceNull(remoteSurfaceView);

2.3.3 getIndexOfSurface

接口描述

创建多个远端显示视频窗口时，得到每个视频窗口的句柄索引。

接口定义

static int getIndexOfSurface(SurfaceView render)；

参数说明

名称类型说明

SurfaceView render 窗口视图

返回值

返回一个视图窗口的句柄索引。

使用示例

获取 render 句柄的索引，通过 JNI 传输句柄索引


int indexOfSurface = ViERenderer.getIndexOfSurface(remoteSurfaceView);

conf.VideoAttach(indexOfSurface); //把窗口句柄索引传下去

2.3.4 setSurfaceNull

接口描述

把窗口视频给清空。





14

接口定义

void setSurfaceNull(SurfaceView render)；

参数说明

名称类型说明

SurfaceView render 窗口视图

返回值

无。

使用示例


//远端 render 资源释放,使用索引方式传递句柄时序调用此方法释放资源

ViERenderer.setSurfaceNull(remoteSurfaceView);

2.4 Conference 类说明

该类为会议组件的 JNI 类，主要用于初始化基本信息，主要对外函数如下：

2.4.1 initSDK

接口描述

初始化 SDK，初始化前需要设置上面几个参数





15

接口定义

void initSDK(boolean bSelfThread, int devType)

参数说明

名称类型说明

bSelfThread Boolean 是否组件独立线程

devType Int 设备类型

返回值

无

2.4.2 initIsv

接口描述

初始化 ISV 信息，包括 ISV帐号和私钥

接口定义

void initIsv(String isvAccount,String rsaKey,String keyPath)

参数说明

名称类型说明

isvAccount String ISV 帐号

rsaKey String 私钥，可以为空

keyPath String 私钥存储路径，如果私钥为空，则在该路径直

接读取私钥，私钥文件名为 rsa_private_key.pem

返回值

无

2.4.3 exitSDK

接口描述

退出 SDK





16

接口定义

void exitSDK()

参数说明

无

返回值

无

2.4.4 setDpi

接口描述

设置设备的 DPI

接口定义

setDpi(float xdpi, float ydpi)

参数说明

名称类型说明

xdpi Float 屏幕 x 轴 DPI

ydpi Float 屏幕 y 轴 DPI

返回值

无

2.4.5 setLogLevel

接口描述

设置日志级别





17

接口定义

setLogLevel(int media_level, int sdk_level)

参数说明

名称类型说明

media_leve int 媒体库日志级别

sdk_level int SDK 库日志级别

返回值

无

2.4.6 setPath

接口描述

设置日志目录和临时目录

接口定义

void setPath(String logpath, String temppath)

参数说明

名称类型说明

logpath String 日志文件写目录

temppath String 临时文件写目录

返回值

无





18

2.4.7 setCaneraName

接口描述

设置前后摄像头的名称

接口定义

void setCaneraName(String backCamera, String frontCanmera)

参数说明

名称类型说明

backCamera String 后置摄像头名称

frontCanmera String 前置摄像头名称

返回值

无





19

3 Android ConfInstance 类说明

3.1 会议控制（Conference Control）

3.1.1 Conf_New

接口描述

新建一个会议对象，返回一个会议的唯一标识。

接口定义

boolean Conf_New(ConfInfo cinfo)

参数说明

名称类型说明

cinfo ConfInfo 会议信息

返回值

返回 true 表示成功，返回 false 表示失败。

相关参考

Conf_Release

3.1.2 Conf_Release

接口描述

销毁一个会议对象，该函数必须和 Conf_New 在同一个线程。

该函数建议在程序退出时调用，如在主线程退出的最后一刻调用。

不能调用 Conf_Leave 接口之后立刻调用该接口，否则一些消息无法发送，未能正常离开会议

不能调用 Conf_Terminate 接口之后立刻调用该接口，否则一些消息无法发送，会议未被正常终止，

或者可能会造成组件崩溃。可在收到终止确认消息后调用该接口

说明





20

接口定义

void Conf_Release()

3.1.3 Conf_Join

接口描述

加入一个会议。

接口定义

int Conf_Join()

回调消息

消息 ID 说明值说明

(nValue1)

值说明(nValue2)

返回参数

(xml)

CONF_MSG_ON_CONFERENC

E_JOIN

加入会议通

知

接收者：接口

调用者

TcResult

结果

NA NULL





21

CONF_MSG_USER_ON_ENTE

R_IND

入会成功后

的用户加入

通知

接收者：所有

用户（包括自

己）

1：会议中

用户加入

0：会中已

有用户通

知

角色 "<?xml

version=\"1.0

\"

encoding=\"

UTF-8\"

standalone=

\"yes\"?> \

<MSG type

= \"%s\"> \

<version>%

d</version

> \

<userid>%u

</userid> \

<devicetype

>%d</devic

etype> \

<ostype>%

d</ostype>

\

<user_prese

nce_flag>%d

</user_pres

ence_flag> \

<user_capab

ility>%d</u

ser_capabilit

y> \

<user_statu

s>%d</use

r_status> \

<user_name

>%s</user_

name> \

<user_alt_uri

>%s</user_

alt_uri> \

<user_join_fl

ag>%d</us

er_join_flag>

\

</MSG>"

CONF_MSG_USER_ON_HOST

_CHANGE_IND

如果是主持

人入会会收

到主持人变

更通知

接收者：所有

用户（包括自

己）

原主持人UserID

新主持

人UserID

NA





22

CONF_MSG_USER_ON_PRES

ENTER_CHANGE_IND

如果是主讲

人入会，会收

到主讲人变

更通知

接收者：所有

用户（包括自

己）

变更前主

讲人 ID

变更后

主讲人ID

NA

返回值

返回 TC_OK 表示成功，其它表示失败。

相关参考

Conf_Leave

3.1.4 Conf_Terminate

接口描述

结束一个会议

即通知会议服务器释放会议资源，所有与会者会收到会议结束的通知消息，会议结束后再次入会

会提示入会用户“会议已经结束”

接口定义

int Conf_Terminate()

回调消息


(nValue1)

值说明

(nValue2) 返回参

数(xml)

CONF_MSG_ON_CONFERENCE_T

ERMINATE

会议终止通

知

接收者：包括

自己在内的

所有用户

TcResult

操作的

结果

NA NULL

返回值


说明





23

3.1.5 Conf_Leave

接口描述

离开一个会议。

接口定义

int Conf_Leave()

回调消息


(nValue1

)

值说明

(nValue2

)

返回参数(xml)

CONF_MSG_USER_ON_L

EAVE_IND

数据用户

离开会议

后其他与

会者收到

的消息

接收者：除

离开的用

户外的其

他用户

NA NA "<?xml version=\"1.0\"

encoding=\"UTF-8\"

standalone=\"yes\"?>

\

<MSG type = \"%s\">

\

<version>%d</versio

n> \

<userid>%u</userid

> \

<devicetype>%d</de

vicetype> \

<ostype>%d</ostype

> \

<user_presence_flag>

%d</user_presence_fl

ag> \

<user_capability>%d<

/user_capability> \

<user_status>%d</u

ser_status> \

<user_name>%s</use

r_name> \

<user_alt_uri>%s</us

er_alt_uri> \

<user_join_flag>%d</

user_join_flag> \

</MSG>"

返回值


相关参考

Conf_Join





24

3.1.6 Conf_HeartBeat

接口描述

提供消息驱动的心跳，让 ISV 应用层驱动消息循环是为了保证消息循环在主线程中。

Windows 平台无需调用该接口，移动平台必须调用该接口。

接口定义

void Conf_HeartBeat()

3.1.7 Conf_Mute

接口描述

会场静音。包括电话和 PC 用户

只有主持人才有权限静音和取消静音操作。

接口定义

int Conf_Mute(boolean bMute)

参数说明

名称类型说明

bMute boolean 会场静音标识。取值：

true：静音；

false：取消静音

返回值


回调消息


(nValue1)

值说明

(nValue2)

返回参数

(xml)

CONF_MSG_ON_MUTE 会场静音通知

接收者：所有

与会者会收到

此消息

bMute: 1 会

场静音，0

取消会场

静音

0 NULL

说明

说明





25

3.1.8 Conf_LoadComponent

接口描述

加载指定组件

接口定义

int Conf_LoadComponent(int nComps)

参数说明

名称类型说明

coms int 各个组件 ID 定义，取值为 COMPONENT_IID

枚举类型

返回值

返回 TC_OK 只表示调用成功，组件是否加载成功需要看查看 CONF_MSG_ON_COMPONENT_LOAD

回调消息

回调消息


(nValue1)

值说明

(nValue2) 返回参数

(pvoid)

CONF_MSG_ON_COMPONENT_LOAD 组件加

载成功

通知

接收者：

接口调

用者

返回值组件 ID NULL

3.2 用户管理 (Visitor)

3.2.1 Conf_User_Kickout

接口描述

踢除一个用户。





26

接口定义

int Conf_User_Kickout(int nUserID)

参数说明

回调消息

消息 ID 说明值说

明(nValue1)

值

说

明(nValue2)

返回参数(xml)

CONF_MSG

_ON_CONF

ERENCE_LE

AVE

用户剔除通

知

接收者：被踢

用户收到

TC_I

MCC

_RE

ASO

N_U

SER_

EJEC

TED

无

效

NULL

名称类型说明

nUserID uint32 用户 ID





27

CONF_MSG

_USER_ON_

LEAVE_IND

数据用户离

开会议

接收者：除被

踢用户外会

议中其他用

户收到

NA NA "<?xml version=\"1.0\"

encoding=\"UTF-8\"

standalone=\"yes\"?> \

<MSG type = \"%s\"> \

<version>%d</version> \

<userid>%u</userid> \

<devicetype>%d</devicetype>

\

<ostype>%d</ostype> \

<user_presence_flag>%d</user

_presence_flag> \

<user_capability>%d</user_cap

ability> \

<user_status>%d</user_status

> \

<user_name>%s</user_name>

\

<user_alt_uri>%s</user_alt_uri>

\

<user_join_flag>%d</user_join_f

lag> \

</MSG>"

返回值


3.2.2 Conf_User_SetRole

接口描述

设置用户角色。

接口定义

int Conf_User_SetRole(int nUserID, int nRole)

参数说明

名称类型说明

nUserID int 用户 ID





28

回调消息

消息 ID 说明值说明(nValue1) 值说明(nValue2)

返回参数

(xml)

CONF_MSG_USER_

ON_HOST_GIVE_IN

D

赋予主持人

消息通知

接收者：被赋

予者收到

被赋予用户的USERID

NA NA

CONF_MSG_USER_

ON_HOST_GIVE_CF

M

赋予主持人

操作结果

接收者：主动

赋予者收到

TC_OK 操作成功 NA NA

CONF_MSG_USER_

ON_HOST_CHANGE

_IND

主持人变更

通知

接收者：所有

人收到

原主持人 UserID 新主持人UserID

NA

CONF_MSG_USER_

ON_PRESENTER_GI

VE_IND

赋予主讲人

消息通知

接收者：被赋

予主讲人的

用户才能收

到该消息

被赋予用户的USERID

NA NA

CONF_MSG_USER_

ON_PRESENTER_GI

VE_CFM

赋予主讲人

操作结果

接收者：主动

赋予主讲人

的用户

TC_OK 操作成功 NA NA

CONF_MSG_USER_

ON_PRESENTER_C

HANGE_IND

主讲人变更

通知

接收者：所有

用户

变更前主讲人 ID 变更后主

讲人 ID

NA

返回值


nRole int 用户角色，取值：

CONF_ROLE_HOST//主持人

CONF_ROLE_PRESENTER//主讲人

CONF_ROLE_GENERAL//普通与会者





29

3.3 桌面/应用程序共享（Desktop or Application Share）

3.3.1 As_SetOwner

接口描述

设置屏幕共享的拥有者。

成功调用该接口后，原来拥有共享权限的用户的共享权限会自动取消，正在进行的共享会停止

接口定义

int As_SetOwner(int userid, int action)

参数说明

名称类型说明

userid int 用户 ID，范围(0，2147483647]，非法用户返

回失败

action int 取值范围（非法值返回失败）：

释放：AS_ACTION_DELETE

拥有：AS_ACTION_ADD

返回值


回调消息


(nValue1)

值说明

(nValue2

)

返回参数(pvoid)

COMPT_MSG_

AS_ON_SHARI

NG_SESSION

共享状态更

新

接收者：所

有与会者

AS_SESSI

ON_OWNE

R

0 (当前共享者用户 ID) "<?xml version=\"1.0\"

encoding=\"UTF-8\"


<MSG type = \"%s\"> \



</MSG>"

说明





30

3.3.2 As_Start

接口描述

开始桌面共享或应用程序共享。

前提条件

调用 As_SetOwner()函数设置屏幕共享的共享者成功。

接口定义

int As_Start()

返回值


回调消息

消息 ID 说明值说明(nValue1) 值说明(nValue2) 返回参数(xml)

COMPT_MSG

_AS_ON_SHA

RING_STATE

共享状

态更新

接收者：

所有与

会者

SHSHARINGTYP

E_DESKTOP

SHSHARINGTYP

E_APP

AS_STATE_ST

ART

"<?xml

version=\"1.0\"

encoding=\"UTF-8

\"

standalone=\"yes\"

?> \

<MSG type =

\"%s\"> \

<version>%d</ver

sion> \

<action>%lu</acti

on> \

</MSG>"

Action 取值：

AS_STATE_SUB

_NORMAL

AS_STATE_SUB

_CONTROL

AS_STATE_SUB

_ANNOTATION

3.3.3 As_Stop

接口描述

停止桌面共享或应用程序共享。





31

前提条件

用户正在进行共享。

接口定义

int As_Stop()

返回值


回调消息

消息 ID 说明值说明(nValue1) 值说明(nValue2) 返回参数(xml)

COMPT_

MSG_AS

_ON_SH

ARING_S

TATE

共享状

态更新

接收者：

所有与

会者

SHSHARINGTYP

E_DESKTOP

SHSHARINGTYP

E_APP

AS_

STATE_NULL

"<?xml

version=\"1.0\"

encoding=\"UTF-8\"


<MSG type = \"%s\">

\

<version>%d</versio

n> \

<action>%lu</action>

\

</MSG>"

Action 取值：

AS_STATE_SUB_N

ORMAL

AS_STATE_SUB_C

ONTROL

AS_STATE_SUB_A

NNOTATION

3.3.4 As_SetPrivilege

接口描述

赋予/收回远程控制权限，自动生效，不通知上层。





32

接口定义

int As_SetPrivilege(long userid, int privilege, int action )

参数说明

名称类型说明

userid int 用户 ID，范围(0，2147483647]，非法用户返

回失败

privilege int 权限类型。取值范围（非法值返回失败）：

远程控制：AS_PRIVILEGETYPE_CONTROL

标注：AS_PRIVILEGETYPE_ANNOTATION

action int 操作类型。取值范围（非法值返回失败）：

AS_ACTION_DELETE

AS_ACTION_ADD

AS_ACTION_MODIFY

AS_ACTION_REJECT

返回值






33

回调消息

消息 ID 说明值说明(nValue1) 值说明(nValue2) 返回参数

(xml)

COMPT_MSG_

AS_ON_PRIVIL

EGE

权限状态

更新

接收者：所

有会议用

户会收到

此消息

AS_PRIVILEGETY

PE_CONTROL

AS_PRIVILEGETY

PE_ANNOTATION

AS_ACTION_DEL

ETE

AS_ACTION_ADD

AS_ACTION_MOD

IFY

AS_ACTION_REJE

CT

用户 ID，

(ID 权限

变更用

户)

"<?xml

version=\"

1.0\"

encoding

=\"UTF-8

\"

standalon

e=\"yes\"?

> \

<MSG

type =

\"%s\"> \

<version>

%d</versi

on> \

<userid>

%u</useri

d> \

</MSG>"

3.3.5 As_InputMsg

接口描述

输入鼠标和键盘消息，用于远程控制用途。

当前的屏幕组件支持的远程控制事件包括：鼠标左键单击/双击、右键单击/双击、鼠标

滚轮及文字字符按键（不支持特殊功能键，如 Alt 键、Ctrl 键、Windows 键、Print 键等），

同时屏幕组件不支持组合按键，应用程序在调用该接口时，需要注意消息事件的组合。

接口定义

int As_InputMsg(int msgid,int wparam,int lparam)

参数说明

名称类型说明

msgid int 消息类型

wparam int 消息参数





34

lparam int 消息参数

返回值


3.3.6 As_ViewCreate

接口描述

新建 View 用于限定采集范围。该接口用于 Android 应用共享。

接口定义

void As_ViewCreate(int nWidth,int nHeight,int nBitCount)

参数说明

名称类型说明

nWidth int 要采集的视图宽度

nHeight int 要采集的视图高度

nBitCount int 要采集的视图图像位宽

3.3.7 As_ViewDestroy

接口描述

销毁 As_ViewCreate 创建的 View。该接口用于 Android 应用共享。

接口定义

void As_ViewDestroy()

3.3.8 As_ViewUpdate

接口描述

更新 View。该接口用于 Android 应用共享。





35

接口定义

void As_ViewUpdate(int nWidth,int nHeight,int nBitCount)

参数说明

名称类型说明

nWidth int 要采集的视图宽度

nHeight int 要采集的视图高度

nBitCount int 要采集的视图图像位宽

3.3.9 As_ViewUpdateData

接口描述

更新 view 图像数据。该接口用于 Android 应用共享。

接口定义

void As_ViewUpdateData(int[] bmpData)

参数说明

名称类型说明

bmpData int[] View 图像数据

3.4 文档共享（Document Share）

3.4.1 Ds_Open

接口描述

打开共享文档，文档成功加载后将被上传到服务器，其他所有与会者将会接收到该文档

的内容。文档 ID 通过回调消息 COMPT_MSG_DS_XML_ON_OPEN 异步返回。





36

接口定义

int Ds_Open(String strFileName)

参数说明

名称类型说明

strFileName String 要打开的共享文档的全路径，不能为 NULL

返回值

TC_OK：成功

TC_NULL_POINT：会议未创建；参数错误

TC_DS_ERROR_DOC_NO_INIT：文档共享模块未被初始化

TC_DS_ERROR_DOC_NO_SINK：未设置回调对象

TC_DS_ERROR_DOC_NO_SESSION_JOIN：文档共享会话未加入

TC_DS_ERROR_DOC_USER_OFFLINE：用户掉线

TC_DS_ERROR_DOC_ALREADY_OPEN：文档已经被共享，不能再次共享

TC_ERROR：其它错误





37

回调消息

消息 ID 说明值说明(nValue

1)

值说明(nValue2)

返回参数(xml)

COMPT_MSG

_DS_XML_O

N_OPEN

返回文档 ID

接收者：自己

文档 ID NA NULL

COMPT_MSG

_DS_ON_DOC

LOAD_STAR

T

主动打开文档会收

到，表示开始从文

件中加载数据到应

用中

接收者：自己

文档 ID 页数 NULL

COMPT_MSG

_DS_ON_DOC

_NEW

打开一个文档成功

或下载到一个文档

头

接收者：所有人

文档 ID NA NULL 或文档名

"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?> \

<MSG type = \"%s\"> \


<fileName>%s</fileName> \

</MSG>"

COMPT_MSG

_DS_ON_PAG

E_NEW

加载一页成功或下

载到一个页头


文档 ID 页 ID NULL

COMPT_MSG

_DS_ON_PAG

E_LOADED


到，表示一页从文

件中加载到应用成

功

接收者：自己


COMPT_MSG

_DS_ON_DOC

LOAD_FINIS

H


到，表示从文件加

载文档完成

接收者：自己

文档 ID 文档加载

结果，参

考TcResult

中的定义

NULL





38

COMPT_MSG

_DS_ON_CUR

RENT_PAGE_

IND

当前文档或当前页

发生变化



3.4.2 Ds_Close

接口描述

关闭一个文档，其他所有与会者都会收到关闭消息。

接口定义

int Ds_Close(int nDocID)

参数说明

名称类型说明

nDocID int 要关闭的共享文档的 ID

返回值

TC_OK：成功

TC_NULL_POINT：会议未创建




TC_DS_ERROR_DOC_USER_OFFLINE：用户已掉线






39

回调消息

消息 ID 说明值说明(nValue1)

值说明(nValue2)

返回参数(pvoid)

COMPT_M

SG_DS_ON

_DOC_DE

L

一个文档被删

除，所有与会

者都会收到

接收者：所有

人

文档 ID NA NULL 或文档名


<MSG type = \"%s\"> \


<fileName>%s</fileName> \

</MSG>"

COMPT_M

SG_DS_ON

_PAGE_DE

L

一页被删除，

除删除发起方

的其他与会者

可能收到

接收者：所有

人


COMPT_M

SG_DS_ON

_CURREN

T_PAGE_I

ND

当前文档或当

前页发生变

化，所有人可

能收到

接收者：所有

人


3.4.3 Ds_SetCurrentPage

接口描述

设置当前显示的页面，调用该接口后，当前显示的页面将被切换到指定的文档页，如果

指定的文档 ID 为有效值而页面 ID 为 0，则切换到该文档上次显示的页面。该函数有同

步设置和非同步两种，同步设置时，其他所有与会者都会收到切换消息并执行相应操作，

非同步时，只有本地发生变化。





40

接口定义

int Ds_SetCurrentPage(int nDocID, int nPageID)

参数说明

返回值

TC_OK：成功

TC_NULL_POIN

T：会议未创建






回调消息


值说明(nValue2)

返回参数(xml)

COMPT_MSG_DS_ON_

CURRENT_PAGE_IND 收到同步翻页信息（收

到此消息底层并未实

际翻页，上层需要指

定），其他与会者可能

收到，收到此消息不应

该再调用同步翻页

接收者：如果调用该接

口时 bSync 为 1，所有

人会收到，为 0 都不会

收到


名称类型说明

nDocID int 共享文档的 ID

nPageID int 页面 ID





41

COMPT_MSG_DS_ON_

CURRENT_PAGE

当前文档或当前页发

生变化，自己可能收到

接收者：bSync 为 0 时

自己会收到


3.5 白板（White Board）

3.5.1 Wb_NewDoc

接口描述

新建一个空的白板文档，其他所有与会者都会收到新建白板的通知。文档 ID 通过回调

消息 COMPT_MSG_WB_XML_ON_NEW_DOC 异步返回。

接口定义

int Wb_NewDoc()

返回值

TC_OK：成功


TC_DS_ERROR_DOC_NO_INIT：白板模块未被初始化


TC_DS_ERROR_DOC_NO_SESSION_JOIN：白板会话未加入







42

回调消息


(nValue1)

值说明


(xml)

COMPT_MSG_WB_XML_ON_NEW_DOC 返回新建的

白板文档

ID

文档 ID 0 NULL

COMPT_MSG_WB_ON_DOC_NEW 新建一个白

板文档成功

或下载到一

个白板文档

头

接收者：所

有人

文档 ID 0 NULL

3.5.2 Wb_SetCurrentPage

接口描述

设置当前显示的页面，调用该接口后，当前显示的页面将被切换到指定的文档页，如果

指定的文档 ID 为有效值而页面 ID 为 0，则切换到该文档上次显示的页面。

接口定义

int Wb_SetCurrentPage(int nDocID, int nPageID)

参数说明

返回值

TC_OK：成功

TC_NULL_POIN

T：会议未创建






名称类型说明

nDocID Int 白板文档的 ID

nPageID int 页面 ID





43

回调消息


(nValu

e1)

值说明

(nValu

e2)

返回

参数(pvoid)

COMPT_MSG_WB_ON_CURRENT_PA

GE_IND

收到同步翻页信息（收到此

消息底层并未实际翻页，上

层需要指定），其他与会者

可能收到，收到此消息不应

该再调用同步翻页

接收者：如果 bSync 为 1，

所有人会收到

文档ID

页 ID NULL

COMPT_MSG_WB_ON_CURRENT_PA

GE

当前文档或当前页发生变

化，自己可能收到

接收者：如果 bSync 为 0，

自己会收到

文档ID

页 ID NULL

COMPT_MSG_WB_ON_DRAW_DATA_

NOTIFY

界面更新通知，上层收到该

消息后应该调用

conf_wb_get_surfacebmp 获

取数据去渲染，自己可能收

到


文档ID

页 ID NULL

3.5.3 Wb_NewPage

接口描述

在指定的白板文档中新建白板页，如果新建成功，新建的页面将被作为该文档的最后一

页，其他所有与会者都会收到新建页的通知。通过回调消息 COMPT_MSG_WB_XML_ON_NEW_PAGE

异步返回新建页的 ID。

接口定义

int Wb_NewPage(int nDocID,int nWidth,int nHeight)

参数说明

名称类型说明

nDocID int 白板文档的 ID

nWidth int 要创建的页面的宽度，以 TWIPS 为单位





44

返回值

TC_OK：成功







回调消息


(nValue

1)

值说明

(nValue

2)

返回参

数(xml)

COMPT_MSG_WB_XML_ON_NEW_PAGE 返回新建页的 ID 文档ID

页 ID NULL

COMPT_MSG_WB_ON_PAGE_NEW 新建一页成功或下载到

一个页头


文档

ID

页 ID NULL

COMPT_MSG_WB_ON_DRAW_DATA_NOTIFY 界面更新通知，上层收

到该消息后应该调用conf_wb_get_surfaceb

mp 获取数据去渲染


文档

ID

页 ID NULL

COMPT_MSG_WB_ON_CURRENT_PAGE_IND 当前文档或当前页发生

变化


文档ID

页 ID NULL

3.6 标注（Annotation）

3.6.1 Annot_CreateStart

接口描述

开始创建一个标注，该接口用于 DS_ANNOT_TYPE_DRAWING 和

DS_ANNOT_TYPE_CUSTOMER 两种标注的创建，这两类标注的创建必须通过调用该

函数开始。

nHeight int 要创建的页面的高度，以 TWIPS 为单位





45

接口定义

int Annot_CreateStart(int ciid, int docid, int pageid, int type, int subType, float x, float y)

参数说明

名称类型说明

ciid COMPONENT_II

D

组件 ID，目前标注支持文档共享和白板

docid int 要创建标注的文档的 ID

pageid int 要创建标注的页面 ID

type int 标注主类型，这里暂时只有

DS_ANNOT_TYPE_DRAWING 和

DS_ANNOT_TYPE_CUSTOMER 两种

subType int 标注子类型，包括 DRAWING 的子类型和通

过 Annot_RegCustomerType 注册的类型

x float 标注的起点横坐标（一般起点是鼠标按下的点

或图片标注的左上角，以 TWIPS 为单位，且

该值必须是相对于页面左上角并且无缩放情

况下的值，向下向右为正）

y float 标注的起点纵坐标（一般起点是鼠标按下的点

或图片标注的左上角，以 TWIPS 为单位，且

该值必须是相对于页面左上角并且无缩放情

况下的值，向下向右为正）

返回值

TC_OK：成功






TC_DS_ERROR_DOC_NOTEXIST：文档不存在

TC_DS_ERROR_PAGE_NOTEXIST：页面不存在

TC_ANNOT_ERROR_CUSTOMERTYPE_NOTEXIST：标注类型未定义






46

3.6.2 Annot_CreateDrawingUpdate

接口描述

DS_ANNOT_TYPE_DRAWING 类型标注创建过程中更新数据，调用该函数后，组件将

会更新创建过程中的虚线框，并向应用层提供变化后的界面数据。

接口定义

int Annot_CreateDrawingUpdate(int ciid, float x, float y)

参数说明

名称类型说明

ciid COMPONENT_II

D

组件 ID，目前标注支持文档共享和白板

x float 横坐标

Y float 纵坐标

返回值

TC_OK：成功



3.6.3 Annot_CreateCustomerUpdate

接口描述

DS_ANNOT_TYPE_DRAWING 类型标注创建过程中更新数据，调用该函数后，组件将

会更新创建过程中的虚线框，并向应用层提供变化后的界面数据。





47

接口定义

int Annot_CreateCustomerUpdate(int ciid, int localIndex, int picFormat, int left, int right, int top, int bottom, String filename)

参数说明

名称类型说明

ciid int 组件 ID，目前标注支持文档共享和白板

localIndex int 本地化图片索引

picFormat int 图片格式

left int 左上角横坐标

right int 左上角纵坐标

top int 右下角横坐标

bottom int 右下角纵坐标

filename String 图片名字

返回值

TC_OK：成功



3.6.4 Annot_CreateDone

接口描述

标注创建结束，主要用于 DS_ANNOT_TYPE_DRAWING 和

DS_ANNOT_TYPE_CUSTOMER 两种标注，这两种标注必须调用该接口来完成创建，

标注创建完成后，其他与会者会收到创建标注的通知。

接口定义

int Annot_CreateDone(int ciid, boolean bCancel)





48

参数说明

名称类型说明


bCancel int 取消创建，还是创建完成，0：完成创建，1：

取消创建，完成创建则该标注被添加到创建的

页面上，取消创建则会删除该标注。

返回值

TC_OK：成功



3.6.5 Annot_HittestPoint

接口描述

测试一个点是否落在标注上，如果落在标注上则返回该标注的 ID、类型及落点的位置。





49

接口定义

int Annot_HittestPoint(int ciid, int docId, int pageId, int x, int y, int hitMode, int userId, int

reDraw)

参数说明

名称类型说明


Docid Int 文档 ID

Pageid Int 页面 ID

(x,y) Int 要判断的点，以 TWIPS 以单位，且必须是相

对于页面原点无缩放的坐标

hitMode int 测试条件

userId int 用户 ID，当 hitMode 为

DS_HITTEST_MODE_OTHERS 或

DS_HITTEST_MODE_SOMEONE 时有效

reDraw int 是否重绘

返回值

TC_OK：成功



3.6.6 Annot_Delete

接口描述

删除标注。





50

接口定义

int Annot_Delete(int ciid)

参数说明

名称类型说明


返回值

TC_OK：成功






TC_DS_ERROR_DOC_NOTEXIST：文档不存在

TC_DS_ERROR_PAGE_NOTEXIST：页面不存在


3.7 视频（Video）

3.7.1 Video_GetDeviceCount

接口描述

通过回调消息 COMPT_MSG_VIDEO_ON_GETDEVICE_NUM 异步返回视频设备的个

数， Video_GetDeviceInfo 需要参考此接口，此接口获取的是当前用户的视频设备个数。

此接口应用场景：视频模块加载成功后，获取当前用户的设备个数。

接口定义

int Video_GetDeviceCount()

返回值


说明





51

回调消息


(nValue1) 值说明


(xml)

COMPT_MSG_VIDEO_

ON_GETDEVICE_NUM 返回视频设备个

数

视频设备

个数

0 NULL

3.7.2 Video_GetDeviceInfo

接口描述

通过回调消息 COMPT_MSG_VIDEO_ON_GETDEVICE_INFO 异步获取设备信息列表。

此接口获得的是自己的设备信息。

此接口应用场景：视频模块加载成功后，获取自己的设备信息。

接口定义

int Video_GetDeviceInfo()

返回值

返回 TC_OK 表示成功，其他表示失败。\

回调消息


值说明(nValue2)

返回参数(xml)

COMPT_MSG_VI

DEO_ON_GETD

EVICE_INFO

返回视频设

备个数

索引号设备 ID "<?xml version=\"1.0\"

encoding=\"UTF-8\"


<MSG type = \"%s\"> \

<version>%d</version>

\


<deviceID>%u</device

ID> \

<deviceName>%s</dev

iceName> \

<status>%d</status> \

</MSG>"

说明





52

3.7.3 Video_Open

接口描述

打开自己的摄像头，该操作会启用自己的摄像头。

接口定义

int Video_Open(int nDeviceID)

参数说明

名称类型说明

dwDeviceID int 视频设备 ID

返回值

返回 TC_OK 表示成功，其他表示失败。





53

回调消息

消息 ID 说

明

值说

明(nVal

ue1)

值说

明(nVal

ue2)

返回参数(pvoid)

COMPT_MSG_VIDEO_ON_SWIT

CH

视

频

变

化

通

知

接

收

者

：

包

括

自

己

在

内

的

所

有

与

会

者

0:表

示是

视频

关闭

状态

1: 表

示是

视频

打开

状态

2: 表

示取

消暂

停状

态，即

打开

状态

4:表

示暂

停状

态

用户ID

设备 ID 号


<MSG type = \"%s\"> \


<deviceID>%u</deviceID> \

</MSG>"

3.7.4 Video_Close

接口描述

关闭自己的摄像头。

接口定义

int Video_Close(int nDeviceID,boolean bCloseAll)

参数说明

返回值

返回 TC_OK 表示

成功，其他表示失

名称类型说明

dwDeviceID int 视频设备 ID

bCloseAll boolean 是否关闭所有





54

败。

回调消息

消息 ID 说

明

值说

明(nVal

ue1)

值说

明(nVal

ue2)

返回参数(pvoid)


CH

视

频

变

化

通

知

接

收

者

：

包

括

自

己

或

在

内

的

所

有

与

会

者

0:表

示是

关闭

视频

1: 表

示是

打开

视频

2: 表

示取

消暂

停状

态，即

打开

状态

4:表

示暂

停状

态

用户ID

设备 ID 号


<MSG type = \"%s\"> \



</MSG>"

3.7.5 Video_Pause

接口描述

暂停自己或别人的视频。如果暂停自己的视频，则暂停指定视频设备的采集功能；如果

暂停其它用户的视频，则不接收该用户指定视频设备的视频数据。





55

接口定义

int Video_Pause(int nUserID,int nDeviceID)

参数说明

名称类型说明

nUserID int 用户 ID，范围(0，2147483647]

dwDeviceID int 暂停视频的设备 ID

bWizPause BOOL TRUE：代表向导时的暂停；FALSE 代表非向

导时的暂停。

返回值






56

回调消息

消息 ID 说

明

值说

明(nVal

ue1)

值说

明(nVal

ue2)

返回参数(pvoid)


CH

视

频

变

化

通

知

接

收

者

：

包

括

自

己

在

内

地

的

所

有

与

会

者

0:表

示是

关闭

视频

1: 表

示是

打开

视频

2: 表

示取

消暂

停状

态，即

打开

状态

4:表

示暂

停状

态

用户ID

设备 ID 号


<MSG type = \"%s\"> \



</MSG>"

相关参考

conf_video_resume

3.7.6 Video_Resume

接口描述

取消暂停自己或别人的视频。

接口定义

int Video_Resume(int nUserID,int nDeviceID)





57

参数说明

名称类型说明

nUserID int 用户 ID，范围(0，2147483647]

dwDeviceID int 取消暂停视频的设备 ID

返回值


回调消息

消息 ID 说

明

值说

明(nVal

ue1)

值说

明(nVal

ue2)

返回参数(pvoid)


CH

视

频

变

化

通

知

接

收

者

：

包

括

自

己

在

内

地

的

所

有

与

会

者

0:表

示是

关闭

视频

1: 表

示是

打开

视频

2: 表

示取

消暂

停状

态，即

打开

状态

4:表

示暂

停状

态

用户ID

设备 ID 号


<MSG type = \"%s\"> \



</MSG>"

3.7.7 Video_SetParam

接口描述

设置视频的相关参数，打开视频之前需要设置，如不设置那么就采用缺省值进行设置。





58

接口定义

int Video_SetParam(int devicdID,int xRes, int yRes, int nFrame)

参数说明

名称类型说明

dwDeviceID int 设备 ID

xRes int 视频宽

yRes int 视频高

nFrame int 视频帧率

返回值


3.7.8 Video_GetParam

接口描述

通过回调消息异步获取视频的相关参数，需要在成功创建引擎之后，才能获取。

接口定义

int Video_GetParam(int nUserID,int nDeviceID)

参数说明

返回值

返回 TC_OK 表示


败。

名称类型说明

nUserID int 用户 ID

nDeviceID int 设备 ID





59

回调消息


(nValue1) 值说明

(nValue2) 返回参数(xml)

COMPT_MSG_VI

DEO_GETPARA

M

返回视频设

备个数

设备 ID 0 "<?xml version=\"1.0\"

encoding=\"UTF-8\"


<MSG type = \"%s\"> \

<version>%d</version>

\

<deviceID>%u</device

ID> \

<xResolution>%d</xRe

solution> \

<yResolution>%d</yRe

solution> \

<nFrameRate>%d</nFr

ameRate> \

<nBitRate>%d</nBitRa

te> \

<nRawtype>%d</nRaw

type> \

<nFecValue>%d</nFec

Value> \

</MSG>"

3.7.9 Video_Attach

接口描述

指定用户的视频与窗口进行绑定。绑定自己则是预览，绑定别人则当前用户加入别人的

视频通道从而可以观看别人的视频。

接口定义

int Video_Attach( int userid, int deviceid,int IndexWnd,int bHigh,int showmode)

参数说明

名称类型说明

userid int 用户 ID，范围(0，2147483647]

deviceid int 设备 ID

IndexWnd int 窗口句柄





60

返回值

返回 TC_OK 表示


败。

3.7.10 Video_Detach

接口描述

指定用户视频与窗口进行解绑

接口定义

int Video_Detach(int userid, int deviceid,boolean leavechannel)

参数说明

返回值

返回 TC_OK 表示


败。

3.7.11 Video_SetCaptureRotate

接口描述

设置视频旋转的角度（只适用于移动版本）。

接口定义

int Video_SetCaptureRotate(int nUserID,int nDeviceID,int rotate)

参数说明

bHigh int 加入低流或是高流(默认高流)

showmode int 视频在窗口显示模式

0:表示布满窗口

1:表示按视频的比例进行显示，其余部分以黑

色填充

2:表示按窗口大小进行裁剪

名称类型说明

userid int 用户 ID，范围(0，2147483647]

deviceid int 设备 ID

IndexWnd int 窗口句柄

leavechannel boolean Detach 窗口的时候，是否需要离开 channel (默

认是不离开 channel)

名称类型说明

dwDeviceID uint32 设备 ID





61

返回值

返回 TC_OK 表示


败。

3.7.12 Video_SetEncodeMaxResolution

接口描述

设置编码的最大分辨率，如果未设置那么就采用缺省值。Windows 系统为 1920*1080，

Android 和 IOS 版本为 640*480。

接口定义

int Video_SetEncodeMaxResolution(int xResolution,int yResolution)

参数说明

返回值

返回 TC_OK 表示


败。

3.8 音频（Audio）

3.8.1 Audio_SetParam

接口描述

设置语音相关参数。

iPicRotate int 设备旋转的角度

enum{

VIDEO_ROTATE_0 = 0 , //视频不

旋转

VIDEO_ROTATE_90 = 90 , //视频逆

时针旋转 90 度

VIDEO_ROTATE_180 = 180, //视频逆

时针旋转 180 度

VIDEO_ROTATE_270 = 270 //视频逆时

针旋转 270 度 };

名称类型说明

xResolution int 编码的最大分辨率的宽

yResolution int 编码的最大分辨率的高





62

接口定义

int Audio_SetParam(int mix,int codec)

参数说明

名称类型说明

mix int 混音模式。客户端混音为 1，服务器混音为 2

Codec int 默认客户端混音= AUDIO_CODEC_iLBC; 服

务器混音= AUDIO_CODEC_PCMA

返回值






63

回调消息


(nValue1)

值说明(nValue2) 返回参数

(xml)

COMPT_MSG

_AUDIO_ON_

AUDIO_DEVI

CE_STATUS_

CHANGE

当会议中有某个与

会者执行本地设备

mic 的相关操作后，

其他当前与会者会

及时收到此回调消

息。另新入会者会

收到已在会议中的

人员的设备状态通

知。

int 值（设备

类型）

AUDIO_MI

C=0 或者

AUDIO_SP

EAKER=1

long 值（设备状

态）

AUDIO_STATU

S_OPEN = 0,

AUDIO_STA

TUS_CLOSE=1,

AUDIO_STA

TUS_MUTE=2,

AUDIO_STA

TUS_NO_DEVI

CE=3

设备状态变

更者的 userid


<MSG type = \"%s\"> \


<devicetype>%d</devicetype> \

<devicestatus>%d</devicestatus> \

<userID>%u</userID> \

</MSG>"

注：当初始化音频引擎之后，本地客户端会检测本地设备的数量，当麦克风数量等于 0

时，发送此消息，告知其他客户端本地无麦克风；当麦克风数量大于 0 时，发送此消息，

告知其他客户端本地麦克风关闭。

3.8.2 Audio_OpenMic

接口描述

打开音频输入设备。

分为同步和异步两种模式。当 conf_audio_set_max_open_devic 调用后或者有COMPT_MSG_AUDIO_ON_AUDIO_MAX_OPEN_DEVICE回调消息上抛，则为异步调用模式。否则为同步模

式。





64

接口定义

int Audio_OpenMic(int micID)

参数说明

名称类型说明

micID int 音频输入设备的设备 ID

返回值

在同步调用情况下：返回 TC_OK 表示成功，其他表示失败。

否则，异步情况下：返回 TC_OK 表示成功，表示异步操作已成功发出，真正是否成功

需要等待回调消息才能最终确定；其他情况表示失败，不会有异步消息再回来。





65

回调消息


(nValue1)

值说明


COMPT_MSG_

AUDIO_ON_A

UDIO_DEVICE

_STATUS_CHA

NGE

当会议中有某个与会

者执行本地设备 mic

的相关操作后，其他

当前与会者会及时收

到此消息回调。另新

入会者会收到已在会

议中的人员的设备状

态通知。

接收者：所有与会者

int 值（设备

类型）

AUDIO_MI

C=0 或者

AUDIO_SP

EAKER=1

long 值

（设备状

态）

AUDIO_S

TATUS_

OPEN =

0,

AUDI

O_STAT

US_CLOS

E=1,

AUDI

O_STAT

US_MUT

E=2,

AUDI

O_STAT

US_NO_

DEVICE=

3

设备状态变更者

的 userid


<MSG type = \"%s\"> \





</MSG>"

COMPT_MSG_

AUDIO_ON_A

UDIO_OPEN_M

IC

异步打开 mic 时的回

调消息（只有当会场

中有最大 mic 限制

时，才会触发异步操

作）

接收者：接口调用者

Int 值，

见 TcResult

无无

3.8.3 Audio_CloseMic

接口描述

关闭音频输入设备。

接口定义

int Audio_CloseMic()

返回值






66

回调消息


(nValue1)

值说明


COMPT

_MSG_

AUDIO

_ON_A

UDIO_

DEVICE

_STAT

US_CH

ANGE








态通知。


int 值（设备

类型）

AUDIO_MI

C=0 或者

AUDIO_SP

EAKER=1

long 值（设备

状态）

AUDIO_STA

TUS_OPEN

= 0,

AUDIO_S

TATUS_CL

OSE=1,

AUDIO_S

TATUS_MU

TE=2,

AUDIO_S

TATUS_NO_

DEVICE=3

设备状态变更者的userid


<MSG type = \"%s\"> \





</MSG>"

3.8.4 Audio_MuteMic

接口描述

静音音频输入设备。

接口定义

int Audio_MuteMic()

返回值






67

回调消息


(nValue1)

值说明


COMPT

_MSG_

AUDIO

_ON_A

UDIO_

DEVICE

_STAT

US_CH

ANGE








态通知。


int 值（设备

类型）

AUDIO_MI

C=0 或者

AUDIO_SP

EAKER=1

long 值（设备

状态）

AUDIO_STA

TUS_OPEN

= 0,

AUDIO_S

TATUS_CL

OSE=1,

AUDIO_S

TATUS_MU

TE=2,

AUDIO_S

TATUS_NO_

DEVICE=3

设备状态变更者的userid


<MSG type = \"%s\"> \





</MSG>"

3.8.5 Audio_UnMuteMic

接口描述

取消静音音频输入设备。

接口定义

int Audio_UnMuteMic()

返回值






68

回调消息


(nValue

1)

值说明(nValue2) 返回参数(xml)

COMPT_MSG_A

UDIO_ON_AUDI

O_DEVICE_STA

TUS_CHANGE

当会议中有某

个与会者执行

本地设备 mic

的相关操作

后，其他当前

与会者会及时

收到此消息回

调。另新入会

者会收到已在

会议中的人员

的设备状态通

知。

接收者：所有

与会者

int 值

（设备

类型）

AUDI

O_MI

C=0 或

者

AUDI

O_SPE

AKER

=1

long 值（设备状

态）

AUDIO_STATUS

_OPEN = 0,

AUDIO_STAT

US_CLOSE=1,

AUDIO_STAT

US_MUTE=2,

AUDIO_STAT

US_NO_DEVICE

=3

设备状态变更者

的 userid


<MSG type = \"%s\"> \





</MSG>"

3.8.6 Audio_OpenSpeaker

接口描述

打开音频输出设备。

接口定义

int Audio_OpenSpeaker(int speakerID)

参数说明

名称类型说明

speakerID int 输出设备 ID

返回值






69

3.8.7 Audio_CloseSpeaker

接口描述

关闭音频输出设备。

接口定义

int Audio_CloseSpeaker()

返回值

返回 TC_OK 不少成功，其他表示失败。

3.8.8 Audio_MuteSpeaker

接口描述

静音音频输出设备。

接口定义

int Audio_MuteSpeaker()

返回值


3.8.9 Audio_UnMuteSpeaker

接口描述

取消静音音频输出设备。

接口定义

int Audio_UnMuteSpeaker()

返回值






70

3.9 即时消息（Instant Message）

3.9.1 Chat_SendMsgEx

接口描述

发送即时消息扩展接口。

此接口比 Chat_SendMsg 接口多一个发送者用户名的参数。Chat_SendMsg 接口从组件中获取发送

者用户名，通过回调消息返回给 UI 层的消息接收者；而 Chat_SendMsgEx 接口从 UI 层中传入发

送者用户名，通过回调消息返回给 UI 层的消息接收者。解决了组件层无法获取用户入会后修改

的用户名，仍然返回给 UI 层修改之前的用户名这个问题。

接口定义

int Chat_SendMsgEx(int nType, int nDstID, String strMsg, String dispSenderName)

参数说明

返回值

返回 TC_OK 表示

成功，其它表示失

败。

回调消息


值说明(nValue2)

返回参数(xml)

说明

名称类型说明

nType int 消息类型，取值：

CHAT_TYPE_PUBLIC //公共即时消息

CHAT_TYPE_GROUP //一对一即时消息

CHAT_TYPE_PRIVATE //群组即时消息

nUserID uint32 一对一即时消息时为接收者用户 ID，范围(0，

2147483647]，公共即时消息时忽略，群组即

时消息时为群组 ID

strMsg String 消息内容

dispSenderName String 消息发送者的用户名，最大长度为 48 个字节，

如果大于 48 个字节，取前 47 个字节+’\0’。





71

COMPT_MSG_CHAT_ON_R

ECV_MSG 收到即时消

息通知

接收者：消

息的接收者

会收到该消

息

0 0 "<?xml

version=\"1.0\"

encoding=\"UTF-

8\"

standalone=\"yes\"

?> \

<MSG type =

\"%s\"> \

<version>%d</ver

sion> \

<groupID>%d</gr

oupID> \

<userid>%u</user

id> \

<username>%s</u

sername> \

<msgtype>%d</m

sgtype> \

<servertime>%lld

</servertime> \

</MSG>"


产品概述 4 返回码



72

4 返回码

本章详细说明返回值为 TcResult 类型时，各值的具体含义。

#define TcResult int

表4-1 返回码定义

枚举值值含义其他说明

TC_OK 0 正确

TC_WARNING 1 警告

TC_ERROR 2 错误

TC_FAILURE 3 失败

TC_NULL_POINT 4 空指针

TC_CALL_TIMEOUT 5 调用超时

TC_PARAM_ERROR 6 参数错误

TC_BUFFER_TOO_SHORT 7 内存太小

TC_XML_PARAM_ERROR 8 XML 参数错误

TC_NO_PRIVILEGE 9 没有权限

TC_FUNC_NOT_SUPPORT 10 调用的接口不支持

或未实现

TC_MODULE_NOT_LOAD 11 模块没有加载

底层错误代码

TC_IMCC_RESULT_BASE 100 T.120 协议栈错误号基

数

调用者不

用关心

TC_IMCC_RESULT_USER_REJECTED 101 拒绝用户请求

说明





73

TC_IMCC_RESULT_NETWORK_ERROR 102 网络错误

TC_IMCC_RESULT_VERSION_NOT_MATCH 103 版本不支持

TC_IMCC_RESULT_PROTOCOL_NOT_RIGHT 104 通信协议错误

TC_IMCC_RESULT_TOO_MANY_CONNECTIONS 105 服务器超出最大连接数

TC_IMCC_RESULT_EXPIRED 106 license过期

TC_IMCC_RESULT_DOMAIN_TERMINATED 107 会议已结束

TC_IMCC_RESULT_SERVER_CONN_FAILED 108 连接上级服务器失败调用者不

用关心

TC_IMCC_RESULT_SYS_SHUTINGDOWN 109 连接断开

TC_IMCC_RESULT_DOMAIN_MERGING 110 会议状态错误调用者不

用关心

TC_IMCC_RESULT_NO_SUCH_USER 111 鉴权时发现该用户不存

在

TC_IMCC_RESULT_CHANNEL_NOT_AVAILABLE 112 会议中 channel达到阈

值

TC_IMCC_RESULT_TOKEN_AUTH_FAIL 115 调用者不

用关心

TC_IMCC_RESULT_POOL_NOT_AVAILABLE 124 Audio 打开 MIC 数量已

超过设置的最大打开

MIC 数

调用者不

用关心

TC_IMCC_RESULT_AUTH_FAILED 126 鉴权失败

TC_IMCC_RESULT_UNKNOWN 127 未知错误

TC_IMCC_RESULT_AUTH_REDIRECT 128 调用者不

用关心

TC_IMCC_RESULT_QUERY_PARENT_OR_TOP_AG

ENT_EXPIRED

129 集群服务异常调用者不

用关心

TC_IMCC_RESULT_DOMAIN_LOCKED 130 会议锁定调用者不

用关心

TC_IMCC_RESULT_AUTH_TIMEOUT 131 鉴权超时调用者不

用关心

TC_IMCC_RESULT_AUTH_KEY_NOT_AVAILABLE 132 会议密码错误调用者不

用关心

TC_IMCC_RESULT_TOO_MANY_CONFERENCE 133 会议数超过限制调用者不

用关心





74

TC_IMCC_RESULT_TOO_MANY_CONFERENCE_U

SER

134 会议成员超过限制调用者不

用关心

TC_IMCC_RESULT_NOT_DATA_USER_LICENSE 135 没有足够的数据

License，不允许入会

调用者不

用关心

TC_IMCC_RESULT_AUTH_LINCENSE_TIMEOUT 136 鉴权 License超时，不

允许入会

TC_IMCC_RESULT_SVR_NOT_ALLOW 137 服务器区域不允许，不

允许入会

TC_IMCC_RESULT_USER_NOT_ALLOW 138 用户重复入会，不允许

入会

copy from IMCC_ERROR

TC_IMCC_ERROR_BASE 200

copy from IMCC_REASON

TC_IMCC_REASON_BASE 300

TC_IMCC_REASON_USER_INITIATED 300 会议正常离会

TC_IMCC_REASON_USER_EJECTED 301 用户被踢

TC_IMCC_REASON_TOKEN_PURGED 302

TC_IMCC_REASON_SYS_SHUTTINGDOWN 303 系统异常

TC_IMCC_REASON_NETWORK_ERROR 304 网络错误

TC_IMCC_REASON_TIME_OUT 305 超时

TC_IMCC_REASON_UNKNOWN 306 未知错误

TC_IMCC_REASON_EXTEND_MAX_LICENSE 307

TC_IMCC_REASON_SYSTEM_ERROR 308

TC_IMCC_REASON_USER_OFFLINE 309 用户离线

会议错误信息定义

TC_CONF_ERROR_NO_INIT 400 未初始化

TC_CONF_ERROR_REPEAT_INIT 401 重复初始化

TC_CONF_ERROR_REPEAT_JOIN 402 重复入会

TC_CONF_ERROR_NO_JOIN 403 未入会

TC_CONF_ERROR_NO_LOAD_COM 404 组件未加载

TC_CONF_ERROR_DATA_TOO_LAGE 405 数据太大

TC_CONF_ERROR_SEND_TOO_FAST 406 发送太快





75

TC_CONF_ERROR_ALREADY_TERMINATE 407 会议已结束

TC_CONF_ERROR_ALREADY_LEAVE 408 会议已离开

TC_CONF_ERROR_COM_LOADED 409 组件已加载

TC_CONF_ERROR_CON_UNLOADED 410 组件已卸载

TC_CONF_ERROR_DISCONNECT_EXC 411 会议已断开

TC_CONF_ERROR_CONF_INFO 412 参数错误

TC_CONF_ERROR_CONF_NOT_INIT 413 会议环境尚未初始

化完成

TC_CONF_ERROR_SELF_PRESENTER 414 自己已经是主讲人

TC_CONF_ERROR_PHONE_INIT 415 电话未初始化

TC_CONF_ERROR_PHONE_JOIN 416 加入电话会议失败

TC_CONF_ERROR_NO_MEMORY 417 申请内存失败

TC_CONF_ERROR_PARAM_INVALID 418 参数无效

TC_CONF_ERROR_ALREADY_NEW 419 相同的会议已经存

在

TC_CONF_ERROR_PAAS_ID_INVALID 420

Paas 模式下，错误

的会议 ID，会议前

12 位不能有值

即时消息模块

TC_CHAT_ERROR_INVALIDSESSION 1001 通道未加入

TC_CHAT_ERROR_INVALIDUSERID 1002 错误的 UserID

TC_CHAT_ERROR_INVALIDGROUPID 1003 错误的分组 ID

TC_CHAT_ERROR_TOO_MANY_CHAR 1004 字符串超过长度限

制

TC_CHAT_ERROR_TOO_MIN_INTERVAL 1005 发送间隔太短

文档模块错误代码

TC_DS_ERROR_DOC_NOTEXIST 1101 文档不存在

TC_DS_ERROR_PAGE_NOTEXIST 1102 页面不存在

TC_DS_ERROR_PARAM_NOTEXIST 1103 参数不存在

TC_DS_ERROR_DE_NOTEXIST 1104 元素(DE)不存在

TC_DS_ERROR_DOC_ALREADYEXIST 1105 文档已存在





76

TC_DS_ERROR_PAGE_ALREADYEXIST 1106 页面已存在

TC_DS_ERROR_NOT_VALID_CWP 1107 不是一个有效的

CWP 文档

TC_ANNOT_ERROR_CUSTOMERTYPE_NOTEXIST 1108 自定义标注类型不

存在

TC_DS_ERROR_PROP_NOT_EXIT 1109 文档属性不存在

TC_DS_ERROR_DOC_ALREADY_OPEN 1110 文档已经打开

TC_DS_ERROR_DOC_NO_INIT 1111 模块未初始化

TC_DS_ERROR_DOC_NO_SINK 1112 回调接口未设置调用者不

关心

TC_DS_ERROR_DOC_NO_SESSION_JOIN 1113 通道未加入

TC_DS_ERROR_DOC_USER_OFFLINE 1114 用户已离线

TC_DS_ERROR_DOC_PRINTING 1115 文档正在打印中

TC_DS_ERROR_DOC_PAGE_DOWN 1116 文档页面数据正在

下载中

TC_DS_ERROR_DOC_FORMAT_ERROR 1117 在文档共享时打开

了保存的白板文

件，或在白板共享

时加载了保存的文

档共享文档

TC_DS_ERROR_DOC_PAGE_NOT_UPLOAD 1118 页面数据没有上传

到服务器，并且此

时共享者已不在会

议中

TC_DS_LOADER_ERROR_COM 1121 COM 调用失败

TC_DS_LOADER_ERROR_NO_PAGE 1122 该文档 0 页

TC_DS_LOADER_CANCELED 1123 取消打印

TC_DS_LOADER_NOT_SUPPORT 1124 文档格式不支持

TC_DS_LOADER_OFFICE_NOT_SUPPORT 1125 Office 版本不支持

TC_DS_LOADER_ERROR_TRANSFORM 1126 转换失败

TC_DS_LOADER_FILE_EMPTY 1127 文档为空





77

TC_DS_LOADER_FORMAT_ERROR 1128 文档格式错误在文档共

享时打开

了保存的

白板文

件，或在

白板共享

时加载了

保存的文

档共享文

档

TC_DS_LOADER_TIMEOUT 1129 文档加载超时

TC_DS_LOADER_PRINTER_UNINSTALL 1130 虚拟打印机未安装

TC_DS_LOADER_PPT_THREAD_ERROR 1131 PPT 加载线程错误

TC_DS_LOADER_PPT_LOAD_ERROR 1132 PPT 加载错误

TC_DS_LOADER_PAGE_OVER_MAX 1133 超出最大页数(200

页)

TC_DS_LOADER_PRINTER_ERROR 1134 打印机错误

TC_DS_LOADER_SERVICE_ERROR 1135 打印服务出现错误

TC_DS_LOADER_PPT2003_RUNNING 1136 PowerPoint2003 运

行中，不能加载

TC_DS_LOADER_NO_PERMISSION 1137 没有权限打开

TC_DS_LOADER_WPS_NOT_INSTALLED 1138 WPS 没有安装 s

TC_ANNOT_ERROR_LASER_EXIST 1140 激光笔已经存在

TC_ANNOT_ERROR_CUSTOMERTYPE_NOTEXIST 1141 自定义标注类型不

存在

屏幕共享

TC_AS_ERROR_UNKNOW 1201 未知错误

TC_AS_ERROR_INVALIDPARA 1202 参数异常

TC_AS_ERROR_INVALIDUSER 1203 角色异常

TC_AS_ERROR_INVALIDSESSION 1204 通道异常

TC_AS_ERROR_NULLCOMHANDLE 1205 模块句柄异常

TC_AS_ERROR_INVALIDSTATE 1206 共享状态错误

TC_AS_ERROR_INVALIDWND 1207 窗口句柄设置异常

TC_AS_ERROR_CREATETASKFAIL 1208 创建共享进程异常





78

TC_AS_ERROR_USERDROPPED 1209 用户已掉线

TC_AS_ERROR_XMLERROR 1210 XML 读写异常

TC_AS_ERROR_MODULELOCKED 1211 模块被锁定

TC_AS_ERROR_WAITFIRSTFRAME 1212 等待首帧发送

TC_AS_ERROR_UNSUPPORT 1213 当前版本不支持

TC_AS_ERROR_FORBID_SCALE 1214 不支持放大

TC_AS_ERROR_MEM_ALLOC_FAILED 1215 内存分配失败

TC_AS_ERROR_NULLCTRLHANDLE 1216 空屏幕共享句柄

TC_AS_ERROR_INVALIDCHANNEL 1217 非法数据通道

TC_AS_ERROR_GDI_ALLOC_FAILED 1218 GDI 对象申请失败

TC_AS_ERROR_P2P_CONNECTION_FAILED 1219 P2P 连接出错

TC_AS_ERROR_ANNOT_BASE 1250 AS 标注错误起始

TC_AS_ERROR_ANNOT_NOTEXIST 1251 文档不存在

TC_AS_ERROR_ANNOT_PAGE_NOTEXIST 1252 页面不存在

TC_AS_ERROR_ANNOT_PARAM_NOTEXIST 1253 参数不存在

TC_AS_ERROR_ANNOT_DE_NOTEXIST 1254 元素不存在

TC_AS_ERROR_ANNOT_ANNOT_ALREADYEXIST 1255 文档已存在

TC_AS_ERROR_ANNOT_PAGE_ALREADYEXIST 1256 页面已存在

TC_AS_ERROR_ANNOT_NOT_VALID_CWP 1257 给定的文件不是一

个有效的CWP文件

TC_AS_ERROR_ANNOT_CUSTOMERTYPE_NOTEXIST 1258 自定义标注类型不

存在

TC_AS_ERROR_SC_BASE 1270 AS 采集错误起始

TC_AS_ERROR_SC_UNKNOW 1271 采集未知错误

TC_AS_ERROR_SC_GDI_OBJECT 1272 创建 GDI 对象失败

视频模块

TC_AS_ERROR_SC_BASE 1300

TC_VIDEO_ERROR_WND_NULL 1301 窗口为空

TC_VIDEO_ERROR_WND_ISUSED 1302 窗口已经被使用

TC_VIDEO_ERROR_DISCONNECT 1303 视频正在断线中





79

TC_VIDEO_ERROR_CREATE_ENGINE 1305 创建 Engine 失败

TC_VIDEO_ERROR_NO_SESSION 1306 视频没有 Session

TC_VIDEO_ERROR_NO_VIDEO_OBJ 1307 视频没有 Obj 对象

TC_VIDEO_ERROR_NO_TABLE 1308 视频没有空闲的

Table 表

TC_VIDEO_ERROR_ALREADY_EXIST_OPENLIST 1309 打开设备时，此设

备已经在正在打开

的列表中

TC_VIDEO_ERROR_COMPONENT_NOTREADY 1310 视频组件还没有准

备好

TC_VIDEO_ERROR_DLL_UNLOAD 1311 视频库已经被卸载

掉了

TC_VIDEO_ERROR_NOTIN_RESOLUTION_RANGE 1312 分辨率不在使用范

围之内

TC_VIDEO_ERROR_RESOLUTION_NOTSUPPORT 1313 分辨率超过设备本

身的最大能力范围

TC_VIDEO_ERROR_OVER_MAX_OPENVIDEO 1314 超过最大的打开视

频路数

TC_VIDEO_ERROR_SAME_CAPBILITY_USED 1320 此设备相同的能力

已经在使用中

TC_VIDEO_ERROR_STATUS_UNINIT 1321 视频组件当前是释

放状态

TC_VIDEO_ERROR_NOT_FIND_WNDCELL 1322 视频打不到相此用

户设备的对应 Cell

TC_VIDEO_ERROR_NOTIN_MAXOPEN_RANGE 1323 超过最大的打开视

频路数

TC_VIDEO_ERROR_ALLREADY_PAUSE 1324 此视频已经处于暂

停状态

TC_VIDEO_ERROR_NOT_PAUSE_STATUS 1325 此视频未处于暂停

状态

TC_VIDEO_ERROR_SWITCH_STREAM_STATUS 1326 切换高低流时错误

(不是 Decode 方，或

是处于暂停状态)

TC_VIDEO_ERROR_OPERATE_STATUS 1327 操作视频错误(数据

Table表值已经不正

常)





80

TC_VIDEO_ERROR_RESOLUTION_NOTFIT 1329 设置分辨率跟能力

分辨率不一致(针对

外部采集设备)

TC_VIDEO_ERROR_FLOWCTRL 1330 正在进行流控

TC_VIDEO_ERROR_OUTSIDE_FLOWCTRL 1331 正在进行外部流控

TC_VIDEO_ERROR_DEVICE_OPENED 1340 视频设备已经在使

用中

TC_VIDEO_ERROR_DEVICE_WIZARD_USED 1341 视频设备已经被向

导使用中

TC_VIDEO_ERROR_WIZARD_NOTSAME_DEVICE 1342 向导设置参数时，

不是同一个设备

TC_VIDEO_ERROR_WIZARD_SAME_PARAM 1343 向导设置参数时，

已有相同的参数

TC_VIDEO_ERROR_MY_NODEID 1344 使用了自己的NodeID

TC_VIDEO_ERROR_DEVICE_NOT_OPENED 1345 设备还没有打开

TC_VIDEO_ERROR_NOT_MYDEVICE 1350 此视频设备不是当

前用户的设备

TC_VIDEO_ERROR_TOOLONG_FILENAME 1351 视频的文件名太长

TC_VIDEO_ERROR_RENDER_DISPLAY_PARAM 1352 视频 Render 参数出

错

TC_VIDEO_ERROR_ROTATE 1353 视频旋转参数出错

TC_VIDEO_ERROR_PC_MOBILE_VERSION_API 1354 PC 与移动版本 API

错用

TC_VIDEO_ERROR_NOT_WND 1355 不是窗口

TC_VIDEO_ERROR_OVER_CAPTURECAPBILITY 1356 此设备设置的能力

超出Capture的能力

TC_VIDEO_ERROR_NOT_WND_NOTFIT 1357 窗口在使用过程中

(比如 Detach 时)，

跟刚才 Attach 时的

窗口不一致

TC_VIDEO_ERROR_MULCONF_CANNOT_USERHME 1358 多会议时不能使用

VIDEOHME，另一

个会议正在使用

HME 中

TC_VIDEO_ERROR_MULCONF_HANGUP 1359 多会议时，此会议

正在挂起状态





81

TC_VIDEO_ERROR_IS_THIRDCAPTURE_DEVICE 1360 此设备是第三方设

备

TC_VIDEO_ERROR_ISNOT_THIRDCAPTURE_DEVICE 1361 此设备不是第三方

设备

TC_VIDEO_ERROR_BITRATE_RANGE 1362 码率不在正常的范

围之内

TC_VIDEO_ERROR_NOT_DOUBLESTREAM 1363 当前不是双流

TC_VIDEO_ERROR_NOT_FIND_THIRDCARD 1364 找不到第三方的采

集卡

TC_VIDEO_ERROR_VIDEO_NOTOPEN 1365 视频还没被打开

TC_VIDEO_ERROR_VIDEO_RECORDING 1366 视频正在录制中

TC_VIDEO_ERROR_VIDEO_RECOREND 1367 视频录制已经结束

音频模块

TC_AUDIO_ERROR_BASE 1400

TC_AUDIO_ERROR_NOT_INITIALIZATION 1401 音频模块未初始化

TC_AUDIO_ERROR_PARAM_NOTEXIST 1402 参数不存在

TC_AUDIO_ERROR_FILE_NOT_SUPPORT 1403 文件类型不支持

TC_AUDIO_CREATE_SEND_THREAD_FAIL 1405 创建线程失败,导致

mic 声音无法发送

到服务器

TC_AUDIO_PARAM_WRONG 1406 参数错误

TC_AUDIO_FUNC_ALREADY_CALLED 1407 多次调用

TC_AUDIO_ENGINE_INIT_FAILED 1408 音频引擎初始化失

败

TC_AUDIO_PARAM_NOT_INITIALIZATION 1409 未调用tup_conf_audio_set

Param 设置参数

TC_AUDIO_ERROR_SESSION_NOT_READY 1410 通道未加入

TC_AUDIO_ERROR_MIC_NOT_OPEN 1411 麦克风未打开

TC_AUDIO_MIC_ALREADY_OPEN 1412 麦克风已经打开，

重复调用

TC_AUDIO_OVER_MAX_DEVICE_OPEN 1413 超过麦克风容许打

开的上限数量

TC_AUDIO_SPEAKER_ALREADY_OPEN 1417 扬声器已经打开





82

TC_AUDIO_SPEAKER_ALREADY_MUTE 1418 扬声器已经处于静

音

TC_AUDIO_SPEAKER_ALREADY_UMUTE 1419 扬声器已经处于非

静音（同时也一定

是打开的）

TC_AUDIO_IS_NOT_SUPPORTED 1420 接口不被支持

TC_AUDIO_ERROR_ALREADY_IN_PRIVATE 1421 已在私聊中

TC_AUDIO_ERROR_ALREADY_NOT_IN_PRIVATE 1422 不在私聊中

TC_AUDIO_ERROR_DEVICE_INOPERABLE 1423 多会议中，设备被

其他会议占用

TC_AUDIO_ERROR_CONF_SUSPEND 1424 会议已挂起

TC_AUDIO_ ERROR_PHONE_MGW_CODEC_FAIL 1425 网关编解码协商失

败

TC_AUDIO_ERROR_PHONE_MGW_VA_ALREADY_NO

TIFY 1426 网关已通知

TC_AUDIO_ERROR_PHONE_MGW_VA_ALREADY_TA

LK 1427 网关已通话

TC_AUDIO_ERROR_PHONE_SESSION_NOT_READY 1428 电话模块未初始化

TC_AUDIO_ERROR_PHONE_MGW_VA_NOT_NOTIFY 1429 网关未通知

TC_AUDIO_ERROR_PHONE_MGW_NOT_RESPONSE 1430 网关未反应

TC_AUDIO_ERROR_TRY_LATER 1431 正在打开

TC_AUDIO_ERROR_MGW_CODEC_ALREADY_SUCCE

SS 1432 网关编解码协商成

功

TC_AUDIO_ERROR_SAME_VALUE 1433 两次设置值相同

媒体共享模块

TC_MS_ERROR_BASE 1500

TC_MS_ERROR_BITRATE_TO_HIGH 1501

投票模块

TC_POLLING_ERROR_BASE 1600

录制模块

TC_RECORD_ERROR_BASE 1700

TC_RECORD_ERROR_INOPERABLE 1701 操作错误

TC_RECORD_ERROR_PATH_NOT_FOUND 1702 路径错误





83

TC_RECORD_ERROR_WAIT_TIME_OUT 1703 超时

TC_RECORD_ERROR_SYSTEM_NOT_SUPPORT_WMF 1704 本地不支持 WMV

录制

文件传输模块

TC_FT_ERROR_BASE 1800

TC_FT_ERROR_CREATE_FILE_FAIL 1801 不能创建指定文件

TC_FT_ERROR_DOWNLOADING_CANCELED 1802 下载已被取消

TC_FT_ERROR_INVALID_FILE_HANDLE 1803 无效文件句柄

TC_FT_ERROR_INVALID_STATE 1804 无效组件状态

TC_FT_ERROR_INVALID_FILE 1805 不是一个有效文件

TC_FT_ERROR_EMPTY_FILE 1806 文件为空(不能上

传)

TC_FT_ERROR_UPLOADING_TIMEOUT 1807 文件上传超时

TC_FT_ERROR_ALREADY_DOWNLOADING 1808 文件已经正在下载


产品概述 5 回调消息



84

5 回调消息 Java 类

说明

回调消息通过 IConferenceUI 接口回调，回调函数如下

void confMsgNotify(ConfMsg msg, ConfExtendMsg extendMsg);

ConfMsg 类为通用类，包含 msgType, nValue1, nValue2 三个成员

ConfExtendMsg为扩展基类，不同回调消息返回不同的子类，在下面表格中列出

5.1 会议管理

消息 ID(ConfMsg.msgType) 说明值说明(ConfMsg.nValue1)

值说明(ConfMsg.nValue2)

返回参数ConfExtendMsg

CONF_MSG_ON_CONFERENCE_JOIN 加入会议通知 TcResult 结

果

NA NA

CONF_MSG_ON_CONFERENCE_TER

MINATE 会议终止通知终止会议原

因

NA NA

CONF_MSG_ON_CONFERENCE_LEA

VE 会议离开通知离开原因 NA NA

CONF_MSG_ON_COMPONENT_LOA

D 组件加载成功

通知

TcResult 结

果

COMPONEN

T_IID

NA

CONF_MSG_ON_MUTE 会场静音通知

（所有与会者

会收到此消

息）

bMute: 1 会

场静音，0

取消会场静

音

0 NA

CONF_MSG_ON_MUTE 静音是否静音 NA NA





85

5.2 人员管理




CONF_MSG_USER_ON_ENTER_IND 用户加入数据

会议

1：会议中用

户加入

0：会中已有

用户通知

角色 ConfExtendUser

InfoMsg

CONF_MSG_USER_ON_LEAVE_IND 用户离开数据

会议

NA NA ConfExtendUser

InfoMsg

CONF_MSG_USER_ON_HOST_CHAN

GE_IND 主持人变更通

知

原主持人UserID

新主持人UserID

NA

CONF_MSG_USER_ON_HOST_GIVE_I

ND 赋予主持人消

息通知

被赋予用户

的 USERID

NA NA

CONF_MSG_USER_ON_HOST_GIVE_

CFM 赋予主持人操

作结果

TC_OK 操作

成功

NA NA

CONF_MSG_USER_ON_PRESENTER_

CHANGE_IND 主讲人变更通

知

变更前主讲

人 ID

变更后主

讲人 ID

NA


GIVE_IND 赋予主讲人消

息通知

被赋予用户

的 USERID

NA NA


GIVE_CFM 赋予主讲人操

作结果

TC_OK 操作

成功

NA NA

CONF_MSG_USER_ON_OFFLINE_IN

D 用户离线通知断线的用户

的 UserID

NA NA





86

5.3 视频模块




COMPT_MSG_VIDEO_ON_SWITCH

触发条件：自己或其它人的设备打开，

关闭，暂停，取消暂停。

视频变化通

知 (包括自

己或其它人

的设备)

0:表示是关

闭视频

1: 表示是

打开视频

2: 表示取

消暂停状

态，即打开

状态

4:表示暂停

状态

用户 ID ConfExtendVideoParamMsg

回调的消息，（包括设备信息，设备打开关闭操作，设备插拨），包括自己与其它人。

5.4 音频模块




CONF_MSG_ON_COMPONENT_LO

AD

触发条件：加载音频组件之后回调上来

的第一个消息

音频组件可用

int nValue1

TC_OK ：音频

组件准备好

TC_FAILURE ：

音频组件初始化

失败

long

nValue2

IID_COMP

ONENT_A

UDIO

NA

COMPT_MSG_AUDIO_ON_AUDIO_

MAX_OPEN_DEVICE

触发条件：

conf_audio_set_max_open_device 接口

触发，所有入会者以及之后入会的都会

收到此消息回调

最大容许打开的

设备数量

int nValue1

当前最大容许打

开的设备数量

long

nValue2

0

NA

说明





87


DEVICE_STATUS_CHANGE

触发条件：当会议中有某个与会者执行

力本地设备 mic 的相关操作后，其他当

前与会者会及时收到此消息回调。另新

入会者会收到已在会议中的人员的设

备状态通知。

某个与会者设备

状态变更通知

int 值（设备类

型）

AUDIO_MIC=0

或者

AUDIO_SPEAK

ER=1

long 值（设

备状态）

AUDIO_ST

ATUS_OPE

N = 0,

AUDI

O_STATUS

_CLOSE=1,

AUDI

O_STATUS

_MUTE=2,

AUDI

O_STATUS

_NO_DEVI

CE=3

uint32*

设备状态

变更者的userid


OPEN_MIC 异步打开 mic 结

果

TcResult 0 0

5.5 桌面/应用程序共享




COMPT_MSG_AS_ON_SHARIN

G_STATE 共享状态通

知

SHSHARINGTYP

E_DESKTOP

SHSHARINGTYP

E_APP

AS_STATE_N

ULL

AS_STATE_V

IEW

AS_STATE_S

TART

AS_STATE_P

AUSE

NA





88

COMPT_MSG_AS_ON_SHARIN

G_SESSION 共享通道通

知

AS_SESSION_CO

NNECT

AS_SESSION_O

WNER

AS_SESSION

_DISCONNE

CT

AS_SESSION

_CONNECTE

D

AS_SESSION

_RECONNEC

TED

AS_ACTION_

DELETE

AS_ACTION_

ADD

AS_ACTION_

MODIFY

ID

ID

COMPT_MSG_AS_ON_PRIVILE

GE 共享权限通

知

AS_PRIVILEGET

YPE_CONTROL

AS_PRIVILEGET

YPE_ANNOTATI

ON

AS_ACTION_

DELETE

AS_ACTION_

ADD

AS_ACTION_

MODIFY

AS_ACTION_

REQUEST

AS_ACTION_

REJECT

ID

5.6 文档共享




COMPT_MSG_DS_ON_DOC_NEW 打开

一个

文档

成功

或下

载到

一个

文档

头

文档 ID NA ConfExtendDsDocInfoMsg





89

COMPT_MSG_DS_ON_DOC_DEL 一个

文档

被删

除

文档 ID NA ConfExtendDsDocInfoMsg

COMPT_MSG_DS_ON_PAGE_NE

W 加载

一页

成功

或下

载到

一个

页头


COMPT_MSG_DS_ON_PAGE_DEL 一页

被删

除


COMPT_MSG_DS_ON_CURRENT

_PAGE_IND 收到

同步

翻页

信息

（收到

此消

息底

层并

未实

际翻

页，上

层需

要指

定），

收到

此消

息不

应该

再调

用同

步翻

页


COMPT_MSG_DS_ON_CURRENT

_PAGE 当前

文档

或当

前页

发生

变化






90

COMPT_MSG_DS_ON_DOCLOAD

_START 开始

加载

一个

文档

文档 ID 保留 NULL

COMPT_MSG_DS_ON_PAGE_LO

ADED 加载

完成

一页


COMPT_MSG_DS_ON_DOCLOAD

_FINISH 一个

文档

加载

完成

文档 ID 文档加载结果，

参考 TcResult

中的定义

NULL

COMPT_MSG_DS_XML_ON_OPE

N

Andr

oid 打

开文

档返

回 ID

文档 ID NA NULL

5.7 白板




COMPT_MSG_WB_ON_DOC_NEW 新建一个白板文档成

功或下载到一个白板

文档头

文档 ID 保留 ConfExtendDsDocInfoMsg

COMPT_MSG_WB_ON_PAGE_NEW 新建一页成功或下载

到一个页头


COMPT_MSG_WB_ON_CURRENT_P

AGE_IND 收到同步翻页信息

（收到此消息底层并

未实际翻页，上层需

要指定），收到此消

息不应该再调用同步

翻页


COMPT_MSG_WB_ON_CURRENT_P

AGE 当前文档或当前页发

生变化


COMPT_MSG_WB_ON_DRAW_DAT

A_NOTIFY 界面更新通知，上层

收到该消息后应该调

用 ds_get_surfacebmp

获取数据去渲染






91

COMPT_MSG_WB_XML_ON_NEW_

DOC Android 新建文档后

返回 ID

文档 ID NULL

COMPT_MSG_WB_XML_ON_NEW_

PAGE Android 新建页后返

回页 ID


5.8 即时消息




COMPT_MSG_CHAT_ON_RECV_M

SG 收到即时消息通

知（消息的接收

者会收到该消

息）

0 0 ConfExtendChatMsg





92

6 回调类说明

6.1 会议控制

6.1.1 ConfExtendParamMsg

会议全局参数回调类

paramName 全局参数名称

paramData 参数值，二进制

6.1.2 ConfExtendUserDataMsg

用户数据回调类。

fromuserid 发送者用户 ID

msgtype 消息类型

userData 数据

6.1.3 ConfExtendUserInfoMsg

用户信息回调类。

userid 用户的 Id

deviceType 用户设备类型

osType 用户设备操作系统类型





93

userPresenceFlag 状态

userCapability 能力

userStatus

userName 用户名称

userUri 用户 URI

userInfo 用户扩展数据

6.2 屏幕共享

6.2.1 ConfExtendAsChannelMsg

屏幕共享加入、退出通道回调类。

action 加入或者退出

6.2.2 ConfExtendAsMouseMsg

屏幕共享鼠标动作回调类。

msgtype 鼠标消息

wparam 鼠标消息参数，同 Windows 消息参数

lparam 鼠标消息参数，同 Windows 消息参数

6.2.3 ConfExtendAsParamMsg

获取屏幕共享相关参数回调类，参考 tup_conf_as_getparam

ulPorpType 参数类型

ulParam1 参数 1

ulParam2 参数 2





94

lfParam1 参数 3

6.2.4 ConfExtendAsPrivilegeMsg

屏幕共享赋予/收回远程控制权限回调类。

userid 获得/被收回共享权限的用户 Id

6.2.5 ConfExtendAsScreenSizeMsg

屏幕共享屏幕尺寸回调类，当对方上报屏幕尺寸时调用此类。

screenWidth 屏幕宽度

screenHeight 屏幕高度

6.2.6 ConfExtendAsSessionMsg

屏幕共享共享通道通知回调类。共享端发生变化时，调用此类。

userid 共享端用户 Id

6.3 白板共享

6.3.1 ConfExtendDsNewDocMsg

新建空白文档回调类。

docId 新建文档的 Id

userId 用户 Id

docName 新建文档的名称

6.3.2 ConfExtendFlowControlMsg

流控回调类。

tcpLatency 网络延迟





95

tcpJitter 网络抖动

tcpSendRate 网络发送频率

tcpSendDelay 网络发送延迟

tcpRmtSendRate 远程发送频率

tcpRmtSendDelay 远程发送延迟

6.4 文件

6.4.1 ConfExtendFtFileInfoMsg

fileName 文件名

filePathName 文件路径

senderUserName 发送方用户名

senderUserId 发送方用户 Id

recieverUserId 接收方用户 Id

size 文件大小

status 状态

6.5 音频

6.5.1 ConfExtendMaxVoiceMsg

会场允许最大打开麦克风数量回调类。

maxVoiceUsers 会场允许最大打开麦克风数量





96

6.6 视频

6.6.1 ConfExtendVideoDeviceInfoMsg

视频设备信息回调类。

userid 视频用户 Id

deviceId 视频设备 Id

deviceName 频设备的名称

deivceStatus 视频设备的状态

deviceType 视频设备的类型

deviceIndex 视频设备的索引

isInsert

6.6.2 ConfExtendVideoParamMsg

视频参数回调类。

deviceId 视频设备 Id

xresolution 水平方向的分辨率

yresolution 垂直方向的分辨率

feamerate 帧率

bitrate 带宽

fecValue 冗余数

会议组件接口参考...2016/06/24 · espace desktop v200r001c50 产品概述 目 录...

Documents

会议组件接口参考...2016/06/24 · espace desktop v200r001c50 产品概述目录...