{ "name": "tiw", "display_name": "互动白板", "description": "介绍如何使用API对互动白板进行操作，包括文档转码、实时录制等", "domain": "other", "api_version": "2019-09-19", "endpoint": "tiw.tencentcloudapi.com", "actions": [ { "name": "CreatePPTCheckTask", "description": "检测PPT文件，识别PPT中包含的动态转码任务（Transcode）不支持的元素", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "Url", "type": "string", "required": true, "description": "经过URL编码后的PPT文件地址。URL 编码会将字符转换为可通过因特网传输的格式，例如文档地址为http://example.com/测试.pptx，经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pptx。为了提高URL解析的成功率，请对URL进行编码。", "example": "http://example.com/%E6%B5%8B%E8%AF%95.pptx" }, { "name": "AutoHandleUnsupportedElement", "type": "boolean", "required": false, "description": "是否对不支持元素开启自动处理的功能，默认不开启。 true -- 开启 false -- 不开启 当设置为`true`时，可配合`AutoHandleUnsupportedElementTypes`参数使用，具体有哪些不兼容元素类型，可参考`AutoHandleUnsupportedElementTypes`参数的说明。", "example": "true" }, { "name": "AutoHandleUnsupportedElementTypes", "type": "array", "required": false, "description": "此参数仅在`AutoHandleUnsupportedElement`参数为`true`的情况下有效。 指定需要自动处理的不兼容元素类型，默认对所有不兼容的元素进行自动处理。 目前支持检测的不兼容元素类型及对应的自动处理方式如下： 0: 不支持的墨迹类型 -- 自动处理方式：移除墨迹 1: 自动翻页 -- 自动处理方式：移除自动翻页设置，并修改为单击切换 2: 已损坏音视频 -- 自动处理方式：移除对损坏音视频的...", "example": "[0, 1, 2]", "item_type": "integer" } ], "required": [ "SdkAppId", "Url" ] }, { "name": "CreateSnapshotTask", "description": "创建白板板书生成任务, 在任务结束后，如果提供了回调地址，将通过回调地址通知板书生成结果", "status": "online", "parameters": [ { "name": "Whiteboard", "type": "object", "required": true, "description": "白板相关参数", "example": "无", "children": [ { "name": "Width", "type": "integer", "required": false, "description": "白板宽度大小，默认为1280，有效取值范围[0，2560]", "example": "1280" }, { "name": "Height", "type": "integer", "required": false, "description": "白板高度大小，默认为720，有效取值范围[0，2560]", "example": "960" }, { "name": "InitParams", "type": "string", "required": false, "description": "白板初始化参数的JSON转义字符串，透传到白板 SDK", "example": "{\\\"ratio\\\":\\\"4:3\\\"}" } ] }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "白板房间 `SdkAppId`", "example": "1400124720" }, { "name": "RoomId", "type": "integer", "required": true, "description": "白板房间号", "example": "1234" }, { "name": "CallbackURL", "type": "string", "required": false, "description": "白板板书生成结果通知回调地址", "example": "http://xxx" }, { "name": "COS", "type": "object", "required": false, "description": "白板板书文件 `COS` 存储参数， 不填默认存储在公共存储桶，公共存储桶的数据仅保存3天", "example": "无", "children": [ { "name": "Uin", "type": "integer", "required": true, "description": "cos所在腾讯云账号uin", "example": "100006912345" }, { "name": "Region", "type": "string", "required": true, "description": "cos所在地区", "example": "ap-guangzhou" }, { "name": "Bucket", "type": "string", "required": true, "description": "cos存储桶名称", "example": "examplebucket-1250000000" }, { "name": "TargetDir", "type": "string", "required": false, "description": "板书文件存储根目录", "example": "snapshot" }, { "name": "Domain", "type": "string", "required": false, "description": "CDN加速域名", "example": "xxxx.file.qcloud.com" } ] }, { "name": "SnapshotMode", "type": "string", "required": false, "description": "白板板书生成模式，默认为 `AllMarks`。取值说明如下： `AllMarks` - 全量模式，即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。 `LatestMarksOnly` - 单页去重模式，即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。 （**注意：`LatestMarksOnly` 模式\ufffd\ufffd...", "example": "AllMarks" } ], "required": [ "Whiteboard", "SdkAppId", "RoomId" ] }, { "name": "CreateTranscode", "description": "创建一个文档转码任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "Url", "type": "string", "required": true, "description": "经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式，比如文档地址为http://example.com/测试.pdf，经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率，请对URL进行编码。", "example": "https://path/to/document.ppt" }, { "name": "IsStaticPPT", "type": "boolean", "required": false, "description": "是否为静态PPT，默认为False； 如果IsStaticPPT为False，后缀名为.ppt或.pptx的文档会动态转码成HTML5页面，其他格式的文档会静态转码成图片；如果IsStaticPPT为True，所有格式的文档会静态转码成图片；", "example": "False" }, { "name": "MinResolution", "type": "string", "required": false, "description": "注意: 该参数已废弃, 请使用最新的 [云API SDK](https://cloud.tencent.com/document/api/1137/40060#SDK) ，使用 MinScaleResolution字段传递分辨率 转码后文档的最小分辨率，不传、传空字符串或分辨率格式错误则使用文档原分辨率 示例：1280x720，注意分辨率宽高中间为英文字母\"xyz\"的\"x\"", "example": "960x540" }, { "name": "ThumbnailResolution", "type": "string", "required": false, "description": "动态PPT转码可以为文件生成该分辨率的缩略图，不传、传空字符串或分辨率格式错误则不生成缩略图，分辨率格式同MinResolution", "example": "960x540" }, { "name": "CompressFileType", "type": "string", "required": false, "description": "转码文件压缩格式，不传、传空字符串或不是指定的格式则不生成压缩文件，目前支持如下压缩格式： zip： 生成`.zip`压缩包 tar.gz： 生成`.tar.gz`压缩包", "example": "zip" }, { "name": "ExtraData", "type": "string", "required": false, "description": "内部参数", "example": "空 " }, { "name": "Priority", "type": "string", "required": false, "description": "文档转码优先级， 只有对于PPT动态转码生效，支持填入以下值： - low: 低优先级转码，对于动态转码，能支持500MB（下载超时时间10分钟）以及2000页文档，但资源有限可能会有比较长时间的排队，请酌情使用该功能。 - 不填表示正常优先级转码，支持200MB文件（下载超时时间2分钟），500页以内的文档进行转码 注意：对于PDF等静态文件转码，无论是正常优先级或者低优先级，最\ufffd\ufffd...", "example": "空" }, { "name": "MinScaleResolution", "type": "string", "required": false, "description": "转码后文档的最小分辨率，不传、传空字符串或分辨率格式错误则使用文档原分辨率。 分辨率越高，效果越清晰，转出来的图片资源体积会越大，课件加载耗时会变长，请根据实际使用场景配置此参数。 示例：1280x720，注意分辨率宽高中间为英文字母\"xyz\"的\"x\"", "example": "960x540" }, { "name": "AutoHandleUnsupportedElement", "type": "boolean", "required": false, "description": "此参数仅对动态转码生效。 是否对不支持元素开启自动处理的功能，默认不开启。 true -- 开启 false -- 不开启 当设置为`true`时，可配合`AutoHandleUnsupportedElementTypes`参数使用，具体有哪些不兼容元素类型，可参考`AutoHandleUnsupportedElementTypes`参数的说明。", "example": "true" }, { "name": "AutoHandleUnsupportedElementTypes", "type": "array", "required": false, "description": "此参数仅在`AutoHandleUnsupportedElement`参数为`true`的情况下有效。 指定需要自动处理的不兼容元素类型，默认对所有不兼容的元素进行自动处理。 目前支持检测的不兼容元素类型及对应的自动处理方式如下： 0: 不支持的墨迹类型 -- 自动处理方式：移除墨迹 1: 自动翻页 -- 自动处理方式：移除自动翻页设置，并修改为单击切换 2: 已损坏音视频 -- 自动处理方式：移除对损坏音视频的...", "example": "[0, 1, 2]", "item_type": "integer" }, { "name": "ExcelParam", "type": "object", "required": false, "description": "Excel表格转码参数，可设置转码时表格纸张大小及纸张方向等参数（仅对转码文件为Excel表格文件的静态转码任务生效）", "example": "无", "children": [ { "name": "PaperSize", "type": "integer", "required": false, "description": "表格转码纸张（画布）大小，默认为0。 0 -- A4 1 -- A2 2 -- A0 注：当设置的值超出合法取值范围时，将采用默认值。", "example": "0" }, { "name": "PaperDirection", "type": "integer", "required": false, "description": "表格文件转换纸张方向，默认为0。 0 -- 代表垂直方向 非0 -- 代表水平方向", "example": "0" } ] } ], "required": [ "SdkAppId", "Url" ] }, { "name": "CreateVideoGenerationTask", "description": "创建视频生成任务", "status": "online", "parameters": [ { "name": "OnlineRecordTaskId", "type": "string", "required": true, "description": "实时录制任务的TaskId", "example": "bj0mt2l23osdj300hl30" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "Whiteboard", "type": "object", "required": false, "description": "视频生成的白板参数，例如白板宽高等。 此参数与开始录制接口提供的Whiteboard参数互斥，在本接口与开始录制接口都提供了Whiteboard参数时，优先使用本接口指定的Whiteboard参数进行视频生成，否则使用开始录制接口提供的Whiteboard参数进行视频生成。", "example": "1280*960", "children": [ { "name": "Width", "type": "integer", "required": false, "description": "实时录制结果里白板视频宽，取值必须大于等于2，默认为1280", "example": "1280" }, { "name": "Height", "type": "integer", "required": false, "description": "实时录制结果里白板视频高，取值必须大于等于2，默认为960", "example": "960" }, { "name": "InitParam", "type": "string", "required": false, "description": "白板初始化参数，透传到白板 SDK", "example": "无" } ] }, { "name": "Concat", "type": "object", "required": false, "description": "视频拼接参数 此参数与开始录制接口提供的Concat参数互斥，在本接口与开始录制接口都提供了Concat参数时，优先使用本接口指定的Concat参数进行视频拼接，否则使用开始录制接口提供的Concat参数进行视频拼接。", "example": "否", "children": [ { "name": "Enabled", "type": "boolean", "required": true, "description": "是否开启拼接功能 在开启了视频拼接功能的情况下，实时录制服务会把同一个用户因为暂停导致的多段视频拼接成一个视频" }, { "name": "Image", "type": "string", "required": false, "description": "视频拼接时使用的垫片图片下载地址，不填默认用全黑的图片进行视频垫片" } ] }, { "name": "MixStream", "type": "object", "required": false, "description": "视频生成混流参数 此参数与开始录制接口提供的MixStream参数互斥，在本接口与开始录制接口都提供了MixStream参数时，优先使用本接口指定的MixStream参数进行视频混流，否则使用开始录制接口提供的MixStream参数进行视频拼混流。", "example": "否", "children": [ { "name": "Enabled", "type": "boolean", "required": true, "description": "是否开启混流" }, { "name": "DisableAudio", "type": "boolean", "required": false, "description": "是否禁用音频混流" }, { "name": "ModelId", "type": "integer", "required": false, "description": "内置混流布局模板ID, 取值 [1, 2], 区别见内置混流布局模板样式示例说明 在没有填Custom字段时候，ModelId是必填的" }, { "name": "TeacherId", "type": "string", "required": false, "description": "老师用户ID 此字段只有在ModelId填了的情况下生效 填写TeacherId的效果是把指定为TeacherId的用户视频流显示在内置模板的第一个小画面中" }, { "name": "Custom", "type": "object", "required": false, "description": "自定义混流布局参数 当此字段存在时，ModelId 及 TeacherId 字段将被忽略", "children": [ { "name": "Canvas", "type": "object", "required": true, "description": "混流画布参数", "children": [ { "name": "LayoutParams", "type": "object", "required": true, "description": "混流画布宽高配置" }, { "name": "BackgroundColor", "type": "string", "required": false, "description": "背景颜色，默认为黑色，格式为RGB格式，如红色为\"#FF0000\"" } ] }, { "name": "InputStreamList", "type": "array", "required": true, "description": "流布局参数，每路流的布局不能超出画布区域", "item_type": "object", "children": [ { "name": "LayoutParams", "type": "object", "required": true, "description": "流布局配置参数" }, { "name": "InputStreamId", "type": "string", "required": false, "description": "视频流ID 流ID的取值含义如下： 1. tic_record_user - 表示当前画面用于显示白板视频流 2. tic_substream - 表示当前画面用于显示辅路视频流 3. 特定用户ID - 表示当前画面用于显示指定用户的视频流 4. 不填 - 表示当前画面用于备选，当有新的视频流加入时，会从这些备选的空位中选择一个没有被占用的位置来显示新的视频流画面" }, { "name": "BackgroundColor", "type": "string", "required": false, "description": "背景颜色，默认为黑色，格式为RGB格式，如红色为\"#FF0000\"" }, { "name": "FillMode", "type": "integer", "required": false, "description": "视频画面填充模式。 0 - 自适应模式，对视频画面进行等比例缩放，在指定区域内显示完整的画面。此模式可能存在黑边。 1 - 全屏模式，对视频画面进行等比例缩放，让画面填充满整个指定区域。此模式不会存在黑边，但会将超出区域的那一部分画面裁剪掉。" } ] } ] } ] }, { "name": "RecordControl", "type": "object", "required": false, "description": "视频生成控制参数，用于更精细地指定需要生成哪些流，某一路流是否禁用音频，是否只录制小画面等 此参数与开始录制接口提供的RecordControl参数互斥，在本接口与开始录制接口都提供了RecordControl参数时，优先使用本接口指定的RecordControl参数进行视频生成控制，否则使用开始录制接口提供的RecordControl参数进行视频拼生成控制。", "example": "否", "children": [ { "name": "Enabled", "type": "boolean", "required": true, "description": "设置是否开启录制控制参数，只有设置为true的时候，录制控制参数才生效。" }, { "name": "DisableRecord", "type": "boolean", "required": false, "description": "设置是否禁用录制的全局控制参数。一般与`StreamControls`参数配合使用。 true - 所有流都不录制。 false - 所有流都录制。默认为false。 这里的设置对所有流都生效，如果同时在 `StreamControls` 列表中针对指定流设置了控制参数，则优先采用`StreamControls`中设置的控制参数。" }, { "name": "DisableAudio", "type": "boolean", "required": false, "description": "设置是否禁用所有流的音频录制的全局控制参数。一般与`StreamControls`参数配合使用。 true - 所有流的录制都不对音频进行录制。 false - 所有流的录制都需要对音频进行录制。默认为false。 这里的设置对所有流都生效，如果同时在 `StreamControls` 列表中针对指定流设置了控制参数，则优先采用`StreamControls`中设置的控制参数。" }, { "name": "PullSmallVideo", "type": "boolean", "required": false, "description": "设置是否所有流都只录制小画面的全局控制参数。一般与`StreamControls`参数配合使用。 true - 所有流都只录制小画面。设置为true时，请确保上行端在推流的时候同时上行了小画面，否则录制视频可能是黑屏。 false - 所有流都录制大画面，默认为false。 这里的设置对所有流都生效，如果同时在 `StreamControls` 列表中针对指定流设置了控制参数，则优先采用`StreamControls`中设置的控制参..." }, { "name": "StreamControls", "type": "array", "required": false, "description": "针对具体流指定控制参数，如果列表为空，则所有流采用全局配置的控制参数进行录制。列表不为空，则列表中指定的流将优先按此列表指定的控制参数进行录制。", "item_type": "object", "children": [ { "name": "StreamId", "type": "string", "required": true, "description": "视频流ID 视频流ID的取值含义如下： 1. tic_record_user - 表示白板视频流 2. tic_substream - 表示辅路视频流 3. 特定用户ID - 表示指定用户的视频流 在实际录制过程中，视频流ID的匹配规则为前缀匹配，只要真实流ID的前缀与指定的流ID一致就认为匹配成功。" }, { "name": "DisableRecord", "type": "boolean", "required": false, "description": "设置是否对此路流开启录制。 true - 表示不对这路流进行录制，录制结果将不包含这路流的视频。 false - 表示需要对这路流进行录制，录制结果会包含这路流的视频。 默认为 false。" }, { "name": "DisableAudio", "type": "boolean", "required": false, "description": "设置是否禁用这路流的音频录制。 true - 表示不对这路流的音频进行录制，录制结果里这路流的视频将会没有声音。 false - 录制视频会保留音频，如果设置为true，则录制视频会丢弃这路流的音频。 默认为 false。" }, { "name": "PullSmallVideo", "type": "boolean", "required": false, "description": "设置当前流录制视频是否只录制小画面。 true - 录制小画面。设置为true时，请确保上行端同时上行了小画面，否则录制视频可能是黑屏。 false - 录制大画面。 默认为 false。" } ] } ] }, { "name": "ExtraData", "type": "string", "required": false, "description": "内部参数", "example": "'''" } ], "required": [ "OnlineRecordTaskId", "SdkAppId" ] }, { "name": "DescribeOnlineRecord", "description": "查询录制任务状态与结果", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "TaskId", "type": "string", "required": true, "description": "实时录制任务Id", "example": "ghucnligqtgtvk2624mb" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DescribeOnlineRecordCallback", "description": "查询实时录制回调地址", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用的SdkAppId", "example": "1400000001" } ], "required": [ "SdkAppId" ] }, { "name": "DescribePPTCheck", "description": "查询PPT检测任务的执行进度或结果，支持查询最近半年内的任务结果", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务的唯一标识Id", "example": "g0jb42ps49vtebjshilb" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DescribePPTCheckCallback", "description": "查询PPT检测任务回调地址", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用的SdkAppId", "example": "1400000001" } ], "required": [ "SdkAppId" ] }, { "name": "DescribeRunningTasks", "description": "根据指定的任务类型，获取当前正在执行中的任务列表。只能查询最近3天内创建的任务。", "status": "online", "parameters": [ { "name": "SdkAppID", "type": "integer", "required": true, "description": "应用的SdkAppID", "example": "1400000001" }, { "name": "TaskType", "type": "string", "required": true, "description": "指定需要获取的任务类型。 有效取值如下： - TranscodeH5: 动态转码任务，文档转HTML5页面 - TranscodeJPG: 静态转码任务，文档转图片 - WhiteboardPush: 白板推流任务 - OnlineRecord: 实时录制任务", "example": "WhiteboardPush" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页获取时的任务偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每次获取任务列表时最大获取任务数，默认值为100。 有效取值范围：[1, 500]", "example": "100" } ], "required": [ "SdkAppID", "TaskType" ] }, { "name": "DescribeSnapshotTask", "description": "获取指定白板板书生成任务信息", "status": "online", "parameters": [ { "name": "TaskID", "type": "string", "required": true, "description": "查询任务ID", "example": "f2e1728c-6e87-4481-abe1-cde8542a5a10" }, { "name": "SdkAppId", "type": "integer", "required": true, "description": "任务SdkAppId", "example": "1400124720" } ], "required": [ "TaskID", "SdkAppId" ] }, { "name": "DescribeTranscode", "description": "查询文档转码任务的执行进度与转码结果", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "TaskId", "type": "string", "required": true, "description": "文档转码任务的唯一标识Id", "example": "g0jb42ps49vtebjshilb" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DescribeTranscodeByUrl", "description": "通过文档URL查询转码任务，返回最近一天内最新的转码任务状态", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "Url", "type": "string", "required": true, "description": "经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式，比如文档地址为http://example.com/测试.pdf，经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率，请对URL进行编码。", "example": "https://path/to/document.ppt" } ], "required": [ "SdkAppId", "Url" ] }, { "name": "DescribeTranscodeCallback", "description": "查询文档转码回调地址", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用的SdkAppId", "example": "1400000001" } ], "required": [ "SdkAppId" ] }, { "name": "DescribeVideoGenerationTask", "description": "查询录制视频生成任务状态与结果", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId" }, { "name": "TaskId", "type": "string", "required": true, "description": "录制视频生成的任务Id" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DescribeVideoGenerationTaskCallback", "description": "查询录制视频生成回调地址", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用的SdkAppId" } ], "required": [ "SdkAppId" ] }, { "name": "DescribeWarningCallback", "description": "查询告警回调地址。此功能需要申请白名单使用。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用的SdkAppId", "example": "1400000001" } ], "required": [ "SdkAppId" ] }, { "name": "DescribeWhiteboardPush", "description": "查询推流任务状态与结果", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "TaskId", "type": "string", "required": true, "description": "白板推流任务Id", "example": "ghucnligqtgtvk2624mb" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "DescribeWhiteboardPushCallback", "description": "查询白板推流回调地址", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用的SdkAppId", "example": "1400000001" } ], "required": [ "SdkAppId" ] }, { "name": "PauseOnlineRecord", "description": "暂停实时录制", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId" }, { "name": "TaskId", "type": "string", "required": true, "description": "实时录制任务 Id" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "ResumeOnlineRecord", "description": "恢复实时录制", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId" }, { "name": "TaskId", "type": "string", "required": true, "description": "恢复录制的实时录制任务 Id" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "SetOnlineRecordCallback", "description": "设置实时录制回调地址，回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40258", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "Callback", "type": "string", "required": true, "description": "实时录制任务结果回调地址，如果传空字符串会删除原来的回调地址配置，回调地址仅支持 http或https协议，即回调地址以http://或https://开头。回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40258", "example": "https://example.com/online/callback" } ], "required": [ "SdkAppId", "Callback" ] }, { "name": "SetOnlineRecordCallbackKey", "description": "设置实时录制回调鉴权密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用的SdkAppId" }, { "name": "CallbackKey", "type": "string", "required": true, "description": "设置实时录制回调鉴权密钥，最长64字符，如果传入空字符串，那么删除现有的鉴权回调密钥。回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257" } ], "required": [ "SdkAppId", "CallbackKey" ] }, { "name": "SetPPTCheckCallback", "description": "设置PPT检测任务回调地址，回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40260#c9cbe05f-fe1a-4410-b4dc-40cc301c7b81", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "Callback", "type": "string", "required": true, "description": "进度回调地址，如果传空字符串会删除原来的回调地址配置，回调地址仅支持http或https协议，即回调地址以http://或https://开头。 回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40260#c9cbe05f-fe1a-4410-b4dc-40cc301c7b81", "example": "https://example.com/transcode/callback" } ], "required": [ "SdkAppId", "Callback" ] }, { "name": "SetPPTCheckCallbackKey", "description": "设置PPT检测任务回调密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用的SdkAppId", "example": "1400000001" }, { "name": "CallbackKey", "type": "string", "required": true, "description": "设置回调鉴权密钥，最长64字符，如果传入空字符串，那么删除现有的鉴权回调密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257", "example": "无" } ], "required": [ "SdkAppId", "CallbackKey" ] }, { "name": "SetTranscodeCallback", "description": "设置文档转码回调地址，回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40260", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "Callback", "type": "string", "required": true, "description": "文档转码进度回调地址，如果传空字符串会删除原来的回调地址配置，回调地址仅支持http或https协议，即回调地址以http://或https://开头。 回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40260", "example": "https://example.com/transcode/callback" } ], "required": [ "SdkAppId", "Callback" ] }, { "name": "SetTranscodeCallbackKey", "description": "设置文档转码回调鉴权密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用的SdkAppId" }, { "name": "CallbackKey", "type": "string", "required": true, "description": "设置文档转码回调鉴权密钥，最长64字符，如果传入空字符串，那么删除现有的鉴权回调密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257" } ], "required": [ "SdkAppId", "CallbackKey" ] }, { "name": "SetVideoGenerationTaskCallback", "description": "设置录制视频生成回调地址", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId" }, { "name": "Callback", "type": "string", "required": true, "description": "课后录制任务结果回调地址，如果传空字符串会删除原来的回调地址配置，回调地址仅支持 http或https协议，即回调地址以http://或https://开头" } ], "required": [ "SdkAppId", "Callback" ] }, { "name": "SetVideoGenerationTaskCallbackKey", "description": "设置视频生成回调鉴权密钥", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用的SdkAppId" }, { "name": "CallbackKey", "type": "string", "required": true, "description": "设置视频生成回调鉴权密钥，最长64字符，如果传入空字符串，那么删除现有的鉴权回调密钥" } ], "required": [ "SdkAppId", "CallbackKey" ] }, { "name": "SetWarningCallback", "description": "设置告警回调地址。此功能需要申请白名单使用。", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "Callback", "type": "string", "required": true, "description": "告警回调地址，如果传空字符串会删除原来的回调地址配置，回调地址仅支持http或https协议，即回调地址以http://或https://开头。 回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/90112", "example": "https://example.com/transcode/callback" }, { "name": "CallbackKey", "type": "string", "required": true, "description": "设置告警回调鉴权密钥，最长64字符，如果传入空字符串，那么删除现有的鉴权回调密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257", "example": "123456" } ], "required": [ "SdkAppId", "Callback", "CallbackKey" ] }, { "name": "SetWhiteboardPushCallback", "description": "设置白板推流回调地址，回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40257", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "Callback", "type": "string", "required": true, "description": "白板推流任务结果回调地址，如果传空字符串会删除原来的回调地址配置，回调地址仅支持 http或https协议，即回调地址以http://或https://开头。回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40257", "example": "https://example.com/online/callback" } ], "required": [ "SdkAppId", "Callback" ] }, { "name": "SetWhiteboardPushCallbackKey", "description": "设置白板推流回调鉴权密钥，回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用的SdkAppId" }, { "name": "CallbackKey", "type": "string", "required": true, "description": "设置白板推流回调鉴权密钥，最长64字符，如果传入空字符串，那么删除现有的鉴权回调密钥。回调鉴权方式请参考文档：https://cloud.tencent.com/document/product/1137/40257" } ], "required": [ "SdkAppId", "CallbackKey" ] }, { "name": "StartOnlineRecord", "description": "发起一个实时录制任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "RoomId", "type": "integer", "required": true, "description": "需要录制的白板房间号，取值范围: (1, 4294967295)。 1. 在没有指定`GroupId`的情况下，实时录制默认以`RoomId`的字符串表达形式作为同步白板信令的IM群组ID（比如`RoomId`为12358，则IM群组ID为\"12358\"），并加群进行信令同步，请在开始录制前确保相应IM群组已创建完成，否则会导致录制失败。 2. 在没有指定`TRTCRoomId`和`TRTCRoomIdStr`的情况下，默认会以`RoomId`作为TRTC房间号进房拉流进行录\ufffd\ufffd...", "example": "12358" }, { "name": "RecordUserId", "type": "string", "required": true, "description": "用于录制服务进房的用户ID，最大长度不能大于60个字节，格式为`tic_record_user_${RoomId}_${Random}`，其中 `${RoomId} `与录制房间号对应，`${Random}`为一个随机字符串。 该ID必须是一个单独的未在SDK中使用的ID，录制服务使用这个用户ID进入房间进行音视频与白板录制，若该ID和SDK中使用的ID重复，会导致SDK和录制服务互踢，影响正常录制。", "example": "tic_record_user_12358_1258" }, { "name": "RecordUserSig", "type": "string", "required": true, "description": "与`RecordUserId`对应的IM签名", "example": "eJwtjb0OgjAAhN*lK4a0tcVC4iDGkIg-g7K4NEiLViLUUsFgfHcRmS733eXuDY6b" }, { "name": "GroupId", "type": "string", "required": false, "description": "白板进行信令同步的 IM 群组 ID。 在没有指定`GroupId`的情况下，实时录制服务将使用 `RoomId` 的字符串形式作为同步白板信令的IM群组ID。 在指定了`GroupId`的情况下，实时录制将优先使用`GroupId`作为同步白板信令的群组ID。请在开始录制前确保相应的IM群组已创建完成，否则会导致录制失败。", "example": "12358" }, { "name": "Concat", "type": "object", "required": false, "description": "录制视频拼接参数", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": true, "description": "是否开启拼接功能 在开启了视频拼接功能的情况下，实时录制服务会把同一个用户因为暂停导致的多段视频拼接成一个视频" }, { "name": "Image", "type": "string", "required": false, "description": "视频拼接时使用的垫片图片下载地址，不填默认用全黑的图片进行视频垫片" } ] }, { "name": "Whiteboard", "type": "object", "required": false, "description": "录制白板参数，例如白板宽高等", "example": "无", "children": [ { "name": "Width", "type": "integer", "required": false, "description": "实时录制结果里白板视频宽，取值必须大于等于2，默认为1280", "example": "1280" }, { "name": "Height", "type": "integer", "required": false, "description": "实时录制结果里白板视频高，取值必须大于等于2，默认为960", "example": "960" }, { "name": "InitParam", "type": "string", "required": false, "description": "白板初始化参数，透传到白板 SDK", "example": "无" } ] }, { "name": "MixStream", "type": "object", "required": false, "description": "录制混流参数 特别说明： 1. 混流功能需要根据额外开通， 请联系腾讯云互动白板客服人员 2. 使用混流功能，必须提供 Extras 参数，且 Extras 参数中必须包含 \"MIX_STREAM\"", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": true, "description": "是否开启混流" }, { "name": "DisableAudio", "type": "boolean", "required": false, "description": "是否禁用音频混流" }, { "name": "ModelId", "type": "integer", "required": false, "description": "内置混流布局模板ID, 取值 [1, 2], 区别见内置混流布局模板样式示例说明 在没有填Custom字段时候，ModelId是必填的" }, { "name": "TeacherId", "type": "string", "required": false, "description": "老师用户ID 此字段只有在ModelId填了的情况下生效 填写TeacherId的效果是把指定为TeacherId的用户视频流显示在内置模板的第一个小画面中" }, { "name": "Custom", "type": "object", "required": false, "description": "自定义混流布局参数 当此字段存在时，ModelId 及 TeacherId 字段将被忽略", "children": [ { "name": "Canvas", "type": "object", "required": true, "description": "混流画布参数", "children": [ { "name": "LayoutParams", "type": "object", "required": true, "description": "混流画布宽高配置" }, { "name": "BackgroundColor", "type": "string", "required": false, "description": "背景颜色，默认为黑色，格式为RGB格式，如红色为\"#FF0000\"" } ] }, { "name": "InputStreamList", "type": "array", "required": true, "description": "流布局参数，每路流的布局不能超出画布区域", "item_type": "object", "children": [ { "name": "LayoutParams", "type": "object", "required": true, "description": "流布局配置参数" }, { "name": "InputStreamId", "type": "string", "required": false, "description": "视频流ID 流ID的取值含义如下： 1. tic_record_user - 表示当前画面用于显示白板视频流 2. tic_substream - 表示当前画面用于显示辅路视频流 3. 特定用户ID - 表示当前画面用于显示指定用户的视频流 4. 不填 - 表示当前画面用于备选，当有新的视频流加入时，会从这些备选的空位中选择一个没有被占用的位置来显示新的视频流画面" }, { "name": "BackgroundColor", "type": "string", "required": false, "description": "背景颜色，默认为黑色，格式为RGB格式，如红色为\"#FF0000\"" }, { "name": "FillMode", "type": "integer", "required": false, "description": "视频画面填充模式。 0 - 自适应模式，对视频画面进行等比例缩放，在指定区域内显示完整的画面。此模式可能存在黑边。 1 - 全屏模式，对视频画面进行等比例缩放，让画面填充满整个指定区域。此模式不会存在黑边，但会将超出区域的那一部分画面裁剪掉。" } ] } ] } ] }, { "name": "Extras", "type": "array", "required": false, "description": "使用到的高级功能列表 可以选值列表： MIX_STREAM - 混流功能", "example": "[\"MixStream\"]", "item_type": "string" }, { "name": "AudioFileNeeded", "type": "boolean", "required": false, "description": "是否需要在结果回调中返回各路流的纯音频录制文件，文件格式为mp3", "example": "false" }, { "name": "RecordControl", "type": "object", "required": false, "description": "录制控制参数，用于更精细地指定需要录制哪些流，某一路流是否禁用音频，是否只录制小画面等", "example": "无", "children": [ { "name": "Enabled", "type": "boolean", "required": true, "description": "设置是否开启录制控制参数，只有设置为true的时候，录制控制参数才生效。" }, { "name": "DisableRecord", "type": "boolean", "required": false, "description": "设置是否禁用录制的全局控制参数。一般与`StreamControls`参数配合使用。 true - 所有流都不录制。 false - 所有流都录制。默认为false。 这里的设置对所有流都生效，如果同时在 `StreamControls` 列表中针对指定流设置了控制参数，则优先采用`StreamControls`中设置的控制参数。" }, { "name": "DisableAudio", "type": "boolean", "required": false, "description": "设置是否禁用所有流的音频录制的全局控制参数。一般与`StreamControls`参数配合使用。 true - 所有流的录制都不对音频进行录制。 false - 所有流的录制都需要对音频进行录制。默认为false。 这里的设置对所有流都生效，如果同时在 `StreamControls` 列表中针对指定流设置了控制参数，则优先采用`StreamControls`中设置的控制参数。" }, { "name": "PullSmallVideo", "type": "boolean", "required": false, "description": "设置是否所有流都只录制小画面的全局控制参数。一般与`StreamControls`参数配合使用。 true - 所有流都只录制小画面。设置为true时，请确保上行端在推流的时候同时上行了小画面，否则录制视频可能是黑屏。 false - 所有流都录制大画面，默认为false。 这里的设置对所有流都生效，如果同时在 `StreamControls` 列表中针对指定流设置了控制参数，则优先采用`StreamControls`中设置的控制参..." }, { "name": "StreamControls", "type": "array", "required": false, "description": "针对具体流指定控制参数，如果列表为空，则所有流采用全局配置的控制参数进行录制。列表不为空，则列表中指定的流将优先按此列表指定的控制参数进行录制。", "item_type": "object", "children": [ { "name": "StreamId", "type": "string", "required": true, "description": "视频流ID 视频流ID的取值含义如下： 1. tic_record_user - 表示白板视频流 2. tic_substream - 表示辅路视频流 3. 特定用户ID - 表示指定用户的视频流 在实际录制过程中，视频流ID的匹配规则为前缀匹配，只要真实流ID的前缀与指定的流ID一致就认为匹配成功。" }, { "name": "DisableRecord", "type": "boolean", "required": false, "description": "设置是否对此路流开启录制。 true - 表示不对这路流进行录制，录制结果将不包含这路流的视频。 false - 表示需要对这路流进行录制，录制结果会包含这路流的视频。 默认为 false。" }, { "name": "DisableAudio", "type": "boolean", "required": false, "description": "设置是否禁用这路流的音频录制。 true - 表示不对这路流的音频进行录制，录制结果里这路流的视频将会没有声音。 false - 录制视频会保留音频，如果设置为true，则录制视频会丢弃这路流的音频。 默认为 false。" }, { "name": "PullSmallVideo", "type": "boolean", "required": false, "description": "设置当前流录制视频是否只录制小画面。 true - 录制小画面。设置为true时，请确保上行端同时上行了小画面，否则录制视频可能是黑屏。 false - 录制大画面。 默认为 false。" } ] } ] }, { "name": "RecordMode", "type": "string", "required": false, "description": "录制模式 REALTIME_MODE - 实时录制模式（默认） VIDEO_GENERATION_MODE - 视频生成模式（内测中，需邮件申请开通）", "example": "REALTIME_MODE" }, { "name": "ChatGroupId", "type": "string", "required": false, "description": "聊天群组ID，此字段仅适用于`视频生成模式` 在`视频生成模式`下，默认会记录白板群组内的非白板信令消息，如果指定了`ChatGroupId`，则会记录指定群ID的聊天消息。", "example": "12358" }, { "name": "AutoStopTimeout", "type": "integer", "required": false, "description": "自动停止录制超时时间，单位秒，取值范围[300, 86400], 默认值为300秒。 当超过设定时间房间内没有音视频上行且没有白板操作的时候，录制服务会自动停止当前录制任务。", "example": "300" }, { "name": "ExtraData", "type": "string", "required": false, "description": "内部参数，可忽略", "example": "无" }, { "name": "TRTCRoomId", "type": "integer", "required": false, "description": "TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了`RoomId`与`TRTCRoomId`的情况下，优先使用`TRTCRoomId`作为实时录制拉TRTC流的TRTC房间号。 当指定了`TRTCRoomIdStr`的情况下，此字段将被忽略。", "example": "12358" }, { "name": "TRTCRoomIdStr", "type": "string", "required": false, "description": "TRTC字符串类型房间号。 在指定了`TRTCRoomIdStr`的情况下，会优先使用`TRTCRoomIdStr`作为实时录制拉TRTC流的TRTC房间号。", "example": "record-room" } ], "required": [ "SdkAppId", "RoomId", "RecordUserId", "RecordUserSig" ] }, { "name": "StartWhiteboardPush", "description": "发起一个白板推流任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId", "example": "1400000001" }, { "name": "RoomId", "type": "integer", "required": true, "description": "需要推流的白板房间号，取值范围: (1, 4294967295)。 1. 在没有指定`GroupId`的情况下，白板推流默认以`RoomId`的字符串表达形式作为IM群组ID（比如RoomId为1234，则IM群组ID为\"1234\"），并加群进行信令同步，请在开始推流前确保相应IM群组已创建完成，否则会导致推流失败。 2. 在没有指定`TRTCRoomId`和`TRTCRoomIdStr`的情况下，默认会以`RoomId`作为白板流进行推流的TRTC房间号。", "example": "1268" }, { "name": "PushUserId", "type": "string", "required": true, "description": "用于白板推流服务进入白板房间的用户ID。在没有额外指定`IMAuthParam`和`TRTCAuthParam`的情况下，这个用户ID同时会用于IM登录、IM加群、TRTC进房推流等操作。 用户ID最大长度不能大于60个字节，该用户ID必须是一个单独的未同时在其他地方使用的用户ID，白板推流服务使用这个用户ID进入房间进行白板音视频推流，若该用户ID和其他地方同时在使用的用户ID重复，会导致白板推流服务\ufffd...", "example": "tic_push_1268_xxx" }, { "name": "PushUserSig", "type": "string", "required": true, "description": "与`PushUserId`对应的IM签名(usersig)。", "example": "eJwtjb0OgjAAhN*lK4a0tcVC4iDGkIg-g7K4NEiLViLUUsFgfHcRmS733eXuDY6b" }, { "name": "Whiteboard", "type": "object", "required": false, "description": "白板参数，例如白板宽高、背景颜色等", "example": "无", "children": [ { "name": "Width", "type": "integer", "required": false, "description": "实时录制结果里白板视频宽，取值必须大于等于2，默认为1280", "example": "1280" }, { "name": "Height", "type": "integer", "required": false, "description": "实时录制结果里白板视频高，取值必须大于等于2，默认为960", "example": "960" }, { "name": "InitParam", "type": "string", "required": false, "description": "白板初始化参数，透传到白板 SDK", "example": "无" } ] }, { "name": "AutoStopTimeout", "type": "integer", "required": false, "description": "自动停止推流超时时间，单位秒，取值范围[300, 259200], 默认值为1800秒。 当白板超过设定时间没有操作的时候，白板推流服务会自动停止白板推流。", "example": "300" }, { "name": "AutoManageBackup", "type": "boolean", "required": false, "description": "对主白板推流任务进行操作时，是否同时同步操作备份任务", "example": "false" }, { "name": "Backup", "type": "object", "required": false, "description": "备份白板推流相关参数。 指定了备份参数的情况下，白板推流服务会在房间内新增一路白板画面视频流，即同一个房间内会有两路白板画面推流。", "example": "无", "children": [ { "name": "PushUserId", "type": "string", "required": true, "description": "用于白板推流服务进房的用户ID， 该ID必须是一个单独的未在SDK中使用的ID，白板推流服务将使用这个用户ID进入房间进行白板推流，若该ID和SDK中使用的ID重复，会导致SDK和录制服务互踢，影响正常推流。" }, { "name": "PushUserSig", "type": "string", "required": true, "description": "与PushUserId对应的签名" } ] }, { "name": "PrivateMapKey", "type": "string", "required": false, "description": "TRTC高级权限控制参数，如果在实时音视频开启了高级权限控制功能，必须提供PrivateMapKey才能保证正常推流。", "example": "无" }, { "name": "VideoFPS", "type": "integer", "required": false, "description": "白板推流视频帧率，取值范围[0, 30]，默认20fps", "example": "15" }, { "name": "VideoBitrate", "type": "integer", "required": false, "description": "白板推流码率， 取值范围[0, 2000]，默认1200kbps。 这里的码率设置是一个参考值，实际推流的时候使用的是动态码率，所以真实码率不会固定为指定值，会在指定值附近波动。", "example": "1200" }, { "name": "AutoRecord", "type": "boolean", "required": false, "description": "在实时音视频云端录制模式选择为 `指定用户录制` 模式的时候是否自动录制白板推流。 默认在实时音视频的云端录制模式选择为 `指定用户录制` 模式的情况下，不会自动进行白板推流录制，如果希望进行白板推流录制，请将此参数设置为true。 如果实时音视频的云端录制模式选择为 `全局自动录制` 模式，可忽略此参数。", "example": "false" }, { "name": "UserDefinedRecordId", "type": "string", "required": false, "description": "指定白板推流这路流在音视频云端录制中的RecordID，指定的RecordID会用于填充实时音视频云端录制完成后的回调消息中的 \"userdefinerecordid\" 字段内容，便于您更方便的识别录制回调，以及在点播媒体资源管理中查找相应的录制视频文件。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoRecord`字段取值如何，都将自\ufffd\ufffd...", "example": "12345678_12345_push_user_1" }, { "name": "AutoPublish", "type": "boolean", "required": false, "description": "在实时音视频旁路推流模式选择为`指定用户旁路`模式的时候，是否自动旁路白板推流。 默认在实时音视频的旁路推流模式选择为 `指定用户旁路` 模式的情况下，不会自动旁路白板推流，如果希望旁路白板推流，请将此参数设置为true。 如果实时音视频的旁路推流模式选择为 `全局自动旁路` 模式，可忽略此参数。", "example": "false" }, { "name": "UserDefinedStreamId", "type": "string", "required": false, "description": "指定实时音视频在旁路白板推流这路流时的StreamID，设置之后，您就可以在腾讯云直播 CDN 上通过标准直播方案（FLV或HLS）播放该用户的音视频流。 限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。 此字段设置后，不管`AutoPublish`字段取值如何，都将自动旁路白板推流。 默认StreamID生成规则如下： urlencode(SdkAppID_RoomID_PushUserID_main) 例如： Sd...", "example": "12345678_12345_push_user_1_main" }, { "name": "ExtraData", "type": "string", "required": false, "description": "内部参数，不需要关注此参数", "example": "无" }, { "name": "TRTCRoomId", "type": "integer", "required": false, "description": "TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了`RoomId`与`TRTCRoomId`的情况下，优先使用`TRTCRoomId`作为白板流进行推流的TRTC房间号。 当指定了`TRTCRoomIdStr`的情况下，此字段将被忽略。", "example": "1368" }, { "name": "TRTCRoomIdStr", "type": "string", "required": false, "description": "TRTC字符串类型房间号。 在指定了`TRTCRoomIdStr`的情况下，会优先使用`TRTCRoomIdStr`作为白板流进行推流的TRTC房间号。", "example": "wbpush-12345" }, { "name": "IMAuthParam", "type": "object", "required": false, "description": "IM鉴权信息参数，用于IM鉴权。 当白板信令所使用的IM应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应IM应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板信令的传输通道，否则使用公共参数中的SdkAppId作为白板信令的传输通道。", "example": "无", "children": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用SdkAppId", "example": "12345678" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID", "example": "userid" }, { "name": "UserSig", "type": "string", "required": true, "description": "用户ID对应的签名", "example": "usersig" } ] }, { "name": "TRTCAuthParam", "type": "object", "required": false, "description": "TRTC鉴权信息参数，用于TRTC进房推流鉴权。 当需要推流到的TRTC房间所对应的TRTC应用与白板应用的SdkAppId不一致时，可以通过此参数提供对应的TRTC应用鉴权信息。 如果提供了此参数，白板推流服务会优先使用此参数指定的SdkAppId作为白板推流的目标TRTC应用，否则使用公共参数中的SdkAppId作为白板推流的目标TRTC应用。", "example": "无", "children": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "应用SdkAppId", "example": "12345678" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID", "example": "userid" }, { "name": "UserSig", "type": "string", "required": true, "description": "用户ID对应的签名", "example": "usersig" } ] }, { "name": "TRTCEnterRoomMode", "type": "string", "required": false, "description": "指定白板推流时推流用户进TRTC房间的进房模式。默认为 TRTCAppSceneVideoCall TRTCAppSceneVideoCall - 视频通话场景，即绝大多数时间都是两人或两人以上视频通话的场景，内部编码器和网络协议优化侧重流畅性，降低通话延迟和卡顿率。 TRTCAppSceneLIVE - 直播场景，即绝大多数时间都是一人直播，偶尔有多人视频互动的场景，内部编码器和网络协议优化侧重性能和兼容性，性能和清晰度表...", "example": "TRTCAppSceneVideoCall" }, { "name": "GroupId", "type": "string", "required": false, "description": "白板进行信令同步的 IM 群组 ID。 在没有指定`GroupId`的情况下，白板推流服务将使用 `RoomId` 的字符串形式作为同步白板信令的IM群组ID。 在指定了`GroupId`的情况下，白板推流将优先`GroupId`作为同步白板信令的群组ID。请在开始推流前确保指定的IM群组已创建完成，否则会导致推流失败。", "example": "1368" } ], "required": [ "SdkAppId", "RoomId", "PushUserId", "PushUserSig" ] }, { "name": "StopOnlineRecord", "description": "停止实时录制", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId" }, { "name": "TaskId", "type": "string", "required": true, "description": "需要停止录制的任务 Id" } ], "required": [ "SdkAppId", "TaskId" ] }, { "name": "StopWhiteboardPush", "description": "停止白板推流任务", "status": "online", "parameters": [ { "name": "SdkAppId", "type": "integer", "required": true, "description": "客户的SdkAppId" }, { "name": "TaskId", "type": "string", "required": true, "description": "需要停止的白板推流任务 Id" } ], "required": [ "SdkAppId", "TaskId" ] } ] }