更新时间:2019-12-10
业务类别 |
数据结构 |
---|---|
组件初始化与配置 |
|
登录和注销 |
|
音视频通话 |
|
音视频会议 |
|
数据会议 |
|
通讯录 |
|
参数名 |
类型 |
描述 |
---|---|---|
client_type |
终端类型 |
|
product_name |
TSDK_CHAR[] |
产品信息,如:"SoftClient on Desktop" |
device_sn |
TSDK_CHAR[] |
设备sn号,可选参数 |
support_audio_and_video_call |
TSDK_BOOL |
是否支持音视频呼叫 |
support_audio_and_video_conf |
TSDK_BOOL |
是否支持音视频会议 |
support_data_conf |
TSDK_BOOL |
是否支持数据会议 |
support_ctd |
TSDK_BOOL |
是否支持点击呼叫 |
support_im |
TSDK_BOOL |
是否支持即时消息 |
support_rich_media_message |
TSDK_BOOL |
是否支持富媒体消息 |
support_enterprise_address_book |
TSDK_BOOL |
是否支持企业通讯录 |
support_svc_conf_caps |
TSDK_BOOL |
是否支持SVC(多流)会议能力 |
参数名 |
类型 |
描述 |
---|---|---|
level |
日志级别 |
|
max_size_kb |
TSDK_INT32 |
每个日志文件的最大值,单位: KB,最大10*1024 KB |
file_count |
TSDK_INT32 |
日志文件个数,最大值为所能取到的最大值,建议为4 |
path |
TSDK_CHAR[] |
日志存放路径 |
参数名 |
类型 |
描述 |
---|---|---|
ca_cert_path |
TSDK_CHAR[] |
ca根证书存储路径 |
client_cert_path |
TSDK_CHAR[] |
客户端证书存储路径 |
client_key_path |
TSDK_CHAR[] |
客户端私钥存储路径 |
client_privkey_pwd |
TSDK_CHAR[] |
客户端私钥密码 |
verify_mode |
认证模式 |
|
verify_server_mode |
校验服务器模式 |
参数名 |
类型 |
描述 |
---|---|---|
user_name |
TSDK_CHAR[] |
帐户用户名 |
password |
TSDK_CHAR[] |
帐户密码 |
proxy_uri |
TSDK_CHAR[] |
服务器地址 |
proxy_port |
TSDK_UINT16 |
代理服务器端口号 |
参数名 |
类型 |
描述 |
---|---|---|
sip_transport_mode |
信令传输模式,默认值为TSDK_E_SIP_TRANSPORT_UDP |
|
media_srtp_mode |
媒体SRTP模式,默认值为TSDK_E_MEDIA_SRTP_MODE_DISABLE |
|
security_tunnel_mode |
安全隧道使用模式 |
|
is_apply_config_priority |
TSDK_BOOL |
是否使用应用程序配置,默认使用鉴权过程下发的业务配置或系统默认配置。 |
变量名 |
类型 |
描述 |
---|---|---|
sip_server_udp_port |
TSDK_UINT16 |
SIP服务器的UDP端口,在is_apply_config_priority为TRUE时有效。 |
sip_server_tls_port |
TSDK_UINT16 |
SIP服务器的TLS端口,在is_apply_config_priority为TRUE时有效。 |
sip_server_tcp_port |
TSDK_UINT16 |
SIP服务器的TCP端口,在is_apply_config_priority为TRUE时有效。 |
参数名 |
类型 |
描述 |
---|---|---|
icon_file_path |
TSDK_CHAR[] |
头像文件保存路径 |
dept_file_path |
TSDK_CHAR[] |
部门查询结果文件保存路径 |
变量名 |
类型 |
描述 |
---|---|---|
push_operation |
Push操作类型 |
|
enable_no_push_by_time |
TSDK_BOOL |
是否开启时段免打扰(根据时间段屏蔽Push),默认为False,不开启 |
no_push_start_time |
TSDK_CHAR[] |
免打扰开始时间,格式为00:00的24小时制的UTC时间字符串,如:"13:00" |
no_push_end_time |
TSDK_CHAR[] |
免打扰结束时间,格式为00:00的24小时制的UTC时间字符串,如:"14:00" |
变量名 |
类型 |
描述 |
---|---|---|
app_id |
TSDK_UINT32 |
应用ID |
language |
语言类型 |
|
push_token |
TSDK_CHAR[] |
Push Token |
push_class_name |
TSDK_CHAR[] |
Android App启动的第一个activity类路径 |
heart_beat_time |
TSDK_UINT32 |
安卓后台进程心跳超时时长 |
变量名 |
类型 |
描述 |
---|---|---|
app_id |
TSDK_UINT32 |
应用ID |
language |
语言类型 |
|
apns_env_type |
苹果推送服务器环境类型 |
|
apns_cert_type |
苹果推送服务证书类型 |
|
device_token |
TSDK_CHAR[] |
设备Push Token |
voip_token |
TSDK_CHAR[] |
Voip业务Push Token |
push_im_active |
TSDK_CHAR[] |
IM通知栏或者透传action |
push_voip_active |
TSDK_CHAR[] |
VOIP后台来电 action |
参数名 |
类型 |
描述 |
---|---|---|
user_id |
TSDK_UINT32 |
用户id,需要APP生成 |
auth_type |
鉴权类型 |
|
user_name |
TSDK_CHAR[] |
帐户用户名,鉴权类型为TSDK_E_AUTH_NORMAL时填写 |
password |
TSDK_CHAR[] |
帐户密码,鉴权类型为TSDK_E_AUTH_NORMAL时填写 |
user_ticket |
TSDK_CHAR* |
Ticket值,鉴权类型为TSDK_E_AUTH_TICKET时填写, 最大64K字节 |
server_type |
服务器类型,当前仅支持TSDK_E_SERVER_TYPE_PORTAL |
|
server_version |
TSDK_CHAR[] |
服务器版本 |
server_addr |
TSDK_CHAR[] |
服务器地址 |
server_port |
TSDK_UINT16 |
服务器端口号 |
参数名 |
类型 |
描述 |
---|---|---|
e_server_uri |
TSDK_CHAR[] |
eServer服务器(IM业务服务器)地址 |
maa_server_uri |
TSDK_CHAR[] |
MAA服务器地址 |
push_server_uri |
TSDK_CHAR[] |
Push服务器地址 |
account |
TSDK_CHAR[] |
帐号 |
password |
TSDK_CHAR[] |
密码 |
token |
TSDK_CHAR[] |
U-Portal token鉴权 |
参数名 |
类型 |
描述 |
---|---|---|
server_addr |
TSDK_CHAR |
服务器地址 |
server_port |
TSDK_UINT16 |
服务器端口号 |
参数名 |
类型 |
描述 |
---|---|---|
server_addr_info_num |
TSDK_UINT32 |
服务器数量 |
server_addr_info |
服务器地址信息 |
参数名 |
类型 |
描述 |
---|---|---|
firewall_mode |
防火墙模式,外网接入时必选 |
|
stg |
stg服务器信息,外网接入时必选 |
|
sip_stg |
sip stg服务器信息,外网接入时必选 |
|
e_server_stg |
通过STG接入的内网eServer地址,外网接入时必选 |
|
maa_stg |
通过STG接入的内网MAA地址,外网接入时必选 |
|
ms_stg |
通过STG接入的内网MS地址,外网接入时必选 |
|
svn |
SVN代理服务器地址 |
|
https_proxy |
HTTPS反向代理地址 |
参数名 |
类型 |
描述 |
---|---|---|
account |
TSDK_CHAR |
帐号 |
number |
TSDK_CHAR |
voip 注册号码 |
terminal |
TSDK_CHAR |
terminal 号码(短号) |
参数名 |
类型 |
描述 |
---|---|---|
conf_env_type |
会议组网类型 |
|
left_days_of_password |
TSDK_UINT32 |
登录密码剩余有效期天数 |
is_first_login |
TSDK_BOOL |
是否首次登录 |
is_free_user |
TSDK_BOOL |
是否免费用户 |
参数名 |
类型 |
描述 |
---|---|---|
account |
TSDK_CHAR |
帐号 |
region_id |
TSDK_INT32 |
区域ID |
last_login_addr |
TSDK_CHAR |
上一次登录的地址 |
last_login_time |
TSDK_CHAR |
上一次登录的时间 |
um_server_login_token |
TSDK_CHAR |
UM服务器(富媒体服务器)登录Token |
terminal_login_info_list |
同时登录的终端信息列表(暂不支持,预留) |
参数名 |
类型 |
描述 |
---|---|---|
call_id |
TSDK_UINT32 |
呼叫id |
is_caller |
TSDK_BOOL |
是否为主叫 |
is_video_call |
TSDK_BOOL |
是否为视频呼叫 |
peer_number |
TSDK_CHAR[] |
对端号码 |
peer_display_name |
TSDK_CHAR[] |
对端名称 |
call_state |
呼叫状态 |
|
is_auto_answer |
TSDK_BOOL |
是否为自动应答 |
is_focus |
TSDK_BOOL |
是否带isfoucs标识 |
conf_id |
TSDK_CHAR[] |
会议id |
reason_code |
TSDK_UINT32 |
原因码 |
reason_description |
TSDK_CHAR[] |
原因描述 |
参数名 |
类型 |
描述 |
---|---|---|
coordinate_x |
TSDK_INT32 |
X 轴 |
coordinate_y |
TSDK_INT32 |
Y 轴 |
coordinate_w |
TSDK_INT32 |
宽 |
coordinate_h |
TSDK_INT32 |
高 |
coordinate_z |
TSDK_INT32 |
Z轴 |
参数名 |
类型 |
描述 |
---|---|---|
video_wnd_type |
视频窗口类型 |
|
coordinate |
坐标信息 |
|
render |
TSDK_UPTR |
窗口句柄 |
index |
TSDK_INT32 |
窗口序号 |
session_id |
TSDK_UINT32 |
本地预览session值 |
ref_count |
TSDK_UINT32 |
使用引用计数 |
display_mode |
显示模式 |
|
start_image_file_path |
TSDK_CHAR[] |
视频显示初始图像,必须为jpeg图像,且长宽都是8的倍数 |
参数名 |
类型 |
描述 |
---|---|---|
operation |
TSDK_UINT32 |
操作动作,取值:TSDK_E_VIDEO_CTRL_OPERATION_ACT,可以使用逻辑运算符"|"连接,open|start,close|stop |
object |
TSDK_UINT32 |
视频控制对象,取值: TSDK_E_VIDEO_CTRL_OBJ,可以使用逻辑运算符"|"连接 |
is_sync |
TSDK_BOOL |
是否使用同步执行,ios8.3使用异步,否则在切后台时调用该接口会被系统迅速挂起导致崩溃卡死 |
参数名 |
类型 |
描述 |
---|---|---|
index |
TSDK_UINT32 |
设备索引 |
device_name |
TSDK_CHAR[] |
设备名称 |
camera_orient |
TSDK_UINT32 |
摄像头角度,仅移动平台摄像头设备有值 |
参数名 |
类型 |
描述 |
---|---|---|
choice |
TSDK_UINT32 |
视频横竖屏情况 1:竖屏;2:横屏;3:反向横屏 |
portrait |
TSDK_UINT32 |
竖屏视频捕获(逆时针旋转)角度 0:0度;1:90度;2:180度;3:270度 |
landscape |
TSDK_UINT32 |
横屏视频捕获(逆时针旋转)角度 0:0度;1:90度;2:180度;3:270度 |
seascape |
TSDK_UINT32 |
反向横屏视频捕获(逆时针旋转)角度 0:0度;1:90度;2:180度;3:270度 |
参数名 |
类型 |
描述 |
---|---|---|
render_type |
窗口类型枚举值 |
|
display_type |
窗口显示模式 0:拉伸模式 1:(不拉伸)黑边模式 2:(不拉伸)裁剪模式 3:(需保证窗口尺寸 >= 图像尺寸)按原始分辨率显示 |
|
mirror_type |
窗口镜像模式 0:不做镜像(默认值) 1:垂直镜像(X轴镜像)(目前未支持) 2:水平镜像(Y轴镜像) |
参数名 |
类型 |
描述 |
---|---|---|
account |
TSDK_CHAR[] |
帐号 |
number |
TSDK_CHAR[] |
voip 注册号码 |
terminal |
TSDK_CHAR[] |
terminal 号码(短号) |
参数名 |
类型 |
描述 |
---|---|---|
call_id |
TSDK_UINT32 |
呼叫ID |
is_fouces |
TSDK_BOOL |
是否带isfoucs标识,移动会议场景使用 |
orient_type |
移动视频横竖屏情况 |
|
local_addr |
TSDK_INT8[] |
本地地址 |
remote_addr |
TSDK_INT8[] |
移动上报远端地址 |
reinvite_type |
主被叫控业务中Reinvite消息指示的事件类型 |
|
audio_send_mode |
音频媒体方向 |
|
video_send_mode |
视频媒体方向 |
|
data_send_mode |
辅流媒体方向 |
|
is_low_bw_switch_to_audio |
TSDK_BOOL |
是否是由低带宽造成的视频切换到音频 |
参数名 |
类型 |
描述 |
---|---|---|
call_id |
TSDK_UINT32 |
呼叫ID |
media_type |
媒体类型1 : 音频。 2 : 视频。 3 : 辅流 |
|
codec_type |
TSDK_UINT32 |
编解码器类型 1 : 编码器。2 : 解码器 |
codec_name |
TSDK_CHAR[] |
编解码名称 |
参数名 |
类型 |
描述 |
---|---|---|
audio_anr |
TSDK_UINT32 |
音频配置:噪音抑制,[0,4] 0:关闭 1-4:数值越大,噪音抑制强度越大 默认2 |
audio_aec |
TSDK_BOOL |
音频配置:回声消除,0关闭 1开启,默认开启,建议开启 |
audio_agc |
TSDK_BOOL |
音频配置:自动增益,0关闭 1开启,默认开启,建议开启 |
video_arq |
TSDK_BOOL |
视频配置:是否开启丢包重传,0关闭 1开启,默认开启 |
video_tactic |
TSDK_UINT32 |
视频配置:策略 0 图像质量优先 1 流畅优先,默认图像质量优先 |
video_avg_bit_rate |
TSDK_UINT32 |
视频配置:平均码率,单位:bps,取值[min_bit_rate, max_bit_rate],默认值4096 |
video_min_bit_rate |
TSDK_UINT32 |
视频配置:最小码率(可选),单位:bps,取值[10, avg_bit_rate],默认值10 |
video_max_bit_rate |
TSDK_UINT32 |
视频配置:最大码率(可选),单位:bps,取值[avg_bit_rate, 30000],默认值30000 |
video_max_bandwidth |
TSDK_UINT32 |
视频配置:最大带宽,单位:kbps,取值[64, 2048],默认值1920 |
video_frame_size |
TSDK_UINT32 |
视频配置:编码分辨率,取值TSDK_E_VIDEO_FRAME_SIZE |
video_frame_rate |
TSDK_UINT32 |
视频配置:帧率,单位:fps,取值[1, 30],默认值30 |
video_min_frame_rate |
TSDK_UINT32 |
视频配置:最小帧率,单位:fps,取值[1, FrameRate],默认值15 |
参数名 |
类型 |
描述 |
---|---|---|
render |
TSDK_UPTR |
窗口句柄 |
label |
TSDK_UINT32 |
SVC Label |
width |
TSDK_UINT32 |
分辨率:宽 |
height |
TSDK_UINT32 |
分辨率:高 |
max_bandwidth |
TSDK_UINT32 |
多流接收方向每一路流的最大带宽 |
is_sharpness |
TSDK_BOOL |
是否使用锐化模式 |
is_sync |
TSDK_BOOL |
是否使用同步执行,ios 平台应用切后台时使用,默认 TSDK_FALSE |
参数名 |
类型 |
描述 |
---|---|---|
nego_bandwidth |
TSDK_INT32 |
会话协商出的带宽 |
nego_audio_codec |
TSDK_CHAR |
会话协商出的所支持的音频编解码列表 |
nego_video_codec |
TSDK_CHAR |
会话协商出的所支持的视频编解码列表 |
effective_bitrate |
TSDK_UINT32 |
有效带宽(组件探测出的下行方向总tmmbr) |
audio_stream_info |
音频流信息 |
|
video_stream_info |
单流视频流信息 |
|
is_svc_conf |
TSDK_INT32 |
是否多流视频会议 |
svc_stream_count |
TSDK_INT32 |
多流视频流信息数 |
svc_stream_info |
多流视频流信息 |
参数名 |
类型 |
描述 |
---|---|---|
is_srtp |
TSDK_BOOL |
是否启用SRTP, 取值: 0 RTP, 1 SRTP |
encode_protocol |
TSDK_CHAR |
编码协议描述 |
send_bit_rate |
TSDK_UINT32 |
发送比特率(kbps) |
send_loss_fraction |
TSDK_FLOAT |
发送方丢包率(%) |
send_delay |
TSDK_FLOAT |
发送方平均时延(ms) |
send_jitter |
TSDK_FLOAT |
发送方平均抖动(ms) |
decode_protocol |
TSDK_CHAR |
解码协议名 |
recv_bit_rate |
TSDK_UINT32 |
接收比特率(kbps) |
recv_loss_fraction |
TSDK_FLOAT |
接收方丢包率(%) |
recv_delay |
TSDK_FLOAT |
接收方平均时延(ms) |
recv_jitter |
TSDK_FLOAT |
接收方平均抖动(ms) |
recv_average_mos |
TSDK_FLOAT |
接收方向MOS分平均值,用浮点数表示:取值范围[0, 5], 0表示该参数无效 |
参数名 |
类型 |
描述 |
---|---|---|
is_srtp |
TSDK_BOOL |
是否启用SRTP, 取值: 0 RTP, 1 SRTP |
bandwidth |
TSDK_UINT32 |
有效带宽 |
encode_protocol |
TSDK_CHAR |
编码协议描述 |
send_bit_rate |
TSDK_UINT32 |
发送比特率(kbps) |
send_frame_size |
TSDK_CHAR |
发送(编码)图像分辨率描述 |
send_frame_rate |
TSDK_UINT32 |
发送(编码)视频帧率 |
send_loss_fraction |
TSDK_FLOAT |
发送方丢包率(%) |
send_delay |
TSDK_FLOAT |
发送方平均时延(ms) |
send_jitter |
TSDK_FLOAT |
发送方平均抖动(ms) |
decode_protocol |
TSDK_CHAR |
解码协议名 |
recv_bit_rate |
TSDK_UINT32 |
接收比特率(kbps) |
recv_frame_size |
TSDK_CHAR |
接收(解码)图像分辨率描述 |
recv_frame_rate |
TSDK_UINT32 |
接收(解码)视频帧率 |
recv_loss_fraction |
TSDK_FLOAT |
接收方丢包率(%) |
recv_delay |
TSDK_FLOAT |
接收方平均时延(ms) |
recv_jitter |
TSDK_FLOAT |
接收方平均抖动(ms) |
recv_ssrc_label |
TSDK_UINT32 |
接收方对应的ssrc label, 多流时有效 |
参数名 |
类型 |
描述 |
---|---|---|
number |
TSDK_CHAR[] |
号码 |
display_name |
TSDK_CHAR[] |
可选,与会者显示名称 |
account_id |
TSDK_CHAR[] |
可选,用户帐号,预约会议时若不填写,则该用户无法查询到 |
|
TSDK_CHAR[] |
可选,电子邮箱地址 |
sms |
TSDK_CHAR[] |
可选,短信通知手机号码 |
role |
会议成员角色 |
参数名 |
类型 |
描述 |
---|---|---|
size |
TSDK_UINT32 |
会议方数 |
subject |
TSDK_CHAR[] |
会议主题 |
group_uri |
TSDK_CHAR[] |
可选,群组uri |
start_time |
TSDK_CHAR[] |
可选,会议开始时间,格式:YYYY-MM-DD HH:MM,立即会议时无需填写 |
duration |
TSDK_UINT32 |
可选,会议持续时长,单位: 分钟,默认60分钟 |
conf_type |
会议类型 |
|
conf_media_type |
媒体类型 |
|
is_hd_conf |
TSDK_BOOL |
可选,是否高清视频会议 |
is_multi_stream_conf |
TSDK_BOOL |
可选,是否为多流视频会议,预留 |
is_auto_record |
TSDK_BOOL |
可选,会议是否自动启动录制,预留 |
is_auto_prolong |
TSDK_BOOL |
可选,是否自动延长会议 |
is_auto_invite |
TSDK_BOOL |
可选,预约会议到时间之后是否自动拉起 |
is_auto_mute |
TSDK_BOOL |
可选,非主席在入会后是否自动闭音 |
welcome_prompt |
可选,入会提示音类型 |
|
enter_prompt |
可选,有成员入会提示音类型 |
|
leave_prompt |
可选,有成员离会提示音类型 |
|
reminder |
可选,会议提醒方式 |
|
language |
可选,会议的默认语言 |
|
conf_encrypt_mode |
可选,会议媒体加密模式 |
|
record_mode |
可选,会议媒体录制模式 |
|
attendee_num |
TSDK_UINT32 |
与会者数量 |
attendee_list |
与会者列表 |
参数名 |
类型 |
描述 |
---|---|---|
size |
TSDK_UINT32 |
会议方数 |
conf_id |
TSDK_CHAR[] |
会议id |
subject |
TSDK_CHAR[] |
会议主题 |
access_number |
TSDK_CHAR[] |
会议接入码 |
chairman_pwd |
TSDK_CHAR[] |
主席密码,在EC会议下,查询会议列表时不能获取,需要通过查询会议详情获取 |
guest_pwd |
TSDK_CHAR[] |
来宾密码,在EC会议下,查询会议列表时不能获取,需要通过查询会议详情获取 |
start_time |
TSDK_CHAR[] |
会议开始时间 |
end_time |
TSDK_CHAR[] |
会议结束时间 |
conf_media_type |
媒体类型 |
|
is_hd_conf |
TSDK_BOOL |
是否高清视频会议 |
conf_state |
会议状态 |
|
record_mode |
会议媒体录制模式 |
|
scheduser_account |
TSDK_CHAR[] |
预订者帐号 |
scheduser_name |
TSDK_CHAR[] |
预订者姓名 |
token |
TSDK_CHAR[] |
会控token 仅入驻式融合会议有效 |
chair_join_uri |
TSDK_CHAR[] |
主持人加入会议uri链接 |
guest_join_uri |
TSDK_CHAR[] |
来宾加入会议uri链接 |
参数名 |
类型 |
描述 |
---|---|---|
participant_id |
TSDK_CHAR[] |
与会者唯一标识 |
data_user_id |
TSDK_UINT32 |
与会者在数据会议中的用户ID |
state |
用户状态 |
|
is_self |
TSDK_BOOL |
是否自己 |
is_mute |
TSDK_BOOL |
是否闭音 |
is_handup |
TSDK_BOOL |
是否举手 |
is_broadcast |
TSDK_BOOL |
是否被广播 |
is_video |
TSDK_BOOL |
是否视频方式加入会议 |
is_join_dataconf |
TSDK_BOOL |
是否已加入数据会议 |
is_present |
TSDK_BOOL |
是否主讲人 |
has_camera |
TSDK_BOOL |
是否有摄像头 |
is_only_in_data_conf |
TSDK_BOOL |
是否仅在数据会议中 |
is_anonymous |
TSDK_BOOL |
是否匿名用户(匿名方式加入会议) |
is_share_owner |
TSDK_BOOL |
是否共享的拥有者 |
is_be_watching |
TSDK_BOOL |
是否被本地观看状态,SVC会议下有效 |
参数名 |
类型 |
描述 |
---|---|---|
operation_type |
会控操作类型 |
|
reason_code |
TSDK_INT32 |
操作失败原因码 |
description |
TSDK_CHAR[] |
操作失败原因描述 |
参数名 |
类型 |
描述 |
---|---|---|
conf_right |
会议权限 |
|
is_include_end |
TSDK_BOOL |
是否包含已结束的会议 |
page_index |
TSDK_UINT32 |
指定返回的会议列表页页面索引, 索引取值从1开始 |
page_size |
TSDK_UINT32 |
指定每页返回的会议记录数,每页最多返回400个 |
参数名 |
类型 |
描述 |
---|---|---|
total_count |
TSDK_UINT32 |
会议总个数 |
current_count |
TSDK_UINT32 |
当前返回会议个数 |
conf_info_list |
当前返回会议列表 |
参数名 |
类型 |
描述 |
---|---|---|
conf_id |
TSDK_CHAR[] |
会议id |
page_index |
TSDK_UINT32 |
指定返回的与会者列表页的页面索引, 索引取值从1开始 |
page_size |
TSDK_UINT32 |
指定每页返回与会者的记录数,每页最多返回400个 |
sub_conf_id |
TSDK_CHAR[ |
周期会议子会议id(预留,暂不支持) |
参数名 |
类型 |
描述 |
---|---|---|
conf_info |
会议信息 |
|
attendee_num |
TSDK_UINT32 |
与会者数量 |
attendee_list |
与会者列表 |
参数名 |
类型 |
描述 |
---|---|---|
call_id |
TSDK_UINT32 |
呼叫ID,软终端号码入会时有效 |
conf_media_type |
媒体类型 |
|
is_hd_conf |
TSDK_BOOL |
是否高清视频会议 |
conf_env_type |
会议组网类型 |
|
is_svc_conf |
TSDK_BOOL |
是否多流会议 |
svc_label_count |
TSDK_INT8 |
多流Label有效个数 |
svc_label |
TSDK_UINT32[TSDK_D_MAX_SVC_LABEL_NUM] |
多流Label对应的ssrc值 |
参数名 |
类型 |
描述 |
---|---|---|
size |
TSDK_UINT32 |
会议方数 |
conf_id |
TSDK_CHAR[] |
会议id |
subject |
TSDK_CHAR[] |
会议主题 |
group_uri |
TSDK_CHAR[] |
群组uri |
conf_media_type |
媒体类型 |
|
is_hd_conf |
TSDK_BOOL |
是否高清视频会议 |
conf_state |
会议状态 |
|
scheduser_account |
TSDK_CHAR[] |
预订者帐号 |
scheduser_name |
TSDK_CHAR[] |
预订者姓名 |
is_record |
TSDK_BOOL |
会场是否为录播状态 |
is_lock |
TSDK_BOOL |
会场是否为锁定状态 |
is_all_mute |
TSDK_BOOL |
会场是否为静音状态 |
update_type |
成员更新方式 |
|
attendee_num |
TSDK_UINT32 |
与会者数量 |
attendee_list |
与会者列表 |
|
is_live_broadcast |
TSDK_BOOL |
会场是否为直播状态 |
is_support_live_broadcast |
TSDK_BOOL |
是否支持直播 |
is_support_record_broadcast |
TSDK_BOOL |
是否支持录播 |
参数名 |
类型 |
描述 |
---|---|---|
conf_id |
TSDK_CHAR[] |
会议id |
access_number |
TSDK_CHAR[] |
会议接入码 |
conf_password |
TSDK_CHAR[] |
会议密码 |
参数名 |
类型 |
描述 |
---|---|---|
watch_attendee_num |
TSDK_UINT32 |
被选看的与会者个数 |
watch_attendee_list |
被选看的与会者信息列表 |
参数名 |
类型 |
描述 |
---|---|---|
number |
TSDK_CHAR[] |
号码 |
label |
TSDK_UINT32 |
SVC Label,SVC 会议功能时有效 |
width |
TSDK_UINT32 |
分辨率:宽,SVC 会议功能时有效 |
height |
TSDK_UINT32 |
分辨率:高,SVC 会议功能时有效 |
参数名 |
类型 |
描述 |
---|---|---|
conf_id |
TSDK_CHAR[] |
会议id |
host_key |
TSDK_CHAR[] |
主持人密码:主持人入会必须设置,其他情况不需要 |
crypt_key |
TSDK_CHAR[] |
会议鉴权密码 |
cm_address |
TSDK_CHAR[] |
sip网关地址及端口 |
site_url |
TSDK_CHAR[] |
会议站点地址 |
site_id |
TSDK_CHAR[] |
站点ID |
server_ip |
TSDK_CHAR[] |
会议服务器地址,单个地址或URL |
user_id |
TSDK_CHAR[] |
用户id |
user_name |
TSDK_CHAR[] |
用户名 |
user_uri |
TSDK_CHAR[] |
用户uri |
conf_name |
TSDK_CHAR[] |
会议名称 |
access_code |
TSDK_CHAR[] |
会议接入码 |
part_secure_conf_num |
TSDK_CHAR[] |
与会者安全会议号 |
stg_server_address |
TSDK_CHAR[] |
stg服务器地址 |
sbc_server_address |
TSDK_CHAR[] |
sbc服务器地址 |
user_role |
TSDK_UINT32 |
会议成员角色 |
mcu_number |
TSDK_UINT32 |
MCU 号 |
terminal_number |
TSDK_UINT32 |
Terminal 号 |
pin_code |
TSDK_CHAR[] |
pin code 码 |
participant_id |
TSDK_CHAR[] |
与会者 id |
short_user_name |
TSDK_CHAR[] |
用户名称(取user_name的前63个字节) |
short_conf_name |
TSDK_CHAR[] |
会议名称(取conf_name的前63个字节) |
参数名 |
类型 |
描述 |
---|---|---|
base_info |
与会者基础信息 |
|
status_info |
与会者状态信息 |
|
is_speaking |
TSDK_BOOL |
是否发言 |
speaking_volume |
TSDK_UINT32 |
音量 |
参数名 |
类型 |
描述 |
---|---|---|
conf_media_type |
媒体类型 |
|
is_hd_conf |
TSDK_BOOL |
是否高清视频会议 |
number |
TSDK_CHAR[] |
来电号码 |
subject |
TSDK_CHAR[] |
会议主题 |
group_uri |
TSDK_CHAR[] |
群组uri |
conf_id |
TSDK_CHAR[] |
会议id |
参数名 |
类型 |
描述 |
---|---|---|
user_id |
TSDK_UINT32 |
用户id,需要APP生成 |
conf_id |
TSDK_CHAR[] |
会议id |
conf_password |
TSDK_CHAR[] |
会议密码 |
display_name |
TSDK_CHAR[] |
可选,与会者显示名称 |
server_addr |
TSDK_CHAR[] |
会议服务器地址 |
server_port |
TSDK_UINT16 |
服务器端口号 |
参数名 |
类型 |
描述 |
---|---|---|
label |
TSDK_UINT32 |
SVC Label,SVC 会议功能时有效 |
base_info |
与会者基础信息 |
|
status_info |
与会者状态信息 |
参数名 |
类型 |
描述 |
---|---|---|
watch_attendee_num |
TSDK_UINT32 |
观看的与会者画面信息个数 |
watch_attendees |
TSDK_S_CONF_SVC_WATCH_ATTENDEE[TSDK_D_MAX_SVC_STREAM_NUM] |
观看的与会者画面信息列表 |
参数名 |
类型 |
描述 |
---|---|---|
data_format |
屏幕数据格式 |
|
data |
TSDK_VOID * |
屏幕数据 |
update_info |
TSDK_VOID * |
留待扩展使用 |
参数名 |
类型 |
描述 |
---|---|---|
window_handle |
TSDK_VOID* |
应用程序窗口句柄 |
window_title |
TSDK_UINT16* |
窗口名称 |
small_icon_handle |
TSDK_VOID* |
ICON图标Handle |
is_checked |
TSDK_BOOL |
是否被选中 取值;true为被选中,false为没有被选中 |
参数名 |
类型 |
描述 |
---|---|---|
type |
TSDK_UINT32 |
参数类型 |
data_len |
TSDK_UINT32 |
参数数据长度 |
data |
TSDK_VOID* |
参数数据 |
参数名 |
类型 |
描述 |
---|---|---|
document_id |
TSDK_UINT32 |
文档ID |
page_count |
TSDK_UINT32 |
页数 |
document_name |
TSDK_CHAR[] |
文档名称 |
参数名 |
类型 |
描述 |
---|---|---|
component_id |
组件ID |
|
document_id |
TSDK_UINT32 |
文档ID |
page_index |
TSDK_INT32 |
页面索引 |
page_count |
TSDK_INT32 |
文档总页数 |
参数名 |
类型 |
描述 |
---|---|---|
doc_page_info |
文档页信息,目前标注支持文档共享和白板 |
|
width |
TSDK_INT32 |
当前页的宽 |
height |
TSDK_INT32 |
当前页的高 |
org_x |
TSDK_INT32 |
服务器上的该页起点X会标 |
org_y |
TSDK_INT32 |
服务器上的该页起点Y会标 |
rotate_type |
服务器上的该页旋转类型 |
|
zoom_percent |
TSDK_FLOAT |
该页的缩放比例 |
is_copied |
TSDK_UCHAR |
该页是否复制的页 |
is_e_pen_drawn |
TSDK_UCHAR |
该页是否被电子白板画过 |
参数名 |
类型 |
描述 |
---|---|---|
doc_base_info |
文档页信息,目前标注支持文档共享和白板 |
|
doc_del_number |
TSDK_CHAR[] |
文档拥有者的号码 |
doc_del_display_name |
TSDK_CHAR[] |
显示的文档名称 |
doc_del_attendee |
删除文档的与会者的详细信息 |
参数名 |
类型 |
描述 |
---|---|---|
display_size |
激光点显示尺寸 |
|
is_local |
TSDK_BOOL |
是否本地化图片(即由客户端固化打包,不需要经过网络传输),0表示普通图片,1表示本地化图片 |
local_index |
TSDK_UINT32 |
当is_local为1时有效,表示对应的本地化图片的索引,该索引用于底层向上层取数据 |
pic_format |
is_local为0时有效,表示图片格式 |
|
data |
TSDK_VOID* |
当is_local为0时有效,存放普通图片的数据,is_local为1时,可以为NULL |
data_len |
TSDK_UINT32 |
当bLocal为0时有效,存放图片数据的长度 |
pic_width |
TSDK_INT32 |
当is_local为0时有效,图片宽 |
pic_high |
TSDK_INT32 |
当is_local为0时有效,图片高 |
offset |
相对于图片左上角的偏移,TWIP为单位,用于缩放时用于计算图片位置的参照点 |
参数名 |
类型 |
描述 |
---|---|---|
bounds |
外接矩形 |
|
text_string |
TSDK_CHAR* |
标注文本,utf8字符串 |
font |
TSDK_CHAR* |
字体名 |
color |
TSDK_UINT32 |
文字颜色(RGBA),0xRRGGBBAA表示,其中AA为透明值,目前应该全部传FF |
size |
TSDK_UINT32 |
字体大小 |
参数名 |
类型 |
描述 |
---|---|---|
left |
TSDK_INT32 |
矩形左侧x坐标 |
top |
TSDK_INT32 |
矩形顶部y坐标 |
right |
TSDK_INT32 |
矩形右侧x坐标 |
bottom |
TSDK_INT32 |
矩形下部y坐标 |
参数名 |
类型 |
描述 |
---|---|---|
component_id |
组件ID |
|
doc_page_info |
文档页信息,目前标注支持文档共享和白板 |
|
point |
要判断的点,以TWIPS以单位,且必须是相对于页面原点无缩放的坐标 |
|
hit_test_mode |
测试模式 |
|
user_number |
TSDK_CHAR[] |
用户号码,当hit_test_mode为TSDK_E_ANNOTATION_HIT_SET_OTHERS、TSDK_E_ANNOTATION_HIT_SET_SOMEONE时有效 |
参数名 |
类型 |
描述 |
---|---|---|
component_id |
组件ID |
|
doc_page_info |
文档页信息,目前标注支持文档共享和白板 |
|
rectangle_area |
要测试的矩形区域 |
|
hit_test_mode |
测试模式 |
|
user_number |
TSDK_CHAR[] |
用户号码,当hit_test_mode为TSDK_E_ANNOTATION_HIT_SET_OTHERS、TSDK_E_ANNOTATION_HIT_SET_SOMEONE时有效 |
参数名 |
类型 |
描述 |
---|---|---|
component_id |
组件ID |
|
doc_page_info |
文档页信息,目前标注支持文档共享和白板 |
|
start_point |
起始点 |
|
end_point |
结束点 |
|
hit_test_mode |
测试式 |
|
user_number |
TSDK_CHAR[] |
用户号码,当hit_test_mode为TSDK_E_ANNOTATION_HIT_SET_OTHERS、TSDK_E_ANNOTATION_HIT_SET_SOMEONE时有效 |
参数名 |
类型 |
描述 |
---|---|---|
component_id |
组件ID |
|
doc_page_info |
文档页信息,目前标注支持文档共享和白板 |
|
annotation_id_list |
TSDK_UINT32* |
要设置的标注元素id的数组 |
count |
TSDK_UINT32 |
annotation_id_list中的元素个数 |
select_mode |
选中的模式 |
|
creator_number |
TSDK_CHAR[] |
用户号码,当select_mode为TSDK_E_ANNOTATION_SELECT_OTHERS、TSDK_E_ANNOTATION_SELECT_SOMEONE时有效 |
参数名 |
类型 |
描述 |
---|---|---|
component_id |
组件ID |
|
doc_page_info |
文档页信息,目前标注支持文档共享和白板 |
|
annotation_id_list |
TSDK_UINT32* |
要设置的标注元素id的数组 |
count |
TSDK_UINT32 |
annotation_id_list中的元素个数 |
参数名 |
类型 |
描述 |
---|---|---|
bounds |
外接矩形 |
|
main_type |
标注类型 |
|
sub_type |
TSDK_UINT32 |
标注子类型 |
creator_number |
TSDK_CHAR[] |
创建者号码 |
flag |
TSDK_UINT32 |
该子类型标注的属性,所有互通终端需要相同 |
参数名 |
类型 |
描述 |
---|---|---|
style |
画笔样式 |
|
color |
TSDK_UINT32 |
颜色(RGBA),0xRRGGBBAA表示 |
width |
TSDK_INT32 |
画笔宽度 |
参数名 |
类型 |
描述 |
---|---|---|
style |
画刷样式 |
|
color |
TSDK_UINT32 |
颜色(RGBA),0xRRGGBBAA表示 |
参数名 |
类型 |
描述 |
---|---|---|
chat_type |
消息类型,当前仅支持TSDK_E_CONF_CHAT_PUBLIC |
|
reviciver_number |
TSDK_CHAR[] |
消息接收者号码,当前仅支持发送公共消息,无需填写,预留 |
sender_number |
TSDK_CHAR[] |
发送者的号码(接收消息携带,发送消息时无需填写) |
sender_display_name |
TSDK_CHAR[] |
发送者的名称(接收消息携带,发送消息时无需填写) |
sender |
发送者详细信息(接收消息携带,发送消息时无需填写) |
|
chat_msg |
TSDK_CHAR* |
消息内容 |
chat_msg_len |
TSDK_UINT32 |
消息内容长度 |
sender_display_name |
TSDK_CHAR[] |
发送者的名称 |
time |
TSDK_LONG |
消息发送时服务器时间(接收消息携带,发送消息时无需填写) |
参数名 |
类型 |
描述 |
---|---|---|
wb_base_info |
文档基础信息 |
|
wb_del_number |
TSDK_CHAR |
删除白板的与会者的号码 |
wb_del_display_name |
TSDK_CHAR |
删除白板的与会者的名称 |
wb_del_attendee |
删除白板的与会者的详细信息 |
参数名 |
类型 |
描述 |
---|---|---|
is_local |
TSDK_BOOL |
是否本地化图片(即由客户端固化打包,不需要经过网络传输),0表示普通图片,1表示本地化图片 |
local_index |
TSDK_UINT32 |
当is_local为1时有效,表示对应的本地化图片的索引,该索引用于底层向上层取数据 |
pic_format |
当is_local为0时有效,表示图片格式 |
|
data |
TSDK_VOID* |
当is_local为0时有效,存放普通图片的数据,is_local为1时,可以为NULL |
data_len |
TSDK_UINT32 |
当bLocal为0时有效,存放图片数据的长度 |
pic_width |
TSDK_INT32 |
当is_local为0时有效,图片宽 |
pic_high |
TSDK_INT32 |
当is_local为0时有效,图片高 |
display_area |
TSDK_S_RECTANGULAR |
图片显示区域,当bLocal为1时,dispRect的宽高必须与初始化资源时传入的显示宽高相同 |
offset |
TSDK_S_POINT |
相对于图片左上角的偏移,TWIP为单位,用于缩放时用于计算图片位置的参照点 |
参数名 |
类型 |
描述 |
---|---|---|
share_status |
共享状态 |
|
component_id |
TSDK_UINT32 |
正在共享的组件ID,取值TSDK_E_COMPONENT_ID |
sharing_number |
TSDK_CHAR |
正在共享的与会者的号码 |
sharing_display_name |
TSDK_CHAR |
正在共享的与会者的名称 |
sharing_attendee |
正在共享的与会者的详细信息 |
参数名 |
类型 |
描述 |
---|---|---|
width |
TSDK_UINT32 |
虚拟显示器的宽度 |
height |
TSDK_UINT32 |
虚拟显示器的高度 |
bit_count |
TSDK_UINT32 |
虚拟显示器图像每个像素的位数 |
参数名 |
类型 |
描述 |
---|---|---|
y_data |
TSDK_UINT8* |
图片明亮度(Luminance)信息 |
cb_cr_data |
TSDK_UINT8* |
图片色度(Chrominance)信息 |
y_data_size |
TSDK_UINT32 |
图片明亮度(Luminance)信息长度 |
cb_cr_data_size |
TSDK_UINT32 |
图片色度(Chrominance)信息长度 |
width |
TSDK_UINT32 |
图片宽度(单位:ppi) |
height |
TSDK_UINT32 |
图片高度(单位:ppi) |
orientation |
TSDK_E_IMAGE_ORIENTATION |
图片方向 |
参数名 |
类型 |
描述 |
---|---|---|
status |
TSDK_UINT32 |
状态,不涉及:0,发送数据:1,接收数据:2 |
send_frame_size_width |
TSDK_UINT32 |
发送(编码)视频分辨率-宽 |
send_frame_size_height |
TSDK_UINT32 |
发送(编码)视频分辨率-高 |
send_bit_rate |
TSDK_UINT32 |
发送(编码)码率(bps) |
send_frame_rate |
TSDK_UINT32 |
发送(编码)视频帧率 |
encode_version |
TSDK_UINT32 |
编码协议版本 |
send_pkt_loss |
TSDK_FLOAT |
发送方丢包率(0.xx%);-1表示未启用该参数 |
send_rtt |
TSDK_UINT32 |
发送方环路时延(ms);0表示未启用该参数;不支持获取平均值、最大值和最小值 |
send_jitter |
TSDK_UINT32 |
发送方抖动(ms);0表示未启用该参数;不支持获取平均值、最大值和最小值 |
recv_frame_size_width |
TSDK_UINT32 |
接收(解码)视频分辨率-宽 |
recv_frame_size_height |
TSDK_UINT32 |
接收(解码)视频分辨率-高 |
recv_bit_rate |
TSDK_UINT32 |
接收(解码)码率(bps) |
recv_frame_rate |
TSDK_UINT32 |
接收(解码)视频帧率 |
decode_version |
TSDK_UINT32 |
解码协议版本 |
recv_pkt_loss |
TSDK_FLOAT |
接收方丢包率(0.xx%);-1表示未启用该参数 |
recv_rtt |
TSDK_UINT32 |
接收方环路时延(ms);0表示未启用该参数;不支持获取平均值、最大值和最小值 |
recv_jitter |
TSDK_UINT32 |
接收方抖动(ms);0表示未启用该参数;不支持获取平均值、最大值和最小值 |
参数名 |
类型 |
描述 |
---|---|---|
small_icon_path |
TSDK_CHAR[] |
小头像路径+文件名 |
medium_icon_path |
TSDK_CHAR[] |
中头像路径+文件名 |
large_icon_path |
TSDK_CHAR[] |
大头像路径+文件名 |
参数名 |
类型 |
描述 |
---|---|---|
search_keyword |
TSDK_CHAR[] |
搜索关键字 |
page_index |
TSDK_UINT32 |
当前需要查找的页数 |
is_exact_search |
TSDK_BOOL |
是否精确查找,取值:
|
department_id |
TSDK_CHAR[] |
可选,部门ID,若填写则在指定部门下查找 |
seq_no |
TSDK_UINT32 |
查询序号 |
参数名 |
类型 |
描述 |
---|---|---|
staff_account |
TSDK_CHAR[] |
UC帐号 |
person_name |
TSDK_CHAR[] |
姓名 |
staff_no |
TSDK_CHAR[] |
工号 |
terminal |
TSDK_CHAR[] |
IP号码 软终端号码 |
terminal2 |
TSDK_CHAR[] |
软终端公网长号 |
department_name |
TSDK_CHAR[] |
部门名字 |
title |
TSDK_CHAR[] |
职务 |
mobile |
TSDK_CHAR[] |
手机号码 |
home_phone |
TSDK_CHAR[] |
家庭电话 |
|
TSDK_CHAR[] |
邮箱 |
office_phone |
TSDK_CHAR[] |
座机号码 办公电话 |
office_phone2 |
TSDK_CHAR[] |
硬终端2 |
office_phone3 |
TSDK_CHAR[] |
硬终端3 |
office_phone4 |
TSDK_CHAR[] |
硬终端4 |
office_phone5 |
TSDK_CHAR[] |
硬终端5 |
office_phone6 |
TSDK_CHAR[] |
硬终端6 |
other_phone |
TSDK_CHAR[] |
其他电话 |
other_phone2 |
TSDK_CHAR[] |
其他电话2 |
gender |
TSDK_CHAR[] |
性别 |
zip_code |
TSDK_CHAR[] |
邮编 |
address |
TSDK_CHAR[] |
地址 |
signature |
TSDK_CHAR[] |
签名 |
参数名 |
类型 |
描述 |
---|---|---|
page |
TSDK_UINT32 |
当前页码 |
total_num |
TSDK_UINT32 |
联系人总数 |
contact_info |
联系人信息 |
|
current_num |
TSDK_UINT32 |
当前查询结果数 |
参数名 |
类型 |
描述 |
---|---|---|
icon_id |
TSDK_UINT32 |
系统头像id |
icon_path |
TSDK_CHAR[] |
自定义头像文件路径 |
参数名 |
类型 |
描述 |
---|---|---|
department_id |
TSDK_CHAR[] |
部门id |
parent_id |
TSDK_CHAR[] |
父节点id |
department_name |
TSDK_CHAR[] |
部门名称 |