{ "name": "live", "display_name": "云直播CSS", "description": "介绍如何使用API对云直播进行操作，如创建直播域名、直播回调、直播混流等。", "domain": "other", "api_version": "2018-08-01", "endpoint": "live.tencentcloudapi.com", "actions": [ { "name": "AddCasterInputInfo", "description": "该接口用来向导播台中添加一个输入源，该输入源可以是拉流地址、或是一个文件链接", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" }, { "name": "InputInfo", "type": "object", "required": true, "description": "导播台输入源详细信息。", "example": "无", "children": [ { "name": "InputIndex", "type": "integer", "required": true, "description": "输入源Index。范围[1, 24]", "example": "1" }, { "name": "InputType", "type": "integer", "required": false, "description": "输入源类型。范围[0,1,2,3,4]。0：推流地址。1：点播文件地址。2：直播拉流地址。3：图片地址。4：webrtc协议推流地址。", "example": "1" }, { "name": "InputUrl", "type": "string", "required": false, "description": "输入源的源地址。最大允许长度512。当InputType为0（推流地址），2（直播拉流地址），3（图片地址）,4（webrtc推流地址）这几种类型时，URL需填入该字段。", "example": "http://example.domain.com/example.mp4" }, { "name": "Description", "type": "string", "required": false, "description": "输入源描述。最大允许长度256字符。", "example": "example" }, { "name": "InputUrls", "type": "array", "required": false, "description": "点播地址列表。仅当input type为1（点播地址）时，将一个或多个点播地址，填入该字段。单个地址最大允许长度512字符。最多允许同时填入5个地址。注：此时需保持InputUrl字段为空。", "example": "[\"http://example.domain.com/example.mp4\"]", "item_type": "string" }, { "name": "LoopEnable", "type": "boolean", "required": false, "description": "是否启用点播无限循环播放。注：当前该字段未生效，默认为True。", "example": "true" }, { "name": "LoopNumber", "type": "integer", "required": false, "description": "点播循环次数。允许值-1或正整数。当值为-1时，表示无限循环。当值为其他正整数时，表示循环对应次数。注：该字段暂未生效。", "example": "-1" }, { "name": "PullPushEnable", "type": "boolean", "required": false, "description": "是否启用拉取到导播台。注：该字段默认强制为true。", "example": "true" }, { "name": "Volume", "type": "integer", "required": false, "description": "输入源音量百分比。默认为100。表示音量为原始大小。允许值[0,200]。", "example": "100" } ] } ], "required": [ "CasterId", "InputInfo" ] }, { "name": "AddCasterLayoutInfo", "description": "该接口用来增加导播台的布局参数。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID", "example": "63501" }, { "name": "LayoutInfo", "type": "object", "required": true, "description": "导播台布局参数信息。", "example": "无", "children": [ { "name": "LayoutIndex", "type": "integer", "required": true, "description": "布局Index。取值范围：[1, 1000]", "example": "1" }, { "name": "LayoutTemplateId", "type": "integer", "required": false, "description": "布局模板Id。有效值[1，20，21，31，32，41]当使用布局模板时，无需LayoutParams参数，导播台将使用模板布局参数。", "example": "21" }, { "name": "InputIndexList", "type": "string", "required": false, "description": "布局绑定的输入列表。按布局LayerId从小到大，按顺序排列。已有两个画面的布局为例，输入1对应LayerId为1，输入2对应的LayerId为2，该字段应该填入\"1|2\"。", "example": "1|2" }, { "name": "LayoutParams", "type": "array", "required": false, "description": "详细的布局参数列表。", "example": "无", "item_type": "object", "children": [ { "name": "LayerId", "type": "integer", "required": true, "description": "布局层ID。 在画面最终渲染时，将按ID从小到大的顺序，由下至上渲染。", "example": "1" }, { "name": "LayerWidth", "type": "float", "required": true, "description": "布局层宽度。单位为百分比，范围[0.0,1.0]，表示该层在最终画面上所占的比例值。", "example": "1.0" }, { "name": "LayerHeight", "type": "float", "required": true, "description": "布局层高度。单位为百分比，范围[0.0,1.0]， 表示该层在最终画面上所占的比例值。", "example": "1.0" }, { "name": "LayerLocationX", "type": "float", "required": true, "description": "布局层位置x坐标。单位为百分比，范围[0.0,1.0]，表示该层在最终画面上x坐标所占的比例值。", "example": "0.0" }, { "name": "LayerLocationY", "type": "float", "required": true, "description": "布局层位置Y坐标。单位为百分比，范围[0.0,1.0]， 表示该层在最终画面Y坐标上所占的比例值。", "example": "0.0" }, { "name": "UsePortraitSegment", "type": "boolean", "required": false, "description": "是否启用抠图。", "example": "False" } ] }, { "name": "LayoutWidth", "type": "integer", "required": false, "description": "布局输出的宽度，单位为像素。默认为1280像素。注：该值仅在画中画布局，且未设置PgmWidth时生效。", "example": "1080" }, { "name": "LayoutHeight", "type": "integer", "required": false, "description": "布局输出的高度，单位为像素。注：该参数仅在画中画布局，且未设置PgmHeight时生效。", "example": "1920" } ] } ], "required": [ "CasterId", "LayoutInfo" ] }, { "name": "AddCasterMarkPicInfo", "description": "该接口用来新增图片水印。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID", "example": "63501" }, { "name": "MarkPicInfo", "type": "object", "required": true, "description": "图片水印详细参数。", "example": "无", "children": [ { "name": "MarkPicIndex", "type": "integer", "required": true, "description": "水印图片Index。", "example": "1" }, { "name": "MarkPicId", "type": "integer", "required": false, "description": "注：该字段已废弃。", "example": "0" }, { "name": "MarkPicWidth", "type": "float", "required": false, "description": "水印图片在输出时的宽度。 当该值为大于1的整数值时，单位为像素，允许范围[1,1920]。 当该值为小于1大于0的小数时，单位为百分比，表示水印在最终画面上所占的比例值。", "example": "1.0" }, { "name": "MarkPicHeight", "type": "float", "required": false, "description": "水印图片在输出时的高度。 当该值为大于1的整数值时，单位为像素，允许范围[1,1080]。 当该值为小于1大于0的小数时，单位为百分比，表示水印在输出上所占的比例值。", "example": "1.0" }, { "name": "MarkPicLocationX", "type": "float", "required": false, "description": "水印图片在输出时的X轴坐标。 当该值为大于1的整数值时，单位为像素，允许范围[1,1920]。 当该值为小于1大于0的小数时，单位为百分比，表示水印在最终画面上x坐标所占的比例值。", "example": "0.5" }, { "name": "MarkPicLocationY", "type": "float", "required": false, "description": "水印图片在输出时的Y坐标。 当该值为大于1的整数值时，单位为像素，允许范围[1,1080]。 当该值为小于1大于0的小数时，单位为百分比，表示水印在最终画面Y坐标上所占的比例值。", "example": "0.5" }, { "name": "MarkPicUrl", "type": "string", "required": false, "description": "水印地址。 最大长度256字符，且url需以jpg、jpeg、png、bmp、gif后缀结尾。", "example": "http://www.example.com/pic.jpg" }, { "name": "Description", "type": "string", "required": false, "description": "水印描述。 最大允许长度为256。", "example": "example" }, { "name": "IsEqualProportion", "type": "boolean", "required": false, "description": "是否启用了等比例缩放。 注：该字段仅做状态保存，无实际效果。", "example": "true" } ] } ], "required": [ "CasterId", "MarkPicInfo" ] }, { "name": "AddCasterMarkWordInfo", "description": "为导播台添加文本配置。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" }, { "name": "MarkWordInfo", "type": "object", "required": true, "description": "文本的详细配置。", "example": "无", "children": [ { "name": "MarkWordIndex", "type": "integer", "required": true, "description": "文字水印Index。", "example": "1" }, { "name": "MarkWordText", "type": "string", "required": false, "description": "文字水印内容。", "example": "示例文字" }, { "name": "MarkWordFontSize", "type": "integer", "required": false, "description": "文字水印的字号。 范围[16, 60]", "example": "12" }, { "name": "MarkWordFontColor", "type": "string", "required": false, "description": "文字水印的颜色，值为HEX颜色代码", "example": "0xffffff" }, { "name": "MarkWordFontType", "type": "integer", "required": false, "description": "文字水印的字体类型。 范围[1,2]。 1. 宋体 2. 黑体", "example": "1" }, { "name": "MarkWordLocationX", "type": "float", "required": false, "description": "文字水印的x坐标位置，单位百分比。 范围[0.0, 1.0]", "example": "0.1" }, { "name": "MarkWordLocationY", "type": "float", "required": false, "description": "文字水印的Y坐标位置，单位百分比。 范围[0.0, 1.0]", "example": "0.1" }, { "name": "MarkWordRollEnable", "type": "boolean", "required": false, "description": "是否开启文字跑马灯功能。 默认为false。", "example": "0" }, { "name": "MarkWordRollOnceTime", "type": "integer", "required": false, "description": "跑马灯文字显示一遍的时间，单位为秒。 默认为5s。 范围[5, 600]。", "example": "5" }, { "name": "MarkWordRollDirection", "type": "integer", "required": false, "description": "跑马灯文字的方向。 默认值为0。 范围[0,1]。 0 从左到右 1 从右到左", "example": "0" }, { "name": "MarkWordRollStartLocationX", "type": "float", "required": false, "description": "跑马灯文字显示的起始x坐标，单位百分比。 范围[0.0, 1.0]", "example": "0.0" }, { "name": "MarkWordRollEndLocationX", "type": "float", "required": false, "description": "跑马灯文字显示的截止x坐标，单位百分比。 范围[0.0, 1.0]", "example": "1.0" } ] } ], "required": [ "CasterId", "MarkWordInfo" ] }, { "name": "AddCasterOutputInfo", "description": "该接口用来新增导播台推流信息。导播台主监启动后，将会将主监画面推向该接口设置的地址。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID", "example": "63501" }, { "name": "OutputInfo", "type": "object", "required": true, "description": "导播台推流参数信息。", "example": "无", "children": [ { "name": "OutputIndex", "type": "integer", "required": true, "description": "推流信息Index。 当OutputType为1（表示推流到腾讯云直播）时，该值固定为0。 范围[0,10]。", "example": "0" }, { "name": "OutputUrl", "type": "string", "required": false, "description": "rtmp协议推流地址。 最大允许长度512字符。", "example": "rtmp://www.example.com/live/example" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。", "example": "example" }, { "name": "OutputStreamId", "type": "string", "required": false, "description": "推流到腾讯云直播源站时，使用的流ID。 仅当OutputType为1时生效。 最大允许128字符。", "example": "caster_output" }, { "name": "OutputType", "type": "integer", "required": false, "description": "推流类型。 范围[1,2] 1. 推送到腾讯云直播源站。 2. 推送到第三方源站。", "example": "1" }, { "name": "OutputDomainName", "type": "string", "required": false, "description": "推到腾讯云直播源站时，使用的域名。 最大允许128字符，且域名需属于当前账号绑定的云直播推流域名。 仅在OutputType为1时生效。", "example": "1234.livepush.myqcloud.com" }, { "name": "OutputAppName", "type": "string", "required": false, "description": "推到腾讯云直播源站时，使用的AppName。 最大允许64字符。 仅在OutputType为1时生效。", "example": "live" }, { "name": "OutputParam", "type": "string", "required": false, "description": "推到腾讯云直播源站时需要添加的推流参数。 最大允许长度256字符。 仅在OutputType为1时生效。", "example": "example_param=xxx" } ] } ], "required": [ "CasterId", "OutputInfo" ] }, { "name": "AddDelayLiveStream", "description": "针对大型活动直播，通过对直播流设置延时来控制现场与观众播放画面的时间间隔，避免突发状况造成影响。 注意：如果在推流前设置延播，需要提前5分钟设置，目前该接口只支持流粒度。", "status": "online", "parameters": [ { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的 AppName 保持一致，默认为 live。", "example": "live" }, { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" }, { "name": "DelayTime", "type": "integer", "required": true, "description": "延播时间，单位：秒，上限：600秒。", "example": "30" }, { "name": "ExpireTime", "type": "string", "required": false, "description": "延播设置的过期时间。UTC 格式，例如：2018-11-29T19:00:00Z。 注意： 1. 默认7天后过期，且最长支持7天内生效。 2. 北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。", "example": "2018-12-30T11:00:00Z" } ], "required": [ "AppName", "DomainName", "StreamName", "DelayTime" ] }, { "name": "AddLiveDomain", "description": "添加域名，一次只能提交一个域名。域名必须已备案。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "域名名称。", "example": "www.test.com" }, { "name": "DomainType", "type": "integer", "required": true, "description": "域名类型， 0：推流域名， 1：播放域名。", "example": "0" }, { "name": "PlayType", "type": "integer", "required": false, "description": "拉流域名类型： 1：国内， 2：全球， 3：境外。 默认值：1。", "example": "1" }, { "name": "IsDelayLive", "type": "integer", "required": false, "description": "是否是慢直播： 0： 普通直播， 1 ：慢直播 。 默认值： 0。", "example": "1" }, { "name": "IsMiniProgramLive", "type": "integer", "required": false, "description": "是否是小程序直播： 0： 标准直播， 1 ：小程序直播 。 默认值： 0。", "example": "1" }, { "name": "VerifyOwnerType", "type": "string", "required": false, "description": "域名归属校验类型。 可取值（与 AuthenticateDomainOwner 接口的 VerifyType 参数一致。）： dnsCheck ：立即验证配置 dns 的解析记录是否与待验证内容一致，成功则保存记录。 fileCheck ：立即验证 web 文件是否与待验证内容一致，成功则保存记录。 dbCheck : 检查是否已经验证成功过。 若不传默认为 dbCheck 。", "example": "dbCheck" } ], "required": [ "DomainName", "DomainType" ] }, { "name": "AddLiveWatermark", "description": "添加水印，成功返回水印 ID 后，需要调用[CreateLiveWatermarkRule](/document/product/267/32629)接口将水印 ID 绑定到流使用。 水印数量上限 100，超过后需要先删除，再添加。", "status": "online", "parameters": [ { "name": "PictureUrl", "type": "string", "required": true, "description": "水印图片 URL。 URL中禁止包含的字符： ;(){}$\u003e`#\"\\'|", "example": "http://watermark-101.cos.myqcloud.com/1251830167/imglogo.png" }, { "name": "WatermarkName", "type": "string", "required": true, "description": "水印名称。 最长30字节。", "example": "logo" }, { "name": "XPosition", "type": "integer", "required": false, "description": "显示位置，X轴偏移，单位是百分比，默认 0。", "example": "80" }, { "name": "YPosition", "type": "integer", "required": false, "description": "显示位置，Y轴偏移，单位是百分比，默认 0。", "example": "10" }, { "name": "Width", "type": "integer", "required": false, "description": "水印宽度，占直播原始画面宽度百分比，建议高宽只设置一项，另外一项会自适应缩放，避免变形。默认原始宽度。", "example": "100" }, { "name": "Height", "type": "integer", "required": false, "description": "水印高度，占直播原始画面高度百分比，建议高宽只设置一项，另外一项会自适应缩放，避免变形。默认原始高度。", "example": "100" }, { "name": "BackgroundWidth", "type": "integer", "required": false, "description": "背景水印宽度。默认宽度1920。", "example": "1920" }, { "name": "BackgroundHeight", "type": "integer", "required": false, "description": "背景水印高度。默认高度1080。", "example": "1080" } ], "required": [ "PictureUrl", "WatermarkName" ] }, { "name": "AuthenticateDomainOwner", "description": "验证用户是否拥有特定直播域名。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "要验证的域名。", "example": "foodscloud.com" }, { "name": "VerifyType", "type": "string", "required": true, "description": "验证类型。可取值： dnsCheck ：立即验证配置 dns 的解析记录是否与待验证内容一致，成功则保存记录。 fileCheck ：立即验证 web 文件是否与待验证内容一致，成功则保存记录。 dbCheck : 检查是否已经验证成功过。", "example": "dnsCheck" } ], "required": [ "DomainName", "VerifyType" ] }, { "name": "CancelCommonMixStream", "description": "该接口用来取消混流。用法与 mix_streamv2.cancel_mix_stream 基本一致。", "status": "online", "parameters": [ { "name": "MixStreamSessionId", "type": "string", "required": true, "description": "混流会话（申请混流开始到取消混流结束）标识 ID。 该值与CreateCommonMixStream中的MixStreamSessionId保持一致。", "example": "example_session_id" } ], "required": [ "MixStreamSessionId" ] }, { "name": "CopyCaster", "description": "该接口用来复制导播台配置", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "源导播台的ID", "example": "63501" }, { "name": "CasterName", "type": "string", "required": false, "description": "复制产生的新导播台名称", "example": "copy_example" }, { "name": "OutputStreamId", "type": "string", "required": false, "description": "复制产生的导播台推送到云直播的流id 注意：该流id不能与云直播中的流id重复", "example": "copy_output_example" } ], "required": [ "CasterId" ] }, { "name": "CreateAuditKeywordLib", "description": "创建关键词库，直播审核功能使用。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "自定义词库名称。", "example": "我的严禁词库" }, { "name": "Description", "type": "string", "required": true, "description": "自定义词库名称描述。", "example": "我的严禁词库" }, { "name": "Suggestion", "type": "string", "required": true, "description": "处理建议。可取值：Review 疑似，Block 违规。", "example": "Block" }, { "name": "MatchType", "type": "string", "required": true, "description": "匹配模式。可取值：ExactMatch 精确匹配， FuzzyMatch 模糊匹配。", "example": "ExactMatch" } ], "required": [ "Name", "Description", "Suggestion", "MatchType" ] }, { "name": "CreateAuditKeywords", "description": "创建关键词，并关联到关键词库。", "status": "online", "parameters": [ { "name": "Keywords", "type": "array", "required": true, "description": "关键词列表。", "example": "无", "item_type": "object", "children": [ { "name": "Content", "type": "string", "required": true, "description": "关键词内容。", "example": "黄暴词" }, { "name": "Label", "type": "string", "required": true, "description": "关键词标签。 可取值：Normal: 正常 ，Polity: 政治，Porn: 色情，Sexy：性感，Ad: 广告，Illegal: 违法，Abuse: 谩骂，Terror: 暴恐，Spam: 灌水，Moan:呻吟。", "example": "Polity" } ] }, { "name": "LibId", "type": "string", "required": true, "description": "直播审核词库Id。", "example": "4c49c04f-6617-4705-b3ff-bedce642bfcb" } ], "required": [ "Keywords", "LibId" ] }, { "name": "CreateCaster", "description": "该接口用来创建新的导播台", "status": "online", "parameters": [ { "name": "CasterName", "type": "string", "required": false, "description": "导播台名称", "example": "example" }, { "name": "Description", "type": "string", "required": false, "description": "导播台的描述 最大允许长度256", "example": "example_caster" }, { "name": "ExpireTime", "type": "integer", "required": false, "description": "导播台的过期时间戳。值为-1或unix时间戳。 默认值为-1。 当值为-1时，表示该导播台永不过期。 当值为正常unix时间戳时，导播台将在该时间过期。 导播台过期后，预监与主监画面将自动停止，转推自动停止。 点播、直播url将停止转拉，推流url需自行停止推流。", "example": "-1" }, { "name": "DelayTime", "type": "integer", "required": false, "description": "导播台延时播放时间，单位为秒。 默认为0，最大支持300秒", "example": "0" }, { "name": "TransitionType", "type": "string", "required": false, "description": "导播台转场类型。 默认为空。 允许使用通过DescribeCasterTransitionTypes接口中查询到的转场类型。", "example": " heart" }, { "name": "PgmWidth", "type": "integer", "required": false, "description": "导播台主监输出的宽度，单位为像素。 默认为1280，最大允许4096。", "example": "1280" }, { "name": "PgmHeight", "type": "integer", "required": false, "description": "导播台主监输出的高度，单位为像素。 默认为720，最大允许2160。", "example": "720" }, { "name": "PgmFps", "type": "integer", "required": false, "description": "导播台主监输出的帧率。 默认为0，表示随源输出。 最大支持60。", "example": "25" }, { "name": "PgmBitRate", "type": "integer", "required": false, "description": "导播台主监输出的码率，单位为kbps。 默认为0，表示随源的码率输出。 最大允许10000kbps。", "example": "1500" }, { "name": "FeeType", "type": "integer", "required": false, "description": "导播台的计费类型。 0 通用型 1 播单型。 注： 本参数暂无作用。", "example": "0" }, { "name": "PgmAudioBitRate", "type": "integer", "required": false, "description": "导播台主监输出的音频码率，单位为kbps。 可选项：[0, 128, 192, 256] 默认值为0，表示随源的音频码率输出。", "example": "128" } ], "required": [] }, { "name": "CreateCasterInputPushUrl", "description": "该接口用来生成导播台推流地址", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID", "example": "63501" }, { "name": "InputIndex", "type": "integer", "required": true, "description": "请求生成推流地址的输入Index。 允许范围[1,24]。", "example": "1" }, { "name": "Protocol", "type": "string", "required": false, "description": "生成推流地址协议。 范围[rtmp,webrtc]。 注：获取webrtc推流地址时，需配合腾讯云快直播推流sdk才可成功推流。", "example": "rtmp" } ], "required": [ "CasterId", "InputIndex" ] }, { "name": "CreateCasterPgm", "description": "该接口用来启动主监任务，并将获取主监画面的播放地址。", "status": "online", "parameters": [ { "name": "PgmDisplayInfo", "type": "object", "required": true, "description": "导播台展示信息参数。", "example": "无", "children": [ { "name": "LayoutIndex", "type": "integer", "required": false, "description": "布局Index。 如果使用自定义布局，为自定义布局下标。 如果使用单输入布局，如使用输入1，则LayoutIndexType=1， 且LayoutIndex=1，以此类推。", "example": "1" }, { "name": "MarkPicIndexList", "type": "array", "required": false, "description": "使用的水印Index列表。 注：当作为入参使用时，列表中的水印Index需要已经存在。", "example": "[1]", "item_type": "integer" }, { "name": "MarkWordIndexList", "type": "array", "required": false, "description": "使用的文字水印Index列表。 注：作为入参使用时，列表中的Index需要已经存在。", "example": "[1]", "item_type": "integer" }, { "name": "TransitionType", "type": "string", "required": false, "description": "使用的转场类型。 注：支持的转场类型可通过DescribeCasterTransitionTypes接口获取。", "example": "heart" }, { "name": "AudioIndexList", "type": "array", "required": false, "description": "使用的音频输入Index列表。 注：当该字段非空时，表示使用布局中对应的输入源的视频，AudioIndexList中对应的输入源的音频。且这些输入源需已存在。", "example": "[2]", "item_type": "integer" }, { "name": "InputStartType", "type": "integer", "required": false, "description": "作为入参时，表示使用点播输入源，单画面输入时，点播文件是否从头开始播放。 默认为0。 有效值，0,1。 0代表不从头播放 1代表从头播放", "example": "0" }, { "name": "LayoutIndexType", "type": "integer", "required": false, "description": "LayoutIndex类型， 默认值:0 可选值[0,1] 0:默认类型，代表普通布局 1:单输入类型，代表单输入布局", "example": "0" } ] }, { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" } ], "required": [ "PgmDisplayInfo", "CasterId" ] }, { "name": "CreateCasterPgmFromPvw", "description": "该接口用来将预监画面的布局、水印、字幕等配置，复制到主监画面中。 该接口使用时，预监任务需处于运行状态。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "CreateCasterPvw", "description": "该接口用来启动预监任务，并将获取预监画面的播放地址。", "status": "online", "parameters": [ { "name": "PvwDisplayInfo", "type": "object", "required": true, "description": "导播台预监展示信息参数", "example": "无", "children": [ { "name": "LayoutIndex", "type": "integer", "required": false, "description": "布局Index。 如果使用自定义布局，为自定义布局下标。 如果使用单输入布局，如使用输入1，则LayoutIndexType=1， 且LayoutIndex=1，以此类推。", "example": "1" }, { "name": "MarkPicIndexList", "type": "array", "required": false, "description": "使用的水印Index列表。 注：当作为入参使用时，列表中的水印Index需要已经存在。", "example": "[1]", "item_type": "integer" }, { "name": "MarkWordIndexList", "type": "array", "required": false, "description": "使用的文字水印Index列表。 注：作为入参使用时，列表中的Index需要已经存在。", "example": "[1]", "item_type": "integer" }, { "name": "TransitionType", "type": "string", "required": false, "description": "使用的转场类型。 注：支持的转场类型可通过DescribeCasterTransitionTypes接口获取。", "example": "heart" }, { "name": "AudioIndexList", "type": "array", "required": false, "description": "使用的音频输入Index列表。 注：当该字段非空时，表示使用布局中对应的输入源的视频，AudioIndexList中对应的输入源的音频。且这些输入源需已存在。", "example": "[2]", "item_type": "integer" }, { "name": "InputStartType", "type": "integer", "required": false, "description": "作为入参时，表示使用点播输入源，单画面输入时，点播文件是否从头开始播放。 默认为0。 有效值，0,1。 0代表不从头播放 1代表从头播放", "example": "0" }, { "name": "LayoutIndexType", "type": "integer", "required": false, "description": "LayoutIndex类型， 默认值:0 可选值[0,1] 0:默认类型，代表普通布局 1:单输入类型，代表单输入布局", "example": "0" } ] }, { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" } ], "required": [ "PvwDisplayInfo", "CasterId" ] }, { "name": "CreateCommonMixStream", "description": "该接口用来创建通用混流。用法与旧接口 mix_streamv2.start_mix_stream_advanced 基本一致。 注意：当前最多支持16路混流。 最佳实践：https://cloud.tencent.com/document/product/267/45566", "status": "online", "parameters": [ { "name": "MixStreamSessionId", "type": "string", "required": true, "description": "混流会话（申请混流开始到取消混流结束）标识 ID。80字节以内，仅含字母、数字以及下划线的字符串。", "example": "test_room" }, { "name": "InputStreamList", "type": "array", "required": true, "description": "混流输入流列表。", "example": "无", "item_type": "object", "children": [ { "name": "InputStreamName", "type": "string", "required": true, "description": "输入流名称。80字节以内，仅含字母、数字以及下划线的字符串。 当LayoutParams.InputType=0(音视频)/4(纯音频)/5(纯视频)时，该值为需要混流的流名称。 当LayoutParams.InputType=2(图片)/3(画布)时，该值仅用作标识输入，可用类似Canvas1、Pictrue1的名称。", "example": "ExampleStreamName1" }, { "name": "LayoutParams", "type": "object", "required": true, "description": "输入流布局参数。", "example": "无", "children": [ { "name": "ImageLayer", "type": "integer", "required": true, "description": "输入图层。取值范围[1，16]。1)背景流（即大主播画面或画布）的 image_layer 填1。2)纯音频混流，该参数也需填。注意：不同输入，该值不可重复", "example": "1" }, { "name": "InputType", "type": "integer", "required": false, "description": "输入类型。取值范围[0，5]。不填默认为0。0表示输入流为音视频。2表示输入流为图片。3表示输入流为画布。4表示输入流为音频。5表示输入流为纯视频。", "example": "0" }, { "name": "ImageHeight", "type": "float", "required": false, "description": "输入画面在输出时的高度。取值范围：像素：[0，2000]百分比：[0.01，0.99]不填默认为输入流的高度。使用百分比时，期望输出为（百分比 * 背景高）。", "example": "720" }, { "name": "ImageWidth", "type": "float", "required": false, "description": "输入画面在输出时的宽度。取值范围：像素：[0，2000]百分比：[0.01，0.99]不填默认为输入流的宽度。使用百分比时，期望输出为（百分比 * 背景宽）。", "example": "1024" }, { "name": "LocationX", "type": "float", "required": false, "description": "输入在输出画面的X偏移。取值范围：像素：[0，2000]百分比：[0.01，0.99]不填默认为0。相对于大主播背景画面左上角的横向偏移。使用百分比时，期望输出为（百分比 * 背景宽）。", "example": "0" }, { "name": "LocationY", "type": "float", "required": false, "description": "输入在输出画面的Y偏移。取值范围：像素：[0，2000]百分比：[0.01，0.99]不填默认为0。相对于大主播背景画面左上角的纵向偏移。使用百分比时，期望输出为（百分比 * 背景宽）", "example": "0" }, { "name": "Color", "type": "string", "required": false, "description": "当InputType为3(画布)时，该值表示画布的颜色。常用的颜色有：红色：0xCC0033。黄色：0xCC9900。绿色：0xCCCC33。蓝色：0x99CCFF。黑色：0x000000。白色：0xFFFFFF。灰色：0x999999。", "example": "0xFFFFFF" }, { "name": "WatermarkId", "type": "integer", "required": false, "description": "当InputType为2(图片)时，该值是水印ID。", "example": "0" }, { "name": "WebPageUrl", "type": "string", "required": false, "description": "当InputType为8时，该值是动效贴片的URL", "example": "https://www.example.com/webpage" } ] }, { "name": "CropParams", "type": "object", "required": false, "description": "输入流裁剪参数。", "example": "无", "children": [ { "name": "CropWidth", "type": "float", "required": false, "description": "裁剪的宽度。取值范围[0，2000]。", "example": "0" }, { "name": "CropHeight", "type": "float", "required": false, "description": "裁剪的高度。取值范围[0，2000]。", "example": "0" }, { "name": "CropStartLocationX", "type": "float", "required": false, "description": "裁剪的起始X坐标。取值范围[0，2000]。", "example": "0" }, { "name": "CropStartLocationY", "type": "float", "required": false, "description": "裁剪的起始Y坐标。取值范围[0，2000]。", "example": "0" } ] }, { "name": "PortraitSegmentParams", "type": "object", "required": false, "description": "抠图参数。", "example": "无", "children": [ { "name": "Color", "type": "string", "required": false, "description": "抠图背景颜色， 常用的颜色有： 红色：0xcc0033。 黄色：0xcc9900。 绿色：0xcccc33。 蓝色：0x99CCFF。 黑色：0x000000。 白色：0xFFFFFF。 灰色：0x999999。", "example": "0xcccc33" } ] } ] }, { "name": "OutputParams", "type": "object", "required": true, "description": "混流输出流参数。", "example": "无", "children": [ { "name": "OutputStreamName", "type": "string", "required": true, "description": "输出流名称。", "example": "example_ourput_name" }, { "name": "OutputStreamType", "type": "integer", "required": false, "description": "输出流类型，取值范围[0,1]。 不填默认为0。 当输出流为输入流 list 中的一条时，填写0。 当期望生成的混流结果成为一条新流时，该值填为1。 该值为1时，output_stream_id 不能出现在 input_stram_list 中，且直播后台中，不能存在相同 ID 的流。", "example": "0" }, { "name": "OutputStreamBitRate", "type": "integer", "required": false, "description": "输出流比特率。取值范围[1，10000]。 不填的情况下，系统会自动判断。", "example": "2000" }, { "name": "OutputStreamGop", "type": "integer", "required": false, "description": "输出流GOP大小。取值范围[1,10]。 不填的情况下，系统会自动判断。", "example": "2" }, { "name": "OutputStreamFrameRate", "type": "integer", "required": false, "description": "输出流帧率大小。取值范围[1,60]。 不填的情况下，系统会自动判断。", "example": "30" }, { "name": "OutputAudioBitRate", "type": "integer", "required": false, "description": "输出流音频比特率。取值范围[1,500] 不填的情况下，系统会自动判断。", "example": "256" }, { "name": "OutputAudioSampleRate", "type": "integer", "required": false, "description": "输出流音频采样率。取值范围[96000, 88200, 64000, 48000, 44100, 32000,24000, 22050, 16000, 12000, 11025, 8000]。 不填的情况下，系统会自动判断。", "example": "48000" }, { "name": "OutputAudioChannels", "type": "integer", "required": false, "description": "输出流音频声道数。取值范围[1,2]。 不填的情况下，系统会自动判断。", "example": "2" }, { "name": "MixSei", "type": "string", "required": false, "description": "输出流中的sei信息。如果无特殊需要，不填。", "example": "example_sei" } ] }, { "name": "MixStreamTemplateId", "type": "integer", "required": false, "description": "输入模板 ID，若设置该参数，将按默认模板布局输出，无需填入自定义位置参数。 不填默认为0。 两输入源支持10，20，30，40，50。 三输入源支持310，390，391。 四输入源支持410。 五输入源支持510，590。 六输入源支持610。", "example": "40" }, { "name": "ControlParams", "type": "object", "required": false, "description": "混流的特殊控制参数。如无特殊需求，无需填写。", "example": "无", "children": [ { "name": "UseMixCropCenter", "type": "integer", "required": false, "description": "取值范围[0,1]。 填1时，当参数中图层分辨率参数与视频实际分辨率不一致时，自动从视频中按图层设置的分辨率比例进行裁剪。", "example": "0" }, { "name": "AllowCopy", "type": "integer", "required": false, "description": "取值范围[0,1] 填1时，当InputStreamList中个数为1时，且OutputParams.OutputStreamType为1时，不执行取消操作，执行拷贝流操作", "example": "0" }, { "name": "PassInputSei", "type": "integer", "required": false, "description": "取值范围[0,1] 填1时，透传原始流的sei", "example": "0" }, { "name": "UsePictureTransparent", "type": "integer", "required": false, "description": "取值范围[0,1] 填1时，图片输入中的透明通道生效。", "example": "0" } ] } ], "required": [ "MixStreamSessionId", "InputStreamList", "OutputParams" ] }, { "name": "CreateLiveCallbackRule", "description": "创建回调规则，需要先调用[CreateLiveCallbackTemplate](/document/product/267/32637)接口创建回调模板，将返回的模板id绑定到域名/路径进行使用。 回调协议相关文档：[事件消息通知](/document/product/267/32744)。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "push.domain.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为live。", "example": "app" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "模板ID。", "example": "78895" } ], "required": [ "DomainName", "AppName", "TemplateId" ] }, { "name": "CreateLiveCallbackTemplate", "description": "创建回调模板，数量上限：50，成功返回模板id后，需要调用[CreateLiveCallbackRule](/document/product/267/32638)接口将模板 ID 绑定到域名/路径使用。 回调协议相关文档：[事件消息通知](/document/product/267/32744)。 注意：至少填写一个回调 URL。", "status": "online", "parameters": [ { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称。 长度上限：255字节。 仅支持中文、英文、数字、_、-。", "example": "testName" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。 长度上限：1024字节。 仅支持中文、英文、数字、_、-。", "example": "callback" }, { "name": "StreamBeginNotifyUrl", "type": "string", "required": false, "description": "开播回调 URL， 相关协议文档：[事件消息通知](/document/product/267/32744)。", "example": "http://domain.com/path" }, { "name": "StreamEndNotifyUrl", "type": "string", "required": false, "description": "断流回调 URL， 相关协议文档：[事件消息通知](/document/product/267/32744)。", "example": "http://domain.com/path" }, { "name": "RecordNotifyUrl", "type": "string", "required": false, "description": "录制文件回调 URL， 相关协议文档：[事件消息通知](/document/product/267/32744)。", "example": "http://domain.com/path" }, { "name": "RecordStatusNotifyUrl", "type": "string", "required": false, "description": "录制状态回调 URL ， 相关协议文档：[事件消息通知](/document/product/267/32744)。", "example": "http://domain.com/path" }, { "name": "SnapshotNotifyUrl", "type": "string", "required": false, "description": "截图回调 URL， 相关协议文档：[事件消息通知](/document/product/267/32744)。", "example": "http://domain.com/path" }, { "name": "PornCensorshipNotifyUrl", "type": "string", "required": false, "description": "鉴黄回调 URL ， 相关协议文档：[事件消息通知](/document/product/267/32741)。", "example": "http://domain.com/path" }, { "name": "CallbackKey", "type": "string", "required": false, "description": "回调 Key，回调 URL 公用，回调签名详见事件消息通知文档。 [事件消息通知](/document/product/267/32744)。", "example": "adasda131312" }, { "name": "StreamMixNotifyUrl", "type": "string", "required": false, "description": "参数已弃用。", "example": "asdsad" }, { "name": "PushExceptionNotifyUrl", "type": "string", "required": false, "description": "推流异常回调 URL。", "example": "http://abc.com/abc" }, { "name": "AudioAuditNotifyUrl", "type": "string", "required": false, "description": "音频审核回调 URL。", "example": "http://domain.com/path" }, { "name": "RecordExceptionNotifyUrl", "type": "string", "required": false, "description": "录制异常回调 URL。", "example": "http://domain.com/path" }, { "name": "RecordExceptionLevels", "type": "array", "required": false, "description": "录制异常回调级别，可选择：error、warning、info。", "example": "[\"error\"]", "item_type": "string" } ], "required": [ "TemplateName" ] }, { "name": "CreateLiveCloudEffect", "description": "使用该接口生成云端特效。特效可用于叠加到直播流上，供播放端观看。 注意：云端特效生成需要一定时间，调用生成接口后，可通过查询接口，获取是否特效已生成。", "status": "online", "parameters": [ { "name": "Prompt", "type": "string", "required": false, "description": "用于生成云端特效的 Prompt。示例：飞鸟。Prompt 和 ImageUrl 二选一。", "example": "一只猫咪" }, { "name": "TemplateId", "type": "string", "required": false, "description": "模板生礼物的模板ID。目前支持的模板ID：queen_accession, wizard_of_oz，red_envelopes，fishermen，captain_america。", "example": "wizard of oz" }, { "name": "ImageUrl", "type": "string", "required": false, "description": "输入我的图片地址，用于生成云端特效。ImageUrl 和 Prompt 二选一。", "example": "http://my.image.com/live/cat.png" }, { "name": "Type", "type": "string", "required": false, "description": "指定生成云端特效的方式。默认自动选取。标准方式：text2video，高品质方式：text2video_hq。", "example": "text2video" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者名称。", "example": "admin" } ], "required": [] }, { "name": "CreateLivePadRule", "description": "创建直播垫片规则。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "xxx.xx.com" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。", "example": "8945241" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称。 注：如果本参数设置为非空字符串，规则将只对此推流起作用。", "example": "s" } ], "required": [ "DomainName", "TemplateId" ] }, { "name": "CreateLivePadTemplate", "description": "创建直播垫片模板。", "status": "online", "parameters": [ { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称。 长度上限：255字节。 仅支持中文、英文、数字、_、-。", "example": "testName" }, { "name": "Url", "type": "string", "required": true, "description": "垫片内容。", "example": "https://test.com/a.mp4" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。 长度上限：1024字节。 仅支持中文、英文、数字、_、-。", "example": "testDesc" }, { "name": "WaitDuration", "type": "integer", "required": false, "description": "断流等待时间。 取值范围：0-30000。 单位：ms。", "example": "1" }, { "name": "MaxDuration", "type": "integer", "required": false, "description": "最大垫片时长。 取值范围：0 - 正无穷。 单位：ms。", "example": "1" }, { "name": "Type", "type": "integer", "required": false, "description": "垫片内容类型： 1：图片，2：视频。 默认值：1。", "example": "1" } ], "required": [ "TemplateName", "Url" ] }, { "name": "CreateLivePullStreamTask", "description": "创建直播拉流任务。支持将外部已有的点播文件，或者直播源拉取过来转推到指定的目标地址。 注意： 1. 默认支持任务数上限200个，如有特殊需求，可通过提单到售后进行评估增加上限。 2. 源流视频编码目前只支持: H264, H265。其他编码格式建议先进行转码处理。 3. 源流音频编码目前只支持: AAC。其他编码格式建议先进行转码处理。 4. 可在控制台开启过期自动清理，避免过期\ufffd...", "status": "online", "parameters": [ { "name": "SourceType", "type": "string", "required": true, "description": "拉流源的类型： PullLivePushLive -直播， PullVodPushLive -点播， PullPicPushLive -图片。", "example": "PullLivePushLive" }, { "name": "SourceUrls", "type": "array", "required": true, "description": "拉流源 url 列表。 SourceType 为直播（PullLivePushLive）只可以填1个， SourceType 为点播（PullVodPushLive）可以填多个，上限30个。 当前支持的文件格式：flv，mp4，hls。 当前支持的拉流协议：http，https，rtmp，rtmps，rtsp，srt。 注意： 1. 建议优先使用 flv 文件，对于 mp4 未交织好的文件轮播推流易产生卡顿以及因为频繁拉取导致源产生大量源出口带宽成本，可通过点播转码进行重新交织后\ufffd\ufffd...", "example": "http://5000.liveplay.myqcloud.com/live/testsrc.flv?txSecret=4d8e", "item_type": "string" }, { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。 将拉取过来的流推到该域名。 注意：如果目标地址为非云直播，且样式不同于云直播，请使用 ToUrl 传入完整推流地址，详细用法请参考 ToUrl 参数说明。", "example": "5000.livepush.myqcloud.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径。 将拉取过来的流推到该路径。", "example": "live" }, { "name": "StreamName", "type": "string", "required": true, "description": "推流名称。 将拉取过来的流推到该流名称。", "example": "teststream" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。 使用 UTC 格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时。", "example": "2021-02-07T08:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，注意：1. 结束时间必须大于开始时间；2. 结束时间必须大于当前时间；3. 结束时间 和 开始时间 间隔必须小于30天。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时。", "example": "2021-02-09T08:00:00Z" }, { "name": "Operator", "type": "string", "required": true, "description": "任务操作人备注。", "example": "admin" }, { "name": "PushArgs", "type": "string", "required": false, "description": "推流参数。 推流时携带自定义参数。 示例： bak=1\u0026test=2 。", "example": "bak=1\u0026room=2" }, { "name": "CallbackEvents", "type": "array", "required": false, "description": "选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。 TaskAlarm: 用于告警事件通知，AlarmType 示例: PullFileUnstable - 文件拉取不稳定， PushStreamUnstable - 推流不稳定， PullFileFailed - 文件拉取出错， PushStreamFailed - 推流出现\ufffd\ufffd...", "example": "[\"PushStreamFailed\"]", "item_type": "string" }, { "name": "VodLoopTimes", "type": "string", "required": false, "description": "点播拉流转推循环次数。默认：-1。 -1：无限循环，直到任务结束。 0：不循环。 \u003e0：具体循环次数。次数和时间以先结束的为准。 注意：该配置仅对拉流源为点播时生效。", "example": "-1" }, { "name": "VodRefreshType", "type": "string", "required": false, "description": "点播更新SourceUrls后的播放方式： ImmediateNewSource：立即播放新的拉流源内容； ContinueBreakPoint：播放完当前正在播放的点播 url 后再使用新的拉流源播放。（旧拉流源未播放的点播 url 不会再播放） 注意：该配置生效仅对变更前拉流源为点播时生效。", "example": "ContinueBreakPoint" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "自定义回调地址。 拉流转推任务相关事件会回调到该地址。 回调事件使用方法请查看： https://cloud.tencent.com/document/product/267/32744 https://cloud.tencent.com/document/product/267/56208", "example": "http://my.callback.rcv/lvb/interface.php" }, { "name": "ExtraCmd", "type": "string", "required": false, "description": "其他参数。 示例: ignore_region 用于忽略传入地域, 内部按负载分配。", "example": "ignore_region" }, { "name": "SpecifyTaskId", "type": "string", "required": false, "description": "自定义任务 ID。 注： 1. 该自定义 ID 为可选参数，如果传入，请确保该账号下传入的 ID 唯一。 2. 该自定义 ID 用于防止重复发起请求时产生重复任务。后面也可以用 SpecifyTaskId 来修改或删除任务。", "example": "sfvdfsdfserfsdff" }, { "name": "Comment", "type": "string", "required": false, "description": "任务描述，限制 512 字节。不可以使用特殊字符，如Unicode的特殊字符集。", "example": "任务描述" }, { "name": "ToUrl", "type": "string", "required": false, "description": "完整目标 URL 地址。 用法注意：如果使用该参数来传完整目标地址，则 DomainName, AppName, StreamName 需要传入空字符串，任务将会使用该 ToUrl 参数指定的目标地址。 使用该方式传入目标地址支持的协议有： rtmp、rtmps、rtsp、rtp、srt。 注意：签名时间需要超过任务结束时间，避免因签名过期造成任务失败。", "example": "rtmp://5000.livepush.myqcloud.com/live/myroom?txSecret=0065e4ef55825ab5883e2771a91017bd\u0026txTime=687bfb41" }, { "name": "FileIndex", "type": "integer", "required": false, "description": "指定播放文件索引。 注意： 1. 从1开始，不大于SourceUrls中文件个数。 2. 该偏移仅在首次轮播时有效。 3. 提前创建的任务指定的偏移最长有效期为24小时，24小时后未开始的任务偏移失效。", "example": "0" }, { "name": "OffsetTime", "type": "integer", "required": false, "description": "指定播放文件偏移。 注意： 1. 单位：秒，配合FileIndex使用。", "example": "0" }, { "name": "BackupSourceType", "type": "string", "required": false, "description": "备源的类型： PullLivePushLive -直播， PullVodPushLive -点播。 注意： 1. 仅当主源类型为直播源时，备源才会生效。 2. 主直播源拉流中断时，自动使用备源进行拉流。 3. 如果备源为点播文件时，则每次轮播完点播文件就检查主源是否恢复，如果主源恢复则自动切回到主源，否则继续拉备源。", "example": "PullLivePushLive" }, { "name": "BackupSourceUrl", "type": "string", "required": false, "description": "备源 URL。 只允许填一个备源 URL", "example": "http://5000.liveplay.myqcloud.com/live/backup.flv?txSecret=4d8e" }, { "name": "WatermarkList", "type": "array", "required": false, "description": "水印信息列表。 注意： 1. 最多支持4个不同位置的水印。 2. 水印图片 URL 请使用合法外网可访问地址。 3. 支持的水印图片格式：png，jpg，gif 等。", "example": "无", "item_type": "object", "children": [ { "name": "PictureUrl", "type": "string", "required": true, "description": "水印图片 URL。 URL中禁止包含的字符： ;(){}$\u003e`#\"'|", "example": "http://xxx.gifshow/pic.jpg" }, { "name": "XPosition", "type": "integer", "required": true, "description": "显示位置，X轴偏移，单位是百分比，默认 0。", "example": "0" }, { "name": "YPosition", "type": "integer", "required": true, "description": "显示位置，Y轴偏移，单位是百分比，默认 0。", "example": "0" }, { "name": "Width", "type": "integer", "required": true, "description": "水印宽度，占直播原始画面宽度百分比，建议高宽只设置一项，另外一项会自适应缩放，避免变形。默认原始宽度。", "example": "100" }, { "name": "Height", "type": "integer", "required": true, "description": "水印高度，占直播原始画面高度百分比，建议高宽只设置一项，另外一项会自适应缩放，避免变形。默认原始高度。", "example": "100" }, { "name": "Location", "type": "integer", "required": true, "description": "水印位置，默认 0。 0：左上角。 1：右上角。 2：右下角。 3：左下角。", "example": "0" } ] }, { "name": "VodLocalMode", "type": "integer", "required": false, "description": "点播源是否启用本地推流模式，默认0，不启用。 0 - 不启用。 1 - 启用。 注意：启用本地模式后，会将源列表中的 MP4 文件进行本地下载，优先使用本地已下载文件进行推流，提高点播源推流稳定性。使用本地下载文件推流时，会产生增值费用。", "example": "0" }, { "name": "RecordTemplateId", "type": "string", "required": false, "description": "录制模板 ID。", "example": "19342" }, { "name": "BackupToUrl", "type": "string", "required": false, "description": "新的目标地址，用于任务同时推两路场景。", "example": "rtmp://5000.livepush.myqcloud.com/live/mybackroom?txSecret=58deaf30f95a7a134c7f0d8512e90b14\u0026txTime=687bfb1d" }, { "name": "TranscodeTemplateName", "type": "string", "required": false, "description": "直播转码模板，使用云直播的转码功能进行转码后再转推出去。转码模板需在云直播控制台创建。", "example": "hevc720" } ], "required": [ "SourceType", "SourceUrls", "DomainName", "AppName", "StreamName", "StartTime", "EndTime", "Operator" ] }, { "name": "CreateLiveRecord", "description": "- 使用前提 1. 录制文件存放于点播平台，所以用户如需使用录制功能，需首先自行开通点播服务。 2. 录制文件存放后相关费用（含存储以及下行播放流量）按照点播平台计费方式收取，具体请参考 [对应文档](https://cloud.tencent.com/document/product/266/2838)。 - 模式说明 该接口支持两种录制模式： 1. 定时录制模式【默认模式】。 需要传入开始时间与结束时间，录制任务根据起止时间\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "livetest" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与推流和播放地址中的 AppName保持一致，默认为 live。", "example": "live" }, { "name": "DomainName", "type": "string", "required": false, "description": "推流域名。多域名推流必须设置。", "example": "5000.live.push.com" }, { "name": "StartTime", "type": "string", "required": false, "description": "录制开始时间。中国标准时间，需要 URLEncode(rfc3986)。如 2017-01-01 10:10:01，编码为：2017-01-01+10%3a10%3a01。 定时录制模式，必须设置该字段；实时视频录制模式，忽略该字段。", "example": "2017-01-01+10%3a10%3a01" }, { "name": "EndTime", "type": "string", "required": false, "description": "录制结束时间。中国标准时间，需要 URLEncode(rfc3986)。如 2017-01-01 10:30:01，编码为：2017-01-01+10%3a30%3a01。 定时录制模式，必须设置该字段；实时录制模式，为可选字段。如果通过Highlight参数，设置录制为实时视频录制模式，其设置的结束时间不应超过当前时间+30分钟，如果设置的结束时间超过当前时间+30分钟或者小于当前时间或者不设置该参数，则实际结束时间为当前时间+30分\ufffd\ufffd...", "example": "2017-01-01+10%3a30%3a01" }, { "name": "RecordType", "type": "string", "required": false, "description": "录制类型。 “video” : 音视频录制【默认】。 “audio” : 纯音频录制。 在定时录制模式或实时视频录制模式下，该参数均有效，不区分大小写。", "example": "video" }, { "name": "FileFormat", "type": "string", "required": false, "description": "录制文件格式。其值为： “flv”【默认】,“hls”,”mp4”,“aac”,”mp3”。 在定时录制模式或实时视频录制模式下，该参数均有效，不区分大小写。", "example": "flv" }, { "name": "Highlight", "type": "integer", "required": false, "description": "开启实时视频录制模式标志。 0：不开启实时视频录制模式，即定时录制模式【默认】。见[示例一](#.E7.A4.BA.E4.BE.8B1-.E5.88.9B.E5.BB.BA.E5.AE.9A.E6.97.B6.E5.BD.95.E5.88.B6.E4.BB.BB.E5.8A.A1)。 1：开启实时视频录制模式。见[示例二](#.E7.A4.BA.E4.BE.8B2-.E5.88.9B.E5.BB.BA.E5.AE.9E.E6.97.B6.E5.BD.95.E5.88.B6.E4.BB.BB.E5.8A.A1)。", "example": "0" }, { "name": "MixStream", "type": "integer", "required": false, "description": "开启 A+B=C混流C流录制标志。 0：不开启 A+B=C混流C流录制【默认】。 1：开启 A+B=C混流C流录制。 在定时录制模式或实时视频录制模式下，该参数均有效。", "example": "0" }, { "name": "StreamParam", "type": "string", "required": false, "description": "录制流参数。当前支持以下参数： record_interval - 录制分片时长，单位 秒，1800 - 7200。 storage_time - 录制文件存储时长，单位 秒。 eg. record_interval=3600\u0026storage_time=2592000。 注：参数需要url encode。 在定时录制模式或实时视频录制模式下，该参数均有效。", "example": "record_interval%3D3600" } ], "required": [ "StreamName" ] }, { "name": "CreateLiveRecordRule", "description": "创建录制规则，需要先调用[CreateLiveRecordTemplate](/document/product/267/32614)接口创建录制模板，将返回的模板id绑定到流使用。 录制相关文档：[直播录制](/document/product/267/32739)。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "xxx.xx.com" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。", "example": "47526" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称。 注：如果本参数设置为非空字符串，规则将只对此推流起作用。", "example": "stream1" } ], "required": [ "DomainName", "TemplateId" ] }, { "name": "CreateLiveRecordTemplate", "description": "创建录制模板，数量上限：50，成功返回模板id后，需要调用[CreateLiveRecordRule](/document/product/267/32615)接口，将模板id绑定到流进行使用。 录制相关文档：[直播录制](/document/product/267/32739)。", "status": "online", "parameters": [ { "name": "TemplateName", "type": "string", "required": true, "description": "模板名。仅支持中文、英文、数字、_、-。", "example": "templat" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。", "example": "录制规则" }, { "name": "FlvParam", "type": "object", "required": false, "description": "Flv录制参数，开启Flv录制时设置。", "example": "无", "children": [ { "name": "RecordInterval", "type": "integer", "required": false, "description": "录制间隔。 单位秒，默认：1800。 FLV、MP4取值范围： 60-43200， AAC取值范围： 60-7200 。 此参数对 HLS 无效，当录制 HLS 时从推流到断流生成一个文件。", "example": "400" }, { "name": "StorageTime", "type": "integer", "required": false, "description": "录制存储时长。 单位秒，取值范围： 0 - 1500天。 0：表示永久存储。 注：此参数只对录制到VOD有效。", "example": "800" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否开启当前格式录制，默认值为0，0：否， 1：是。", "example": "0" }, { "name": "VodSubAppId", "type": "integer", "required": false, "description": "点播子应用 ID。", "example": "1" }, { "name": "VodFileName", "type": "string", "required": false, "description": "录制文件名。 支持的特殊占位符有： {StreamID}: 流ID {StartYear}: 开始时间-年 {StartMonth}: 开始时间-月 {StartDay}: 开始时间-日 {StartHour}: 开始时间-小时 {StartMinute}: 开始时间-分钟 {StartSecond}: 开始时间-秒 {StartMillisecond}: 开始时间-毫秒 {EndYear}: 结束时间-年 {EndMonth}: 结束时间-月 {EndDay}: 结束时间-日 {EndHour}: 结束时间-小时 {EndMinute}: 结束时间-分钟 {EndSecond}: 结束时间-秒 {EndMillisecond}: 结束...", "example": "{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}" }, { "name": "Procedure", "type": "string", "required": false, "description": "任务流 注意：此字段可能返回 null，表示取不到有效值。", "example": "liu" }, { "name": "StorageMode", "type": "string", "required": false, "description": "视频存储策略。 normal：标准存储。 cold：低频存储。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" }, { "name": "ClassId", "type": "integer", "required": false, "description": "点播应用分类 注意：此字段可能返回 null，表示取不到有效值。", "example": "4512" }, { "name": "CosBucketName", "type": "string", "required": false, "description": "存储至 cos 的 bucket 桶名称。 注：CosBucketName参数值不能包含-[appid] 部分。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "存储至 cos 的 bucket 区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketPath", "type": "string", "required": false, "description": "存储至 cos 的 bucket 路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" } ] }, { "name": "HlsParam", "type": "object", "required": false, "description": "Hls录制参数，开启hls录制时设置。", "example": "无", "children": [ { "name": "RecordInterval", "type": "integer", "required": false, "description": "录制间隔。 单位秒，默认：1800。 FLV、MP4取值范围： 60-43200， AAC取值范围： 60-7200 。 此参数对 HLS 无效，当录制 HLS 时从推流到断流生成一个文件。", "example": "400" }, { "name": "StorageTime", "type": "integer", "required": false, "description": "录制存储时长。 单位秒，取值范围： 0 - 1500天。 0：表示永久存储。 注：此参数只对录制到VOD有效。", "example": "800" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否开启当前格式录制，默认值为0，0：否， 1：是。", "example": "0" }, { "name": "VodSubAppId", "type": "integer", "required": false, "description": "点播子应用 ID。", "example": "1" }, { "name": "VodFileName", "type": "string", "required": false, "description": "录制文件名。 支持的特殊占位符有： {StreamID}: 流ID {StartYear}: 开始时间-年 {StartMonth}: 开始时间-月 {StartDay}: 开始时间-日 {StartHour}: 开始时间-小时 {StartMinute}: 开始时间-分钟 {StartSecond}: 开始时间-秒 {StartMillisecond}: 开始时间-毫秒 {EndYear}: 结束时间-年 {EndMonth}: 结束时间-月 {EndDay}: 结束时间-日 {EndHour}: 结束时间-小时 {EndMinute}: 结束时间-分钟 {EndSecond}: 结束时间-秒 {EndMillisecond}: 结束...", "example": "{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}" }, { "name": "Procedure", "type": "string", "required": false, "description": "任务流 注意：此字段可能返回 null，表示取不到有效值。", "example": "liu" }, { "name": "StorageMode", "type": "string", "required": false, "description": "视频存储策略。 normal：标准存储。 cold：低频存储。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" }, { "name": "ClassId", "type": "integer", "required": false, "description": "点播应用分类 注意：此字段可能返回 null，表示取不到有效值。", "example": "4512" }, { "name": "CosBucketName", "type": "string", "required": false, "description": "存储至 cos 的 bucket 桶名称。 注：CosBucketName参数值不能包含-[appid] 部分。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "存储至 cos 的 bucket 区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketPath", "type": "string", "required": false, "description": "存储至 cos 的 bucket 路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" } ] }, { "name": "Mp4Param", "type": "object", "required": false, "description": "Mp4录制参数，开启Mp4录制时设置。", "example": "无", "children": [ { "name": "RecordInterval", "type": "integer", "required": false, "description": "录制间隔。 单位秒，默认：1800。 FLV、MP4取值范围： 60-43200， AAC取值范围： 60-7200 。 此参数对 HLS 无效，当录制 HLS 时从推流到断流生成一个文件。", "example": "400" }, { "name": "StorageTime", "type": "integer", "required": false, "description": "录制存储时长。 单位秒，取值范围： 0 - 1500天。 0：表示永久存储。 注：此参数只对录制到VOD有效。", "example": "800" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否开启当前格式录制，默认值为0，0：否， 1：是。", "example": "0" }, { "name": "VodSubAppId", "type": "integer", "required": false, "description": "点播子应用 ID。", "example": "1" }, { "name": "VodFileName", "type": "string", "required": false, "description": "录制文件名。 支持的特殊占位符有： {StreamID}: 流ID {StartYear}: 开始时间-年 {StartMonth}: 开始时间-月 {StartDay}: 开始时间-日 {StartHour}: 开始时间-小时 {StartMinute}: 开始时间-分钟 {StartSecond}: 开始时间-秒 {StartMillisecond}: 开始时间-毫秒 {EndYear}: 结束时间-年 {EndMonth}: 结束时间-月 {EndDay}: 结束时间-日 {EndHour}: 结束时间-小时 {EndMinute}: 结束时间-分钟 {EndSecond}: 结束时间-秒 {EndMillisecond}: 结束...", "example": "{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}" }, { "name": "Procedure", "type": "string", "required": false, "description": "任务流 注意：此字段可能返回 null，表示取不到有效值。", "example": "liu" }, { "name": "StorageMode", "type": "string", "required": false, "description": "视频存储策略。 normal：标准存储。 cold：低频存储。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" }, { "name": "ClassId", "type": "integer", "required": false, "description": "点播应用分类 注意：此字段可能返回 null，表示取不到有效值。", "example": "4512" }, { "name": "CosBucketName", "type": "string", "required": false, "description": "存储至 cos 的 bucket 桶名称。 注：CosBucketName参数值不能包含-[appid] 部分。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "存储至 cos 的 bucket 区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketPath", "type": "string", "required": false, "description": "存储至 cos 的 bucket 路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" } ] }, { "name": "AacParam", "type": "object", "required": false, "description": "Aac录制参数，开启Aac录制时设置。", "example": "无", "children": [ { "name": "RecordInterval", "type": "integer", "required": false, "description": "录制间隔。 单位秒，默认：1800。 FLV、MP4取值范围： 60-43200， AAC取值范围： 60-7200 。 此参数对 HLS 无效，当录制 HLS 时从推流到断流生成一个文件。", "example": "400" }, { "name": "StorageTime", "type": "integer", "required": false, "description": "录制存储时长。 单位秒，取值范围： 0 - 1500天。 0：表示永久存储。 注：此参数只对录制到VOD有效。", "example": "800" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否开启当前格式录制，默认值为0，0：否， 1：是。", "example": "0" }, { "name": "VodSubAppId", "type": "integer", "required": false, "description": "点播子应用 ID。", "example": "1" }, { "name": "VodFileName", "type": "string", "required": false, "description": "录制文件名。 支持的特殊占位符有： {StreamID}: 流ID {StartYear}: 开始时间-年 {StartMonth}: 开始时间-月 {StartDay}: 开始时间-日 {StartHour}: 开始时间-小时 {StartMinute}: 开始时间-分钟 {StartSecond}: 开始时间-秒 {StartMillisecond}: 开始时间-毫秒 {EndYear}: 结束时间-年 {EndMonth}: 结束时间-月 {EndDay}: 结束时间-日 {EndHour}: 结束时间-小时 {EndMinute}: 结束时间-分钟 {EndSecond}: 结束时间-秒 {EndMillisecond}: 结束...", "example": "{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}" }, { "name": "Procedure", "type": "string", "required": false, "description": "任务流 注意：此字段可能返回 null，表示取不到有效值。", "example": "liu" }, { "name": "StorageMode", "type": "string", "required": false, "description": "视频存储策略。 normal：标准存储。 cold：低频存储。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" }, { "name": "ClassId", "type": "integer", "required": false, "description": "点播应用分类 注意：此字段可能返回 null，表示取不到有效值。", "example": "4512" }, { "name": "CosBucketName", "type": "string", "required": false, "description": "存储至 cos 的 bucket 桶名称。 注：CosBucketName参数值不能包含-[appid] 部分。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "存储至 cos 的 bucket 区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketPath", "type": "string", "required": false, "description": "存储至 cos 的 bucket 路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" } ] }, { "name": "IsDelayLive", "type": "integer", "required": false, "description": "直播类型，默认 0。 0：普通直播， 1：慢直播。", "example": "12" }, { "name": "HlsSpecialParam", "type": "object", "required": false, "description": "HLS专属录制参数。", "example": "无", "children": [ { "name": "FlowContinueDuration", "type": "integer", "required": false, "description": "HLS续流超时时间。 取值范围[0，1800]。 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" } ] }, { "name": "Mp3Param", "type": "object", "required": false, "description": "Mp3录制参数，开启Mp3录制时设置。", "example": "无", "children": [ { "name": "RecordInterval", "type": "integer", "required": false, "description": "录制间隔。 单位秒，默认：1800。 FLV、MP4取值范围： 60-43200， AAC取值范围： 60-7200 。 此参数对 HLS 无效，当录制 HLS 时从推流到断流生成一个文件。", "example": "400" }, { "name": "StorageTime", "type": "integer", "required": false, "description": "录制存储时长。 单位秒，取值范围： 0 - 1500天。 0：表示永久存储。 注：此参数只对录制到VOD有效。", "example": "800" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否开启当前格式录制，默认值为0，0：否， 1：是。", "example": "0" }, { "name": "VodSubAppId", "type": "integer", "required": false, "description": "点播子应用 ID。", "example": "1" }, { "name": "VodFileName", "type": "string", "required": false, "description": "录制文件名。 支持的特殊占位符有： {StreamID}: 流ID {StartYear}: 开始时间-年 {StartMonth}: 开始时间-月 {StartDay}: 开始时间-日 {StartHour}: 开始时间-小时 {StartMinute}: 开始时间-分钟 {StartSecond}: 开始时间-秒 {StartMillisecond}: 开始时间-毫秒 {EndYear}: 结束时间-年 {EndMonth}: 结束时间-月 {EndDay}: 结束时间-日 {EndHour}: 结束时间-小时 {EndMinute}: 结束时间-分钟 {EndSecond}: 结束时间-秒 {EndMillisecond}: 结束...", "example": "{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}" }, { "name": "Procedure", "type": "string", "required": false, "description": "任务流 注意：此字段可能返回 null，表示取不到有效值。", "example": "liu" }, { "name": "StorageMode", "type": "string", "required": false, "description": "视频存储策略。 normal：标准存储。 cold：低频存储。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" }, { "name": "ClassId", "type": "integer", "required": false, "description": "点播应用分类 注意：此字段可能返回 null，表示取不到有效值。", "example": "4512" }, { "name": "CosBucketName", "type": "string", "required": false, "description": "存储至 cos 的 bucket 桶名称。 注：CosBucketName参数值不能包含-[appid] 部分。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "存储至 cos 的 bucket 区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketPath", "type": "string", "required": false, "description": "存储至 cos 的 bucket 路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" } ] }, { "name": "CosStore", "type": "integer", "required": false, "description": "是否存储至 cos，值为 1 时表示存储至 cos。", "example": "1" }, { "name": "RemoveWatermark", "type": "boolean", "required": false, "description": "是否去除水印，类型为慢直播时此参数无效。 如果为false，则录制水印流或转码流；如果为true，则录制原始流。", "example": "false" }, { "name": "FlvSpecialParam", "type": "object", "required": false, "description": "FLV 录制特殊参数。", "example": "无", "children": [ { "name": "UploadInRecording", "type": "boolean", "required": false, "description": "是否开启边录边传，仅flv格式有效。", "example": "false" } ] } ], "required": [ "TemplateName" ] }, { "name": "CreateLiveSnapshotRule", "description": "创建截图规则，需要先调用[CreateLiveSnapshotTemplate](/document/product/267/32624)接口创建截图模板，然后将返回的模板 ID 绑定到流进行使用。 截图相关文档：[直播截图](/document/product/267/32737)。 注意：单个域名仅支持关联一个截图模板。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "xxx.xx.com" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。", "example": "12346753" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与推流和播放地址中的 AppName 保持一致，默认为 live。", "example": "live" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称。 注：如果本参数设置为非空字符串，规则将只对此推流起作用。", "example": "s" } ], "required": [ "DomainName", "TemplateId" ] }, { "name": "CreateLiveSnapshotTemplate", "description": "创建截图模板，数量上限：50，成功返回模板id后，需要调用[CreateLiveSnapshotRule](/document/product/267/32625)接口，将模板id绑定到流使用。 截图相关文档：[直播截图](/document/product/267/32737)。", "status": "online", "parameters": [ { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称。 长度上限：255字节。 仅支持中文、英文、数字、_、-。", "example": "testName" }, { "name": "CosAppId", "type": "integer", "required": true, "description": "Cos 应用 ID。", "example": "9654125" }, { "name": "CosBucket", "type": "string", "required": true, "description": "Cos Bucket名称。 注：CosBucket参数值不能包含-[appid] 部分。", "example": "bucket" }, { "name": "CosRegion", "type": "string", "required": true, "description": "Cos地区。", "example": "beijing" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。 长度上限：1024字节。 仅支持中文、英文、数字、_、-。", "example": "testDesc" }, { "name": "SnapshotInterval", "type": "integer", "required": false, "description": "截图间隔，单位s，默认10s。 范围： 2s ~ 300s。", "example": "10" }, { "name": "Width", "type": "integer", "required": false, "description": "截图宽度。默认：0（原始宽）。 范围：0-3000 。", "example": "250" }, { "name": "Height", "type": "integer", "required": false, "description": "截图高度。默认：0（原始高）。 范围：0-2000 。", "example": "250" }, { "name": "PornFlag", "type": "integer", "required": false, "description": "是否开启鉴黄，0：不开启，1：开启。默认：0。", "example": "0" }, { "name": "CosPrefix", "type": "string", "required": false, "description": "Cos Bucket文件夹前缀。 如不传，实际按默认值 /{Year}-{Month}-{Day} 生效", "example": "12" }, { "name": "CosFileName", "type": "string", "required": false, "description": "Cos 文件名称。 如不传，实际按默认值 {StreamID}-screenshot-{Hour}-{Minute}-{Second}-{Width}x{Height}{Ext} 生效", "example": "{StreamID}-screenshot-{Hour}-{Minute}-{Second}-{Width}x{Height}{Ext}" } ], "required": [ "TemplateName", "CosAppId", "CosBucket", "CosRegion" ] }, { "name": "CreateLiveStreamMonitor", "description": "该接口用来创建直播流监播任务。", "status": "online", "parameters": [ { "name": "OutputInfo", "type": "object", "required": true, "description": "监播任务的输出信息。", "example": "无", "children": [ { "name": "OutputStreamWidth", "type": "integer", "required": true, "description": "监播任务输出流宽度像素。范围[1,1920]。建议至少大于100像素。", "example": "1920" }, { "name": "OutputStreamHeight", "type": "integer", "required": true, "description": "监播任务输出流长度像素。范围[1,1080]，建议至少大于100像素。", "example": "1080" }, { "name": "OutputStreamName", "type": "string", "required": false, "description": "监播任务输出流名称。 不填时，系统会自动生成。 256字节以内，只允许包含字母、数字、‘-’，‘_’，'.'字符。", "example": "OutputExampleName" }, { "name": "OutputDomain", "type": "string", "required": false, "description": "监播任务播放域名。128字节以内，只允许填处于启用状态的播放域名。", "example": "OutputExampleDomain" }, { "name": "OutputApp", "type": "string", "required": false, "description": "监播任务播放路径。32字节以内，只允许包含字母、数字、‘-’，‘_’，'.'字符。", "example": "Live" } ] }, { "name": "InputList", "type": "array", "required": true, "description": "待监播的输入流信息列表。", "example": "无", "item_type": "object", "children": [ { "name": "InputStreamName", "type": "string", "required": true, "description": "待监播的输入流名称。256字节以内，只允许包含字母、数字、‘-’，‘_’，'.'字符。", "example": "ExampleStreamName" }, { "name": "InputDomain", "type": "string", "required": false, "description": "待监播的输入流推流域名。128字节以内，只允许填处于启用状态的推流域名。", "example": "ExampleDomain" }, { "name": "InputApp", "type": "string", "required": false, "description": "待监播的输入流推流路径。32字节以内，只允许包含字母、数字、‘-’，‘_’，'.'字符。", "example": "Live" }, { "name": "InputUrl", "type": "string", "required": false, "description": "待监播的输入流推流url。一般场景下，无需该参数。", "example": "rtmp://ExampleDomain/Live/ExampleStreamName" }, { "name": "Description", "type": "string", "required": false, "description": "描述。256字节以内。", "example": "Input1" }, { "name": "CasterInputIndex", "type": "integer", "required": false, "description": "导播台输入源索引（10000 pvw， 10001 pgm， 其余代表输入下标）", "example": "1" }, { "name": "NeedMonitor", "type": "boolean", "required": false, "description": "该输入源是否正在监播", "example": "True" }, { "name": "CdnStreamId", "type": "string", "required": false, "description": "导播台pvw pgm的cdn流id", "example": "ExampleStreamName" } ] }, { "name": "MonitorName", "type": "string", "required": false, "description": "监播任务名称。字段长度小于128字节（一个汉字两个字节）。", "example": "ExampleMonitorName" }, { "name": "NotifyPolicy", "type": "object", "required": false, "description": "监播事件通知策略。 不填默认为没有任何通知。", "example": "无", "children": [ { "name": "NotifyPolicyType", "type": "integer", "required": false, "description": "通知策略类型：范围[0,1] 0:代表不使用任何通知策略 1:代表使用全局回调策略，所有事件通知到CallbackUrl。", "example": "0" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "回调URL：长度[0,512] 只支持http和https类型的url。", "example": "http://notify.example.com/notify" } ] }, { "name": "AsrLanguage", "type": "integer", "required": false, "description": "智能语音识别语种设置： 0 关闭 1 中文 2 英文 3 日文 4 韩文。", "example": "0" }, { "name": "OcrLanguage", "type": "integer", "required": false, "description": "智能文字识别语种设置： 0 关闭 1 中、英文。", "example": "0" }, { "name": "AiAsrInputIndexList", "type": "array", "required": false, "description": "智能语音识别的输入列表，若开启语音识别则必填。 （第1条输入流index为1）", "example": "[1, 2]", "item_type": "integer" }, { "name": "AiOcrInputIndexList", "type": "array", "required": false, "description": "智能文字识别的输入列表，若开启文字识别则必填。 （第1条输入流index为1）", "example": "[1, 2]", "item_type": "integer" }, { "name": "CheckStreamBroken", "type": "integer", "required": false, "description": "是否开启断流检测。", "example": "0" }, { "name": "CheckStreamLowFrameRate", "type": "integer", "required": false, "description": "是否开启低帧率检测。", "example": "0" }, { "name": "AllowMonitorReport", "type": "integer", "required": false, "description": "是否存储监播事件到监播报告，以及是否允许查询监播报告。", "example": "0" }, { "name": "AiFormatDiagnose", "type": "integer", "required": false, "description": "是否开启格式诊断。", "example": "0" }, { "name": "AiQualityControl", "type": "integer", "required": false, "description": "是否开启内容质检。", "example": "0" }, { "name": "CasterId", "type": "string", "required": false, "description": "导播台监播对应的导播台场次id。", "example": "\"101\"" }, { "name": "PullPushTaskId", "type": "string", "required": false, "description": "拉流转推监播任务对应的拉流转推场次id", "example": "“xxxx”" } ], "required": [ "OutputInfo", "InputList" ] }, { "name": "CreateLiveTimeShiftRule", "description": "创建直播时移规则，需要先调用[CreateLiveTimeShiftTemplate](/document/product/267/86169)接口创建直播时移模板，将返回的模板id绑定到流使用。 直播时移相关文档：[直播时移](/document/product/267/86134)。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "xxx.xx.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。注：如果需要对所有AppName生效，可填写“*”。", "example": "live" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。注：如果本参数设置为非空字符串，规则将只对此推流起作用。如果需要对所有StreamName生效，可填写“*”。", "example": "s" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。", "example": "458925" } ], "required": [ "DomainName", "AppName", "StreamName", "TemplateId" ] }, { "name": "CreateLiveTimeShiftTemplate", "description": "创建直播时移模板。", "status": "online", "parameters": [ { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称。 长度上限：255字节。 仅支持中文、英文、数字、_、-。", "example": "testName" }, { "name": "Duration", "type": "integer", "required": true, "description": "时移时长。单位：s。取值范围：86400 259200 604800 1296000 2592000。", "example": "604800" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。 仅支持中文、英文、数字、_、-。", "example": "testDesc" }, { "name": "Area", "type": "string", "required": false, "description": "地域。 Mainland：中国大陆。 Overseas：海外及港澳台地区。 默认值：Mainland。", "example": "Mainland" }, { "name": "ItemDuration", "type": "integer", "required": false, "description": "分片时长。 可取3-10。 单位：s。 默认值：5。", "example": "5" }, { "name": "RemoveWatermark", "type": "boolean", "required": false, "description": "是否去除水印。 传true则将录制原始流。 默认值：false。", "example": "false" }, { "name": "TranscodeTemplateIds", "type": "array", "required": false, "description": "转码流id列表。 此参数仅在 RemoveWatermark为false时生效。", "example": "[1]", "item_type": "integer" } ], "required": [ "TemplateName", "Duration" ] }, { "name": "CreateLiveTranscodeRule", "description": "创建转码规则，数量上限：50，需要先调用[CreateLiveTranscodeTemplate](/document/product/267/32646)接口创建转码模板，将返回的模板id绑定到流使用。 转码相关文档：[直播转封装及转码](/document/product/267/32736)。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "播放域名。", "example": "xxx.xx.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致。如果只绑定域名，则此处填\"\"。", "example": "live" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。已废弃该字段，请传入空字符串。", "example": "stream" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "指定已有的模板Id。", "example": "1000" } ], "required": [ "DomainName", "AppName", "StreamName", "TemplateId" ] }, { "name": "CreateLiveTranscodeTemplate", "description": "创建转码模板，数量上限：50，成功返回模板id后，需要调用[CreateLiveTranscodeRule](/document/product/267/32647)接口，将返回的模板id绑定到流使用。 转码相关文档：[直播转封装及转码](/document/product/267/32736)。", "status": "online", "parameters": [ { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称，例： 900p 仅支持字母和数字的组合。 长度限制： 标准转码：1-10个字符 极速高清转码：3-10个字符", "example": "900p" }, { "name": "VideoBitrate", "type": "integer", "required": true, "description": "视频码率。范围：0kbps - 8000kbps。 0为保持原始码率。 注: 转码模板有码率唯一要求，最终保存的码率可能与输入码率有所差别。", "example": "0" }, { "name": "Acodec", "type": "string", "required": false, "description": "音频编码：aac，默认aac。 注意：当前该参数未生效，待后续支持！", "example": "aac" }, { "name": "AudioBitrate", "type": "integer", "required": false, "description": "音频码率，默认0。 范围：0-500。", "example": "0" }, { "name": "Vcodec", "type": "string", "required": false, "description": "视频编码：h264/h265/origin，默认origin。 origin: 保持原始编码格式", "example": "h264" }, { "name": "Description", "type": "string", "required": false, "description": "模板描述。", "example": "transcode" }, { "name": "NeedVideo", "type": "integer", "required": false, "description": "是否保留视频，0：否，1：是。默认1。", "example": "0" }, { "name": "Width", "type": "integer", "required": false, "description": "宽，默认0。 范围[0-3000] 数值必须是2的倍数，0是原始宽度", "example": "0" }, { "name": "NeedAudio", "type": "integer", "required": false, "description": "是否保留音频，0：否，1：是。默认1。", "example": "0" }, { "name": "Height", "type": "integer", "required": false, "description": "高，默认0。 范围[0-3000] 数值必须是2的倍数，0是原始高度。 极速高清模板（AiTransCode = 1 的时候）必须传。", "example": "0" }, { "name": "Fps", "type": "integer", "required": false, "description": "帧率，默认0。 范围0-60fps", "example": "0" }, { "name": "Gop", "type": "integer", "required": false, "description": "关键帧间隔，单位：秒。 默认原始的间隔 范围1-6", "example": "2" }, { "name": "Rotate", "type": "integer", "required": false, "description": "旋转角度，默认0。 可取值：0，90，180，270", "example": "0" }, { "name": "Profile", "type": "string", "required": false, "description": "编码质量： baseline/main/high。默认baseline", "example": "baseline" }, { "name": "BitrateToOrig", "type": "integer", "required": false, "description": "当设置的码率\u003e原始码率时，是否以原始码率为准。 0：否， 1：是 默认 0。", "example": "0" }, { "name": "HeightToOrig", "type": "integer", "required": false, "description": "当设置的高度\u003e原始高度时，是否以原始高度为准。 0：否， 1：是 默认 0。", "example": "0" }, { "name": "FpsToOrig", "type": "integer", "required": false, "description": "当设置的帧率\u003e原始帧率时，是否以原始帧率为准。 0：否， 1：是 默认 0。", "example": "0" }, { "name": "AiTransCode", "type": "integer", "required": false, "description": "是否是极速高清模板，0：否，1：是。默认0。", "example": "0" }, { "name": "AdaptBitratePercent", "type": "float", "required": false, "description": "极速高清视频码率压缩比。 极速高清目标码率=VideoBitrate * (1-AdaptBitratePercent) 取值范围：0.0到0.5", "example": "0.0" }, { "name": "ShortEdgeAsHeight", "type": "integer", "required": false, "description": "是否以短边作为高度，0：否，1：是。默认0。", "example": "0" }, { "name": "DRMType", "type": "string", "required": false, "description": "DRM 加密类型，可选值：fairplay、normalaes、widevine。 不传递或者为空字符串，清空之前的DRM配置。", "example": "normalaes" }, { "name": "DRMTracks", "type": "string", "required": false, "description": "DRM 加密项，可选值：AUDIO、SD、HD、UHD1、UHD2，后四个为一组，同组中的内容只能选一个。 不传递或者为空字符串，清空之前的DRM配置。", "example": "AUDIO|HD" }, { "name": "IsAdaptiveBitRate", "type": "integer", "required": false, "description": "是否创建自适应码率，默认值 0。 0：否。 1：是。", "example": "0" }, { "name": "AdaptiveChildren", "type": "array", "required": false, "description": "自适应码率，子转码模板信息，当 IsAdaptiveBitRate 为 1 时有效。", "example": "无", "item_type": "object", "children": [ { "name": "TemplateId", "type": "integer", "required": false, "description": "自适应码率转码模板，子模板Id。 入参时候，填写此字段，表示更新子模板，否则是新增子模板。 注意：此字段可能返回 null，表示取不到有效值。", "example": "485142" }, { "name": "TemplateName", "type": "string", "required": false, "description": "子模板名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "p_500" }, { "name": "Vcodec", "type": "string", "required": false, "description": "视频编码：h264/h265/origin，默认origin。 origin: 保持原始编码格式。 注意：此字段可能返回 null，表示取不到有效值。", "example": "origin" }, { "name": "VideoBitrate", "type": "integer", "required": false, "description": "视频码率。范围：0kbps - 8000kbps。 0为保持原始码率。 注: 转码模板有码率唯一要求，最终保存的码率可能与输入码率有所差别。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1080" }, { "name": "Width", "type": "integer", "required": false, "description": "宽，默认0。 范围[0-3000]。 数值必须是2的倍数，0是原始宽度。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Height", "type": "integer", "required": false, "description": "高，默认0。 范围[0-3000] 数值必须是2的倍数，0是原始高度。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Fps", "type": "integer", "required": false, "description": "帧率，默认0。 范围0-60fps。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Gop", "type": "integer", "required": false, "description": "关键帧间隔，单位：秒。 默认原始的间隔。 范围2-6。 同一个父模板下面的所有子模板，gop必须相等且存在。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2" }, { "name": "NeedVideo", "type": "integer", "required": false, "description": "是否保留视频，0：否，1：是。默认1。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "NeedAudio", "type": "integer", "required": false, "description": "是否保留音频，0：否，1：是。默认1。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "BitrateToOrig", "type": "integer", "required": false, "description": "当设置的码率\u003e原始码率时，是否以原始码率为准。 0：否， 1：是 默认 0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "HeightToOrig", "type": "integer", "required": false, "description": "当设置的高度\u003e原始高度时，是否以原始高度为准。 0：否， 1：是 默认 0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "FpsToOrig", "type": "integer", "required": false, "description": "当设置的帧率\u003e原始帧率时，是否以原始帧率为准。 0：否， 1：是 默认 0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "ShortEdgeAsHeight", "type": "integer", "required": false, "description": "是否以短边作为高度，0：否，1：是。默认0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "HlsContainerFormat", "type": "string", "required": false, "description": "HLS 分片类型。 可选值：ts、fmp4。 注：编码方式为 H.265 时生效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ts" }, { "name": "HlsMp4VideoCodecTag", "type": "string", "required": false, "description": "编码标签。 可选值：hvc1、hev1。 注：HLS 分片类型选择 fmp4 时生效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "hvc1" } ] } ], "required": [ "TemplateName", "VideoBitrate" ] }, { "name": "CreateLiveWatermarkRule", "description": "创建水印规则，需要先调用[AddLiveWatermark](/document/product/267/30154)接口添加水印，将返回的水印id绑定到流使用。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "xxx.xx.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为live。", "example": "live" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "水印Id，即调用[AddLiveWatermark](/document/product/267/30154)接口返回的WatermarkId。", "example": "1000" } ], "required": [ "DomainName", "AppName", "StreamName", "TemplateId" ] }, { "name": "CreatePullStreamConfig", "description": "创建临时拉流转推任务，目前限制添加10条任务。 该接口已下线,请使用新接口 CreateLivePullStreamTask。 注意：该接口用于创建临时拉流转推任务， 拉流源地址即 FromUrl 可以是腾讯或非腾讯数据源， 但转推目标地址即 ToUrl 目前限制为已注册的腾讯直播域名。", "status": "online", "parameters": [ { "name": "FromUrl", "type": "string", "required": true, "description": "源 Url ，用于拉流的地址。目前可支持直播流及点播文件。 注意： 1. 多个点播url之间使用空格拼接。 2. 目前上限支持10个url。 3. 目前不支持https协议。 4. 支持拉流文件格式：flv，rtmp，hls，mp4。", "example": "rtmp://5000.liveplay.myqcloud.com/live/stream1" }, { "name": "ToUrl", "type": "string", "required": true, "description": "目的 Url ，用于推流的地址，目前限制该目标地址为腾讯域名。 仅支持：rtmp 协议。", "example": "rtmp://5000.livepush.myqcloud.com/live/stream2" }, { "name": "AreaId", "type": "integer", "required": true, "description": "选择完成转拉推的服务所在区域: 1-深圳， 2-上海， 3-天津， 4-中国香港。", "example": "1" }, { "name": "IspId", "type": "integer", "required": true, "description": "选择完成转拉推服务使用的运营商网络： 1-电信， 2-移动， 3-联通， 4-其他。 注：AreaId 为4的时候，IspId 只能为其他。", "example": "1" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。 使用 UTC 格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。", "example": "2018-12-31T11:02:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，注意： 1. 结束时间必须大于开始时间； 2. 结束时间和开始时间必须大于当前时间； 3. 结束时间 和 开始时间 间隔必须小于七天。 使用 UTC 格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。", "example": "2018-12-31T12:02:00Z" } ], "required": [ "FromUrl", "ToUrl", "AreaId", "IspId", "StartTime", "EndTime" ] }, { "name": "CreateRecordTask", "description": "创建一个在指定时间启动、结束的录制任务，并使用指定录制模板ID对应的配置进行录制。 - 使用前提 1. 录制文件存放于点播平台或对象存储内，所以用户如需使用录制功能，需首先自行开通点播服务或对象存储服务。 2. 录制文件存放后相关费用（含存储以及下行播放流量）按照点播平台计费方式收取，具体请参考[对应文档](https://cloud.tencent.com/document/product/266/2837)。 - 注意事...", "status": "online", "parameters": [ { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "livetest" }, { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "5000.live.push.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径。", "example": "live" }, { "name": "EndTime", "type": "integer", "required": true, "description": "录制任务结束时间，Unix时间戳。设置时间必须大于StartTime及当前时间，且小于当前时间+7天。", "example": "1589904000" }, { "name": "StartTime", "type": "integer", "required": false, "description": "录制任务开始时间，Unix时间戳。如果不填表示立即启动录制。EndTime - StartTime不能超过24小时。", "example": "1589889600" }, { "name": "StreamType", "type": "integer", "required": false, "description": "推流类型，默认0。取值： 0-直播推流。 1-合成流，即 A+B=C 类型混流。", "example": "0" }, { "name": "TemplateId", "type": "integer", "required": false, "description": "录制模板ID，CreateLiveRecordTemplate 返回值。如果不填或者传入错误ID，则默认录制HLS格式、永久存储。", "example": "0" }, { "name": "Extension", "type": "string", "required": false, "description": "扩展字段，暂无定义。默认为空。", "example": "extension" } ], "required": [ "StreamName", "DomainName", "AppName", "EndTime" ] }, { "name": "CreateScreenshotTask", "description": "创建一个在指定时间启动、结束的截图任务，并使用指定截图模板ID对应的配置进行截图。 - 注意事项 1. 断流会结束当前截图。在结束时间到达之前任务仍然有效，期间只要正常推流都会正常截图，与是否多次推、断流无关。 2. 使用上避免创建时间段相互重叠的截图任务。若同一条流当前存在多个时段重叠的任务，为避免重复系统将启动最多3个截图任务。 3. 创建的截图任务\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "livetest" }, { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "5000.live.push.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径。", "example": "live" }, { "name": "EndTime", "type": "integer", "required": true, "description": "截图任务结束时间，Unix时间戳。设置时间必须大于StartTime及当前时间，且小于当前时间+7天。", "example": "1589904000" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "截图模板ID，CreateLiveSnapshotTemplate 返回值。如果传入错误ID，则不拉起截图。", "example": "0" }, { "name": "StartTime", "type": "integer", "required": false, "description": "截图任务开始时间，Unix时间戳。如果不填表示立即启动截图。EndTime - StartTime不能超过24小时。", "example": "1589889600" }, { "name": "StreamType", "type": "integer", "required": false, "description": "推流类型，默认0。取值： 0-直播推流。 1-合成流，即 A+B=C 类型混流。", "example": "0" }, { "name": "Extension", "type": "string", "required": false, "description": "扩展字段，暂无定义。默认为空。", "example": "extension" } ], "required": [ "StreamName", "DomainName", "AppName", "EndTime", "TemplateId" ] }, { "name": "DeleteAuditKeywords", "description": "删除关键词信息。", "status": "online", "parameters": [ { "name": "KeywordIds", "type": "array", "required": true, "description": "要删除的关键词 Id 列表。", "example": "[\"id1\", \"id2]", "item_type": "string" }, { "name": "LibId", "type": "string", "required": true, "description": "关键词库 Id。", "example": "4c49c04f-6617-4705-b3ff-bedce642bfcb" } ], "required": [ "KeywordIds", "LibId" ] }, { "name": "DeleteCaster", "description": "该接口用来删除一个导播台的所有信息。 注意，调用该接口后，所有的导播台信息将被清除，包括正在直播的内容也将直接中断。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "待删除的导播台ID", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "DeleteCasterInputInfo", "description": "该接口用来删除导播台中的输入源信息。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID", "example": "63501" }, { "name": "InputIndex", "type": "integer", "required": true, "description": "导播台输入Index。 范围[0,20] 注：该Index对应的输入源需存在。", "example": "1" } ], "required": [ "CasterId", "InputIndex" ] }, { "name": "DeleteCasterLayoutInfo", "description": "该接口用来将布局信息从导播台中删除", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" }, { "name": "LayoutIndex", "type": "integer", "required": true, "description": "要删除的布局Index。注：待删除的Index对应的布局需存在。", "example": "1" } ], "required": [ "CasterId", "LayoutIndex" ] }, { "name": "DeleteCasterMarkPicInfo", "description": "该接口用来删除导播台某个Index对应的水印。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" }, { "name": "MarkPicIndex", "type": "integer", "required": true, "description": "需要删除的水印Index。", "example": "1" } ], "required": [ "CasterId", "MarkPicIndex" ] }, { "name": "DeleteCasterMarkWordInfo", "description": "该接口用来删除导播台的文本配置。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" }, { "name": "MarkWordIndex", "type": "integer", "required": true, "description": "需要删除的文字水印Index。", "example": "1" } ], "required": [ "CasterId", "MarkWordIndex" ] }, { "name": "DeleteCasterOutputInfo", "description": "该接口用来删除导播台的推流信息。 注：若删除推流到腾讯云直播源站配置，即OutputIndex为0，OutputType为1的推流配置，在重新启动主监后，系统会自动重新生成一个推流到腾讯云直播源站配置。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" }, { "name": "OutputIndex", "type": "integer", "required": true, "description": "待删除的推流信息Index。 注：删除时，该Index对应的配置需要存在。", "example": "1" } ], "required": [ "CasterId", "OutputIndex" ] }, { "name": "DeleteLiveCallbackRule", "description": "删除回调规则。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的 AppName 保持一致，默认为 live。", "example": "live" } ], "required": [ "DomainName", "AppName" ] }, { "name": "DeleteLiveCallbackTemplate", "description": "删除回调模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。 1. 在创建回调模板接口 [CreateLiveCallbackTemplate](/document/product/267/32637) 调用的返回值中获取模板 ID。 2. 可以从接口 [DescribeLiveCallbackTemplates](/document/product/267/32632) 查询已经创建的过的模板列表。", "example": "1000" } ], "required": [ "TemplateId" ] }, { "name": "DeleteLiveDomain", "description": "删除已添加的直播域名", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "要删除的域名", "example": "www.test.com" }, { "name": "DomainType", "type": "integer", "required": true, "description": "类型。0-推流，1-播放", "example": "0" } ], "required": [ "DomainName", "DomainType" ] }, { "name": "DeleteLivePadRule", "description": "删除直播垫片规则。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。 域名+AppName+StreamName唯一标识单个转码规则，如需删除需要强匹配，例如AppName为空也需要传空字符串进行强匹配。", "example": "yourdomain.test.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。 域名+AppName+StreamName唯一标识单个转码规则，如需删除需要强匹配，例如AppName为空也需要传空字符串进行强匹配。", "example": "live" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。 域名+AppName+StreamName唯一标识单个转码规则，如需删除需要强匹配，例如AppName为空也需要传空字符串进行强匹配。", "example": "stream" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "直播垫片模板id。", "example": "100" } ], "required": [ "DomainName", "AppName", "StreamName", "TemplateId" ] }, { "name": "DeleteLivePadTemplate", "description": "删除直播垫片模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。", "example": "1000" } ], "required": [ "TemplateId" ] }, { "name": "DeleteLivePullStreamTask", "description": "删除接口 CreateLivePullStreamTask 创建的拉流任务。 注意： 1. 入参中的 TaskId 为 CreateLivePullStreamTask 接口创建时返回的TaskId。 2. 也可通过 DescribeLivePullStreamTasks 进行查询创建的任务。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务 Id。", "example": "9564231" }, { "name": "Operator", "type": "string", "required": true, "description": "操作人姓名。", "example": "you_name" }, { "name": "SpecifyTaskId", "type": "string", "required": false, "description": "指定任务 ID。注意：用于删除使用自定义任务 ID 创建的任务。", "example": "myspecifytaskid" } ], "required": [ "TaskId", "Operator" ] }, { "name": "DeleteLiveRecord", "description": "注：DeleteLiveRecord 接口仅用于删除录制任务记录，不具备停止录制的功能，也不能删除正在进行中的录制。如果需要停止录制任务，请使用终止录制[StopLiveRecord](/document/product/267/30146) 接口。", "status": "online", "parameters": [ { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID，由CreateLiveRecord接口返回。", "example": "5621442" } ], "required": [ "StreamName", "TaskId" ] }, { "name": "DeleteLiveRecordRule", "description": "删除录制规则。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。 域名+AppName+StreamName唯一标识单个转码规则，如需删除需要强匹配，例如AppName为空也需要传空字符串进行强匹配。", "example": "yourdomain.test.com" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。 域名+AppName+StreamName唯一标识单个转码规则，如需删除需要强匹配，例如AppName为空也需要传空字符串进行强匹配。", "example": "live" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称。 域名+AppName+StreamName唯一标识单个转码规则，如需删除需要强匹配，例如AppName为空也需要传空字符串进行强匹配。", "example": "stream" } ], "required": [ "DomainName" ] }, { "name": "DeleteLiveRecordTemplate", "description": "删除录制模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "DescribeRecordTemplates接口获取到的模板 ID。", "example": "1000" } ], "required": [ "TemplateId" ] }, { "name": "DeleteLiveSnapshotRule", "description": "删除截图规则。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与推流和播放地址中的 AppName 保持一致，默认为 live。", "example": "live" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称。", "example": "stream" } ], "required": [ "DomainName" ] }, { "name": "DeleteLiveSnapshotTemplate", "description": "删除截图模板", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。 1. 在创建截图模板接口 [CreateLiveSnapshotTemplate](/document/product/267/32624) 调用的返回值中获取。 2. 可以从接口 [DescribeLiveSnapshotTemplates](/document/product/267/32619) 中查询已创建的截图模板列表。", "example": "1000" } ], "required": [ "TemplateId" ] }, { "name": "DeleteLiveStreamMonitor", "description": "该接口用来删除直播流监播任务。", "status": "online", "parameters": [ { "name": "MonitorId", "type": "string", "required": true, "description": "监播任务ID", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "required": [ "MonitorId" ] }, { "name": "DeleteLiveTimeShiftRule", "description": "删除直播时移规则。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。 域名+AppName+StreamName唯一标识单个时移规则，如需删除需要强匹配，例如AppName为空也需要传空字符串进行强匹配。", "example": "yourdomain.test.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。 域名+AppName+StreamName唯一标识单个时移规则，如需删除需要强匹配，例如AppName为空也需要传空字符串进行强匹配。", "example": "live" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。 域名+AppName+StreamName唯一标识单个时移规则，如需删除需要强匹配，例如AppName为空也需要传空字符串进行强匹配。", "example": "stream" } ], "required": [ "DomainName", "AppName", "StreamName" ] }, { "name": "DeleteLiveTimeShiftTemplate", "description": "删除直播时移模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。", "example": "1000" } ], "required": [ "TemplateId" ] }, { "name": "DeleteLiveTranscodeRule", "description": "删除转码规则。 DomainName+AppName+StreamName+TemplateId唯一标识单个转码规则，如需删除需要强匹配。其中TemplateId必填，其余参数为空时也需要传空字符串进行强匹配。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "播放域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" }, { "name": "TemplateId", "type": "integer", "required": true, "description": "模板ID。", "example": "1000" } ], "required": [ "DomainName", "AppName", "StreamName", "TemplateId" ] }, { "name": "DeleteLiveTranscodeTemplate", "description": "删除转码模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。 1. 在创建转码模板接口 [CreateLiveTranscodeTemplate](/document/product/267/32646) 调用的返回值中获取模板 ID。 2. 可以从接口 [DescribeLiveTranscodeTemplates](/document/product/267/32641) 查询已经创建过的模板列表。", "example": "1000" } ], "required": [ "TemplateId" ] }, { "name": "DeleteLiveWatermark", "description": "删除水印。", "status": "online", "parameters": [ { "name": "WatermarkId", "type": "integer", "required": true, "description": "水印 ID。 在添加水印接口 [AddLiveWatermark](/document/product/267/30154) 调用返回值中获取水印 ID。 或DescribeLiveWatermarks接口返回的水印ID。", "example": "43527" } ], "required": [ "WatermarkId" ] }, { "name": "DeleteLiveWatermarkRule", "description": "删除水印规则", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径。与推流和播放地址中的 AppName 保持一致，默认为live。", "example": "live" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" } ], "required": [ "DomainName", "AppName", "StreamName" ] }, { "name": "DeletePullStreamConfig", "description": "删除直播拉流配置。该接口已下线,请使用新接口 DeleteLivePullStreamTask。", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "配置 ID。 1. 在添加拉流配置接口 [CreatePullStreamConfig](/document/api/267/30159) 调用返回值中获取配置 ID。 2. 可以从接口 [DescribePullStreamConfigs](/document/api/267/30158) 中查询已创建过的拉流配置列表。", "example": "9485234" } ], "required": [ "ConfigId" ] }, { "name": "DeleteRecordTask", "description": "删除录制任务配置。删除操作不影响正在运行当中的任务，仅对删除之后新的推流有效。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，CreateRecordTask返回。删除TaskId指定的录制任务。", "example": "UZZUVbQ1FSQFlvKxYSBxUVGzB00UEFTZU5RlNURlhR1FDUVBFUWpCkNbUUBKb" } ], "required": [ "TaskId" ] }, { "name": "DeleteScreenshotTask", "description": "删除截图任务配置。删除操作不影响正在运行当中的任务，仅对删除之后新的推流有效。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID，CreateScreenshotTask返回。删除TaskId指定的截图任务。", "example": "UZZUVbQ1FSQFlvKxYSBxUVGzB00UEFTZU5RlNURlhR1FDUVBFUWpCkNbUUBKb" } ], "required": [ "TaskId" ] }, { "name": "DescribeAllStreamPlayInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 输入某个时间点（1分钟维度），查询该时间点所有流的下行信息。", "status": "online", "parameters": [ { "name": "QueryTime", "type": "string", "required": true, "description": "查询时间点，精确到分钟粒度，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO%20%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F,-ISO%20%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。 支持最近1个月的数据查询，数据延迟为5分钟左右，如果要查询实时的数据，建议传\ufffd...", "example": "2019-12-12 10:00:00" }, { "name": "PlayDomains", "type": "array", "required": false, "description": "播放域名列表，若不填，表示总体数据。", "example": "[\"5000.playdomain.com\"]", "item_type": "string" } ], "required": [ "QueryTime" ] }, { "name": "DescribeAreaBillBandwidthAndFluxList", "description": "海外分区直播播放带宽和流量数据查询。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点，格式为yyyy-mm-dd HH:MM:SS。", "example": "2019-02-0100:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点，格式为yyyy-mm-dd HH:MM:SS，起始和结束时间跨度不支持超过1天。", "example": "2019-02-0100:10:00" }, { "name": "PlayDomains", "type": "array", "required": false, "description": "直播播放域名，若不填，表示总体数据。", "example": "[\"5000.playdomain.com\\n\"]", "item_type": "string" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeAuditKeywords", "description": "获取关键词信息。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "获取偏移量。", "example": "20" }, { "name": "Limit", "type": "integer", "required": true, "description": "单页条数，最大为100条，超过则按100条返回。", "example": "0" }, { "name": "LibId", "type": "string", "required": true, "description": "关键词库 Id。", "example": "4c49c04f-6617-4705-b3ff-bedce642bfcb" }, { "name": "Content", "type": "string", "required": true, "description": "关键词搜索字段。 为空字符串时忽略。", "example": "黄暴" }, { "name": "Labels", "type": "array", "required": false, "description": "标签类别搜索。", "example": "[123,456]", "item_type": "integer" } ], "required": [ "Offset", "Limit", "LibId", "Content" ] }, { "name": "DescribeBackupStreamList", "description": "返回正在直播中的流列表。适用于推流成功后查询在线流信息。 注意： 1. 该接口仅提供辅助查询在线流列表功能，业务重要场景不可强依赖该接口。 2. 该接口仅适用于流数少于2万路的情况，对于流数较大用户请联系售后。", "status": "online", "parameters": [ { "name": "StreamName", "type": "string", "required": false, "description": "流名称，用于精确查询。", "example": "mystream" } ], "required": [] }, { "name": "DescribeBillBandwidthAndFluxList", "description": "直播播放带宽和流量数据查询。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。", "example": "2019-02-01T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。 起始和结束时间跨度不支持超过31天。支持最近3年的数据查询", "example": "2019-02-01T00:10:00+08:00" }, { "name": "PlayDomains", "type": "array", "required": false, "description": "直播播放域名，若不填，表示总体数据。", "example": "[\"5000.playdomain.com\\n\"]", "item_type": "string" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "可选值：Mainland：查询国内数据，Oversea：则查询国外数据，默认：查询国内+国外的数据。", "example": "Mainland" }, { "name": "Granularity", "type": "integer", "required": false, "description": "数据粒度，支持如下粒度： 5：5分钟粒度，（跨度不支持超过1天）， 60：1小时粒度（跨度不支持超过一个月）， 1440：天粒度（跨度不支持超过一个月）。 默认值：5。", "example": "5" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称，可选值包括LVB(标准直播)，LEB(快直播)，不填则查LVB+LEB总值。", "example": "LEB" }, { "name": "RegionNames", "type": "array", "required": false, "description": "大区，映射表如下： China Mainland 中国大陆 Asia Pacific I 亚太一区 Asia Pacific II 亚太二区 Asia Pacific III 亚太三区 Europe 欧洲 North America 北美 South America 南美 Middle East 中东 Africa 非洲。", "example": "[\"China Mainland\"]", "item_type": "string" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeCallbackRecordsList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 用于查询回调事件。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F) 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。", "example": "2020-10-12T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F) 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。 查询的起始和结束时间跨度不支持超过1天。仅支持查询最近14天的数据。", "example": "2020-10-12T00:00:00+08:00" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称，精确匹配。", "example": "stream1" }, { "name": "PageNum", "type": "integer", "required": true, "description": "页码。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页条数。", "example": "10" }, { "name": "EventType", "type": "integer", "required": false, "description": "事件类型。 0: \"断流\", 1: \"推流\", 100: \"录制\" 200: \"截图回调\"。", "example": "1" }, { "name": "ResultCode", "type": "integer", "required": false, "description": "回调结果。 0为成功，其他为失败。", "example": "0" } ], "required": [ "StartTime", "EndTime", "StreamName", "PageNum", "PageSize" ] }, { "name": "DescribeCaster", "description": "查询导播台信息接口，用来查询导播台状态、描述、输出长、宽等信息", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "需查询的导播台ID", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "DescribeCasterDisplayInfo", "description": "查询导播台PVW任务和PGM任务的展示信息，包括使用的布局、水印、字幕等信息。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "DescribeCasterEmergencyStatus", "description": "该接口用查询导播台的备播状态", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "DescribeCasterInputInfos", "description": "该接口用来查询导播台的输入源信息列表。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "DescribeCasterLayoutInfos", "description": "该接口用来查询某个导播台的布局列表", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "DescribeCasterList", "description": "该接口用来查询账号下所有的导播台列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeCasterMarkPicInfos", "description": "该接口用来查询某个导播台的水印列表。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "DescribeCasterMarkWordInfos", "description": "该接口用来查询某个导播台的文本列表。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "DescribeCasterOutputInfos", "description": "该接口用来查询某个导播台的推流信息列表。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "DescribeCasterPlayUrl", "description": "该接口用来获取导播台视频流的播放url，用来在页面上拉流展示。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID", "example": "63501" }, { "name": "PlayUrlType", "type": "integer", "required": true, "description": "请求播放url的类型。 取值范围[1，2，3] 1：获取输入源的播放url 2：获取pvw的播放url 3：获取pgm的播放url", "example": "1" }, { "name": "PlayUrlIndex", "type": "integer", "required": false, "description": "仅在PlayUrlType为1时生效，此时该参数表示请求的输入源Index。 注：对应的输入源必须存在。", "example": "1" } ], "required": [ "CasterId", "PlayUrlType" ] }, { "name": "DescribeCasterTransitionTypes", "description": "该接口用来获取所有的转场名称及其对应的素材url。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "DescribeCasterUserStatus", "description": "本接口用来查询当前APPID导播台业务状态", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeConcurrentRecordStreamNum", "description": "查询并发录制路数，对慢直播和普通直播适用。", "status": "online", "parameters": [ { "name": "LiveType", "type": "string", "required": true, "description": "直播类型，SlowLive：慢直播。 NormalLive：普通直播。", "example": "NormalLive" }, { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。 可以查询最近180天的数据。", "example": "2019-03-01T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。 时间跨度最大支持31天。", "example": "2019-03-01T00:00:00+08:00" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "如果为空，查询所有地区数据；如果为“Mainland”，查询国内数据；如果为“Oversea”，则查询国外数据。", "example": "Mainland" }, { "name": "PushDomains", "type": "array", "required": false, "description": "推流域名列表，不填表示总体数据。", "example": "[\"5000.livepush.com\\r\\n\"]", "item_type": "string" } ], "required": [ "LiveType", "StartTime", "EndTime" ] }, { "name": "DescribeDeliverBandwidthList", "description": "查询直播转推计费带宽，查询时间范围最大支持3个月内的数据，时间跨度最长31天。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。", "example": "2020-01-07 21:10:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。 支持最近三个月的数据查询，时间跨度最大是1个月。", "example": "2020-01-07 21:15:00" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeDeliverLogDownList", "description": "批量获取转推日志的URL。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。UTC 格式，例如：2022-02-09T12:36:42Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。", "example": "2022-02-09T12:36:42Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。UTC 格式，例如：2022-02-09T12:36:42Z。注意：结束时间 - 开始时间 \u0026lt;=7天。北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。", "example": "2022-02-09T12:36:42Z" }, { "name": "DeliverDomains", "type": "array", "required": true, "description": "域名列表。", "example": "[\"test.livepabc.com\"]", "item_type": "string" } ], "required": [ "StartTime", "EndTime", "DeliverDomains" ] }, { "name": "DescribeGroupProIspPlayInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 查询按省份和运营商分组的下行播放数据。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。", "example": "2019-03-29 09:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 时间跨度在（0,3小时]，支持最近1个月数据查询。", "example": "2019-03-29 09:10:00" }, { "name": "PlayDomains", "type": "array", "required": false, "description": "播放域名，默认为不填，表示求总体数据。", "example": "[\"live.com\"]", "item_type": "string" }, { "name": "ProvinceNames", "type": "array", "required": false, "description": "省份列表，默认不填，则返回各省份的数据。", "example": "[\"Beijing\"]", "item_type": "string" }, { "name": "IspNames", "type": "array", "required": false, "description": "运营商列表，默认不填，则返回整个运营商的数据。", "example": "[\"China Mobile\"]", "item_type": "string" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "国内还是国外，如果为空，查询所有地区数据；如果为“Mainland”，查询国内数据；如果为“Oversea”，则查询国外数据。", "example": "Mainland" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeHttpStatusInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 查询某段时间内5分钟粒度的各播放http状态码的个数。 备注：数据延迟1小时，如10:00-10:59点的数据12点才能查到。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。", "example": "2019-03-01T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。", "example": "2019-03-01T00:00:00+08:00" }, { "name": "PlayDomains", "type": "array", "required": false, "description": "播放域名列表。", "example": "[\"5000.liveplay.com\\n\"]", "item_type": "string" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeLiveCallbackRules", "description": "获取回调规则列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLiveCallbackTemplate", "description": "获取单个回调模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。 1. 在创建回调模板接口 [CreateLiveCallbackTemplate](/document/product/267/32637) 调用的返回值中获取模板 ID。 2. 可以从接口 [DescribeLiveCallbackTemplates](/document/product/267/32632) 查询已经创建的过的模板列表。", "example": "1000" } ], "required": [ "TemplateId" ] }, { "name": "DescribeLiveCallbackTemplates", "description": "获取回调模板列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLiveCert", "description": "获取证书信息", "status": "online", "parameters": [ { "name": "CertId", "type": "integer", "required": true, "description": "DescribeLiveCerts接口获取到的证书Id。", "example": "F4eO8WVE" } ], "required": [ "CertId" ] }, { "name": "DescribeLiveCerts", "description": "获取证书信息列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLiveCloudEffectConfig", "description": "使用该接口查询云端特效配置信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLiveCloudEffectList", "description": "使用该接口查询云端特效列表，特效列表中包含一部分官方精品特效，同时包含用户自定义生成的特效。", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": false, "description": "云端特效ID。", "example": "1552" }, { "name": "Prompt", "type": "string", "required": false, "description": "云端特效描述词。由用户原始输入的描述词。", "example": "小熊" }, { "name": "Flag", "type": "string", "required": false, "description": "云端特效标签。对云端特效进行分类标签，可用于分类搜索。", "example": "动物" }, { "name": "Type", "type": "string", "required": false, "description": "云端特效类型, 默认不填，返回全部。PGC: 特效库中的特效；AICG : AI生成的特效；UGC：用户自定义上传的特效；", "example": "UGC" } ], "required": [] }, { "name": "DescribeLiveDelayInfoList", "description": "获取直播延播列表。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLiveDomain", "description": "查询直播域名信息。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "域名。", "example": "domain.com" } ], "required": [ "DomainName" ] }, { "name": "DescribeLiveDomainCert", "description": "获取域名证书信息。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "播放域名。", "example": "5000.liveplay.com" } ], "required": [ "DomainName" ] }, { "name": "DescribeLiveDomainCertBindings", "description": "查询绑定证书的域名列表。", "status": "online", "parameters": [ { "name": "DomainSearch", "type": "string", "required": false, "description": "要搜索的域名字符串。", "example": "pull" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录行的位置，从0开始。默认0。", "example": "0" }, { "name": "Length", "type": "integer", "required": false, "description": "记录行的最大数目。默认50。 若不传，则最多返回50条数据。", "example": "10" }, { "name": "DomainName", "type": "string", "required": false, "description": "要查询的单个域名。", "example": "pull.sdzgxx.cn" }, { "name": "OrderBy", "type": "string", "required": false, "description": "可取值： ExpireTimeAsc：证书过期时间升序。 ExpireTimeDesc：证书过期时间降序。", "example": "ExpireTimeAsc" } ], "required": [] }, { "name": "DescribeLiveDomainPlayInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 查询实时的域名维度下行播放数据，由于数据处理有耗时，接口默认查询4分钟前的准实时数据。", "status": "online", "parameters": [ { "name": "PlayDomains", "type": "array", "required": false, "description": "播放域名列表。", "example": "[\"live.com\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeLiveDomainReferer", "description": "查询直播域名 Referer 黑白名单配置。 由于 Referer 信息包含在 http 协议中，在开启配置后，播放协议为 rtmp 或 WebRTC 不会校验 Referer 配置，仍可正常播放。如需配置 Referer 鉴权建议使用 http-flv 或 http-hls 协议播放。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "播放域名。", "example": "5000.liveplay.myqcloud.com" } ], "required": [ "DomainName" ] }, { "name": "DescribeLiveDomains", "description": "根据域名状态、类型等信息查询用户的域名信息。", "status": "online", "parameters": [ { "name": "DomainStatus", "type": "integer", "required": false, "description": "域名状态过滤。0-停用，1-启用。", "example": "1" }, { "name": "DomainType", "type": "integer", "required": false, "description": "域名类型过滤。0-推流，1-播放。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页大小，范围：10~100。默认10。", "example": "10" }, { "name": "PageNum", "type": "integer", "required": false, "description": "取第几页，范围：1~100000。默认1。", "example": "1" }, { "name": "IsDelayLive", "type": "integer", "required": false, "description": "0 普通直播 1慢直播 默认0。", "example": "0" }, { "name": "DomainPrefix", "type": "string", "required": false, "description": "域名前缀。", "example": "qq" }, { "name": "PlayType", "type": "integer", "required": false, "description": "播放区域，只在 DomainType=1 时该参数有意义。 1: 国内。 2: 全球。 3: 海外。", "example": "1" } ], "required": [] }, { "name": "DescribeLiveEnhanceInfoList", "description": "查询直播增强用量明细信息。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点，使用ISO格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见[ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 接口支持最近三个月的查询，开始时间和结束时间查询跨度不能超过三十天。", "example": "2019-03-01T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点，使用ISO格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见[ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 接口支持最近三个月的查询，开始时间和结束时间查询跨度不能超过三十天。", "example": "2019-03-01T12:00:00+08:00" }, { "name": "Granularity", "type": "integer", "required": false, "description": "查询粒度，支持5，60分钟。", "example": "5" }, { "name": "DomainNames", "type": "array", "required": false, "description": "查询域名，如果不填则默认查全部的数据。", "example": "test.com", "item_type": "string" }, { "name": "Type", "type": "array", "required": false, "description": "增强服务类型，如果不填则默认查全部的数据。", "example": "StreamID", "item_type": "string" }, { "name": "Resolution", "type": "array", "required": false, "description": "分辨率，如果不填则默认查全部的数据。", "example": "[\"1080P\"]", "item_type": "string" }, { "name": "Fps", "type": "array", "required": false, "description": "帧率，如果不填则默认查全部的数据。", "example": "[\"30\"]", "item_type": "string" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeLivePackageInfo", "description": "查询用户套餐包总量、使用量、剩余量、包状态、购买时间和过期时间等。", "status": "online", "parameters": [ { "name": "PackageType", "type": "integer", "required": true, "description": "包类型，可选值： 0：流量包 1：转码包 2: 连麦包。", "example": "1" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序规则: 1. BuyTimeDesc： 最新购买的排在最前面 2. BuyTimeAsc： 最老购买的排在最前面 3. ExpireTimeDesc： 最后过期的排在最前面 4. ExpireTimeAsc：最先过期的排在最前面。 注意： 1. PackageType 为 2（连麦包） 的时候，不支持 3、4 排序。", "example": "BuyTime desc" }, { "name": "PageNum", "type": "integer", "required": false, "description": "取得第几页的数据，和 PageSize 同时传递才会生效。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页大小，和 PageNum 同时传递才会生效。 取值：10 ～ 100 之间的任意整数。", "example": "10" } ], "required": [ "PackageType" ] }, { "name": "DescribeLivePadRules", "description": "获取直播垫片规则列表。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLivePadStreamList", "description": "使用该接口查询垫片流列表。垫片流状态更新存在一定延迟，可间隔30秒以上查询，避免频繁查询该接口。", "status": "online", "parameters": [ { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" }, { "name": "DomainName", "type": "string", "required": false, "description": "您的推流域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称。", "example": "stream1" }, { "name": "PageNum", "type": "integer", "required": false, "description": "分页页数。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页个数。", "example": "10" } ], "required": [] }, { "name": "DescribeLivePadTemplate", "description": "获取单个直播垫片模板", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板id。", "example": "1" } ], "required": [ "TemplateId" ] }, { "name": "DescribeLivePadTemplates", "description": "获取直播垫片模板。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLivePlayAuthKey", "description": "查询播放鉴权key。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "域名。", "example": "a.elementtest.org" } ], "required": [ "DomainName" ] }, { "name": "DescribeLivePullStreamTaskStatus", "description": "查询直播拉流任务状态信息。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务 ID。", "example": "965421" } ], "required": [ "TaskId" ] }, { "name": "DescribeLivePullStreamTasks", "description": "查询使用 CreateLivePullStreamTask 接口创建的直播拉流任务。 排序方式：默认按更新时间 倒序排列。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": false, "description": "任务 ID。 来源：调用 CreateLivePullStreamTask 接口时返回。 不填默认查询所有任务，按更新时间倒序排序。", "example": "956321" }, { "name": "PageNum", "type": "integer", "required": false, "description": "取得第几页，默认值：1。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页大小，默认值：10。 取值范围：1~20 之前的任意整数。", "example": "10" }, { "name": "SpecifyTaskId", "type": "string", "required": false, "description": "使用指定任务 ID 查询任务信息。 注意：仅供使用指定 ID 创建的任务查询。", "example": "myspecifytaskid" } ], "required": [] }, { "name": "DescribeLivePushAuthKey", "description": "查询直播推流鉴权key", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "pull.show.com" } ], "required": [ "DomainName" ] }, { "name": "DescribeLiveRecordRules", "description": "获取录制规则列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLiveRecordTemplate", "description": "获取单个录制模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "[DescribeLiveRecordTemplates](/document/product/267/32609)接口获取到的模板 ID。", "example": "10000" } ], "required": [ "TemplateId" ] }, { "name": "DescribeLiveRecordTemplates", "description": "获取录制模板列表。", "status": "online", "parameters": [ { "name": "IsDelayLive", "type": "integer", "required": false, "description": "是否属于慢直播模板，默认：0。 0： 标准直播。 1：慢直播。", "example": "1" } ], "required": [] }, { "name": "DescribeLiveSnapshotRules", "description": "获取截图规则列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLiveSnapshotTemplate", "description": "获取单个截图模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。 调用 [CreateLiveSnapshotTemplate](/document/product/267/32624) 时返回的模板 ID。", "example": "865421" } ], "required": [ "TemplateId" ] }, { "name": "DescribeLiveSnapshotTemplates", "description": "获取截图模板列表。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLiveStreamEventList", "description": "用于查询推断流事件。 注意： 1. 该接口提供离线推断流记录查询功能，不可作为重要业务场景强依赖接口。 2. 该接口可通过使用IsFilter进行过滤，返回推流历史记录。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间。 UTC 格式，例如：2018-12-29T19:00:00Z。支持查询2个月内的历史记录。", "example": "2019-01-04T12:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。UTC 格式，例如：2018-12-29T20:00:00Z。不超过当前时间，且和起始时间相差不得超过1个月。", "example": "2019-01-04T20:00:00Z" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" }, { "name": "DomainName", "type": "string", "required": false, "description": "推流域名。", "example": "yourdomain.test.com" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称，不支持通配符（*）查询，默认模糊匹配。 可使用IsStrict字段改为精确查询。", "example": "stream" }, { "name": "PageNum", "type": "integer", "required": false, "description": "取得第几页。 默认值：1。 注： 目前只支持10000条内的查询。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页大小。 最大值：100。 取值范围：1~100 之间的任意整数。 默认值：10。 注： 目前只支持10000条内的查询。", "example": "10" }, { "name": "IsFilter", "type": "integer", "required": false, "description": "是否过滤，默认不过滤。 0：不进行任何过滤。 1：过滤掉开播失败的，只返回开播成功的。", "example": "1" }, { "name": "IsStrict", "type": "integer", "required": false, "description": "是否精确查询，默认模糊匹配。 0：模糊匹配。 1：精确查询。 注：使用StreamName时该参数生效。", "example": "0" }, { "name": "IsAsc", "type": "integer", "required": false, "description": "是否按结束时间正序显示，默认逆序。 0：逆序。 1：正序。", "example": "0" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeLiveStreamMonitor", "description": "该接口用来查询某个特定监播任务的配置。", "status": "online", "parameters": [ { "name": "MonitorId", "type": "string", "required": true, "description": "监播任务ID。", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "required": [ "MonitorId" ] }, { "name": "DescribeLiveStreamMonitorList", "description": "该接口用来查询直播流监播任务配置的列表信息。", "status": "online", "parameters": [ { "name": "Index", "type": "integer", "required": true, "description": "查询列表时的起始偏移。", "example": "0" }, { "name": "Count", "type": "integer", "required": true, "description": "本次查询的记录个数。最小值为1。", "example": "1" } ], "required": [ "Index", "Count" ] }, { "name": "DescribeLiveStreamOnlineList", "description": "返回正在直播中的流列表。适用于推流成功后查询在线流信息。 注意： 1. 该接口仅提供辅助查询在线流列表功能，业务重要场景不可强依赖该接口。 2. 该接口仅适用于流数少于2万路的情况，对于流数较大用户请联系售后。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": false, "description": "推流域名。多域名用户需要填写 DomainName。", "example": "5000.livepush.myqcloud.com" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与推流和播放地址中的 AppName 保持一致，默认为 live。多路径用户需要填写 AppName。", "example": "live" }, { "name": "PageNum", "type": "integer", "required": false, "description": "取得第几页，默认1。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页大小，最大300000。 取值：10~300000之间的任意整数。 默认值：10。 注意：尽量传入比当前总流数大的PageSize, 一次性拉走全部在线流，减少访问频次，推荐1分钟拉取一次。", "example": "10" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称，用于精确查询。", "example": "mystream" } ], "required": [] }, { "name": "DescribeLiveStreamPublishedList", "description": "返回已经推过流的流列表。 注意：分页最多支持查询1万条记录，可通过调整查询时间范围来获取更多数据。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "您的推流域名。", "example": "5000.livepush.com" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。UTC 格式，例如：2016-06-30T19:00:00Z。不超过当前时间。注意：EndTime和StartTime相差不可超过1个月。", "example": "2024-11-23T00:00:00Z" }, { "name": "StartTime", "type": "string", "required": true, "description": "起始时间。 UTC 格式，例如：2016-06-29T19:00:00Z。最长支持查询2个月内数据。", "example": "2024-11-22T00:00:00Z" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与推流和播放地址中的 AppName 保持一致，默认为 live。不支持模糊匹配。", "example": "live" }, { "name": "PageNum", "type": "integer", "required": false, "description": "取得第几页。 默认值：1。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页大小。 最大值：100。 取值范围：10~100 之前的任意整数。 默认值：10。", "example": "10" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称，支持模糊匹配。", "example": "myroomname" } ], "required": [ "DomainName", "EndTime", "StartTime" ] }, { "name": "DescribeLiveStreamPushInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 查询所有实时流的推流信息，包括客户端IP，服务端IP，帧率，码率，域名，开始推流时间。", "status": "online", "parameters": [ { "name": "PushDomain", "type": "string", "required": false, "description": "推流域名。", "example": "5000.pushdomain.com" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为live。", "example": "live" }, { "name": "PageNum", "type": "integer", "required": false, "description": "页数， 范围[1,10000]， 默认值：1。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页个数， 范围：[1,100000]， 默认值： 200。 注意： 1. 这里尽量PageSize填大于预估在线流数，一次性全部把在线流拉过去，减少分页查询次数。 2. 该接口用于拉取在线流，减少高频调用，推荐每分钟查询一次，结合推断流在线回调来维护在线流状态。", "example": "1000" } ], "required": [] }, { "name": "DescribeLiveStreamState", "description": "返回直播中、无推流或者禁播等状态。 使用建议： 该接口提供实时流状态查询功能，鉴于网络抖动等一些不可抗因素，使用该接口作为判断主播是否开播等重要业务场景时，请参考以下使用建议。 1. 优先使用业务自身的房间开关播逻辑，判断主播是否在线，譬如客户端开播信令和主播在线心跳等。 2. 对于没有房间管理的直播场景，可以结合以下方案综合判断。 2.1 根据[推断\ufffd...", "status": "online", "parameters": [ { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" }, { "name": "DomainName", "type": "string", "required": true, "description": "您的推流域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" } ], "required": [ "AppName", "DomainName", "StreamName" ] }, { "name": "DescribeLiveTimeShiftBillInfoList", "description": "提供给客户对账，按天统计，维度：推流域名、时移文件时长（累加）、配置天数（不累加）、时移总时长（累加）。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "UTC开始时间，支持最近三个月的查询，查询时间最长跨度为一天。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。", "example": "2006-01-02T15:04:05+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "UTC结束时间，支持最近三个月的查询，查询时间最长跨度为一天。使用 UTC 格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。", "example": "2006-01-02T15:04:05+08:00" }, { "name": "PushDomains", "type": "array", "required": false, "description": "推流域名列表，若不传递此参数，则表示查询总体数据。", "example": "[\"5000.pushdomain.com\"]", "item_type": "string" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeLiveTimeShiftRules", "description": "获取直播时移规则列表。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLiveTimeShiftTemplates", "description": "获取直播时移模板。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLiveTimeShiftWriteSizeInfoList", "description": "支持直播时移写入量数据查询。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 支持最近六个月的查询，查询开始和结束时间跨度不支持超过31天。", "example": "2022-11-01T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 支持最近六个月的查询，查询开始和结束时间跨度不支持超过31天。", "example": "2022-11-01T00:00:00+08:00" }, { "name": "DomainNames", "type": "array", "required": false, "description": "域名。", "example": "[\"5000.livepull.stream.com\"]", "item_type": "string" }, { "name": "Dimensions", "type": "array", "required": false, "description": "维度 Area地区、Domain 域名、StorageDays 时移天数", "example": "[\"Time\",\"CountryOrAreaNames\"]", "item_type": "string" }, { "name": "StorageDays", "type": "array", "required": false, "description": "时移天数。", "example": "[1,3,7,15,30]", "item_type": "integer" }, { "name": "Granularity", "type": "integer", "required": false, "description": "时间跨度（分钟） 默认5，可选 5、60或者1440。", "example": "60" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "区域 可选Mainland、Oversea。", "example": "Oversea" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeLiveTranscodeDetailInfo", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 支持查询某天或某段时间的转码详细信息。由于转码数据量较大，如果查询时间跨度太长可能会拉不到数据，可以尝试将查询时间范围缩小些再重试。", "status": "online", "parameters": [ { "name": "PushDomain", "type": "string", "required": false, "description": "推流域名。", "example": "test.push.com" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称。", "example": "streamtest" }, { "name": "DayTime", "type": "string", "required": false, "description": "查询时间，北京时间，格式：yyyymmdd。注意：支持查询近1个月内某天的详细数据，截止到昨天。", "example": "20190307" }, { "name": "PageNum", "type": "integer", "required": false, "description": "页数，默认1，不超过100页。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页个数，默认20，范围：[10,1000]。", "example": "20" }, { "name": "StartDayTime", "type": "string", "required": false, "description": "起始天时间，北京时间，格式：yyyymmdd。注意：支持查询近1个月内的详细数据。", "example": "20190307" }, { "name": "EndDayTime", "type": "string", "required": false, "description": "结束天时间，北京时间，格式：yyyymmdd。注意：支持查询近1个月内的详细数据，截止到昨天，注意DayTime 与（StartDayTime，EndDayTime）必须要传一个，如果都传，会以DayTime为准 。", "example": "20190307" } ], "required": [] }, { "name": "DescribeLiveTranscodeRules", "description": "获取转码规则列表", "status": "online", "parameters": [ { "name": "TemplateIds", "type": "array", "required": false, "description": "要筛选的模板ID数组。", "example": "365245", "item_type": "integer" }, { "name": "DomainNames", "type": "array", "required": false, "description": "要筛选的域名数组。", "example": "tc.videosolar.com", "item_type": "string" } ], "required": [] }, { "name": "DescribeLiveTranscodeTemplate", "description": "获取单个转码模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。 注意：在创建转码模板接口 [CreateLiveTranscodeTemplate](/document/product/267/32646) 调用的返回值中获取模板 ID。", "example": "1000" } ], "required": [ "TemplateId" ] }, { "name": "DescribeLiveTranscodeTemplates", "description": "获取转码模板列表。", "status": "online", "parameters": [ { "name": "TemplateType", "type": "integer", "required": false, "description": "转码模板类型，默认0。 0：普通转码模板。 1：自适应码率转码模板。", "example": "1" } ], "required": [] }, { "name": "DescribeLiveTranscodeTotalInfo", "description": "查询转码总量数据，可查询近三个月内的数据。 注意： 如果是查询某一天内，则返回5分钟粒度数据； 如果是查询跨天或指定域名， 则返回1小时粒度数据。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，支持最近三个月的数据查询，起始时间和结束时间跨度不能超过三个月。接口查询支持两种时间格式：1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 ISO 日期格式说明2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。", "example": "2019-03-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，支持最近三个月的数据查询，起始时间和结束时间跨度不能超过三个月。接口查询支持两种时间格式：1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 ISO 日期格式说明2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。", "example": "2019-03-01 12:00:00" }, { "name": "PushDomains", "type": "array", "required": false, "description": "推流域名列表，若不填，表示查询所有域名总体数据。指定域名时返回1小时粒度数据。", "example": "[\"test.com\"]", "item_type": "string" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "可选值：Mainland：查询中国大陆（境内）数据，Oversea：则查询国际/港澳台（境外）数据，默认：查询全球地区（境内+境外）的数据。", "example": "Mainland" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeLiveWatermark", "description": "获取单个水印信息。", "status": "online", "parameters": [ { "name": "WatermarkId", "type": "integer", "required": true, "description": "DescribeLiveWatermarks接口返回的水印 ID。", "example": "10001" } ], "required": [ "WatermarkId" ] }, { "name": "DescribeLiveWatermarkRules", "description": "获取水印规则列表。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeLiveWatermarks", "description": "查询水印列表。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "水印名称", "example": "watermaker" }, { "name": "PageNo", "type": "integer", "required": false, "description": "分页的索引参数，从1开始", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页的大小参数，默认值500", "example": "10" } ], "required": [] }, { "name": "DescribeLiveXP2PDetailInfoList", "description": "P2P流数据查询接口，用来获取流量、卡播和起播信息。", "status": "online", "parameters": [ { "name": "QueryTime", "type": "string", "required": false, "description": "utc分钟粒度查询时间，查询某一分钟的用量数据，格式为：yyyy-mm-ddTHH:MM:00Z，参考https://cloud.tencent.com/document/product/266/11732#I， 例如：北京时间2019-01-08 10:00:00，对应utc时间为：2019-01-08T10:00:00+08:00。 支持最近六个月的查询。", "example": "2006-01-02T15:02:00Z" }, { "name": "Type", "type": "array", "required": false, "description": "类型数组，分直播live和点播vod，不传默认查全部。", "example": "[\"live\",\"vod\"]", "item_type": "string" }, { "name": "StreamNames", "type": "array", "required": false, "description": "查询流数组，不传默认查所有流。", "example": "[\"streamname\"]", "item_type": "string" }, { "name": "Dimension", "type": "array", "required": false, "description": "查询维度，不传该参数则默认查询流维度的数据，传递该参数则只查对应维度的数据，和返回值的字段相关，目前支持AppId维度查询。", "example": "[\"AppId\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeLogDownloadList", "description": "批量获取日志URL。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，北京时间。 格式：yyyy-mm-dd HH:MM:SS。 注：此字段为北京时间（UTC+8时区）。", "example": "2019-03-12 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，北京时间。 格式：yyyy-mm-dd HH:MM:SS。 注意：结束时间 - 开始时间 \u003c=7天。 注：此字段为北京时间（UTC+8时区）。", "example": "2019-03-12 12:00:00" }, { "name": "PlayDomains", "type": "array", "required": true, "description": "域名列表。", "example": "[\"5000.liveplay.com\\r\\n\"]", "item_type": "string" }, { "name": "IsFastLive", "type": "integer", "required": false, "description": "快直播还是标准直播，0：标准直播，1：快直播。默认为0。", "example": "0" } ], "required": [ "StartTime", "EndTime", "PlayDomains" ] }, { "name": "DescribeMonitorReport", "description": "用来查询监播场次7天内的智能识别、断流、低帧率等信息的汇总报告。", "status": "online", "parameters": [ { "name": "MonitorId", "type": "string", "required": true, "description": "监播任务ID。", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "required": [ "MonitorId" ] }, { "name": "DescribePlayErrorCodeDetailInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 查询下行播放错误码信息，某段时间内1分钟粒度的各http错误码出现的次数，包括4xx，5xx。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。", "example": "2019-03-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 注：EndTime 和 StartTime 只支持最近1天的数据查询。", "example": "2019-03-01 00:01:00" }, { "name": "Granularity", "type": "integer", "required": true, "description": "查询粒度： 1-1分钟粒度。", "example": "1" }, { "name": "StatType", "type": "string", "required": true, "description": "是，可选值包括”4xx”,”5xx”，支持”4xx,5xx”等这种混合模式。", "example": "4xx" }, { "name": "PlayDomains", "type": "array", "required": false, "description": "播放域名列表。", "example": "[\"5000.playdomain.com\\n\"]", "item_type": "string" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "地域，可选值：Mainland，Oversea，China，Foreign，Global（默认值）；如果为空，查询总的数据；如果为“Mainland”，查询中国大陆的数据；如果为“Oversea”，则查询中国大陆以外的数据；如果为China，查询中国的数据（包括港澳台）；如果为Foreign，查询国外的数据（不包括港澳台）。", "example": "Mainland" } ], "required": [ "StartTime", "EndTime", "Granularity", "StatType" ] }, { "name": "DescribePlayErrorCodeSumInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 查询下行播放错误码信息。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点，北京时间。 格式：yyyy-mm-dd HH:MM:SS。", "example": "2019-03-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点，北京时间。 格式：yyyy-mm-dd HH:MM:SS。 注：EndTime 和 StartTime 只支持最近1天的数据查询。", "example": "2019-03-01 12:00:00" }, { "name": "PlayDomains", "type": "array", "required": false, "description": "播放域名列表，不填表示总体数据。", "example": "[\"5000.playdomain.com\\n\"]", "item_type": "string" }, { "name": "PageNum", "type": "integer", "required": false, "description": "页数，范围[1,1000]，默认值是1。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页个数，范围：[1,1000]，默认值是20。", "example": "100" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "地域，可选值：Mainland，Oversea，China，Foreign，Global（默认值）；如果为空，查询总的数据；如果为“Mainland”，查询中国大陆的数据；如果为“Oversea”，则查询中国大陆以外的数据；如果为China，查询中国的数据（包括港澳台）；如果为Foreign，查询国外的数据（不包括港澳台）。", "example": "Mainland" }, { "name": "GroupType", "type": "string", "required": false, "description": "分组参数，可选值：CountryProIsp（默认值），Country（国家），默认是按照国家+省份+运营商来进行分组；目前国外的省份和运营商暂时无法识别。", "example": "CountryProIsp" }, { "name": "OutLanguage", "type": "string", "required": false, "description": "输出字段使用的语言，可选值：Chinese（默认值），English，目前国家，省份和运营商支持多语言。", "example": "Chinese" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeProIspPlaySumInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 查询某段时间内每个国家地区每个省份每个运营商的平均每秒流量，总流量，总请求数信息。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。", "example": "2019-03-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 注：EndTime 和 StartTime 只支持最近1天的数据查询。", "example": "2019-03-01 12:00:00" }, { "name": "StatType", "type": "string", "required": true, "description": "统计的类型，可选值：”Province”(省份)，”Isp”(运营商)，“CountryOrArea”(国家或地区)。", "example": "Province" }, { "name": "PlayDomains", "type": "array", "required": false, "description": "播放域名列表，不填则为全部。", "example": "[\"5000.playdomain.com\\r\\n\"]", "item_type": "string" }, { "name": "PageNum", "type": "integer", "required": false, "description": "页号，范围是[1,1000]，默认值是1。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页个数，范围是[1,1000]，默认值是20。", "example": "100" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "地域，可选值：Mainland，Oversea，China，Foreign，Global（默认值）；如果为空，查询总的数据；如果为“Mainland”，查询中国大陆的数据；如果为“Oversea”，则查询中国大陆以外的数据；如果为China，查询中国的数据（包括港澳台）；如果为Foreign，查询国外的数据（不包括港澳台）。", "example": "Mainland" }, { "name": "OutLanguage", "type": "string", "required": false, "description": "输出字段使用的语言，可选值：Chinese（默认值），English；目前国家，省份和运营商支持多语言。", "example": "Chinese" } ], "required": [ "StartTime", "EndTime", "StatType" ] }, { "name": "DescribeProvinceIspPlayInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 查询某省份某运营商下行播放数据，包括带宽，流量，请求数，并发连接数信息。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。", "example": "2019-02-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 注：EndTime 和 StartTime 只支持最近1天的数据查询。", "example": "2019-02-02 00:00:00" }, { "name": "Granularity", "type": "integer", "required": true, "description": "支持如下粒度： 1：1分钟粒度（跨度不支持超过1天）", "example": "1" }, { "name": "StatType", "type": "string", "required": true, "description": "统计指标类型： “Bandwidth”：带宽 “FluxPerSecond”：平均流量 “Flux”：流量 “Request”：请求数", "example": "Bandwidth" }, { "name": "PlayDomains", "type": "array", "required": false, "description": "播放域名列表。", "example": "[\"5000.playdomain.com\\n\"]", "item_type": "string" }, { "name": "ProvinceNames", "type": "array", "required": false, "description": "要查询的省份（地区）英文名称列表，如 Beijing。", "example": "[\"Beijing\"]", "item_type": "string" }, { "name": "IspNames", "type": "array", "required": false, "description": "要查询的运营商英文名称列表，如 China Mobile ，如果为空，查询所有运营商的数据。", "example": "[\"China Mobile\"]", "item_type": "string" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "地域，可选值：Mainland，Oversea，China，Foreign，Global（默认值）；如果为空，查询总的数据；如果为“Mainland”，查询中国大陆的数据；如果为“Oversea”，则查询中国大陆以外的数据；如果为China，查询中国的数据（包括港澳台）；如果为Foreign，查询国外的数据（不包括港澳台）。", "example": "Mainland" }, { "name": "IpType", "type": "string", "required": false, "description": "ip类型： “Ipv6”：Ipv6数据 如果为空，查询总的数据；", "example": "Ipv6" } ], "required": [ "StartTime", "EndTime", "Granularity", "StatType" ] }, { "name": "DescribePullStreamConfigs", "description": "查询直播拉流配置。该接口已下线,请使用新接口 DescribeLivePullStreamTasks。", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": false, "description": "配置 ID。 获取途径：从 CreatePullStreamConfig 接口返回值获取。", "example": "5674" } ], "required": [] }, { "name": "DescribePullTransformPushInfo", "description": "查询拉流转推任务的时长信息。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。", "example": "2021-05-21T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。 支持最近三年的查询，查询开始和结束时间跨度不支持超过31天。", "example": "2021-05-21T00:00:00+08:00" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "可选值： Mainland：查询国内数据， Oversea：则查询国外数据， 默认：查询国内+国外的数据。", "example": "Mainland" }, { "name": "SourceType", "type": "string", "required": false, "description": "可选值： PullLivePushLive：拉流源类型为直播 PullVodPushLive：拉流源类型为点播 PullPicPushLive：拉流源类型为图片 默认：查询全部拉流源类型", "example": "PullLivePushLive" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribePullTransformPushInfoList", "description": "查询拉流转推任务流数据统计信息。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "utc开始时间，格式为：yyyy-mm-ddTHH:MM:SSZ，参考https://cloud.tencent.com/document/product/266/11732#I， 例如：北京时间2019-01-08 10:00:00，对应utc时间为：2019-01-08T10:00:00+08:00。 支持最近一个月的查询。", "example": "2006-01-02T15:04:05Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "utc结束时间，格式为：yyyy-mm-ddTHH:MM:SSZ，参考https://cloud.tencent.com/document/product/266/11732#I， 例如：北京时间2019-01-08 10:00:00，对应utc时间为：2019-01-08T10:00:00+08:00。 支持最近一个月的查询，时间跨度为一个月。", "example": "2006-01-02T15:04:05Z" }, { "name": "TaskId", "type": "string", "required": true, "description": "拉流转推任务Id。", "example": "test" } ], "required": [ "StartTime", "EndTime", "TaskId" ] }, { "name": "DescribePushBandwidthAndFluxList", "description": "直播推流带宽和流量数据查询。 推流计费会先取全球推流用量和全球播放用量进行比较，满足计费条件后再按各地区用量出账。详情参见[计费文档](https://cloud.tencent.com/document/product/267/34175)。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询开始时间点，精确到分钟粒度，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#52)。 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。 支持最近两个月的查询，查询开始和结束时间跨度不支持超过31天。", "example": "2019-02-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询结束时间点，精确到分钟粒度，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#52)。 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。 支持最近两个月的查询，查询开始和结束时间跨度不支持超过31天。", "example": "2019-02-02 00:00:00" }, { "name": "PushDomains", "type": "array", "required": false, "description": "域名，可以填多个，若不填，表示总体数据。", "example": "[\"5000.pushdomain.com\"]", "item_type": "string" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "可选值： Mainland：查询中国大陆（境内）数据， Oversea：则查询国际/港澳台（境外）数据， 不填则默认查询全球地区（境内+境外）的数据。", "example": "Mainland" }, { "name": "Granularity", "type": "integer", "required": false, "description": "数据粒度，支持如下粒度： 5：5分钟粒度，（跨度不支持超过1天）， 60：1小时粒度（跨度不支持超过一个月）， 1440：天粒度（跨度不支持超过一个月）。 默认值：5。", "example": "5" }, { "name": "RegionNames", "type": "array", "required": false, "description": "大区，映射表如下： China Mainland 中国大陆 Asia Pacific I 亚太一区 Asia Pacific II 亚太二区 Asia Pacific III 亚太三区 Europe 欧洲 North America 北美 South America 南美 Middle East 中东 Africa 非洲。", "example": "[\"China Mainland\"]", "item_type": "string" }, { "name": "CountryNames", "type": "array", "required": false, "description": "国家，映射表参照如下文档： https://cloud.tencent.com/document/product/267/34019。", "example": "[\"孟买\"]", "item_type": "string" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeRecordTask", "description": "查询指定时间段范围内启动和结束的录制任务列表。 - 使用前提 1. 仅用于查询由 CreateRecordTask 接口创建的录制任务。 2. 不能查询被 DeleteRecordTask 接口删除以及已过期（平台侧保留3个月）的录制任务。", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "查询任务开始时间，Unix 时间戳。设置时间不早于当前时间之前90天的时间，且查询时间跨度不超过一周。", "example": "1595779200" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询任务结束时间，Unix 时间戳。EndTime 必须大于 StartTime，设置时间不早于当前时间之前90天的时间，且查询时间跨度不超过一周。（注意：任务开始结束时间必须在查询时间范围内）。", "example": "1595865600" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称。", "example": "livetest" }, { "name": "DomainName", "type": "string", "required": false, "description": "推流域名。", "example": "5000.live.push.com" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径。", "example": "live" }, { "name": "ScrollToken", "type": "string", "required": false, "description": "翻页标识，分批拉取时使用：当单次请求无法拉取所有数据，接口将会返回 ScrollToken，下一次请求携带该 Token，将会从下一条记录开始获取。", "example": "RF1bV9tRVVEW=" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeScreenShotSheetNumList", "description": "接口用来查询直播增值业务--截图的张数", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。", "example": "2019-11-07T16:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。 支持最近三个月的查询，查询开始和结束时间跨度不支持超过31天。", "example": "2019-11-09T15:59:00Z" }, { "name": "Zone", "type": "string", "required": false, "description": "地域信息，可选值包括Mainland，Oversea，前者是查询中国大陆范围内的数据，后者是除中国大陆范围之外的数据，若不传该参数，则查询所有地区的数据。", "example": "Mainland" }, { "name": "PushDomains", "type": "array", "required": false, "description": "推流域名（支持查询2019年11 月1日之后的域名维度数据）。", "example": "[\"push.live.com\"]", "item_type": "string" }, { "name": "Granularity", "type": "string", "required": false, "description": "数据维度，数据延迟1个半小时，可选值包括：1、Minute（5分钟粒度，最大支持查询时间范围是31天），2、Day（天粒度，默认值，按照北京时间做跨天处理，最大支持查询时间范围是186天当天）。", "example": "Minute" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeScreenshotTask", "description": "查询指定时间段范围内启动和结束的截图任务列表。 - 使用前提 1. 仅用于查询由 CreateScreenshotTask接口创建的截图任务。 2. 不能查询被 DeleteScreenshotTask接口删除以及已过期（平台侧保留3个月）的截图任务。", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "查询任务开始时间，Unix 时间戳。设置时间不早于当前时间之前90天的时间，且查询时间跨度不超过一周。", "example": "1595779200" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询任务结束时间，Unix 时间戳。EndTime 必须大于 StartTime，设置时间不早于当前时间之前90天的时间，且查询时间跨度不超过一周。（注意：任务开始结束时间必须在查询时间范围内）。", "example": "1595865600" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称。", "example": "livetest" }, { "name": "DomainName", "type": "string", "required": false, "description": "推流域名。", "example": "5000.live.push.com" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径。", "example": "live" }, { "name": "ScrollToken", "type": "string", "required": false, "description": "翻页标识，分批拉取时使用：当单次请求无法拉取所有数据，接口将会返回 ScrollToken，下一次请求携带该 Token，将会从下一条记录开始获取。", "example": "RF1bV9tRVVEW=" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeStreamDayPlayInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 查询天维度每条流的播放数据，包括总流量等。", "status": "online", "parameters": [ { "name": "DayTime", "type": "string", "required": true, "description": "日期，格式：YYYY-mm-dd。 第二天凌晨3点出昨天的数据，建议在这个时间点之后查询最新数据。支持最近3个月的数据查询。", "example": "2019-02-21" }, { "name": "PlayDomain", "type": "string", "required": false, "description": "播放域名。", "example": "5000.livepush.com" }, { "name": "PageNum", "type": "integer", "required": false, "description": "页号，范围[1,1000]，默认值是1。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页个数，范围[100,1000]，默认值是1000。", "example": "1000" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "可选值： Mainland：查询国内数据， Oversea：则查询国外数据， 默认：查询国内+国外的数据。", "example": "Mainland" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称，可选值包括LVB(标准直播)，LEB(快直播)，不填则查LVB+LEB总值。", "example": "LVB" } ], "required": [ "DayTime" ] }, { "name": "DescribeStreamPlayInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 查询播放数据，支持按流名称查询详细播放数据，也可按播放域名查询详细总数据，数据延迟4分钟左右。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）yyyy-MM-dd HH:mm:ss：使用此格式时，默认代表北京时间。 开始时间和结束时间的格式需要保持一致。", "example": "2019-03-01T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）yyyy-MM-dd HH:mm:ss：使用此格式时，默认代表北京时间。 开始时间和结束时间的格式需要保持一致。结束时间和开始时间跨度不支持超过24小时，支持距当前时间一个月内的数据查询。", "example": "2019-03-01T00:00:00+08:00" }, { "name": "PlayDomain", "type": "string", "required": false, "description": "播放域名， 若不填，则为查询所有播放域名的在线流数据。", "example": "5000.playdomain.com" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称，精确匹配。 若不填，则为查询总体播放数据。", "example": "stream1" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与播放地址中的AppName保持一致，会精确匹配，在同时传递了StreamName时生效。 若不填，则为查询总体播放数据。", "example": "live" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称，可选值包括LVB(标准直播)，LEB(快直播)，不填则查LVB+LEB总值。", "example": "LVB" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeStreamPushInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 查询流id的上行推流质量数据，包括音视频的帧率，码率，流逝时间，编码格式等。", "status": "online", "parameters": [ { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" }, { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。", "example": "2019-06-21T12:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 支持查询最近7天数据，建议查询时间跨度在3小时之内。", "example": "2019-06-21T12:01:02+08:00" }, { "name": "PushDomain", "type": "string", "required": false, "description": "推流域名。", "example": "5000.livepush.com" }, { "name": "AppName", "type": "string", "required": false, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" } ], "required": [ "StreamName", "StartTime", "EndTime" ] }, { "name": "DescribeTimeShiftRecordDetail", "description": "前提调用 DescribeTimeShiftStreamList 获得请求必要参数。查询指定范围内的时移流录制详情，最大支持24小时范围查询。", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "推流域名。", "example": "push.domain.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径。", "example": "push/path" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查询范围起始时间，Unix 时间戳。", "example": "45622563" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询范围终止时间，Unix 时间戳。", "example": "45628563" }, { "name": "DomainGroup", "type": "string", "required": false, "description": "推流域名所属组，没有域名组或者域名组为空字符串可不填。", "example": "75362" }, { "name": "TransCodeId", "type": "integer", "required": false, "description": "转码模板ID，转码模板ID为0可不填。", "example": "5625623" } ], "required": [ "Domain", "AppName", "StreamName", "StartTime", "EndTime" ] }, { "name": "DescribeTimeShiftStreamList", "description": "查询某个时间范围内所有时移流列表。最大支持查询24小时内的数据。", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "查询范围起始时间，Unix 时间戳。", "example": "1669032313" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询范围结束时间，Unix 时间戳。", "example": "1669035913" }, { "name": "StreamName", "type": "string", "required": false, "description": "流名称。", "example": "streamname" }, { "name": "Domain", "type": "string", "required": false, "description": "推流域名。", "example": "push.domain.com" }, { "name": "DomainGroup", "type": "string", "required": false, "description": "推流域名所属域名组。", "example": "domaingroup" }, { "name": "PageSize", "type": "integer", "required": false, "description": "用户指定要返回的最大结果数，取值范围[0,100]，不指定或者指定为0时，API 默认值为100。指定超过100时，API 强制使用100。指定值为负数时，接口返回错误。", "example": "100" }, { "name": "PageNum", "type": "integer", "required": false, "description": "指定拉取的页码，不传时默认为1。", "example": "1" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeTopClientIpSumInfoList", "description": "该接口为监控数据接口，数据采集及统计方式与计费数据不同，仅供运营分析使用，不能用于计费对账参考。 查询某段时间top n客户端ip汇总信息（暂支持top 1000）", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。", "example": "2019-03-01T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点， 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 时间跨度在[0,4小时]，支持最近1天数据查询。", "example": "2019-03-01T04:00:00+08:00" }, { "name": "PlayDomains", "type": "array", "required": false, "description": "播放域名，默认为不填，表示求总体数据。", "example": "[\"live.com\"]", "item_type": "string" }, { "name": "PageNum", "type": "integer", "required": false, "description": "页号，范围是[1,1000]，默认值是1。", "example": "2" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页个数，范围是[1,1000]，默认值是20。", "example": "2" }, { "name": "OrderParam", "type": "string", "required": false, "description": "排序指标，可选值包括TotalRequest（默认值），FailedRequest,TotalFlux。", "example": "TotalFlux" }, { "name": "MainlandOrOversea", "type": "string", "required": false, "description": "地域，可选值：Mainland，Oversea，China，Foreign，Global（默认值）；如果为空，查询总的数据；如果为“Mainland”，查询中国大陆的数据；如果为“Oversea”，则查询中国大陆以外的数据；如果为China，查询中国的数据（包括港澳台）；如果为Foreign，查询国外的数据（不包括港澳台）。", "example": "Mainland" }, { "name": "OutLanguage", "type": "string", "required": false, "description": "输出字段使用的语言，可选值：Chinese（默认值），English；目前国家，省份和运营商支持多语言。", "example": "Chinese" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeTranscodeTaskNum", "description": "查询转码任务数。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间，格式：yyyy-mm-dd HH:MM:SS。", "example": "2022-01-09 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式：yyyy-mm-dd HH:MM:SS。", "example": "2022-01-09 23:00:0" }, { "name": "PushDomains", "type": "array", "required": false, "description": "推流域名列表，不填表示总体数据。", "example": "[\"5000.livepush.com\"]", "item_type": "string" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeUploadStreamNums", "description": "直播上行路数查询。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。", "example": "2020-10-12T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点，接口查询支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）YYYY-MM-DD hh:mm:ss：使用此格式时，默认代表北京时间。 起始和结束时间跨度不支持超过31天。支持最近31天的数据查询", "example": "2020-10-12T01:01:05+08:00" }, { "name": "Domains", "type": "array", "required": false, "description": "直播域名，若不填，表示总体数据。", "example": "[\"test.com\"]", "item_type": "string" }, { "name": "Granularity", "type": "integer", "required": false, "description": "数据粒度，支持如下粒度： 5：5分钟粒度，（跨度不支持超过1天）， 1440：天粒度（跨度不支持超过一个月）。 默认值：5。", "example": "5" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeVisitTopSumInfoList", "description": "查询某时间段top n的域名或流id信息（暂支持top 1000）。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间点，格式为yyyy-mm-dd HH:MM:SS。", "example": "2019-03-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间点，格式为yyyy-mm-dd HH:MM:SS 时间跨度在(0,4小时]，支持最近1天数据查询。", "example": "2019-03-01 04:00:00" }, { "name": "TopIndex", "type": "string", "required": true, "description": "峰值指标，可选值包括”Domain”，”StreamId”。", "example": "StreamId" }, { "name": "PlayDomains", "type": "array", "required": false, "description": "播放域名，默认为不填，表示求总体数据。", "example": "[\"live.com\"]", "item_type": "string" }, { "name": "PageNum", "type": "integer", "required": false, "description": "页号， 范围是[1,1000]， 默认值是1。", "example": "2" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页个数，范围是[1,1000]， 默认值是20。", "example": "2" }, { "name": "OrderParam", "type": "string", "required": false, "description": "排序指标，可选值包括” AvgFluxPerSecond”，”TotalRequest”（默认）,“TotalFlux”。", "example": "TotalFlux" } ], "required": [ "StartTime", "EndTime", "TopIndex" ] }, { "name": "DropLiveStream", "description": "断开推流连接，但可以重新推流。 注：对已经不活跃的流，调用该断流接口时，接口返回成功。", "status": "online", "parameters": [ { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" }, { "name": "DomainName", "type": "string", "required": true, "description": "您的推流域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" } ], "required": [ "StreamName", "DomainName", "AppName" ] }, { "name": "EnableLiveDomain", "description": "启用状态为停用的直播域名。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "待启用的直播域名。", "example": "www.test.com" } ], "required": [ "DomainName" ] }, { "name": "EnableOptimalSwitching", "description": "启用择优调度。 注意：流维度的择优调度，当主备流结束后自动失效。", "status": "online", "parameters": [ { "name": "StreamName", "type": "string", "required": true, "description": "针对该流 ID 启用择优调度。", "example": "mystream" }, { "name": "EnableSwitch", "type": "integer", "required": false, "description": "启用开关，默认为启用。 0 - 禁用。 1 - 启用。", "example": "1" }, { "name": "HostGroupName", "type": "string", "required": false, "description": "要启用自动择优的流所属的域名分组名称。", "example": "groupname" } ], "required": [ "StreamName" ] }, { "name": "ForbidLiveDomain", "description": "停止使用某个直播域名。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "待停用的直播域名。", "example": "5000.livepush.com" } ], "required": [ "DomainName" ] }, { "name": "ForbidLiveStream", "description": "禁止某条流的推送，可以预设某个时刻将流恢复。 注意： 1. 默认只要流名称正确，禁推就会生效。 2. 如需要推流域名+推流路径+流名称 强匹配生效禁推，需提单联系售后开启配置。 3. 如果配置了域名分组，需填写准确推流域名，才可断掉当前推流。", "status": "online", "parameters": [ { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" }, { "name": "DomainName", "type": "string", "required": true, "description": "您的推流域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" }, { "name": "ResumeTime", "type": "string", "required": false, "description": "恢复流的时间。UTC 格式，例如：2018-11-29T19:00:00Z。 注意： 1. 默认禁推7天，且最长支持禁推90天。 2. 北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。", "example": "2018-11-24T12:00:00Z" }, { "name": "Reason", "type": "string", "required": false, "description": "禁推原因。 注明：请务必填写禁推原因，防止误操作。 长度限制：2048字节。", "example": "forbid reason" } ], "required": [ "AppName", "DomainName", "StreamName" ] }, { "name": "InsertTaskTemporaryFiles", "description": "可通过调用该接口，对点播源的直播拉流任务进行插播操作。 注意： 1. 仅支持对有效且运行中的点播源任务进行插播操作。 2. 拉转推插播文件时，事件及回调中的索引均保持为插播前的值。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "直播拉流任务 ID。", "example": "823421" }, { "name": "TemporaryFiles", "type": "array", "required": true, "description": "插播文件列表，支持一次性插播多个文件，文件个数最大支持30个。可在轮播过程中追加新的插播文件。", "example": "[\"http://vod.com/path/test.mp4\"]", "item_type": "string" }, { "name": "Operator", "type": "string", "required": true, "description": "操作人名称。", "example": "admin" }, { "name": "InsertAfterIndex", "type": "integer", "required": false, "description": "将文件插在当前轮播序列的指定位置后面。索引序列从1开始。默认为：0，表示播完当前文件立即播放插入文件。注意：索引不要超过当前总文件个数，否则按播完全部文件后再处理插播文件。", "example": "0" }, { "name": "InsertPriorityType", "type": "integer", "required": false, "description": "用于多个文件插播在同一个轮播序号之后时，可指定队列顺序。 0 - 最高优先级队列。默认值。 1 - 中等优先级队列。 2 - 最低优先级队列。 场景示例： 比如当前播放第2个文件，多个新文件插播在第2个文件之后，播完第二个轮播文件之后，优先播放InsertPriorityType为0的插播队列中的文件，再播放InsertPriorityType为1的插播队列中的文件，最后播放InsertPriorityType为2的插播队列文件。 ...", "example": "2" }, { "name": "InsertContext", "type": "string", "required": false, "description": "插播上下文信息。由用户自定义传入。当播放到使用本此插播请求插入的文件时，在文件播放开始和文件播放结束的回调时，将此上下文信息通过创建任务携带的回调地址回调给用户。 注意：如果有关联每个插播文件的信息需要回调时，可将需要回调的信息自行拼接到插播文件URL上，通过回调信息中的URL进行读取使用。", "example": "InsertId=492" } ], "required": [ "TaskId", "TemporaryFiles", "Operator" ] }, { "name": "ModifyCaster", "description": "该接口用来设置导播台的描述、名称、录制模板id等参数。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID", "example": "63501" }, { "name": "CasterName", "type": "string", "required": false, "description": "导播台名称", "example": "example" }, { "name": "Description", "type": "string", "required": false, "description": "导播台的描述，最大允许长度256", "example": "example caster" }, { "name": "RecordTemplateId", "type": "integer", "required": false, "description": "录制模板id。默认为0。当使用直播录制功能时，可将使用的录制模板填入。该接口仅保存字段，不涉及任何录制功能。", "example": "1" }, { "name": "RecordStatus", "type": "integer", "required": false, "description": "录制状态，当调用录制接口后，可通过该字段保存录制状态。0：未录制1：录制中该接口仅保存字段，不涉及任何录制处理。", "example": "1" }, { "name": "ExpireTime", "type": "integer", "required": false, "description": "导播台的过期时间戳。值为-1或unix时间戳。默认值为-1。当值为-1时，表示该导播台永不过期。当值为正常unix时间戳时，导播台将在该时间过期。导播台过期后，预监与主监画面将自动停止，转推自动停止。点播、直播url将停止转拉，推流url需自行停止推流。", "example": "-1" }, { "name": "DelayTime", "type": "integer", "required": false, "description": "导播台延时播放时间，单位为秒。默认为0，最大支持300秒", "example": "0" }, { "name": "TransitionType", "type": "string", "required": false, "description": "导播台转场类型。默认为空。允许使用通过DescribeCasterTransitionTypes接口中查询到的转场类型。", "example": "heart" }, { "name": "PgmWidth", "type": "integer", "required": false, "description": "导播台主监输出的宽度，单位为像素。默认为1280，最大允许4096。", "example": "1280" }, { "name": "PgmHeight", "type": "integer", "required": false, "description": "导播台主监输出的高度，单位为像素。默认为720，最大允许2160。", "example": "720" }, { "name": "PgmFps", "type": "integer", "required": false, "description": "导播台主监输出的帧率。默认为0，表示随源输出。 最大支持60。", "example": "0" }, { "name": "PgmBitRate", "type": "integer", "required": false, "description": "导播台主监输出的码率，单位为kbps。默认为0，表示随源的码率输出。最大允许10000kbps。", "example": "0" }, { "name": "FeeType", "type": "integer", "required": false, "description": "导播台的计费类型。0 通用型1 播单型。注： 本参数暂无作用。", "example": "0" }, { "name": "RecordTaskId", "type": "string", "required": false, "description": "录制接口返回的taskid注：该接口只做字段保存，不涉及录制操作。", "example": "UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb" }, { "name": "PgmAudioBitRate", "type": "integer", "required": false, "description": "导播台主监输出的音频码率，单位为kbps。可选项：[0, 128, 192, 256]默认值为0，表示随源的音频码率输出。", "example": "128" } ], "required": [ "CasterId" ] }, { "name": "ModifyCasterInputInfo", "description": "该接口用来修改已经设置过的输入源信息，如源地址，源类型等。 设置前，需保证待修改的输入源已经存在。若不存在，需使用AddCasterInputInfo接口。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" }, { "name": "InputInfo", "type": "object", "required": true, "description": "修改的导播台输入源信息", "example": "无", "children": [ { "name": "InputIndex", "type": "integer", "required": true, "description": "输入源Index。范围[1, 24]", "example": "1" }, { "name": "InputType", "type": "integer", "required": false, "description": "输入源类型。范围[0,1,2,3,4]。0：推流地址。1：点播文件地址。2：直播拉流地址。3：图片地址。4：webrtc协议推流地址。", "example": "1" }, { "name": "InputUrl", "type": "string", "required": false, "description": "输入源的源地址。最大允许长度512。当InputType为0（推流地址），2（直播拉流地址），3（图片地址）,4（webrtc推流地址）这几种类型时，URL需填入该字段。", "example": "http://example.domain.com/example.mp4" }, { "name": "Description", "type": "string", "required": false, "description": "输入源描述。最大允许长度256字符。", "example": "example" }, { "name": "InputUrls", "type": "array", "required": false, "description": "点播地址列表。仅当input type为1（点播地址）时，将一个或多个点播地址，填入该字段。单个地址最大允许长度512字符。最多允许同时填入5个地址。注：此时需保持InputUrl字段为空。", "example": "[\"http://example.domain.com/example.mp4\"]", "item_type": "string" }, { "name": "LoopEnable", "type": "boolean", "required": false, "description": "是否启用点播无限循环播放。注：当前该字段未生效，默认为True。", "example": "true" }, { "name": "LoopNumber", "type": "integer", "required": false, "description": "点播循环次数。允许值-1或正整数。当值为-1时，表示无限循环。当值为其他正整数时，表示循环对应次数。注：该字段暂未生效。", "example": "-1" }, { "name": "PullPushEnable", "type": "boolean", "required": false, "description": "是否启用拉取到导播台。注：该字段默认强制为true。", "example": "true" }, { "name": "Volume", "type": "integer", "required": false, "description": "输入源音量百分比。默认为100。表示音量为原始大小。允许值[0,200]。", "example": "100" } ] } ], "required": [ "CasterId", "InputInfo" ] }, { "name": "ModifyCasterLayoutInfo", "description": "该接口用来修改布局参数", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" }, { "name": "LayoutInfo", "type": "object", "required": true, "description": "导播台布局参数信息。", "example": "无", "children": [ { "name": "LayoutIndex", "type": "integer", "required": true, "description": "布局Index。取值范围：[1, 1000]", "example": "1" }, { "name": "LayoutTemplateId", "type": "integer", "required": false, "description": "布局模板Id。有效值[1，20，21，31，32，41]当使用布局模板时，无需LayoutParams参数，导播台将使用模板布局参数。", "example": "21" }, { "name": "InputIndexList", "type": "string", "required": false, "description": "布局绑定的输入列表。按布局LayerId从小到大，按顺序排列。已有两个画面的布局为例，输入1对应LayerId为1，输入2对应的LayerId为2，该字段应该填入\"1|2\"。", "example": "1|2" }, { "name": "LayoutParams", "type": "array", "required": false, "description": "详细的布局参数列表。", "example": "无", "item_type": "object", "children": [ { "name": "LayerId", "type": "integer", "required": true, "description": "布局层ID。 在画面最终渲染时，将按ID从小到大的顺序，由下至上渲染。", "example": "1" }, { "name": "LayerWidth", "type": "float", "required": true, "description": "布局层宽度。单位为百分比，范围[0.0,1.0]，表示该层在最终画面上所占的比例值。", "example": "1.0" }, { "name": "LayerHeight", "type": "float", "required": true, "description": "布局层高度。单位为百分比，范围[0.0,1.0]， 表示该层在最终画面上所占的比例值。", "example": "1.0" }, { "name": "LayerLocationX", "type": "float", "required": true, "description": "布局层位置x坐标。单位为百分比，范围[0.0,1.0]，表示该层在最终画面上x坐标所占的比例值。", "example": "0.0" }, { "name": "LayerLocationY", "type": "float", "required": true, "description": "布局层位置Y坐标。单位为百分比，范围[0.0,1.0]， 表示该层在最终画面Y坐标上所占的比例值。", "example": "0.0" }, { "name": "UsePortraitSegment", "type": "boolean", "required": false, "description": "是否启用抠图。", "example": "False" } ] }, { "name": "LayoutWidth", "type": "integer", "required": false, "description": "布局输出的宽度，单位为像素。默认为1280像素。注：该值仅在画中画布局，且未设置PgmWidth时生效。", "example": "1080" }, { "name": "LayoutHeight", "type": "integer", "required": false, "description": "布局输出的高度，单位为像素。注：该参数仅在画中画布局，且未设置PgmHeight时生效。", "example": "1920" } ] } ], "required": [ "CasterId", "LayoutInfo" ] }, { "name": "ModifyCasterMarkPicInfo", "description": "该接口用来修改导播台水印信息。 注意，修改的Index对应的水印需已存在", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" }, { "name": "MarkPicInfo", "type": "object", "required": true, "description": "新的水印信息。", "example": "无", "children": [ { "name": "MarkPicIndex", "type": "integer", "required": true, "description": "水印图片Index。", "example": "1" }, { "name": "MarkPicId", "type": "integer", "required": false, "description": "注：该字段已废弃。", "example": "0" }, { "name": "MarkPicWidth", "type": "float", "required": false, "description": "水印图片在输出时的宽度。 当该值为大于1的整数值时，单位为像素，允许范围[1,1920]。 当该值为小于1大于0的小数时，单位为百分比，表示水印在最终画面上所占的比例值。", "example": "1.0" }, { "name": "MarkPicHeight", "type": "float", "required": false, "description": "水印图片在输出时的高度。 当该值为大于1的整数值时，单位为像素，允许范围[1,1080]。 当该值为小于1大于0的小数时，单位为百分比，表示水印在输出上所占的比例值。", "example": "1.0" }, { "name": "MarkPicLocationX", "type": "float", "required": false, "description": "水印图片在输出时的X轴坐标。 当该值为大于1的整数值时，单位为像素，允许范围[1,1920]。 当该值为小于1大于0的小数时，单位为百分比，表示水印在最终画面上x坐标所占的比例值。", "example": "0.5" }, { "name": "MarkPicLocationY", "type": "float", "required": false, "description": "水印图片在输出时的Y坐标。 当该值为大于1的整数值时，单位为像素，允许范围[1,1080]。 当该值为小于1大于0的小数时，单位为百分比，表示水印在最终画面Y坐标上所占的比例值。", "example": "0.5" }, { "name": "MarkPicUrl", "type": "string", "required": false, "description": "水印地址。 最大长度256字符，且url需以jpg、jpeg、png、bmp、gif后缀结尾。", "example": "http://www.example.com/pic.jpg" }, { "name": "Description", "type": "string", "required": false, "description": "水印描述。 最大允许长度为256。", "example": "example" }, { "name": "IsEqualProportion", "type": "boolean", "required": false, "description": "是否启用了等比例缩放。 注：该字段仅做状态保存，无实际效果。", "example": "true" } ] } ], "required": [ "CasterId", "MarkPicInfo" ] }, { "name": "ModifyCasterMarkWordInfo", "description": "该接口用来修改导播台文本配置。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" }, { "name": "MarkWordInfo", "type": "object", "required": true, "description": "修改的文本配置。", "example": "无", "children": [ { "name": "MarkWordIndex", "type": "integer", "required": true, "description": "文字水印Index。", "example": "1" }, { "name": "MarkWordText", "type": "string", "required": false, "description": "文字水印内容。", "example": "示例文字" }, { "name": "MarkWordFontSize", "type": "integer", "required": false, "description": "文字水印的字号。 范围[16, 60]", "example": "12" }, { "name": "MarkWordFontColor", "type": "string", "required": false, "description": "文字水印的颜色，值为HEX颜色代码", "example": "0xffffff" }, { "name": "MarkWordFontType", "type": "integer", "required": false, "description": "文字水印的字体类型。 范围[1,2]。 1. 宋体 2. 黑体", "example": "1" }, { "name": "MarkWordLocationX", "type": "float", "required": false, "description": "文字水印的x坐标位置，单位百分比。 范围[0.0, 1.0]", "example": "0.1" }, { "name": "MarkWordLocationY", "type": "float", "required": false, "description": "文字水印的Y坐标位置，单位百分比。 范围[0.0, 1.0]", "example": "0.1" }, { "name": "MarkWordRollEnable", "type": "boolean", "required": false, "description": "是否开启文字跑马灯功能。 默认为false。", "example": "0" }, { "name": "MarkWordRollOnceTime", "type": "integer", "required": false, "description": "跑马灯文字显示一遍的时间，单位为秒。 默认为5s。 范围[5, 600]。", "example": "5" }, { "name": "MarkWordRollDirection", "type": "integer", "required": false, "description": "跑马灯文字的方向。 默认值为0。 范围[0,1]。 0 从左到右 1 从右到左", "example": "0" }, { "name": "MarkWordRollStartLocationX", "type": "float", "required": false, "description": "跑马灯文字显示的起始x坐标，单位百分比。 范围[0.0, 1.0]", "example": "0.0" }, { "name": "MarkWordRollEndLocationX", "type": "float", "required": false, "description": "跑马灯文字显示的截止x坐标，单位百分比。 范围[0.0, 1.0]", "example": "1.0" } ] } ], "required": [ "CasterId", "MarkWordInfo" ] }, { "name": "ModifyCasterOutputInfo", "description": "该接口用来修改导播台的推流信息。 注：只有在主监启动前设置才生效，主监启动后设置，下次推流生效。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" }, { "name": "OutputInfo", "type": "object", "required": true, "description": "导播台推流参数信息。", "example": "无", "children": [ { "name": "OutputIndex", "type": "integer", "required": true, "description": "推流信息Index。 当OutputType为1（表示推流到腾讯云直播）时，该值固定为0。 范围[0,10]。", "example": "0" }, { "name": "OutputUrl", "type": "string", "required": false, "description": "rtmp协议推流地址。 最大允许长度512字符。", "example": "rtmp://www.example.com/live/example" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。", "example": "example" }, { "name": "OutputStreamId", "type": "string", "required": false, "description": "推流到腾讯云直播源站时，使用的流ID。 仅当OutputType为1时生效。 最大允许128字符。", "example": "caster_output" }, { "name": "OutputType", "type": "integer", "required": false, "description": "推流类型。 范围[1,2] 1. 推送到腾讯云直播源站。 2. 推送到第三方源站。", "example": "1" }, { "name": "OutputDomainName", "type": "string", "required": false, "description": "推到腾讯云直播源站时，使用的域名。 最大允许128字符，且域名需属于当前账号绑定的云直播推流域名。 仅在OutputType为1时生效。", "example": "1234.livepush.myqcloud.com" }, { "name": "OutputAppName", "type": "string", "required": false, "description": "推到腾讯云直播源站时，使用的AppName。 最大允许64字符。 仅在OutputType为1时生效。", "example": "live" }, { "name": "OutputParam", "type": "string", "required": false, "description": "推到腾讯云直播源站时需要添加的推流参数。 最大允许长度256字符。 仅在OutputType为1时生效。", "example": "example_param=xxx" } ] } ], "required": [ "CasterId", "OutputInfo" ] }, { "name": "ModifyLiveCallbackTemplate", "description": "修改回调模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "DescribeLiveCallbackTemplates接口返回的模板 ID。", "example": "1000" }, { "name": "TemplateName", "type": "string", "required": false, "description": "模板名称。", "example": "testName" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。", "example": "callback" }, { "name": "StreamBeginNotifyUrl", "type": "string", "required": false, "description": "开播回调 URL。", "example": "http://domain.com/path" }, { "name": "StreamEndNotifyUrl", "type": "string", "required": false, "description": "断流回调 URL。", "example": "http://domain.com/path" }, { "name": "RecordNotifyUrl", "type": "string", "required": false, "description": "录制文件回调 URL。", "example": "http://domain.com/path" }, { "name": "RecordStatusNotifyUrl", "type": "string", "required": false, "description": "录制状态回调 URL 。", "example": "http://domain.com/path" }, { "name": "SnapshotNotifyUrl", "type": "string", "required": false, "description": "截图回调 URL。", "example": "http://domain.com/path" }, { "name": "PornCensorshipNotifyUrl", "type": "string", "required": false, "description": "鉴黄回调 URL。", "example": "http://domain.com/path" }, { "name": "CallbackKey", "type": "string", "required": false, "description": "回调 Key，回调 URL 公用，回调签名详见事件消息通知文档。 [事件消息通知](/document/product/267/32744)。", "example": "ajdjfladla" }, { "name": "PushExceptionNotifyUrl", "type": "string", "required": false, "description": "推流异常回调 URL。", "example": "http://abc.com/abc" }, { "name": "AudioAuditNotifyUrl", "type": "string", "required": false, "description": "音频审核回调 URL。", "example": "http://domain.com/path" }, { "name": "RecordExceptionNotifyUrl", "type": "string", "required": false, "description": "录制异常回调 URL。", "example": "http://domain.com/path\t" }, { "name": "RecordExceptionLevels", "type": "array", "required": false, "description": "录制异常回调级别，可选择：error、warning、info。", "example": "[\"error\"]", "item_type": "string" } ], "required": [ "TemplateId" ] }, { "name": "ModifyLiveDomainCertBindings", "description": "批量绑定证书对应的播放域名，并更新启用状态。 新建自有证书将自动上传至腾讯云ssl。", "status": "online", "parameters": [ { "name": "DomainInfos", "type": "array", "required": true, "description": "要绑定证书的播放域名/状态 信息列表。 如果CloudCertId和证书公钥私钥对均不传，且域名列表已有绑定规则，只批量更新域名https规则的启用状态，并把未上传至腾讯云ssl的已有自有证书上传。", "example": "无", "item_type": "object", "children": [ { "name": "DomainName", "type": "string", "required": true, "description": "域名。", "example": "domain.com" }, { "name": "Status", "type": "integer", "required": true, "description": "是否启用域名的https规则。 1：启用 0：禁用 -1：保持不变", "example": "1" } ] }, { "name": "CloudCertId", "type": "string", "required": false, "description": "腾讯云ssl的证书Id。 见 https://cloud.tencent.com/document/api/400/41665", "example": "Kf2ymCv" }, { "name": "CertificatePublicKey", "type": "string", "required": false, "description": "证书公钥。 CloudCertId和公钥私钥对二选一，若CloudCertId将会舍弃公钥和私钥参数，否则将自动先把公钥私钥对上传至ssl新建证书，并使用上传成功后返回的CloudCertId。", "example": "NXpT4oZAQ0JLclP1I9EbV8daGk9j86hd1oWJlmGMuz-Qc" }, { "name": "CertificatePrivateKey", "type": "string", "required": false, "description": "证书私钥。 CloudCertId和公钥私钥对二选一，若传CloudCertId将会舍弃公钥和私钥参数，否则将自动先把公钥私钥对上传至ssl新建证书，并使用上传成功后返回的CloudCertId。", "example": "lb7KhNmJL8wS7XXIZeFreu353WIeYtQX8xz4OOLwWR2pwamXsH5rLGVSVSDMnpjhd6q7RMbxJeNyByL3WpytvXgA1bn4w" }, { "name": "CertificateAlias", "type": "string", "required": false, "description": "上传至ssl证书中心的备注信息，只有新建证书时有效。传CloudCertId时会忽略。", "example": "Kf2ymCv" } ], "required": [ "DomainInfos" ] }, { "name": "ModifyLiveDomainReferer", "description": "设置直播域名 Referer 黑白名单。 由于 Referer 信息包含在 http 协议中，在开启配置后，播放协议为 rtmp 或 WebRTC 不会校验 Referer 配置，仍可正常播放。如需配置 Referer 鉴权建议使用 http-flv 或 http-hls 协议播放。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "播放域名。", "example": "5000.liveplay.myqcloud.com" }, { "name": "Enable", "type": "integer", "required": true, "description": "是否开启当前域名的 Referer 黑白名单鉴权。", "example": "1" }, { "name": "Type", "type": "integer", "required": true, "description": "名单类型，0：黑名单，1：白名单。", "example": "0" }, { "name": "AllowEmpty", "type": "integer", "required": true, "description": "是否允许空 Referer，0：不允许，1：允许。", "example": "1" }, { "name": "Rules", "type": "string", "required": true, "description": "Referer 名单列表，以;分隔。", "example": "aaa.com;bbb.com" } ], "required": [ "DomainName", "Enable", "Type", "AllowEmpty", "Rules" ] }, { "name": "ModifyLivePadTemplate", "description": "修改直播垫片模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板id。", "example": "1" }, { "name": "Url", "type": "string", "required": true, "description": "垫片内容。", "example": "https://test.com/a.mp4" }, { "name": "WaitDuration", "type": "integer", "required": true, "description": "断流等待时间。 取值范围：0-30000。 单位：ms。", "example": "1" }, { "name": "MaxDuration", "type": "integer", "required": true, "description": "最大垫片时长。 取值范围：0 - 正无穷。 单位：ms。", "example": "1" }, { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称。 长度上限：255字节。 仅支持中文、英文、数字、_、-。", "example": "testName" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。 长度上限：1024字节。 仅支持中文、英文、数字、_、-。", "example": "testDesc" }, { "name": "Type", "type": "integer", "required": false, "description": "垫片内容类型： 1：图片，2：视频。 默认值：1。", "example": "1" } ], "required": [ "TemplateId", "Url", "WaitDuration", "MaxDuration", "TemplateName" ] }, { "name": "ModifyLivePlayAuthKey", "description": "修改播放鉴权key", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "播放域名。", "example": "push.record.com" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否启用，0：关闭，1：启用。 不传表示不修改当前值。", "example": "1" }, { "name": "AuthKey", "type": "string", "required": false, "description": "鉴权key。 不传表示不修改当前值。", "example": "AKID0QJ82oYdLJIgAQlb" }, { "name": "AuthDelta", "type": "integer", "required": false, "description": "有效时间，单位：秒。 不传表示不修改当前值。", "example": "6000" }, { "name": "AuthBackKey", "type": "string", "required": false, "description": "鉴权备用key。 不传表示不修改当前值。", "example": "PUl5VIKKFB1KazNB" } ], "required": [ "DomainName" ] }, { "name": "ModifyLivePlayDomain", "description": "修改播放域名信息。", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "播放域名。", "example": "www.test.com" }, { "name": "PlayType", "type": "integer", "required": true, "description": "拉流域名类型。1-国内；2-全球；3-境外", "example": "1" } ], "required": [ "DomainName", "PlayType" ] }, { "name": "ModifyLivePullStreamTask", "description": "更新直播拉流任务。 1. 不支持修改拉流源类型，如需更换，请创建新任务。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务Id。", "example": "965454" }, { "name": "Operator", "type": "string", "required": true, "description": "操作人姓名。", "example": "yourname" }, { "name": "SourceUrls", "type": "array", "required": false, "description": "拉流源url列表。 SourceType为直播（PullLivePushLive）只可以填1个， SourceType为点播（PullVodPushLive）可以填多个，上限30个。", "example": "[\"rtmp:\\/\\/your.domainname.com\\/live\\/stream1\\n\"]", "item_type": "string" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间。 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。", "example": "2020-04-16T11:02:00Z" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，注意： 1. 结束时间必须大于开始时间； 2. 结束时间和开始时间必须大于当前时间； 3. 结束时间 和 开始时间 间隔必须小于30天。 使用UTC格式时间， 例如：2019-01-08T10:00:00Z。 注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#I)。 4. 只修改EndTime进行续期， 不会影响正在进行中的任务\ufffd\ufffd...", "example": "2020-04-17T12:02:00Z" }, { "name": "VodLoopTimes", "type": "integer", "required": false, "description": "点播拉流转推循环次数。 -1：无限循环，直到任务结束。 0：不循环。 \u003e0：具体循环次数。次数和时间以先结束的为准。 注意：拉流源为点播，该配置生效。", "example": "-1" }, { "name": "VodRefreshType", "type": "string", "required": false, "description": "点播更新SourceUrls后的播放方式： ImmediateNewSource：立即从更新的拉流源开始播放； ContinueBreakPoint：从上次断流url源的断点处继续，结束后再使用新的拉流源。 注意：拉流源为点播，该配置生效。", "example": "ImmediateNewSource" }, { "name": "Status", "type": "string", "required": false, "description": "任务状态： enable - 启用， pause - 暂停。", "example": "enable" }, { "name": "CallbackEvents", "type": "array", "required": false, "description": "选择需要回调的事件（不填则回调全部）： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。", "example": "[\"TaskStart\"]", "item_type": "string" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "自定义回调地址。 相关事件会回调到该地址。", "example": "http://callback.com/interface" }, { "name": "FileIndex", "type": "integer", "required": false, "description": "指定播放文件索引。 注意： 从1开始，不大于SourceUrls中文件个数。", "example": "0" }, { "name": "OffsetTime", "type": "integer", "required": false, "description": "指定播放文件偏移。 注意： 1. 单位：秒，配合FileIndex使用。", "example": "0" }, { "name": "SpecifyTaskId", "type": "string", "required": false, "description": "指定任务 ID 修改任务。 注意：该自定义任务 ID 只有在创建任务时指定了，才可在此处修改时使用。否则请使用系统返回的任务 ID。", "example": "mytaskid" }, { "name": "ToUrl", "type": "string", "required": false, "description": "目标 Url。 换目标地址，会断流重推到新地址。", "example": "rtmp://5000.livepush.myqcloud.com/live/vin1333?txSecret=6e9797ce" }, { "name": "Comment", "type": "string", "required": false, "description": "任务备注。", "example": "备注" }, { "name": "BackupSourceType", "type": "string", "required": false, "description": "备源的类型： PullLivePushLive -直播， PullVodPushLive -点播。 注意： 1. 仅当主源类型为直播源时，备源才会生效。 2. 将该参数置为空，则可将任务去除备源信息。 3. 主直播源拉流中断时，自动使用备源进行拉流。 4. 如果备源为点播文件时，则每次轮播完点播文件就检查主源是否恢复，如果主源恢复则自动切回到主源，否则继续拉备源。", "example": "PullLivePushLive" }, { "name": "BackupSourceUrl", "type": "string", "required": false, "description": "备源 URL。 只允许填一个备源 URL", "example": "http://5000.liveplay.myqcloud.com/live/backup.flv?txSecret=4d8e" }, { "name": "WatermarkList", "type": "array", "required": false, "description": "水印信息列表。 注意： 1. 最多支持4个不同位置的水印。 2. 水印图片 URL 请使用合法外网可访问地址。 3. 支持的水印图片格式：png，jpg等。 4. 轮播任务修改水印后，轮播到下一个文件时新水印生效。 5. 直播源任务修改水印后，水印立即生效。 6. 清除水印时，需携带该水印列表参数，内容为空数组。 7. 暂不支持动图水印。", "example": "无", "item_type": "object", "children": [ { "name": "PictureUrl", "type": "string", "required": true, "description": "水印图片 URL。 URL中禁止包含的字符： ;(){}$\u003e`#\"'|", "example": "http://xxx.gifshow/pic.jpg" }, { "name": "XPosition", "type": "integer", "required": true, "description": "显示位置，X轴偏移，单位是百分比，默认 0。", "example": "0" }, { "name": "YPosition", "type": "integer", "required": true, "description": "显示位置，Y轴偏移，单位是百分比，默认 0。", "example": "0" }, { "name": "Width", "type": "integer", "required": true, "description": "水印宽度，占直播原始画面宽度百分比，建议高宽只设置一项，另外一项会自适应缩放，避免变形。默认原始宽度。", "example": "100" }, { "name": "Height", "type": "integer", "required": true, "description": "水印高度，占直播原始画面高度百分比，建议高宽只设置一项，另外一项会自适应缩放，避免变形。默认原始高度。", "example": "100" }, { "name": "Location", "type": "integer", "required": true, "description": "水印位置，默认 0。 0：左上角。 1：右上角。 2：右下角。 3：左下角。", "example": "0" } ] }, { "name": "VodLocalMode", "type": "integer", "required": false, "description": "点播源是否启用本地推流模式，默认0，不启用。 0 - 不启用。 1 - 启用。 注意：启用本地模式后，会将源列表中的 MP4 文件进行本地下载，优先使用本地已下载文件进行推流，提高点播源推流稳定性。使用本地下载文件推流时，会产生增值费用。", "example": "0" }, { "name": "BackupToUrl", "type": "string", "required": false, "description": "新的目标地址。传空值，则取消该地址的推流。 传入新值，则替换原有地址。", "example": "rtmp://5000.livepush.myqcloud.com/live/mybackroom?txSecret=58deaf30f95a7a134c7f0d8512e90b45\u0026txTime=687bfb2d" }, { "name": "BackupVodUrl", "type": "string", "required": false, "description": "点播垫片文件地址。注意：用于在主源拉不到时自动兜底到垫片文件，切到垫片文件后，每次播完垫片会尝试拉主源，如果主源恢复则自动切回主源。可根据需要的轮询检查时长来传入对应时长的垫片文件。", "example": "http://vod.com/file/pad.mp4" } ], "required": [ "TaskId", "Operator" ] }, { "name": "ModifyLivePushAuthKey", "description": "修改直播推流鉴权key", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "aaa.elementtest.org" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否启用，0：关闭，1：启用。 不传表示不修改当前值。", "example": "1" }, { "name": "MasterAuthKey", "type": "string", "required": false, "description": "主鉴权key。 不传表示不修改当前值。", "example": "714cc271251e714cc271251e" }, { "name": "BackupAuthKey", "type": "string", "required": false, "description": "备鉴权key。 不传表示不修改当前值。", "example": "888cc271251e714cc271251e" }, { "name": "AuthDelta", "type": "integer", "required": false, "description": "有效时间，单位：秒。", "example": "6000" } ], "required": [ "DomainName" ] }, { "name": "ModifyLiveRecordTemplate", "description": "修改录制模板配置。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "DescribeRecordTemplates接口获取到的模板 ID。", "example": "1000" }, { "name": "TemplateName", "type": "string", "required": false, "description": "模板名称。", "example": "templat" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。", "example": "record" }, { "name": "FlvParam", "type": "object", "required": false, "description": "FLV 录制参数，开启 FLV 录制时设置。", "example": "无", "children": [ { "name": "RecordInterval", "type": "integer", "required": false, "description": "录制间隔。 单位秒，默认：1800。 FLV、MP4取值范围： 60-43200， AAC取值范围： 60-7200 。 此参数对 HLS 无效，当录制 HLS 时从推流到断流生成一个文件。", "example": "400" }, { "name": "StorageTime", "type": "integer", "required": false, "description": "录制存储时长。 单位秒，取值范围： 0 - 1500天。 0：表示永久存储。 注：此参数只对录制到VOD有效。", "example": "800" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否开启当前格式录制，默认值为0，0：否， 1：是。", "example": "0" }, { "name": "VodSubAppId", "type": "integer", "required": false, "description": "点播子应用 ID。", "example": "1" }, { "name": "VodFileName", "type": "string", "required": false, "description": "录制文件名。 支持的特殊占位符有： {StreamID}: 流ID {StartYear}: 开始时间-年 {StartMonth}: 开始时间-月 {StartDay}: 开始时间-日 {StartHour}: 开始时间-小时 {StartMinute}: 开始时间-分钟 {StartSecond}: 开始时间-秒 {StartMillisecond}: 开始时间-毫秒 {EndYear}: 结束时间-年 {EndMonth}: 结束时间-月 {EndDay}: 结束时间-日 {EndHour}: 结束时间-小时 {EndMinute}: 结束时间-分钟 {EndSecond}: 结束时间-秒 {EndMillisecond}: 结束...", "example": "{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}" }, { "name": "Procedure", "type": "string", "required": false, "description": "任务流 注意：此字段可能返回 null，表示取不到有效值。", "example": "liu" }, { "name": "StorageMode", "type": "string", "required": false, "description": "视频存储策略。 normal：标准存储。 cold：低频存储。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" }, { "name": "ClassId", "type": "integer", "required": false, "description": "点播应用分类 注意：此字段可能返回 null，表示取不到有效值。", "example": "4512" }, { "name": "CosBucketName", "type": "string", "required": false, "description": "存储至 cos 的 bucket 桶名称。 注：CosBucketName参数值不能包含-[appid] 部分。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "存储至 cos 的 bucket 区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketPath", "type": "string", "required": false, "description": "存储至 cos 的 bucket 路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" } ] }, { "name": "HlsParam", "type": "object", "required": false, "description": "HLS 录制参数，开启 HLS 录制时设置。", "example": "无", "children": [ { "name": "RecordInterval", "type": "integer", "required": false, "description": "录制间隔。 单位秒，默认：1800。 FLV、MP4取值范围： 60-43200， AAC取值范围： 60-7200 。 此参数对 HLS 无效，当录制 HLS 时从推流到断流生成一个文件。", "example": "400" }, { "name": "StorageTime", "type": "integer", "required": false, "description": "录制存储时长。 单位秒，取值范围： 0 - 1500天。 0：表示永久存储。 注：此参数只对录制到VOD有效。", "example": "800" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否开启当前格式录制，默认值为0，0：否， 1：是。", "example": "0" }, { "name": "VodSubAppId", "type": "integer", "required": false, "description": "点播子应用 ID。", "example": "1" }, { "name": "VodFileName", "type": "string", "required": false, "description": "录制文件名。 支持的特殊占位符有： {StreamID}: 流ID {StartYear}: 开始时间-年 {StartMonth}: 开始时间-月 {StartDay}: 开始时间-日 {StartHour}: 开始时间-小时 {StartMinute}: 开始时间-分钟 {StartSecond}: 开始时间-秒 {StartMillisecond}: 开始时间-毫秒 {EndYear}: 结束时间-年 {EndMonth}: 结束时间-月 {EndDay}: 结束时间-日 {EndHour}: 结束时间-小时 {EndMinute}: 结束时间-分钟 {EndSecond}: 结束时间-秒 {EndMillisecond}: 结束...", "example": "{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}" }, { "name": "Procedure", "type": "string", "required": false, "description": "任务流 注意：此字段可能返回 null，表示取不到有效值。", "example": "liu" }, { "name": "StorageMode", "type": "string", "required": false, "description": "视频存储策略。 normal：标准存储。 cold：低频存储。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" }, { "name": "ClassId", "type": "integer", "required": false, "description": "点播应用分类 注意：此字段可能返回 null，表示取不到有效值。", "example": "4512" }, { "name": "CosBucketName", "type": "string", "required": false, "description": "存储至 cos 的 bucket 桶名称。 注：CosBucketName参数值不能包含-[appid] 部分。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "存储至 cos 的 bucket 区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketPath", "type": "string", "required": false, "description": "存储至 cos 的 bucket 路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" } ] }, { "name": "Mp4Param", "type": "object", "required": false, "description": "MP4 录制参数，开启 MP4 录制时设置。", "example": "无", "children": [ { "name": "RecordInterval", "type": "integer", "required": false, "description": "录制间隔。 单位秒，默认：1800。 FLV、MP4取值范围： 60-43200， AAC取值范围： 60-7200 。 此参数对 HLS 无效，当录制 HLS 时从推流到断流生成一个文件。", "example": "400" }, { "name": "StorageTime", "type": "integer", "required": false, "description": "录制存储时长。 单位秒，取值范围： 0 - 1500天。 0：表示永久存储。 注：此参数只对录制到VOD有效。", "example": "800" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否开启当前格式录制，默认值为0，0：否， 1：是。", "example": "0" }, { "name": "VodSubAppId", "type": "integer", "required": false, "description": "点播子应用 ID。", "example": "1" }, { "name": "VodFileName", "type": "string", "required": false, "description": "录制文件名。 支持的特殊占位符有： {StreamID}: 流ID {StartYear}: 开始时间-年 {StartMonth}: 开始时间-月 {StartDay}: 开始时间-日 {StartHour}: 开始时间-小时 {StartMinute}: 开始时间-分钟 {StartSecond}: 开始时间-秒 {StartMillisecond}: 开始时间-毫秒 {EndYear}: 结束时间-年 {EndMonth}: 结束时间-月 {EndDay}: 结束时间-日 {EndHour}: 结束时间-小时 {EndMinute}: 结束时间-分钟 {EndSecond}: 结束时间-秒 {EndMillisecond}: 结束...", "example": "{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}" }, { "name": "Procedure", "type": "string", "required": false, "description": "任务流 注意：此字段可能返回 null，表示取不到有效值。", "example": "liu" }, { "name": "StorageMode", "type": "string", "required": false, "description": "视频存储策略。 normal：标准存储。 cold：低频存储。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" }, { "name": "ClassId", "type": "integer", "required": false, "description": "点播应用分类 注意：此字段可能返回 null，表示取不到有效值。", "example": "4512" }, { "name": "CosBucketName", "type": "string", "required": false, "description": "存储至 cos 的 bucket 桶名称。 注：CosBucketName参数值不能包含-[appid] 部分。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "存储至 cos 的 bucket 区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketPath", "type": "string", "required": false, "description": "存储至 cos 的 bucket 路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" } ] }, { "name": "AacParam", "type": "object", "required": false, "description": "AAC 录制参数，开启 AAC 录制时设置。", "example": "无", "children": [ { "name": "RecordInterval", "type": "integer", "required": false, "description": "录制间隔。 单位秒，默认：1800。 FLV、MP4取值范围： 60-43200， AAC取值范围： 60-7200 。 此参数对 HLS 无效，当录制 HLS 时从推流到断流生成一个文件。", "example": "400" }, { "name": "StorageTime", "type": "integer", "required": false, "description": "录制存储时长。 单位秒，取值范围： 0 - 1500天。 0：表示永久存储。 注：此参数只对录制到VOD有效。", "example": "800" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否开启当前格式录制，默认值为0，0：否， 1：是。", "example": "0" }, { "name": "VodSubAppId", "type": "integer", "required": false, "description": "点播子应用 ID。", "example": "1" }, { "name": "VodFileName", "type": "string", "required": false, "description": "录制文件名。 支持的特殊占位符有： {StreamID}: 流ID {StartYear}: 开始时间-年 {StartMonth}: 开始时间-月 {StartDay}: 开始时间-日 {StartHour}: 开始时间-小时 {StartMinute}: 开始时间-分钟 {StartSecond}: 开始时间-秒 {StartMillisecond}: 开始时间-毫秒 {EndYear}: 结束时间-年 {EndMonth}: 结束时间-月 {EndDay}: 结束时间-日 {EndHour}: 结束时间-小时 {EndMinute}: 结束时间-分钟 {EndSecond}: 结束时间-秒 {EndMillisecond}: 结束...", "example": "{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}" }, { "name": "Procedure", "type": "string", "required": false, "description": "任务流 注意：此字段可能返回 null，表示取不到有效值。", "example": "liu" }, { "name": "StorageMode", "type": "string", "required": false, "description": "视频存储策略。 normal：标准存储。 cold：低频存储。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" }, { "name": "ClassId", "type": "integer", "required": false, "description": "点播应用分类 注意：此字段可能返回 null，表示取不到有效值。", "example": "4512" }, { "name": "CosBucketName", "type": "string", "required": false, "description": "存储至 cos 的 bucket 桶名称。 注：CosBucketName参数值不能包含-[appid] 部分。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "存储至 cos 的 bucket 区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketPath", "type": "string", "required": false, "description": "存储至 cos 的 bucket 路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" } ] }, { "name": "HlsSpecialParam", "type": "object", "required": false, "description": "HLS 录制定制参数。", "example": "无", "children": [ { "name": "FlowContinueDuration", "type": "integer", "required": false, "description": "HLS续流超时时间。 取值范围[0，1800]。 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" } ] }, { "name": "Mp3Param", "type": "object", "required": false, "description": "MP3 录制参数，开启 MP3 录制时设置。", "example": "无", "children": [ { "name": "RecordInterval", "type": "integer", "required": false, "description": "录制间隔。 单位秒，默认：1800。 FLV、MP4取值范围： 60-43200， AAC取值范围： 60-7200 。 此参数对 HLS 无效，当录制 HLS 时从推流到断流生成一个文件。", "example": "400" }, { "name": "StorageTime", "type": "integer", "required": false, "description": "录制存储时长。 单位秒，取值范围： 0 - 1500天。 0：表示永久存储。 注：此参数只对录制到VOD有效。", "example": "800" }, { "name": "Enable", "type": "integer", "required": false, "description": "是否开启当前格式录制，默认值为0，0：否， 1：是。", "example": "0" }, { "name": "VodSubAppId", "type": "integer", "required": false, "description": "点播子应用 ID。", "example": "1" }, { "name": "VodFileName", "type": "string", "required": false, "description": "录制文件名。 支持的特殊占位符有： {StreamID}: 流ID {StartYear}: 开始时间-年 {StartMonth}: 开始时间-月 {StartDay}: 开始时间-日 {StartHour}: 开始时间-小时 {StartMinute}: 开始时间-分钟 {StartSecond}: 开始时间-秒 {StartMillisecond}: 开始时间-毫秒 {EndYear}: 结束时间-年 {EndMonth}: 结束时间-月 {EndDay}: 结束时间-日 {EndHour}: 结束时间-小时 {EndMinute}: 结束时间-分钟 {EndSecond}: 结束时间-秒 {EndMillisecond}: 结束...", "example": "{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}" }, { "name": "Procedure", "type": "string", "required": false, "description": "任务流 注意：此字段可能返回 null，表示取不到有效值。", "example": "liu" }, { "name": "StorageMode", "type": "string", "required": false, "description": "视频存储策略。 normal：标准存储。 cold：低频存储。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" }, { "name": "ClassId", "type": "integer", "required": false, "description": "点播应用分类 注意：此字段可能返回 null，表示取不到有效值。", "example": "4512" }, { "name": "CosBucketName", "type": "string", "required": false, "description": "存储至 cos 的 bucket 桶名称。 注：CosBucketName参数值不能包含-[appid] 部分。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "存储至 cos 的 bucket 区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" }, { "name": "CosBucketPath", "type": "string", "required": false, "description": "存储至 cos 的 bucket 路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "bucket" } ] }, { "name": "RemoveWatermark", "type": "boolean", "required": false, "description": "是否去除水印，类型为慢直播时此参数无效。", "example": "false" }, { "name": "FlvSpecialParam", "type": "object", "required": false, "description": "FLV 录制定制参数。", "example": "false", "children": [ { "name": "UploadInRecording", "type": "boolean", "required": false, "description": "是否开启边录边传，仅flv格式有效。", "example": "false" } ] } ], "required": [ "TemplateId" ] }, { "name": "ModifyLiveSnapshotTemplate", "description": "修改截图模板配置。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 ID。", "example": "1000" }, { "name": "CosAppId", "type": "integer", "required": true, "description": "Cos 应用 ID。 **注：此参数现在须必选。**", "example": "854625" }, { "name": "CosBucket", "type": "string", "required": true, "description": "Cos Bucket名称。 注：CosBucket参数值不能包含-[appid] 部分。 **注：此参数现在须必选。**", "example": "bucket" }, { "name": "CosRegion", "type": "string", "required": true, "description": "Cos 地域。 **注：此参数现在须必选。**", "example": "beijing" }, { "name": "TemplateName", "type": "string", "required": false, "description": "模板名称。 长度上限：255字节。", "example": "testName" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。 长度上限：1024字节。", "example": "testDesc" }, { "name": "SnapshotInterval", "type": "integer", "required": false, "description": "截图间隔，单位s，默认10s。 范围： 5s ~ 300s。", "example": "10" }, { "name": "Width", "type": "integer", "required": false, "description": "截图宽度。默认：0（原始宽）。", "example": "250" }, { "name": "Height", "type": "integer", "required": false, "description": "截图高度。默认：0（原始高）。", "example": "250" }, { "name": "PornFlag", "type": "integer", "required": false, "description": "是否开启鉴黄，默认 0 。 0：不开启。 1：开启。", "example": "0" }, { "name": "CosPrefix", "type": "string", "required": false, "description": "Cos Bucket文件夹前缀。", "example": "12" }, { "name": "CosFileName", "type": "string", "required": false, "description": "Cos 文件名称。", "example": "12" } ], "required": [ "TemplateId", "CosAppId", "CosBucket", "CosRegion" ] }, { "name": "ModifyLiveStreamMonitor", "description": "该接口用来修改直播流监播任务的配置。", "status": "online", "parameters": [ { "name": "MonitorId", "type": "string", "required": true, "description": "监播任务ID。", "example": "caster-124" }, { "name": "MonitorName", "type": "string", "required": false, "description": "监播任务的名称。长度128字节以内（一个汉字两个字节）。", "example": "ExampleStreamMonitor" }, { "name": "OutputInfo", "type": "object", "required": false, "description": "监播任务输出信息。", "example": "{\"OutputDomain\":\"pull-live.jgangwang.cn\",\"OutputStreamHeight\":1080,\"OutputStreamWidth\":1920}", "children": [ { "name": "OutputStreamWidth", "type": "integer", "required": true, "description": "监播任务输出流宽度像素。范围[1,1920]。建议至少大于100像素。", "example": "1920" }, { "name": "OutputStreamHeight", "type": "integer", "required": true, "description": "监播任务输出流长度像素。范围[1,1080]，建议至少大于100像素。", "example": "1080" }, { "name": "OutputStreamName", "type": "string", "required": false, "description": "监播任务输出流名称。 不填时，系统会自动生成。 256字节以内，只允许包含字母、数字、‘-’，‘_’，'.'字符。", "example": "OutputExampleName" }, { "name": "OutputDomain", "type": "string", "required": false, "description": "监播任务播放域名。128字节以内，只允许填处于启用状态的播放域名。", "example": "OutputExampleDomain" }, { "name": "OutputApp", "type": "string", "required": false, "description": "监播任务播放路径。32字节以内，只允许包含字母、数字、‘-’，‘_’，'.'字符。", "example": "Live" } ] }, { "name": "InputList", "type": "array", "required": false, "description": "待监播的输入流信息。", "example": "[{\"InputApp\":\"live\",\"InputDomain\":\"tpush.ztimelive.com\",\"InputStreamName\":\"nioday\"}]", "item_type": "object", "children": [ { "name": "InputStreamName", "type": "string", "required": true, "description": "待监播的输入流名称。256字节以内，只允许包含字母、数字、‘-’，‘_’，'.'字符。", "example": "ExampleStreamName" }, { "name": "InputDomain", "type": "string", "required": false, "description": "待监播的输入流推流域名。128字节以内，只允许填处于启用状态的推流域名。", "example": "ExampleDomain" }, { "name": "InputApp", "type": "string", "required": false, "description": "待监播的输入流推流路径。32字节以内，只允许包含字母、数字、‘-’，‘_’，'.'字符。", "example": "Live" }, { "name": "InputUrl", "type": "string", "required": false, "description": "待监播的输入流推流url。一般场景下，无需该参数。", "example": "rtmp://ExampleDomain/Live/ExampleStreamName" }, { "name": "Description", "type": "string", "required": false, "description": "描述。256字节以内。", "example": "Input1" }, { "name": "CasterInputIndex", "type": "integer", "required": false, "description": "导播台输入源索引（10000 pvw， 10001 pgm， 其余代表输入下标）", "example": "1" }, { "name": "NeedMonitor", "type": "boolean", "required": false, "description": "该输入源是否正在监播", "example": "True" }, { "name": "CdnStreamId", "type": "string", "required": false, "description": "导播台pvw pgm的cdn流id", "example": "ExampleStreamName" } ] }, { "name": "NotifyPolicy", "type": "object", "required": false, "description": "监播事件通知策略。", "example": "{\"CallbackUrl\":\"\",\"NotifyPolicyType\":0}", "children": [ { "name": "NotifyPolicyType", "type": "integer", "required": false, "description": "通知策略类型：范围[0,1] 0:代表不使用任何通知策略 1:代表使用全局回调策略，所有事件通知到CallbackUrl。", "example": "0" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "回调URL：长度[0,512] 只支持http和https类型的url。", "example": "http://notify.example.com/notify" } ] }, { "name": "AsrLanguage", "type": "integer", "required": false, "description": "智能语音识别语种： 0 关闭 1 中文 2 英文 3 日文 4 韩文。", "example": "0" }, { "name": "OcrLanguage", "type": "integer", "required": false, "description": "智能文字识别语种： 0 关闭 1 中、英文。", "example": "0" }, { "name": "AiAsrInputIndexList", "type": "array", "required": false, "description": "语音识别输入流列表，1代表第一条输入流。", "example": "[1, 2]", "item_type": "integer" }, { "name": "AiOcrInputIndexList", "type": "array", "required": false, "description": "文字识别输入流列表，1代表第一条输入流。", "example": "[1, 2]", "item_type": "integer" }, { "name": "CheckStreamBroken", "type": "integer", "required": false, "description": "是否开启断流检测。", "example": "0" }, { "name": "CheckStreamLowFrameRate", "type": "integer", "required": false, "description": "是否开启低帧率检测。", "example": "0" }, { "name": "AllowMonitorReport", "type": "integer", "required": false, "description": "是否存储监播事件到监播报告，以及是否允许查询监播报告。", "example": "0" }, { "name": "AiFormatDiagnose", "type": "integer", "required": false, "description": "是否开启格式诊断。", "example": "0" }, { "name": "AiQualityControl", "type": "integer", "required": false, "description": "是否开启内容质检。", "example": "0" } ], "required": [ "MonitorId" ] }, { "name": "ModifyLiveTimeShiftTemplate", "description": "修改直播时移模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "时移模板id。", "example": "1" }, { "name": "TemplateName", "type": "string", "required": false, "description": "模板名称。 仅支持中文、英文、数字、_、-。", "example": "testName" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。 长度上限：1024字节。 仅支持中文、英文、数字、_、-。", "example": "testDesc" }, { "name": "Duration", "type": "integer", "required": false, "description": "时移时长。 单位：s。", "example": "1" }, { "name": "ItemDuration", "type": "integer", "required": false, "description": "分片时长。 可取3-10。 单位：s。 默认值：5。", "example": "5" }, { "name": "RemoveWatermark", "type": "boolean", "required": false, "description": "是否去除水印。 传true则将录制原始流。 默认值：false。", "example": "false" }, { "name": "TranscodeTemplateIds", "type": "array", "required": false, "description": "转码流id列表。 此参数仅在 RemoveWatermark为false时生效。", "example": "[1]", "item_type": "integer" }, { "name": "Area", "type": "string", "required": false, "description": "地域。 Mainland：中国大陆。 Overseas：海外及港澳台地区。 默认值：Mainland。", "example": "Mainland" } ], "required": [ "TemplateId" ] }, { "name": "ModifyLiveTranscodeTemplate", "description": "修改转码模板配置。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "integer", "required": true, "description": "模板 Id。", "example": "1001" }, { "name": "Vcodec", "type": "string", "required": false, "description": "视频编码：h264/h265/origin，默认origin。 origin: 保持原始编码格式", "example": "h265" }, { "name": "Acodec", "type": "string", "required": false, "description": "音频编码：aac，默认aac。 注意：当前该参数未生效，待后续支持！", "example": "aac" }, { "name": "AudioBitrate", "type": "integer", "required": false, "description": "音频码率，默认0。 范围：0-500。", "example": "600" }, { "name": "Description", "type": "string", "required": false, "description": "模板描述。", "example": "transcode" }, { "name": "VideoBitrate", "type": "integer", "required": false, "description": "视频码率。范围：0kbps - 8000kbps。 0为保持原始码率。 注: 转码模板有码率唯一要求，最终保存的码率可能与输入码率有所差别。", "example": "1500" }, { "name": "Width", "type": "integer", "required": false, "description": "宽。0-3000。 数值必须是2的倍数，0是原始宽度", "example": "250" }, { "name": "NeedVideo", "type": "integer", "required": false, "description": "是否保留视频，0：否，1：是。默认1。", "example": "1" }, { "name": "NeedAudio", "type": "integer", "required": false, "description": "是否保留音频，0：否，1：是。默认1。", "example": "1" }, { "name": "Height", "type": "integer", "required": false, "description": "高。0-3000。 数值必须是2的倍数，0是原始宽度", "example": "240" }, { "name": "Fps", "type": "integer", "required": false, "description": "帧率，默认0。 范围0-60", "example": "30" }, { "name": "Gop", "type": "integer", "required": false, "description": "关键帧间隔，单位：秒。 范围2-6", "example": "3" }, { "name": "Rotate", "type": "integer", "required": false, "description": "旋转角度，默认0。 可取值：0，90，180，270", "example": "0" }, { "name": "Profile", "type": "string", "required": false, "description": "编码质量： baseline/main/high。", "example": "main" }, { "name": "BitrateToOrig", "type": "integer", "required": false, "description": "当设置的码率\u003e原始码率时，是否以原始码率为准。 0：否， 1：是 默认 0。", "example": "0" }, { "name": "HeightToOrig", "type": "integer", "required": false, "description": "当设置的高度\u003e原始高度时，是否以原始高度为准。 0：否， 1：是 默认 0。", "example": "0" }, { "name": "FpsToOrig", "type": "integer", "required": false, "description": "当设置的帧率\u003e原始帧率时，是否以原始帧率为准。 0：否， 1：是 默认 0。", "example": "0" }, { "name": "AdaptBitratePercent", "type": "float", "required": false, "description": "极速高清视频码率压缩比。 极速高清目标码率=VideoBitrate * (1-AdaptBitratePercent) 取值范围：0.0到0.5", "example": "1.1" }, { "name": "ShortEdgeAsHeight", "type": "integer", "required": false, "description": "是否以短边作为高度，0：否，1：是。默认0。", "example": "1" }, { "name": "DRMType", "type": "string", "required": false, "description": "DRM 加密类型，可选值：fairplay、normalaes、widevine。 不传递或者为空字符串，清空之前的DRM配置。", "example": "fairplay" }, { "name": "DRMTracks", "type": "string", "required": false, "description": "DRM 加密项，可选值：AUDIO、SD、HD、UHD1、UHD2，后四个为一组，同组中的内容只能选一个。 不传递或者为空字符串，清空之前的DRM配置。", "example": "AUDIO|HD" }, { "name": "IsAdaptiveBitRate", "type": "integer", "required": false, "description": "是否创建自适应码率，默认值 0。 0：否。 1：是。", "example": "0" }, { "name": "AdaptiveChildren", "type": "array", "required": false, "description": "自适应码率，子转码模板信息，当 IsAdaptiveBitRate 为 1 时有效。", "example": "无", "item_type": "object", "children": [ { "name": "TemplateId", "type": "integer", "required": false, "description": "自适应码率转码模板，子模板Id。 入参时候，填写此字段，表示更新子模板，否则是新增子模板。 注意：此字段可能返回 null，表示取不到有效值。", "example": "485142" }, { "name": "TemplateName", "type": "string", "required": false, "description": "子模板名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "p_500" }, { "name": "Vcodec", "type": "string", "required": false, "description": "视频编码：h264/h265/origin，默认origin。 origin: 保持原始编码格式。 注意：此字段可能返回 null，表示取不到有效值。", "example": "origin" }, { "name": "VideoBitrate", "type": "integer", "required": false, "description": "视频码率。范围：0kbps - 8000kbps。 0为保持原始码率。 注: 转码模板有码率唯一要求，最终保存的码率可能与输入码率有所差别。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1080" }, { "name": "Width", "type": "integer", "required": false, "description": "宽，默认0。 范围[0-3000]。 数值必须是2的倍数，0是原始宽度。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Height", "type": "integer", "required": false, "description": "高，默认0。 范围[0-3000] 数值必须是2的倍数，0是原始高度。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Fps", "type": "integer", "required": false, "description": "帧率，默认0。 范围0-60fps。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Gop", "type": "integer", "required": false, "description": "关键帧间隔，单位：秒。 默认原始的间隔。 范围2-6。 同一个父模板下面的所有子模板，gop必须相等且存在。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2" }, { "name": "NeedVideo", "type": "integer", "required": false, "description": "是否保留视频，0：否，1：是。默认1。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "NeedAudio", "type": "integer", "required": false, "description": "是否保留音频，0：否，1：是。默认1。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "BitrateToOrig", "type": "integer", "required": false, "description": "当设置的码率\u003e原始码率时，是否以原始码率为准。 0：否， 1：是 默认 0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "HeightToOrig", "type": "integer", "required": false, "description": "当设置的高度\u003e原始高度时，是否以原始高度为准。 0：否， 1：是 默认 0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "FpsToOrig", "type": "integer", "required": false, "description": "当设置的帧率\u003e原始帧率时，是否以原始帧率为准。 0：否， 1：是 默认 0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "ShortEdgeAsHeight", "type": "integer", "required": false, "description": "是否以短边作为高度，0：否，1：是。默认0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "HlsContainerFormat", "type": "string", "required": false, "description": "HLS 分片类型。 可选值：ts、fmp4。 注：编码方式为 H.265 时生效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ts" }, { "name": "HlsMp4VideoCodecTag", "type": "string", "required": false, "description": "编码标签。 可选值：hvc1、hev1。 注：HLS 分片类型选择 fmp4 时生效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "hvc1" } ] } ], "required": [ "TemplateId" ] }, { "name": "ModifyPullStreamConfig", "description": "更新拉流配置。该接口为已下线接口，请使用新接口 ModifyLivePullStreamTask。", "status": "online", "parameters": [ { "name": "ConfigId", "type": "string", "required": true, "description": "配置 ID。获取来源：创建拉流配置接口CreatePullStreamConfig返回的配置 ID。通过查询接口DescribePullStreamConfigs获取配置 ID。", "example": "9542135" }, { "name": "FromUrl", "type": "string", "required": false, "description": "源 URL，用于拉流的地址。目前可支持直播流及点播文件。注意：多个点播 URL 之间使用空格拼接。目前上限支持10个 URL。支持拉流文件格式：FLV，RTMP，HLS，MP4。使用标准三层样式，如：http://test.com/live/stream.flv。", "example": "rtmp://5000.liveplay.myqcloud.com/live/stream1" }, { "name": "ToUrl", "type": "string", "required": false, "description": "目的 URL，用于推流的地址，目前限制该目标地址为腾讯域名。仅支持 RTMP 协议。使用标准三层样式，如：http://test.com/live/stream.flv。", "example": "rtmp://5000.livepush.myqcloud.com/live/stream2" }, { "name": "AreaId", "type": "integer", "required": false, "description": "区域 ID：1-深圳。2-上海。3-天津。4-中国香港。如有改动，需同时传入IspId。", "example": "3" }, { "name": "IspId", "type": "integer", "required": false, "description": "运营商 ID，1：电信。2：移动。3：联通。4：其他。AreaId为4的时候，IspId只能为其他。如有改动，需同时传入AreaId。", "example": "1" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间。使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。", "example": "2018-12-31T11:02:00Z" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，注意：结束时间必须大于开始时间；结束时间和开始时间必须大于当前时间；结束时间 和 开始时间 间隔必须小于七天。使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。", "example": "2018-12-31T12:02:00Z" } ], "required": [ "ConfigId" ] }, { "name": "ModifyPullStreamStatus", "description": "修改直播拉流配置的状态。该接口已下线,请使用新接口 ModifyLivePullStreamTask。", "status": "online", "parameters": [ { "name": "ConfigIds", "type": "array", "required": true, "description": "配置 ID 列表。", "example": "[\"123\\n\",\"456\\n\"]", "item_type": "string" }, { "name": "Status", "type": "string", "required": true, "description": "目标状态。0无效，2正在运行，4暂停。", "example": "2" } ], "required": [ "ConfigIds", "Status" ] }, { "name": "ReleaseCaster", "description": "调用该接口，释放导播台实例，但保留所有的配置。 执行该接口，预监与主监画面停止，第三方推流停止。 点播文件与直播地址将停止展示，客户自行推到导播台的流需要手动停止。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "RestartLivePullStreamTask", "description": "将正在运行的拉流转推任务进行重启。 注意： 1. 重启任务会造成推流中断。 2. 点播源任务的重启，会根据VodRefreshType决定是续播还是从头开始播。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务 Id。", "example": "965421" }, { "name": "Operator", "type": "string", "required": true, "description": "操作人备注名称。", "example": "admin" } ], "required": [ "TaskId", "Operator" ] }, { "name": "ResumeDelayLiveStream", "description": "取消直播流设置的延时配置，恢复实时直播画面。", "status": "online", "parameters": [ { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为live。", "example": "live" }, { "name": "DomainName", "type": "string", "required": true, "description": "推流域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" } ], "required": [ "AppName", "DomainName", "StreamName" ] }, { "name": "ResumeLiveStream", "description": "恢复某条流的推流。", "status": "online", "parameters": [ { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" }, { "name": "DomainName", "type": "string", "required": true, "description": "您的推流域名。", "example": "5000.livepush.com" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "mystreamname" } ], "required": [ "AppName", "DomainName", "StreamName" ] }, { "name": "SendLiveCloudEffect", "description": "使用该接口发送云端特效到线上正活跃的直播流，观众可在播放端看到特效从直播流画面中展示。", "status": "online", "parameters": [ { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" }, { "name": "PushDomainName", "type": "string", "required": true, "description": "您的推流域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" }, { "name": "Id", "type": "string", "required": true, "description": "云端特效 ID。", "example": "1001" }, { "name": "LoopTimes", "type": "integer", "required": false, "description": "默认随系统配置，云端特效循环 少于5次。可自定义指定礼物循环次数，不超过100次。", "example": "5" }, { "name": "Operator", "type": "string", "required": false, "description": "操作人备注信息。", "example": "admin" }, { "name": "ZoomFactor", "type": "integer", "required": false, "description": "缩小比例，默认0 不缩放。 可选值：0-9， 值越大，越缩小。", "example": "4" }, { "name": "XPosition", "type": "string", "required": false, "description": "指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的横向比例，可选值 0 - 100。", "example": "20" }, { "name": "YPosition", "type": "string", "required": false, "description": "指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角，该参数指定特效渲染离原点的纵向比例，可选值 0 - 100。", "example": "20" } ], "required": [ "AppName", "PushDomainName", "StreamName", "Id" ] }, { "name": "StartLivePadStream", "description": "使用该接口将直播流开始切入垫片。", "status": "online", "parameters": [ { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" }, { "name": "PushDomainName", "type": "string", "required": true, "description": "您的推流域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" }, { "name": "Operator", "type": "string", "required": false, "description": "操作人备注信息。", "example": "admin" } ], "required": [ "AppName", "PushDomainName", "StreamName" ] }, { "name": "StartLiveStreamMonitor", "description": "该接口用来启动直播流监播任务。", "status": "online", "parameters": [ { "name": "MonitorId", "type": "string", "required": true, "description": "监播ID。", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }, { "name": "AudibleInputIndexList", "type": "array", "required": false, "description": "监播画面声音InputIndex,支持多个输入声音。 取值范围 InputIndex必须已经存在。 不填默认无声音输出。", "example": "[1]", "item_type": "integer" } ], "required": [ "MonitorId" ] }, { "name": "StopCasterPgm", "description": "该接口用来停止导播台的主监输出。 停止主监后，对应的推流到腾讯云直播源站和推流到其他第三方平台均将会停止。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "StopCasterPvw", "description": "该接口用来停止导播台的预监任务。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "StopLivePadStream", "description": "使用该接口将直播流停止切入垫片。", "status": "online", "parameters": [ { "name": "AppName", "type": "string", "required": true, "description": "推流路径，与推流和播放地址中的AppName保持一致，默认为 live。", "example": "live" }, { "name": "PushDomainName", "type": "string", "required": true, "description": "您的推流域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" }, { "name": "Operator", "type": "string", "required": false, "description": "操作人备注信息。", "example": "admin" } ], "required": [ "AppName", "PushDomainName", "StreamName" ] }, { "name": "StopLiveRecord", "description": "说明：录制后的文件存放于点播平台。用户如需使用录制功能，需首先自行开通点播账号并确保账号可用。录制文件存放后，相关费用（含存储以及下行播放流量）按照点播平台计费方式收取，请参考对应文档。", "status": "online", "parameters": [ { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" }, { "name": "TaskId", "type": "integer", "required": true, "description": "任务ID，由CreateLiveRecord接口返回。", "example": "562134" } ], "required": [ "StreamName", "TaskId" ] }, { "name": "StopLiveStreamMonitor", "description": "该接口用来停止直播流监播任务。", "status": "online", "parameters": [ { "name": "MonitorId", "type": "string", "required": true, "description": "监播ID", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "required": [ "MonitorId" ] }, { "name": "StopRecordTask", "description": "提前结束录制，中止运行中的录制任务并生成录制文件。任务被成功终止后，本次任务将不再启动。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "录制任务ID。", "example": "UZZUVbQ1FSQFlvKxYBxUVGzwcBB00UETZU5QRlNURlhR1FDUVBFUWpCUkbUUBKb" } ], "required": [ "TaskId" ] }, { "name": "StopScreenshotTask", "description": "提前结束截图，中止运行中的截图任务。任务被成功终止后，本次任务将不再启动。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "截图任务ID。", "example": "UZZUVbQ1FSQFlvKxYBxUVGzwcBB00UETZU5QRlNURlhR1FDUVBFUWpCUkbUUBKb" } ], "required": [ "TaskId" ] }, { "name": "SwitchBackupStream", "description": "调用该接口实现切换当前播放所使用的主备流。", "status": "online", "parameters": [ { "name": "PushDomainName", "type": "string", "required": true, "description": "推流域名。", "example": "5000.livepush.com" }, { "name": "AppName", "type": "string", "required": true, "description": "应用名称。", "example": "live" }, { "name": "StreamName", "type": "string", "required": true, "description": "流名称。", "example": "stream1" }, { "name": "UpstreamSequence", "type": "string", "required": true, "description": "查询接口获取到该流所有在推的上行 Sequence。指定要切到的目标上行 Sequence。", "example": "843110096313761792" } ], "required": [ "PushDomainName", "AppName", "StreamName", "UpstreamSequence" ] }, { "name": "SwitchCasterToEmergency", "description": "该接口用来将导播台切换到备播状态。 该接口使用时，主监任务需处于运行状态。", "status": "online", "parameters": [ { "name": "CasterId", "type": "integer", "required": true, "description": "导播台ID。", "example": "63501" } ], "required": [ "CasterId" ] }, { "name": "UnBindLiveDomainCert", "description": "解绑域名证书", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "播放域名。", "example": "5000.livepush.myqcloud.com" }, { "name": "Type", "type": "string", "required": false, "description": "枚举值： gray: 解绑灰度规则 formal(默认): 解绑正式规则 不传则为formal", "example": "\"gray\"" } ], "required": [ "DomainName" ] }, { "name": "UpdateLiveWatermark", "description": "更新水印。", "status": "online", "parameters": [ { "name": "WatermarkId", "type": "integer", "required": true, "description": "水印 ID。 在添加水印接口 [AddLiveWatermark](/document/product/267/30154) 调用返回值中获取水印 ID。", "example": "452356" }, { "name": "PictureUrl", "type": "string", "required": true, "description": "水印图片 URL。 URL中禁止包含的字符： ;(){}$\u003e`#\"\\'|", "example": "http://watermark-10005041.cos.myqcloud.com/1251830167/watermark_img_Alogo.png" }, { "name": "XPosition", "type": "integer", "required": true, "description": "显示位置，X轴偏移，单位是百分比，默认 0。", "example": "80" }, { "name": "YPosition", "type": "integer", "required": true, "description": "显示位置，Y轴偏移，单位是百分比，默认 0。", "example": "10" }, { "name": "WatermarkName", "type": "string", "required": false, "description": "水印名称。 最长30字节。", "example": "logo" }, { "name": "Width", "type": "integer", "required": false, "description": "水印宽度，占直播原始画面宽度百分比，建议高宽只设置一项，另外一项会自适应缩放，避免变形。默认原始宽度。", "example": "100" }, { "name": "Height", "type": "integer", "required": false, "description": "水印高度，占直播原始画面宽度百分比，建议高宽只设置一项，另外一项会自适应缩放，避免变形。默认原始高度。", "example": "100" }, { "name": "BackgroundWidth", "type": "integer", "required": false, "description": "背景水印宽度。默认宽度1920。", "example": "1920" }, { "name": "BackgroundHeight", "type": "integer", "required": false, "description": "背景水印高度。默认高度1080。", "example": "1080" } ], "required": [ "WatermarkId", "PictureUrl", "XPosition", "YPosition" ] } ] }