数据结构

ApplicationItem

白板应用

被如下接口引用：DescribeApplicationInfos。

名称	类型	描述
SdkAppId	Integer	应用SdkAppId
AppName	String	应用名
CreateTime	Timestamp	创建时间
TagList	Array of Tag	标签列表

AuthParam

鉴权参数

被如下接口引用：StartWhiteboardPush。

名称	类型	必选	描述
SdkAppId	Integer	是	应用SdkAppId 示例值：12345678
UserId	String	是	用户ID 示例值：userid
UserSig	String	是	用户ID对应的签名 示例值：usersig

Canvas

混流画布参数

被如下接口引用：CreateVideoGenerationTask, StartOnlineRecord。

名称	类型	必选	描述
LayoutParams	LayoutParams	是	混流画布宽高配置
BackgroundColor	String	否	背景颜色，默认为黑色，格式为RGB格式，如红色为"#FF0000"

Concat

实时录制视频拼接参数

被如下接口引用：CreateVideoGenerationTask, StartOnlineRecord。

名称	类型	必选	描述
Enabled	Boolean	是	是否开启拼接功能 在开启了视频拼接功能的情况下，实时录制服务会把同一个用户因为暂停导致的多段视频拼接成一个视频
Image	String	否	视频拼接时使用的垫片图片下载地址，不填默认用全黑的图片进行视频垫片

CustomLayout

自定义混流布局参数

被如下接口引用：CreateVideoGenerationTask, StartOnlineRecord。

名称	类型	必选	描述
Canvas	Canvas	是	混流画布参数
InputStreamList	Array of StreamLayout	是	流布局参数，每路流的布局不能超出画布区域

DataItem

画图数据，Time/Value/Details

被如下接口引用：DescribeApplicationUsage。

名称	类型	描述
Time	String	时间 按月格式yyyy-mm 按天格式yyyy-mm-dd 按分钟格式 yyyy-mm-dd HH:MM:SS
Value	Integer	画图所需要的值
Details	Array of Detail	各个具体指标的详情

Detail

计费用量数据里，带不同指标Tag的详情

被如下接口引用：DescribeApplicationUsage。

名称	类型	描述
TagName	String	用量指标
Weight	Float	用量权重
Value	Float	用量的值

ExcelParam

Excel转码相关参数

被如下接口引用：CreateTranscode。

名称	类型	必选	描述
PaperSize	Integer	否	表格转码纸张（画布）大小，默认为0。 0 -- A4 1 -- A2 2 -- A0 注：当设置的值超出合法取值范围时，将采用默认值。 示例值：0
PaperDirection	Integer	否	表格文件转换纸张方向，默认为0。 0 -- 代表垂直方向 非0 -- 代表水平方向 示例值：0

Interrupt

实时录制中出现的用户视频流断流次数统计

被如下接口引用：DescribeOnlineRecord。

名称	类型	描述
UserId	String	用户ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：tiw_user_634
Count	Integer	视频流断流次数 注意：此字段可能返回 null，表示取不到有效值。 示例值：2

LayoutParams

自定义混流配置布局参数

被如下接口引用：CreateVideoGenerationTask, StartOnlineRecord。

名称	类型	必选	描述
Width	Integer	是	流画面宽，取值范围[2,3000]
Height	Integer	是	流画面高，取值范围[2,3000]
X	Integer	否	当前画面左上角顶点相对于Canvas左上角顶点的x轴偏移量，默认为0，取值范围[0,3000]
Y	Integer	否	当前画面左上角顶点相对于Canvas左上角顶点的y轴偏移量，默认为0， 取值范围[0,3000]
ZOrder	Integer	否	画面z轴位置，默认为0 z轴确定了重叠画面的遮盖顺序，z轴值大的画面处于顶层

MixStream

混流配置

被如下接口引用：CreateVideoGenerationTask, StartOnlineRecord。

名称	类型	必选	描述
Enabled	Boolean	是	是否开启混流
DisableAudio	Boolean	否	是否禁用音频混流
ModelId	Integer	否	内置混流布局模板ID, 取值 [1, 2], 区别见内置混流布局模板样式示例说明 在没有填Custom字段时候，ModelId是必填的
TeacherId	String	否	老师用户ID 此字段只有在ModelId填了的情况下生效 填写TeacherId的效果是把指定为TeacherId的用户视频流显示在内置模板的第一个小画面中
Custom	CustomLayout	否	自定义混流布局参数 当此字段存在时，ModelId 及 TeacherId 字段将被忽略

OmittedDuration

拼接视频中被忽略的时间段

被如下接口引用：DescribeOnlineRecord, DescribeRecordSearch。

名称	类型	描述
VideoTime	Integer	录制暂停时间戳对应的视频播放时间(单位: 毫秒)
PauseTime	Integer	录制暂停时间戳(单位: 毫秒)
ResumeTime	Integer	录制恢复时间戳(单位: 毫秒)

PPTErr

PPT错误元素

被如下接口引用：DescribePPTCheck。

名称	类型	描述
Name	String	元素名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：Ink 1
Type	Integer	0: 不支持的墨迹类型，1: 不支持自动翻页，2: 存在已损坏音视频，3: 存在不可访问资源，4: 只读文件 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
Detail	String	错误详情 注意：此字段可能返回 null，表示取不到有效值。 示例值：wps墨迹

PPTErrSlide

PPT错误页面列表

被如下接口引用：DescribePPTCheck。

名称	类型	描述
Page	String	异常元素存在的页面，由页面类型+页码组成，页码类型包括：幻灯片、幻灯片母版、幻灯片布局等 注意：此字段可能返回 null，表示取不到有效值。 示例值：幻灯片1
Errs	Array of PPTErr	错误元素列表 注意：此字段可能返回 null，表示取不到有效值。

RecordControl

录制控制参数， 用于指定全局录制控制及具体流录制控制参数，比如设置需要对哪些流进行录制，是否只录制小画面等

被如下接口引用：CreateVideoGenerationTask, StartOnlineRecord。

名称	类型	必选	描述
Enabled	Boolean	是	设置是否开启录制控制参数，只有设置为true的时候，录制控制参数才生效。
DisableRecord	Boolean	否	设置是否禁用录制的全局控制参数。一般与StreamControls参数配合使用。 true - 所有流都不录制。 false - 所有流都录制。默认为false。 这里的设置对所有流都生效，如果同时在 StreamControls 列表中针对指定流设置了控制参数，则优先采用StreamControls中设置的控制参数。
DisableAudio	Boolean	否	设置是否禁用所有流的音频录制的全局控制参数。一般与StreamControls参数配合使用。 true - 所有流的录制都不对音频进行录制。 false - 所有流的录制都需要对音频进行录制。默认为false。 这里的设置对所有流都生效，如果同时在 StreamControls 列表中针对指定流设置了控制参数，则优先采用StreamControls中设置的控制参数。
PullSmallVideo	Boolean	否	设置是否所有流都只录制小画面的全局控制参数。一般与StreamControls参数配合使用。 true - 所有流都只录制小画面。设置为true时，请确保上行端在推流的时候同时上行了小画面，否则录制视频可能是黑屏。 false - 所有流都录制大画面，默认为false。 这里的设置对所有流都生效，如果同时在 StreamControls 列表中针对指定流设置了控制参数，则优先采用StreamControls中设置的控制参数。
StreamControls	Array of StreamControl	否	针对具体流指定控制参数，如果列表为空，则所有流采用全局配置的控制参数进行录制。列表不为空，则列表中指定的流将优先按此列表指定的控制参数进行录制。

RecordTaskResult

实时录制结果

被如下接口引用：DescribeRecordSearch。

名称	类型	描述
FinishReason	String	AUTO - 自动停止录制， USER_CALL - 用户主动调用停止录制
ExceptionCnt	Integer	异常数
RoomId	Integer	房间号
GroupId	String	分组
RecordStartTime	Integer	录制真实开始时间
RecordStopTime	Integer	录制结束时间
TotalTime	Integer	录制总时长
VideoInfos	Array of VideoInfo	视频信息列表
OmittedDurations	Array of OmittedDuration	被忽略的视频时间段
Details	String	详情
ErrorCode	Integer	任务失败错误码
ErrorMsg	String	错误信息

RecordTaskSearchResult

实时录制任务搜索结果

被如下接口引用：DescribeRecordSearch。

名称	类型	描述
TaskId	String	任务唯一ID
Status	String	实时录制任务状态 - PAUSED: 录制已暂停 - PREPARED: 录制在准备阶段 - RECORDING: 正在录制 - STOPPED：录制已停止 - FINISHED: 录制已结束
RoomId	Integer	实时录制房间号
CreateTime	Timestamp ISO8601	任务创建时间
SdkAppId	Integer	用户应用SdkAppId
Result	RecordTaskResult	实时录制结果

RoomListItem

日志查询里返回的白板房间数据

被如下接口引用：DescribeRoomList。

名称	类型	必选	描述
RoomId	String	是	房间ID 示例值：100000
StartTime	Integer	是	房间在查询时间段内最早出现的时间，Unix时间戳，单位毫秒 示例值：1614519034000
EndTime	Integer	是	房间在查询时间段内最晚出现的时间，Unix时间戳，单位毫秒 示例值：1614519034000
UserNumber	Integer	是	房间里成员数 示例值：100

RoomUsageDataItem

互动白板房间用量信息

被如下接口引用：DescribeTIWRoomDailyUsage。

名称	类型	描述
Time	String	日期，格式为YYYY-MM-DD 示例值：2021-10-01
SdkAppId	Integer	白板应用SDKAppID 示例值：1400000001
SubProduct	String	互动白板子产品，请求参数传入的一致 - sp_tiw_board: 互动白板时长 - sp_tiw_ric: 实时录制时长 示例值：sp_tiw_board
Value	Float	用量值 - 白板时长、实时录制时长单位为分钟 示例值：100000
RoomID	Integer	互动白板房间号 示例值：12345

RunningTaskItem

正在运行的任务列表项

被如下接口引用：DescribeRunningTasks。

名称	类型	描述
SdkAppID	Integer	应用SdkAppID 示例值：1400000001
TaskID	String	任务ID 示例值：0agdnligqtgtvkm65emb
TaskType	String	任务类型 - TranscodeH5: 动态转码任务，文档转HTML5页面 - TranscodeJPG: 静态转码任务，文档转图片 - WhiteboardPush: 白板推流任务 - OnlineRecord: 实时录制任务 示例值：WhiteboardPush
CreateTime	String	任务创建时间 示例值：2023-03-14 15:00:00
CancelTime	String	任务取消时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-03-14 20:00:00
Status	String	任务状态 - QUEUED: 任务正在排队等待执行中 - PROCESSING: 任务正在执行中 - FINISHED: 任务已完成 示例值：QUEUED
Progress	Integer	任务当前进度 示例值：50
FileURL	String	转码任务中转码文件的原始URL 此参数只有任务类型为TranscodeH5、TranscodeJPG类型时才会有有效值。其他任务类型为空字符串。 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://xxx.pptx
RoomID	Integer	房间号 当任务类型为TranscodeH5、TranscodeJPG时，房间号为0。 注意：此字段可能返回 null，表示取不到有效值。 示例值：12345

SnapshotCOS

板书文件存储cos参数

被如下接口引用：CreateSnapshotTask。

名称	类型	必选	描述
Uin	Integer	是	cos所在腾讯云账号uin 示例值：100006912345
Region	String	是	cos所在地区 示例值：ap-guangzhou
Bucket	String	是	cos存储桶名称 示例值：examplebucket-1250000000
TargetDir	String	否	板书文件存储根目录 示例值：snapshot
Domain	String	否	CDN加速域名 示例值：xxxx.file.qcloud.com

SnapshotResult

白板板书结果

被如下接口引用：DescribeSnapshotTask。

名称	类型	描述
ErrorCode	String	任务执行错误码 注意：此字段可能返回 null，表示取不到有效值。 示例值：InternalErr
ErrorMessage	String	任务执行错误信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：redis connect failed
Total	Integer	快照生成图片总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：12
Snapshots	Array of String	快照图片链接列表 注意：此字段可能返回 null，表示取不到有效值。

SnapshotWhiteboard

生成白板板书时的白板参数，例如白板宽高等

被如下接口引用：CreateSnapshotTask。

名称	类型	必选	描述
Width	Integer	否	白板宽度大小，默认为1280，有效取值范围[0，2560] 示例值：1280
Height	Integer	否	白板高度大小，默认为720，有效取值范围[0，2560] 示例值：960
InitParams	String	否	白板初始化参数的JSON转义字符串，透传到白板 SDK 示例值：{"ratio":"4:3"}

StreamControl

指定流录制的控制参数，比如是否禁用音频、视频是录制大画面还是录制小画面等

被如下接口引用：CreateVideoGenerationTask, StartOnlineRecord。

名称	类型	必选	描述
StreamId	String	是	视频流ID 视频流ID的取值含义如下： 1. tic_record_user - 表示白板视频流 2. tic_substream - 表示辅路视频流 3. 特定用户ID - 表示指定用户的视频流 在实际录制过程中，视频流ID的匹配规则为前缀匹配，只要真实流ID的前缀与指定的流ID一致就认为匹配成功。
DisableRecord	Boolean	否	设置是否对此路流开启录制。 true - 表示不对这路流进行录制，录制结果将不包含这路流的视频。 false - 表示需要对这路流进行录制，录制结果会包含这路流的视频。 默认为 false。
DisableAudio	Boolean	否	设置是否禁用这路流的音频录制。 true - 表示不对这路流的音频进行录制，录制结果里这路流的视频将会没有声音。 false - 录制视频会保留音频，如果设置为true，则录制视频会丢弃这路流的音频。 默认为 false。
PullSmallVideo	Boolean	否	设置当前流录制视频是否只录制小画面。 true - 录制小画面。设置为true时，请确保上行端同时上行了小画面，否则录制视频可能是黑屏。 false - 录制大画面。 默认为 false。

StreamLayout

流布局参数

被如下接口引用：CreateVideoGenerationTask, StartOnlineRecord。

名称	类型	必选	描述
LayoutParams	LayoutParams	是	流布局配置参数
InputStreamId	String	否	视频流ID 流ID的取值含义如下： 1. tic_record_user - 表示当前画面用于显示白板视频流 2. tic_substream - 表示当前画面用于显示辅路视频流 3. 特定用户ID - 表示当前画面用于显示指定用户的视频流 4. 不填 - 表示当前画面用于备选，当有新的视频流加入时，会从这些备选的空位中选择一个没有被占用的位置来显示新的视频流画面
BackgroundColor	String	否	背景颜色，默认为黑色，格式为RGB格式，如红色为"#FF0000"
FillMode	Integer	否	视频画面填充模式。 0 - 自适应模式，对视频画面进行等比例缩放，在指定区域内显示完整的画面。此模式可能存在黑边。 1 - 全屏模式，对视频画面进行等比例缩放，让画面填充满整个指定区域。此模式不会存在黑边，但会将超出区域的那一部分画面裁剪掉。

Tag

标签

被如下接口引用：CreateApplication, DescribeApplicationInfos。

名称	类型	必选	描述
TagKey	String	是	标签键
TagValue	String	是	标签值

TimeValue

查询指标返回的时间序列

被如下接口引用：DescribeQualityMetrics。

名称	类型	描述
Time	Integer	Unix时间戳，单位秒 示例值：1617883200
Value	Float	查询指标对应当前时间的值 示例值：100

TranscodeTaskResult

转码任务结果

被如下接口引用：DescribeTranscodeSearch。

名称	类型	描述
ResultUrl	String	转码结果地址
Resolution	String	分辨率
Title	String	标题（一般为文件名）
Pages	Integer	转码页数
ThumbnailUrl	String	缩略图URL前缀，比如，该URL前缀为http://example.com/g0jb42ps49vtebjshilb/，那么动态PPT第1页的缩略图URL为 http://example.com/g0jb42ps49vtebjshilb/1.jpg，其它页以此类推 如果发起文档转码请求参数中带了ThumbnailResolution参数，并且转码类型为动态转码，该参数不为空，其余情况该参数为空字符串
ThumbnailResolution	String	动态转码缩略图生成分辨率
CompressFileUrl	String	转码压缩文件下载的URL，如果发起文档转码请求参数中CompressFileType为空或者不是支持的压缩格式，该参数为空字符串
ErrorCode	Integer	任务失败错误码
ErrorMsg	String	任务失败错误信息

TranscodeTaskSearchResult

转码任务搜索结果

被如下接口引用：DescribeTranscodeSearch。

名称	类型	描述
CreateTime	Timestamp ISO8601	任务创建时间
TaskId	String	任务唯一ID
Status	String	任务的当前状态 - QUEUED: 正在排队等待转换 - PROCESSING: 转换中 - FINISHED: 转换完成
OriginalFilename	String	转码文件原始名称
SdkAppId	Integer	用户应用SdkAppId
Result	TranscodeTaskResult	转码任务结果
IsStatic	Boolean	是否静态转码

UsageDataItem

互动白板用量信息

被如下接口引用：DescribeTIWDailyUsage。

名称	类型	描述
Time	String	日期，格式为YYYY-MM-DD 示例值：2021-10-01
SdkAppId	Integer	白板应用SDKAppID 示例值：1400000001
SubProduct	String	互动白板子产品，请求参数传入的一致 - sp_tiw_board: 互动白板时长 - sp_tiw_dt: 动态转码页数 - sp_tiw_st: 静态转码页数 - sp_tiw_ric: 实时录制时长 示例值：sp_tiw_board
Value	Float	用量值 - 静态转码、动态转码单位为页 - 白板时长、实时录制时长单位为分钟 示例值：100000

UserListItem

日志查询里返回的白板用户数据

被如下接口引用：DescribeUserList。

名称	类型	必选	描述
UserId	String	是	房间内的用户ID 示例值：100000
StartTime	Integer	是	用户在查询时间段内最早出现的时间，Unix时间戳，单位毫秒 示例值：1614519034000
EndTime	Integer	是	用户在查询时间段内最晚出现的时间，Unix时间戳，单位毫秒 示例值：1614519034000

VideoInfo

视频信息

被如下接口引用：DescribeOnlineRecord, DescribeRecordSearch, DescribeVideoGenerationTask。

名称	类型	描述
VideoPlayTime	Integer	视频开始播放的时间（单位：毫秒）
VideoSize	Integer	视频大小（字节）
VideoFormat	String	视频格式
VideoDuration	Integer	视频播放时长（单位：毫秒）
VideoUrl	String	视频文件URL
VideoId	String	视频文件Id
VideoType	Integer	视频流类型 - 0：摄像头视频 - 1：屏幕分享视频 - 2：白板视频 - 3：混流视频 - 4：纯音频（mp3)
UserId	String	摄像头/屏幕分享视频所属用户的 Id（白板视频为空、混流视频tic_mixstream_房间号混流布局类型、辅路视频ticsubstream_用户Id）
Width	Integer	视频分辨率的宽
Height	Integer	视频分辨率的高

Whiteboard

实时录制白板参数，例如白板宽高等

被如下接口引用：CreateVideoGenerationTask, StartOnlineRecord, StartWhiteboardPush。

名称	类型	必选	描述
Width	Integer	否	实时录制结果里白板视频宽，取值必须大于等于2，默认为1280 示例值：1280
Height	Integer	否	实时录制结果里白板视频高，取值必须大于等于2，默认为960 示例值：960
InitParam	String	否	白板初始化参数，透传到白板 SDK

WhiteboardApplicationConfig

白板应用配置，包括资源存储桶，域名，回调地址，回调密钥等

被如下接口引用：DescribeWhiteboardApplicationConfig, ModifyWhiteboardApplicationConfig。

名称	类型	必选	描述
TaskType	String	是	任务类型 recording: 实时录制 transcode: 文档转码
BucketName	String	是	存储桶名字
BucketLocation	String	是	存储桶地域
BucketPrefix	String	是	资源在存储桶中的前缀
ResultDomain	String	是	目标CDN域名
Callback	String	是	回调地址
CallbackKey	String	是	回调鉴权密钥
SdkAppId	Integer	否	配置的应用SdkAppId
AdminUserId	String	否	IM管理员UserId
AdminUserSig	String	否	IM管理员UserSig

WhiteboardPushBackupParam

白板推流备份相关请求参数

被如下接口引用：StartWhiteboardPush。

名称	类型	必选	描述
PushUserId	String	是	用于白板推流服务进房的用户ID， 该ID必须是一个单独的未在SDK中使用的ID，白板推流服务将使用这个用户ID进入房间进行白板推流，若该ID和SDK中使用的ID重复，会导致SDK和录制服务互踢，影响正常推流。
PushUserSig	String	是	与PushUserId对应的签名

WhiteboardPushResult

白板推流任务结果

被如下接口引用：DescribeWhiteboardPushSearch。

名称	类型	描述
FinishReason	String	AUTO - 自动停止推流， USER_CALL - 用户主动调用停止推流
ExceptionCnt	Integer	异常数
RoomId	Integer	房间号
GroupId	String	IM群组ID
PushStartTime	Integer	推流真实开始时间
PushStopTime	Integer	推流结束时间
IMSyncTime	Integer	白板推流首帧对应的IM时间戳，可用于录制回放时IM聊天消息与白板推流视频进行同步对时。
ErrorCode	Integer	任务失败错误码
ErrorMsg	String	错误信息

WhiteboardPushTaskSearchResult

实时录制任务搜索结果

被如下接口引用：DescribeWhiteboardPushSearch。

名称	类型	描述
TaskId	String	任务唯一ID
Status	String	白板推流任务状态 - PREPARED: 推流在准备阶段 - PUSHING: 正在推流 - STOPPED：推流已停止
RoomId	Integer	白板推流房间号
CreateTime	Timestamp ISO8601	任务创建时间
SdkAppId	Integer	用户应用SdkAppId
Result	WhiteboardPushResult	白板推流结果
PushUserId	String	白板推流用户ID