{ "name": "cme", "display_name": "多媒体创作引擎", "description": "介绍如何使用 API 对多媒体创作引擎进行操作，如视频编辑项目、媒体管理等。", "domain": "other", "api_version": "2019-10-29", "endpoint": "cme.tencentcloudapi.com", "actions": [ { "name": "AddTeamMember", "description": "向一个团队中添加团队成员，并且指定成员的角色。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "TeamId", "type": "string", "required": true, "description": "团队 ID。", "example": "1kdk882ddd88338ddd3k3" }, { "name": "TeamMembers", "type": "array", "required": true, "description": "要添加的成员列表，一次最多添加30个成员。", "example": "无", "item_type": "object", "children": [ { "name": "MemberId", "type": "string", "required": true, "description": "团队成员 ID。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" }, { "name": "Remark", "type": "string", "required": false, "description": "团队成员备注。", "example": "new_admin" }, { "name": "Role", "type": "string", "required": false, "description": "团队成员角色，不填则默认添加普通成员。可选值： Admin：团队管理员； Member：普通成员。", "example": "Member" } ] }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以向任意团队中添加成员。如果指定操作者，则操作者必须为管理员或者团队所有者。", "example": "60097a8a8ea83d00017b484b" } ], "required": [ "Platform", "TeamId", "TeamMembers" ] }, { "name": "CopyProject", "description": "复制一个项目，包括项目素材及轨道数据。目前仅普通剪辑及模板制作项目可复制，其它类型的项目不支持复制。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。", "example": "1000000009" }, { "name": "ProjectId", "type": "string", "required": true, "description": "被复制的项目 ID。", "example": "cmepid_88kkdkkkkd009d9d9d99d9" }, { "name": "Name", "type": "string", "required": false, "description": "复制后的项目名称，不填为原项目名称+\"(副本)\"。", "example": "复制项目" }, { "name": "Owner", "type": "object", "required": false, "description": "复制后的项目归属者，不填为原项目归属者。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。填写用户的 Id，用于标识调用者及校验操作权限。", "example": "user_id_1000001" } ], "required": [ "Platform", "ProjectId" ] }, { "name": "CreateClass", "description": "新增分类，用于管理素材。分类层数不能超过20。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。", "example": "1000000009" }, { "name": "Owner", "type": "object", "required": true, "description": "归属者。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "ClassPath", "type": "string", "required": true, "description": "分类路径。", "example": "/a/b" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。填写用户的 Id，用于标识调用者及校验分类创建权限。", "example": "aaa1e081-***-9162840cadb7" } ], "required": [ "Platform", "Owner", "ClassPath" ] }, { "name": "CreateLink", "description": "创建媒体链接或分类路径链接，将资源信息链接到目标。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "Type", "type": "string", "required": true, "description": "链接类型，可取值有: CLASS: 分类链接； MATERIAL：媒体文件链接。", "example": "MATERIAL" }, { "name": "Name", "type": "string", "required": true, "description": "链接名称，不能超过30个字符。", "example": "link" }, { "name": "Owner", "type": "object", "required": true, "description": "链接归属者。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "DestinationId", "type": "string", "required": true, "description": "目标资源Id。可取值有： 当 Type 为 MATERIAL 时填媒体 ID； 当 Type 为 CLASS 时填写分类路径。", "example": "5fec3806b4e0960001ed9ce2" }, { "name": "DestinationOwner", "type": "object", "required": true, "description": "目标资源归属者。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "ClassPath", "type": "string", "required": false, "description": "链接的分类路径，如填\"/a/b\"则代表链接属于该分类路径，不填则默认为根路径。", "example": "/a/b" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以创建任意源及目标资源的链接。如果指定操作者，则操作者必须对源资源有读权限，对目标媒体有写权限。", "example": "60097a8a8ea83d00017b484b" } ], "required": [ "Platform", "Type", "Name", "Owner", "DestinationId", "DestinationOwner" ] }, { "name": "CreateProject", "description": "创建多媒体创作引擎项目，目前支持的项目类型有： 视频剪辑项目：用于普通视频剪辑； 直播剪辑项目：用于直播流剪辑； 导播台项目：用于云导播台； 视频拆条：用于视频拆条； 录制回放项目：用于直播录制回放； 媒体转推项目：用于媒体文件转直播输出。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "Name", "type": "string", "required": true, "description": "项目名称，不可超过30个字符。", "example": "新建项目" }, { "name": "Owner", "type": "object", "required": true, "description": "项目归属者，即项目的所有者，后续操作只有该所有者有权限操作。 注：目前所有项目只能设置归属个人，暂不支持团队项目。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Category", "type": "string", "required": true, "description": "项目类别，取值有： VIDEO_EDIT：视频编辑。 SWITCHER：导播台。 VIDEO_SEGMENTATION：视频拆条。 STREAM_CONNECT：云转推。 RECORD_REPLAY：录制回放。 MEDIA_CAST：媒体转推。", "example": "VIDEO_EDIT" }, { "name": "Mode", "type": "string", "required": false, "description": "项目模式，一个项目可以有多种模式并相互切换。 当 Category 为 VIDEO_EDIT 时，可选模式有： Default：默认模式，即普通视频编辑项目。 VideoEditTemplate：剪辑模板制作模式，用于制作剪辑模板。 注：不填则为默认模式。", "example": "Default" }, { "name": "Description", "type": "string", "required": false, "description": "项目描述信息。", "example": "新建" }, { "name": "SwitcherProjectInput", "type": "object", "required": false, "description": "导播台项目输入信息，仅当项目类型为 SWITCHER 时必填。", "example": "无", "children": [ { "name": "StopTime", "type": "string", "required": false, "description": "导播台停止时间，格式按照 ISO 8601 标准表示。若不填，该值默认为当前时间加七天。", "example": "2024-01-01T12:34:56+00:00" }, { "name": "PgmOutputConfig", "type": "object", "required": false, "description": "导播台主监输出配置信息。若不填，默认输出 720P。", "example": "无", "children": [ { "name": "TemplateId", "type": "integer", "required": false, "description": "导播台输出模板 ID，可取值： 10001：分辨率为1080 P； 10002：分辨率为720 P； 10003：分辨率为480 P。", "example": "10001" }, { "name": "Width", "type": "integer", "required": false, "description": "导播台输出宽，单位：像素。", "example": "960" }, { "name": "Height", "type": "integer", "required": false, "description": "导播台输出高，单位：像素。", "example": "540" }, { "name": "Fps", "type": "integer", "required": false, "description": "导播台输出帧率，单位：帧/秒", "example": "25" }, { "name": "BitRate", "type": "integer", "required": false, "description": "导播台输出码率， 单位：bit/s。", "example": "64000" } ] } ] }, { "name": "LiveStreamClipProjectInput", "type": "object", "required": false, "description": "直播剪辑项目输入信息，暂未开放，请勿使用。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "直播流播放地址，目前仅支持 HLS 和 FLV 格式。", "example": "https://liveplay.video-studio.myqcloud.com/live.flv" }, { "name": "StreamRecordDuration", "type": "integer", "required": true, "description": "直播流录制时长，单位为秒，最大值为 7200。", "example": "60" } ] }, { "name": "VideoEditProjectInput", "type": "object", "required": false, "description": "视频编辑项目输入信息，仅当项目类型为 VIDEO_EDIT 时必填。", "example": "无", "children": [ { "name": "AspectRatio", "type": "string", "required": false, "description": "画布宽高比，取值有： 16:9； 9:16； 2:1。 默认值 16:9 。", "example": "16:9" }, { "name": "VideoEditTemplateId", "type": "string", "required": false, "description": "视频编辑模板媒体 ID ，通过模板媒体导入项目轨道数据时填写。", "example": "36f19218d1c35ae5" }, { "name": "InitTracks", "type": "array", "required": false, "description": "输入的媒体轨道列表，包括视频、音频，等媒体组成的多个轨道信息。其中：输入的多个轨道在时间轴上和输出媒体文件的时间轴对齐；时间轴上相同时间点的各个轨道的素材进行重叠，视频或者图片按轨道顺序进行图像的叠加，轨道顺序高的素材叠加在上面，音频素材进行混音；视频、音频，每一种类型的轨道最多支持10个。 注：当从模板导入项目时（即 VideoEditTemplateId 不\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "轨道类型，取值有： Video ：视频轨道。视频轨道由以下 Item 组成：VideoTrackItemEmptyTrackItemMediaTransitionItem Audio ：音频轨道。音频轨道由以下 Item 组成：AudioTrackItemEmptyTrackItem", "example": "Video" }, { "name": "TrackItems", "type": "array", "required": true, "description": "轨道上的媒体片段列表。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "片段类型。取值有： Video：视频片段； Audio：音频片段； Empty：空白片段； Transition：转场。", "example": "Video" }, { "name": "VideoItem", "type": "object", "required": false, "description": "视频片段，当 Type = Video 时有效。", "example": "无" }, { "name": "AudioItem", "type": "object", "required": false, "description": "音频片段，当 Type = Audio 时有效。", "example": "无" }, { "name": "EmptyItem", "type": "object", "required": false, "description": "空白片段，当 Type = Empty 时有效。空片段用于时间轴的占位。如需要两个音频片段之间有一段时间的静音，可以用 EmptyTrackItem 来进行占位。 使用 EmptyTrackItem 进行占位，来定位某个Item。", "example": "无" }, { "name": "TransitionItem", "type": "object", "required": false, "description": "转场，当 Type = Transition 时有效。", "example": "b64e98advodcq198uje890" } ] } ] } ] }, { "name": "VideoSegmentationProjectInput", "type": "object", "required": false, "description": "视频拆条项目输入信息，仅当项目类型为 VIDEO_SEGMENTATION 时必填。", "example": "无", "children": [ { "name": "AspectRatio", "type": "string", "required": false, "description": "画布宽高比，取值有： 16:9； 9:16； 2:1。 默认值 16:9 。", "example": "16:9" }, { "name": "ProcessModel", "type": "string", "required": false, "description": "视频拆条处理模型，不填则默认为手工分割视频。取值 ： AI.GameHighlights.PUBG：和平精英集锦 ; AI.GameHighlights.Honor OfKings：王者荣耀集锦 ; AI.SportHighlights.Football：足球集锦 AI.SportHighlights.Basketball：篮球集锦 ； AI.PersonSegmentation：人物集锦 ; AI.NewsSegmentation：新闻拆条。", "example": "AI.NewsSegmentation" } ] }, { "name": "StreamConnectProjectInput", "type": "object", "required": false, "description": "云转推项目输入信息，仅当项目类型为 STREAM_CONNECT 时必填。", "example": "无", "children": [ { "name": "MainInput", "type": "object", "required": false, "description": "云转推主输入源信息。", "example": "无", "children": [ { "name": "InputType", "type": "string", "required": true, "description": "流输入类型，取值： VodPull ： 点播拉流； LivePull ：直播拉流； RtmpPush ： 直播推流。", "example": "LivePull" }, { "name": "VodPullInputInfo", "type": "object", "required": false, "description": "点播拉流信息，当 InputType = VodPull 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InputUrls", "type": "array", "required": true, "description": "点播输入拉流 URL 。", "example": "[\"http://example.com/file1.mp4\"]", "item_type": "string" }, { "name": "LoopTimes", "type": "integer", "required": false, "description": "播放次数，取值有： -1 : 循环播放，直到转推结束； 0 : 不循环； 大于0 : 具体循环次数，次数和时间以先结束的为准。 默认不循环。", "example": "-1" } ] }, { "name": "LivePullInputInfo", "type": "object", "required": false, "description": "直播拉流信息，当 InputType = LivePull 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InputUrl", "type": "string", "required": true, "description": "直播拉流地址。", "example": "rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600c" } ] }, { "name": "RtmpPushInputInfo", "type": "object", "required": false, "description": "直播推流信息，当 InputType = RtmpPush 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExpiredSecond", "type": "integer", "required": true, "description": "直播推流地址有效期，单位：秒 。", "example": "60" }, { "name": "PushUrl", "type": "string", "required": false, "description": "直播推流地址，入参不填默认由多媒体创作引擎生成。", "example": "rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600c" } ] } ] }, { "name": "BackupInput", "type": "object", "required": false, "description": "云转推备输入源信息。", "example": "无", "children": [ { "name": "InputType", "type": "string", "required": true, "description": "流输入类型，取值： VodPull ： 点播拉流； LivePull ：直播拉流； RtmpPush ： 直播推流。", "example": "LivePull" }, { "name": "VodPullInputInfo", "type": "object", "required": false, "description": "点播拉流信息，当 InputType = VodPull 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InputUrls", "type": "array", "required": true, "description": "点播输入拉流 URL 。", "example": "[\"http://example.com/file1.mp4\"]", "item_type": "string" }, { "name": "LoopTimes", "type": "integer", "required": false, "description": "播放次数，取值有： -1 : 循环播放，直到转推结束； 0 : 不循环； 大于0 : 具体循环次数，次数和时间以先结束的为准。 默认不循环。", "example": "-1" } ] }, { "name": "LivePullInputInfo", "type": "object", "required": false, "description": "直播拉流信息，当 InputType = LivePull 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InputUrl", "type": "string", "required": true, "description": "直播拉流地址。", "example": "rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600c" } ] }, { "name": "RtmpPushInputInfo", "type": "object", "required": false, "description": "直播推流信息，当 InputType = RtmpPush 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExpiredSecond", "type": "integer", "required": true, "description": "直播推流地址有效期，单位：秒 。", "example": "60" }, { "name": "PushUrl", "type": "string", "required": false, "description": "直播推流地址，入参不填默认由多媒体创作引擎生成。", "example": "rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600c" } ] } ] }, { "name": "Outputs", "type": "array", "required": false, "description": "云转推输出源信息。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "云转推输出源标识，转推项目级别唯一。若不填则由后端生成。", "example": "135ed54d55d" }, { "name": "Name", "type": "string", "required": false, "description": "云转推输出源名称。", "example": "MyStreamName" }, { "name": "Type", "type": "string", "required": false, "description": "云转推输出源类型，取值： URL ：URL类型 不填默认为URL类型。", "example": "URL" }, { "name": "PushUrl", "type": "string", "required": false, "description": "云转推推流地址。", "example": "rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600c" } ] } ] }, { "name": "RecordReplayProjectInput", "type": "object", "required": false, "description": "录制回放项目输入信息，仅当项目类型为 RECORD_REPLAY 时必填。", "example": "无", "children": [ { "name": "PullStreamUrl", "type": "string", "required": true, "description": "录制拉流地址。", "example": "https://liveplay.video-studio.myqcloud.com/live.flv" }, { "name": "MaterialOwner", "type": "object", "required": true, "description": "录制文件归属者。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "MaterialClassPath", "type": "string", "required": true, "description": "录制文件存储分类路径。", "example": "/录制" }, { "name": "PushStreamUrl", "type": "string", "required": true, "description": "回放推流地址。", "example": "rtmp://push.example.com/cme/live1" } ] }, { "name": "MediaCastProjectInput", "type": "object", "required": false, "description": "媒体转推项目输入信息，仅当项目类型为 MEDIA_CAST 时必填。", "example": "无", "children": [ { "name": "SourceInfos", "type": "array", "required": false, "description": "输入源列表。输入源列表最大个数为100.", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "输入源 Id，由系统分配。", "example": "fa98bf72ad3d334bb3a8" }, { "name": "Type", "type": "string", "required": false, "description": "输入源的媒体类型，取值有： CME：多媒体创作引擎的媒体文件； VOD：云点播的媒资文件。 EXTERNAL：非多媒体创建引擎或者云点播的媒资文件。", "example": "CME" }, { "name": "FileId", "type": "string", "required": false, "description": "云点播媒体文件 ID。当 Type = VOD 时必填。", "example": "a82b830e765aa979" }, { "name": "MaterialId", "type": "string", "required": false, "description": "多媒体创作引擎的媒体 ID。当 Type = CME 时必填。", "example": "7d7ac177781a48c14198" }, { "name": "Offset", "type": "float", "required": false, "description": "文件播放的起始位置，单位：秒。默认为0，从文件头开始播放。当 Type = CME 或者 VOD 时有效。", "example": "0" }, { "name": "Duration", "type": "float", "required": false, "description": "播放时长，单位：秒。默认播放整个文件。当 Type = CME 或者 VOD 时有效。", "example": "23" }, { "name": "Url", "type": "string", "required": false, "description": "外部文件的 Url， Type=EXTERNAL 时必填，可以是点播文件或者直播文件，支持的 Scheme 包括HTTP、HTTPS、RTMP。", "example": "rtmp://push.example.com/cme/live1" } ] }, { "name": "DestinationInfos", "type": "array", "required": false, "description": "输出源列表。输出源列表最大个数为10.", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "输出源 Id。由系统进行分配。", "example": "fa3a12938b007acff7adb59a9e4ae7b9" }, { "name": "PushUrl", "type": "string", "required": false, "description": "输出直播流地址。支持的直播流类型为 RTMP 和 SRT。", "example": "rtmp://push.example.com/cme/live1" }, { "name": "Name", "type": "string", "required": false, "description": "输出源的名称。", "example": "输出" } ] }, { "name": "OutputMediaSetting", "type": "object", "required": false, "description": "输出媒体配置。", "example": "无", "children": [ { "name": "VideoSetting", "type": "object", "required": true, "description": "视频配置。", "example": "无", "children": [ { "name": "Width", "type": "integer", "required": true, "description": "视频宽度，单位：px，默认值为1280。", "example": "1280" }, { "name": "Height", "type": "integer", "required": true, "description": "视频高度，单位：px，默认值为720。支持的视频分辨率最大为1920*1080。", "example": "720" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "视频码率，单位：kbps，默认值为2500。最大值为10000 kbps。", "example": "2000" }, { "name": "FrameRate", "type": "float", "required": false, "description": "视频帧率，单位：Hz，默认值为25。最大值为60。", "example": "25" } ] }, { "name": "FollowSourceInfo", "type": "boolean", "required": false, "description": "视频配置是否和第一个输入源的视频配置相同，默认值：false。如果 FollowSourceInfo 的值为 true，忽略 VideoSetting 参数。", "example": "false" } ] }, { "name": "PlaySetting", "type": "object", "required": false, "description": "播放控制参数。", "example": "无", "children": [ { "name": "LoopCount", "type": "integer", "required": false, "description": "循环播放次数。LoopCount 和 EndTime 同时只能有一个生效。默认循环播放次数为一次。如果同时设置了 LoopCount 和 EndTime 参数，优先使用 LoopCount 参数。", "example": "1" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。", "example": "2022-12-10T15:00:00Z" }, { "name": "AutoStartTime", "type": "string", "required": false, "description": "自动启动时间，采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。", "example": "2022-12-10T15:00:00Z" } ] } ] } ], "required": [ "Platform", "Name", "Owner", "Category" ] }, { "name": "CreateTeam", "description": "创建一个团队。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。", "example": "1000000009" }, { "name": "Name", "type": "string", "required": true, "description": "团队名称，限30个字符。", "example": "测试团队名称" }, { "name": "OwnerId", "type": "string", "required": true, "description": "团队所有者，指定用户 ID。", "example": "997988688" }, { "name": "OwnerRemark", "type": "string", "required": false, "description": "团队所有者的备注，限30个字符。", "example": "管理员李四" }, { "name": "TeamId", "type": "string", "required": false, "description": "自定义团队 ID。创建后不可修改，限20个英文字符及\"-\"。同时不能以 cmetid_开头。不填会生成默认团队 ID。", "example": "fa3a12938b007acff7adb59a9e4ae7b9" } ], "required": [ "Platform", "Name", "OwnerId" ] }, { "name": "CreateVideoEncodingPreset", "description": "指定导出的参数，创建一个视频编码配置", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。", "example": "1000000009" }, { "name": "Name", "type": "string", "required": true, "description": "配置名，可用来简单描述该配置的作用。", "example": "测试模板" }, { "name": "Container", "type": "string", "required": false, "description": "封装格式，可选值： mp4 ； mov 。 默认值：mp4。", "example": "mp4" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，可选值： 0：保留； 1：去除。 默认值：0。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，可选值： 0：保留； 1：去除。 默认值：0。", "example": "1" }, { "name": "VideoSetting", "type": "object", "required": false, "description": "编码配置的视频设置。默认值参考VideoEncodingPresetVideoSetting 定义。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": false, "description": "视频流的编码格式，可选值： H264：H.264 编码。", "example": "H264" }, { "name": "ShortEdge", "type": "integer", "required": false, "description": "视频短边尺寸，取值范围： [128, 4096]，单位：px。 视频最后的分辨率，根据短边尺寸和宽高比进行计算。 例：如果项目的宽高比是 16：9 ： 短边尺寸为 1080，则导出视频的分辨率为 1920 * 1080。 短边尺寸为 720，则导出视频的分辨率为 1280 * 720。 如果项目的宽高比是 9：16 ： 短边尺寸为 1080，则导出视频的分辨率为 1080 * 1920。 短边尺寸为 720，则导出视频的分辨率为 720 * 1280。 默\ufffd\ufffd...", "example": "1080" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "指定码率，单位 bps。当该参数为'0'时则不强制限定码率。 默认值：0。", "example": "0" } ] }, { "name": "AudioSetting", "type": "object", "required": false, "description": "编码配置的音频设置。默认值参考VideoEncodingPresetAudioSetting 定义。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": false, "description": "音频流的编码格式，可选值： AAC：AAC 编码。 默认值：AAC。", "example": "AAC" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "音频码率，单位：bps。 默认值：64K。", "example": "0" }, { "name": "Channels", "type": "integer", "required": false, "description": "音频声道数，可选值： 1：单声道； 2：双声道。 默认值：2。", "example": "2" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "音频流的采样率，仅支持 16000； 32000； 44100； 48000。单位：Hz。 默认值：16000。", "example": "16000" } ] } ], "required": [ "Platform", "Name" ] }, { "name": "DeleteClass", "description": "删除分类信息，删除时检验下述限制： 分类路径必须存在； 分类下没有绑定素材。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。", "example": "1000000009" }, { "name": "Owner", "type": "object", "required": true, "description": "归属者。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "ClassPath", "type": "string", "required": true, "description": "分类路径。", "example": "/a/b" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。填写用户的 Id，用于标识调用者及校验操作权限。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ], "required": [ "Platform", "Owner", "ClassPath" ] }, { "name": "DeleteLoginStatus", "description": "删除用户登录态，使用户登出多媒体创作引擎平台。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。", "example": "1000000009" }, { "name": "UserIds", "type": "array", "required": true, "description": "用户 Id 列表，N 从 0 开始取值，最大 19。", "example": "[\"111\\r\\n\"]", "item_type": "string" } ], "required": [ "Platform", "UserIds" ] }, { "name": "DeleteMaterial", "description": "根据媒体 Id 删除媒体。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。", "example": "1000000009" }, { "name": "MaterialId", "type": "string", "required": true, "description": "媒体 Id。", "example": "397ff3d4730c2e09ba24298f742add6346107826" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。填写用户的 Id，用于标识调用者及校验媒体删除权限。", "example": "user_id" } ], "required": [ "Platform", "MaterialId" ] }, { "name": "DeleteProject", "description": "删除项目。处于推流状态的云转推和点播转直播项目不允许删除，若强行调用删除项目接口会返回失败。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "ProjectId", "type": "string", "required": true, "description": "要删除的项目 Id。", "example": "1112" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以删除一切项目。如果指定操作者，则操作者必须为项目所有者。", "example": "user_id_100001" } ], "required": [ "Platform", "ProjectId" ] }, { "name": "DeleteTeam", "description": "删除一个团队。要删除团队，必须满足以下条件： 要删除的团队必须没有归属的素材； 要删除的团队必须没有归属的分类。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "TeamId", "type": "string", "required": true, "description": "要删除的团队 ID。", "example": "9aoodiiiekj899dkk99d7d6d5dff77f" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以删除所有团队。如果指定操作者，则操作者必须为团队所有者。", "example": "60097a8a8ea83d00017b484b" } ], "required": [ "Platform", "TeamId" ] }, { "name": "DeleteTeamMembers", "description": "将团队成员从团队中删除。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "TeamId", "type": "string", "required": true, "description": "团队 ID。", "example": "1kdk882ddd88338ddd3k3" }, { "name": "MemberIds", "type": "array", "required": true, "description": "要删除的成员列表。", "example": "[\"999kd3ej3okjdije3lejjdjk99\\r\\n\",\"999kd3ej3okjdije3lejjdjk98\\r\\n\"]", "item_type": "string" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以删除所有团队的成员。如果指定操作者，则操作者必须为团队管理员或者所有者。", "example": "60097a8a8ea83d00017b484b" } ], "required": [ "Platform", "TeamId", "MemberIds" ] }, { "name": "DeleteVideoEncodingPreset", "description": "删除指定 ID 的视频编码配置", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。", "example": "1000000009" }, { "name": "Id", "type": "integer", "required": true, "description": "要删除的视频编码配置 ID。", "example": "100050" } ], "required": [ "Platform", "Id" ] }, { "name": "DescribeAccounts", "description": "获取平台中所有的已注册账号。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "Phone", "type": "string", "required": false, "description": "手机号码。指定手机号获取账号信息，目前仅支持国内手机号，且号码不加地区码 `+86` 等。", "example": "15515555055" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回的起始偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回的记录条数，默认值：10，最大值：20。", "example": "10" } ], "required": [ "Platform" ] }, { "name": "DescribeClass", "description": "获取指定归属者下所有的分类信息。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。", "example": "1000000009" }, { "name": "Owner", "type": "object", "required": true, "description": "归属者。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。填写用户的 Id，用于标识调用者及校验操作权限。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ], "required": [ "Platform", "Owner" ] }, { "name": "DescribeJoinTeams", "description": "获取用户所加入的团队列表", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "MemberId", "type": "string", "required": true, "description": "团队成员　ID。", "example": "1993939392iidkei8ei" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：30，最大值：30。", "example": "10" } ], "required": [ "Platform", "MemberId" ] }, { "name": "DescribeLoginStatus", "description": "查询指定用户的登录态。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "UserIds", "type": "array", "required": true, "description": "用户 Id 列表，N 从0开始取值，最大19。", "example": "[\"c9bf9e57-1685-4c89-bafb-ff5af830be8a\"]", "item_type": "string" } ], "required": [ "Platform", "UserIds" ] }, { "name": "DescribeMaterials", "description": "根据媒体 Id 批量获取媒体详情。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "MaterialIds", "type": "array", "required": true, "description": "媒体 ID 列表，一次最多可拉取20个媒体的信息。", "example": "[\"5fd8ad3d628dc30001bd0895\"]", "item_type": "string" }, { "name": "Sort", "type": "object", "required": false, "description": "列表排序，支持下列排序字段： CreateTime：创建时间； UpdateTime：更新时间。", "example": "无", "children": [ { "name": "Field", "type": "string", "required": true, "description": "排序字段。", "example": "CreateTime" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，可选值：Asc（升序）、Desc（降序），默认降序。", "example": "Asc" } ] }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以获取任意媒体的信息。如果指定操作者，则操作者必须对媒体有读权限。", "example": "60097a8a8ea83d00017b484b" } ], "required": [ "Platform", "MaterialIds" ] }, { "name": "DescribePlatforms", "description": "支持获取所创建的所有平台列表信息； 支持获取指定的平台列表信息。 关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "status": "online", "parameters": [ { "name": "Platforms", "type": "array", "required": false, "description": "平台 Id 列表。如果不填，则不按平台 Id 进行过滤。", "example": "[\"1000000009\"]", "item_type": "string" }, { "name": "LicenseIds", "type": "array", "required": false, "description": "平台绑定的 License Id 列表。如果不填，则不按平台绑定的 License Id 进行过滤。", "example": "cmelid_8621ba0483c211ea90dc6c92bf621f6e", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回的起始偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回的记录条数，默认值：10，最大值：20。", "example": "10" } ], "required": [] }, { "name": "DescribeProjects", "description": "支持根据多种条件过滤出项目列表。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目 Id 过滤参数列表，最大支持20个项目 Id 过滤。如果不填不需要项目 Id 进行过滤。", "example": "[\"a82b830e765aa979\"]", "item_type": "string" }, { "name": "AspectRatioSet", "type": "array", "required": false, "description": "画布宽高比过滤参数列表。如果不填则不用画布宽高比进行过滤。", "example": "[\"16:9\"]", "item_type": "string" }, { "name": "CategorySet", "type": "array", "required": false, "description": "项目类型过滤参数列表，取值有： VIDEO_EDIT：视频编辑。 SWITCHER：导播台。 VIDEO_SEGMENTATION：视频拆条。 STREAM_CONNECT：云转推。 RECORD_REPLAY：录制回放。 MEDIA_CAST：点播转直播。 注：如果不填则不使用项目类型进行过滤。", "example": "[\"VIDEO_EDIT\"]", "item_type": "string" }, { "name": "Modes", "type": "array", "required": false, "description": "项目模式过滤参数列表，一个项目可以有多种模式并相互切换。 当 Category 为 VIDEO_EDIT 时，可选模式有： Default：默认模式。 VideoEditTemplate：视频编辑模板制作模式。 注：不填不使用项目模式进行过滤。", "example": "[\"Default\"]", "item_type": "string" }, { "name": "Sort", "type": "object", "required": false, "description": "结果排序方式，支持下列排序字段： CreateTime：创建时间； UpdateTime：更新时间。 注：如不填，则使用项目创建时间倒序排列。", "example": "无", "children": [ { "name": "Field", "type": "string", "required": true, "description": "排序字段。", "example": "CreateTime" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，可选值：Asc（升序）、Desc（降序），默认降序。", "example": "Asc" } ] }, { "name": "Owner", "type": "object", "required": false, "description": "项目所有者，目前仅支持个人项目过滤。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回的起始偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回的记录条数，默认值：10。", "example": "10" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以查询一切用户项目信息。如果指定操作者，则操作者必须为项目所有者。", "example": "378b753f-f91f-4c42-8fa3-34a2a3bf3c56" } ], "required": [ "Platform" ] }, { "name": "DescribeResourceAuthorization", "description": "查询资源被授权的情况。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000001" }, { "name": "Owner", "type": "object", "required": false, "description": "归属者。", "example": "{\"Type\":\"PERSON\",\"Id\":\"e7abc68e-6908-0000-2222-3221728e1111\"}", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Resource", "type": "object", "required": false, "description": "资源。", "example": "{\"Type\":\"CLASS\",\"Id\":\"1\"}", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： MATERIAL：素材。 CLASS：分类。", "example": "MATERIAL" }, { "name": "Id", "type": "string", "required": true, "description": "资源 Id，当 Type 为 MATERIAL 时，取值为素材 Id；当 Type 为 CLASS 时，取值为分类路径 ClassPath。", "example": "67e105de4fb8950001052fff" } ] }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以查询任意资源的被授权情况。如果指定操作者，则操作者必须对被授权资源有读权限。", "example": "1234c68e-1111-2222-3333-3221728e4444" } ], "required": [ "Platform" ] }, { "name": "DescribeSharedSpace", "description": "获取共享空间。当个人或团队A对个人或团队B授权某资源以后，个人或团队B的共享空间就会增加个人或团队A。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "Authorizee", "type": "object", "required": true, "description": "被授权目标，个人或团队。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以查询任意个人或者团队的共享空间。如果指定操作者，则操作者必须本人或者团队成员。", "example": "teamAmemberXXX" } ], "required": [ "Platform", "Authorizee" ] }, { "name": "DescribeTaskDetail", "description": "获取任务详情信息，包含下面几个部分： 任务基础信息：包括任务状态、错误信息、创建时间等； 导出项目输出信息：包括输出的素材 Id 等。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务 Id。", "example": "1400-tfusion-ct0" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以获取任意任务信息。如果指定操作者，则操作者需要是任务发起者。", "example": "85b8cdac-8e18-430a-aeae-08076ac26a11" } ], "required": [ "Platform", "TaskId" ] }, { "name": "DescribeTasks", "description": "获取任务列表，支持条件筛选，返回对应的任务基础信息列表。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "ProjectId", "type": "string", "required": false, "description": "项目 Id，使用项目 Id 进行过滤。", "example": "a82b830e765aa979" }, { "name": "TaskTypeSet", "type": "array", "required": false, "description": "任务类型集合，取值有： VIDEO_EDIT_PROJECT_EXPORT：视频编辑项目导出。 注：不填不使用任务类型进行过滤。", "example": "[\"VIDEO_EDIT_PROJECT_EXPORT\"]", "item_type": "string" }, { "name": "StatusSet", "type": "array", "required": false, "description": "任务状态集合，取值有： PROCESSING：处理中； SUCCESS：成功； FAIL：失败。 注：不填则不使用任务状态进行过滤。", "example": "[\"PROCESSING\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回的起始偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回的记录条数，默认值：10。最大值：20。", "example": "10" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以获取所有任务信息。如果指定操作者，则操作者需要是任务发起者。", "example": "378b753f-f91f-4c42-8fa3-34a2a3bf3c56" } ], "required": [ "Platform" ] }, { "name": "DescribeTeamMembers", "description": "获取指定团队的成员信息。支持获取指定成员的信息，同时也支持分页拉取指定团队的所有成员信息。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "TeamId", "type": "string", "required": true, "description": "团队 ID。", "example": "1kdk882ddd88338ddd3k3" }, { "name": "MemberIds", "type": "array", "required": false, "description": "成员 ID 列表，限指定30个指定成员。如不填，则返回指定团队下的所有成员。", "example": "[\"378b753f-f91f-4c42-8fa3-34a2a3bf3c56\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：30，最大值：30。", "example": "10" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以拉取任意团队成员的信息。如果指定操作者，则操作者必须为团队成员。", "example": "60097a8a8ea83d00017b484b" } ], "required": [ "Platform", "TeamId" ] }, { "name": "DescribeTeams", "description": "获取指定团队的信息，拉取团队信息列表。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "TeamIds", "type": "array", "required": false, "description": "团队 ID 列表，限30个。若不填，则默认获取平台下所有团队。", "example": "[\"1kdk882ddd88338ddd3k3\\n\",\"1kdk882ddd88338ddd3k4\\n\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：20，最大值：30。", "example": "10" } ], "required": [ "Platform" ] }, { "name": "DescribeVideoEncodingPresets", "description": "查询视频编码配置信息。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "Ids", "type": "array", "required": false, "description": "要查询的配置 ID 列表。填写该参数则按照配置 ID 进行查询。", "example": "[100047]", "item_type": "integer" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小，默认20。最大值50。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页起始，默认0。", "example": "0" } ], "required": [ "Platform" ] }, { "name": "ExportVideoByEditorTrackData", "description": "使用 [视频合成协议](https://cloud.tencent.com/document/product/1156/51225) 合成视频，支持导出视频到 CME 云媒资或者云点播媒资。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "Definition", "type": "integer", "required": true, "description": "导出视频预设配置 Id，推荐优先使用下面的默认预设配置 Id，有其他需求可通过接口定制预设配置。 10：分辨率为 480P，输出视频格式为 MP4； 11：分辨率为 720P，输出视频格式为 MP4； 12：分辨率为 1080P，输出视频格式为 MP4。", "example": "10" }, { "name": "ExportDestination", "type": "string", "required": true, "description": "导出目标，指定导出视频的目标媒资库，可取值有： CME：多媒体创建引擎，即导出到多媒体创作引擎媒资库，此导出目标在云点播媒资库依然可见； VOD：云点播，即导出为云点播媒资库，此导出目标在多媒体创作引擎媒资库将不可见。", "example": "VOD" }, { "name": "TrackData", "type": "string", "required": true, "description": "轨道数据，用于描述待导出视频的内容。关于轨道数据的格式请查看 [视频合成协议](https://cloud.tencent.com/document/product/1156/51225)。文档中也描述了如何在页面上查看一个剪辑项目的轨道数据，该能力可以帮助开发者更方便地构造自己的轨道数据。", "example": "[{\"id\":\"469f6d6e\",\"type\":\"video\",\"items\":[]}]" }, { "name": "AspectRatio", "type": "string", "required": false, "description": "轨道数据对应的画布宽高比，配合预设配置中的视频短边尺寸，可决定导出画面的尺寸。例： 如果 AspectRatio 取值 16:9，预设配置选为12（短边1080），则导出尺寸为 1920 * 1080； 如果 AspectRatio 取值 9:16，预设配置选为11（短边720），则导出尺寸为 720 *1280。", "example": "16:9" }, { "name": "CoverData", "type": "string", "required": false, "description": "视频封面图片文件（如 jpeg, png 等）进行 Base64 编码后的字符串，仅支持 gif、jpeg、png 三种图片格式，原图片文件不能超过2 M大 小。", "example": "SGVsbG8sIFdvcmxkIQ==" }, { "name": "CMEExportInfo", "type": "object", "required": false, "description": "导出的多媒体创作引擎媒体信息。当导出目标为 CME 时必填。", "example": "无", "children": [ { "name": "Owner", "type": "object", "required": true, "description": "导出媒体归属，个人或团队。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Name", "type": "string", "required": false, "description": "导出的媒体名称，不得超过30个字符。", "example": "素材" }, { "name": "Description", "type": "string", "required": false, "description": "导出的媒体信息，不得超过50个字符。", "example": "素材" }, { "name": "ClassPath", "type": "string", "required": false, "description": "导出的媒体分类路径，长度不能超过15字符。不存在默认创建。", "example": "/素材" }, { "name": "TagSet", "type": "array", "required": false, "description": "导出的媒体标签，单个标签不得超过10个字符。", "example": "[\"素材\"]", "item_type": "string" }, { "name": "ThirdPartyPublishInfos", "type": "array", "required": false, "description": "第三方平台发布信息列表。暂未正式对外，请勿使用。", "example": "无", "item_type": "object", "children": [ { "name": "ChannelMaterialId", "type": "string", "required": true, "description": "发布通道 ID。", "example": "9d64a35169404c4a250d" }, { "name": "PenguinMediaPlatformPublishInfo", "type": "object", "required": false, "description": "企鹅号发布信息，如果使用的发布通道为企鹅号时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Tags", "type": "array", "required": false, "description": "视频标签。", "example": "视频", "item_type": "string" }, { "name": "Category", "type": "integer", "required": false, "description": "视频分类，详见[企鹅号官网](https://open.om.qq.com/resources/resourcesCenter)视频分类。", "example": "64" } ] }, { "name": "WeiboPublishInfo", "type": "object", "required": false, "description": "新浪微博发布信息，如果使用的发布通道为新浪微博时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Visible", "type": "string", "required": false, "description": "微博可见性，可取值为： Public：公开，所有人可见； Private：私有，仅自己可见。 默认为 Public，所有人可见。", "example": "Public" } ] }, { "name": "KuaishouPublishInfo", "type": "object", "required": false, "description": "快手发布信息，如果使用的发布通道为快手时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题，限30个字符。", "example": "my_news" } ] }, { "name": "CosPublishInfo", "type": "object", "required": false, "description": "腾讯云对象存储发布信息， 如果使用的发布通道为腾讯云对象存储时必填。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "Video-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "VideoKey", "type": "string", "required": true, "description": "发布生成的视频在 COS 存储的对象键。对象键（ObjectKey）是对象（Object）在存储桶（Bucket）中的唯一标识。", "example": "fadd70539811.mp4" }, { "name": "CoverKey", "type": "string", "required": true, "description": "发布生成的封面在 COS 存储的对象键。", "example": "fadd70539812.png" } ] } ] } ] }, { "name": "VODExportInfo", "type": "object", "required": false, "description": "导出的云点播媒资信息。当导出目标为 VOD 时必填。", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "导出的媒资名称。", "example": "MaterialName" }, { "name": "ClassId", "type": "integer", "required": false, "description": "导出的媒资分类 Id。", "example": "9" }, { "name": "ThirdPartyPublishInfos", "type": "array", "required": false, "description": "第三方平台发布信息列表。暂未正式对外，请勿使用。", "example": "无", "item_type": "object", "children": [ { "name": "ChannelMaterialId", "type": "string", "required": true, "description": "发布通道 ID。", "example": "9d64a35169404c4a250d" }, { "name": "PenguinMediaPlatformPublishInfo", "type": "object", "required": false, "description": "企鹅号发布信息，如果使用的发布通道为企鹅号时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Tags", "type": "array", "required": false, "description": "视频标签。", "example": "视频", "item_type": "string" }, { "name": "Category", "type": "integer", "required": false, "description": "视频分类，详见[企鹅号官网](https://open.om.qq.com/resources/resourcesCenter)视频分类。", "example": "64" } ] }, { "name": "WeiboPublishInfo", "type": "object", "required": false, "description": "新浪微博发布信息，如果使用的发布通道为新浪微博时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Visible", "type": "string", "required": false, "description": "微博可见性，可取值为： Public：公开，所有人可见； Private：私有，仅自己可见。 默认为 Public，所有人可见。", "example": "Public" } ] }, { "name": "KuaishouPublishInfo", "type": "object", "required": false, "description": "快手发布信息，如果使用的发布通道为快手时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题，限30个字符。", "example": "my_news" } ] }, { "name": "CosPublishInfo", "type": "object", "required": false, "description": "腾讯云对象存储发布信息， 如果使用的发布通道为腾讯云对象存储时必填。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "Video-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "VideoKey", "type": "string", "required": true, "description": "发布生成的视频在 COS 存储的对象键。对象键（ObjectKey）是对象（Object）在存储桶（Bucket）中的唯一标识。", "example": "fadd70539811.mp4" }, { "name": "CoverKey", "type": "string", "required": true, "description": "发布生成的封面在 COS 存储的对象键。", "example": "fadd70539812.png" } ] } ] } ] }, { "name": "ExportExtensionArgs", "type": "object", "required": false, "description": "视频导出扩展参数。可以覆盖导出模板中的参数，灵活的指定导出规格及参数。", "example": "无", "children": [ { "name": "Container", "type": "string", "required": false, "description": "封装格式，可选值：mp4 mov 不填则使用视频导出编码配置。", "example": "mp4" }, { "name": "ShortEdge", "type": "integer", "required": false, "description": "视频短边尺寸，取值范围： [128, 4096]，单位：px。视频最后的分辨率，根据短边尺寸和宽高比进行计算。例如：项目的宽高比是 16：9 ：短边尺寸为 1080，则导出视频的分辨率为 1920 * 1080。短边尺寸为 720，则导出视频的分辨率为 1280 * 720不填则使用视频导出编码配置。", "example": "1080" }, { "name": "VideoBitrate", "type": "integer", "required": false, "description": "指定码率，单位 bps。当该参数为 0 时则不强制限定码率。不填则使用视频导出编码配置。", "example": "0" }, { "name": "FrameRate", "type": "float", "required": false, "description": "帧率。取值范围：[15, 60]，不填默认值为 25。单位：帧", "example": "0" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，可选值：0：保留；1：去除。不填则使用视频导出编码配置。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，可选值：0：保留；1：去除。不填则使用视频导出编码配置。", "example": "0" }, { "name": "StartTime", "type": "integer", "required": false, "description": "片段起始时间，单位：毫秒。", "example": "0" }, { "name": "EndTime", "type": "integer", "required": false, "description": "片段结束时间，单位：毫秒。", "example": "0" } ] }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，无权限限制。如果指定操作者，轨道数据中使用的媒资该操作者需要拥有使用权限。", "example": "9b92a8e7-a5ef-4e28-d72e-4eff571fabf0" } ], "required": [ "Platform", "Definition", "ExportDestination", "TrackData" ] }, { "name": "ExportVideoByTemplate", "description": "使用视频剪辑模板直接导出视频。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "TemplateId", "type": "string", "required": true, "description": "视频编辑模板 Id。", "example": "60097a8a8ea83d00017b484b" }, { "name": "Definition", "type": "integer", "required": true, "description": "导出视频预设配置 Id，推荐优先使用下面的默认预设配置 Id，有其他需求可通过接口定制预设配置。 10：分辨率为 480P，输出视频格式为 MP4； 11：分辨率为 720P，输出视频格式为 MP4； 12：分辨率为 1080P，输出视频格式为 MP4。", "example": "10" }, { "name": "ExportDestination", "type": "string", "required": true, "description": "导出目标，指定导出视频的目标媒资库，可取值有： CME：多媒体创作引擎，即导出为多媒体创作引擎媒资库，此导出目标在云点播媒资库依然可见； VOD：云点播，即导出为云点播媒资库，此导出目标在多媒体创作引擎媒资库将不可见。", "example": "VOD" }, { "name": "SlotReplacements", "type": "array", "required": false, "description": "需要替换的素材信息。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "integer", "required": true, "description": "卡槽 Id。", "example": "0" }, { "name": "ReplacementType", "type": "string", "required": true, "description": "替换类型，可取值有： AUDIO ：音频； VIDEO ：视频； IMAGE ：图片； TEXT ：文本。 注意：这里必须保证替换的素材类型与模板轨道数据的素材类型一致。如果替换的类型为Text,，则必须保证模板轨道数据中相应卡槽的位置标记的是文本。", "example": "VIDEO" }, { "name": "MediaReplacementInfo", "type": "object", "required": false, "description": "媒体替换信息，仅当要替换的媒体类型为音频、视频、图片时有效。", "example": " 无", "children": [ { "name": "MediaType", "type": "string", "required": false, "description": "替换的媒体类型，取值有： CMEMaterialId：替换的媒体类型为媒体 ID； ImageUrl：替换的媒体类型为图片 URL； 注：默认为 CMEMaterialId 。", "example": "ImageUrl" }, { "name": "MaterialId", "type": "string", "required": false, "description": "媒体 ID。 当媒体类型取值为 CMEMaterialId 时有效。", "example": "60097a8a8ea83d00017b484b" }, { "name": "MediaUrl", "type": "string", "required": false, "description": "媒体 URL。 当媒体类型取值为 ImageUrl 时有效， 图片仅支持 jpg、png 格式，且大小不超过 2M 。", "example": "http://cme.vod2.myqcloud.com/123/f0.jpg" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "替换媒体选取的开始时间，单位为秒，默认为 0。", "example": "0" }, { "name": "PreprocessOperation", "type": "object", "required": false, "description": "预处理操作。 注：目前该功能暂不支持，请勿使用。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "预处理操作的类型，取值范围： ImageTextMask：图片文字遮罩。", "example": "ImageTextMask" }, { "name": "Args", "type": "array", "required": false, "description": "预处理操作参数。 当 Type 取值 ImageTextMask 时，参数为要保留的文字。", "example": "[\"文字\"]", "item_type": "string" } ] }, { "name": "MuteSwitch", "type": "string", "required": false, "description": "静音开关，仅对视频类型媒体生效。取值有： ON：视频媒体开启静音，该段媒体在导出中会屏蔽音频； OFF：视频媒体关闭静音； 注：默认为 OFF，即不对视频媒体的音频做静音处理。", "example": "ON" } ] }, { "name": "TextReplacementInfo", "type": "object", "required": false, "description": "文本替换信息，仅当要替换的卡槽类型为文本时有效。", "example": "无", "children": [ { "name": "Text", "type": "string", "required": true, "description": "替换的文本信息。", "example": "文字" } ] } ] }, { "name": "CMEExportInfo", "type": "object", "required": false, "description": "导出的多媒体创作引擎媒资信息。当导出目标为 CME 时必填。", "example": "无", "children": [ { "name": "Owner", "type": "object", "required": true, "description": "导出媒体归属，个人或团队。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Name", "type": "string", "required": false, "description": "导出的媒体名称，不得超过30个字符。", "example": "素材" }, { "name": "Description", "type": "string", "required": false, "description": "导出的媒体信息，不得超过50个字符。", "example": "素材" }, { "name": "ClassPath", "type": "string", "required": false, "description": "导出的媒体分类路径，长度不能超过15字符。不存在默认创建。", "example": "/素材" }, { "name": "TagSet", "type": "array", "required": false, "description": "导出的媒体标签，单个标签不得超过10个字符。", "example": "[\"素材\"]", "item_type": "string" }, { "name": "ThirdPartyPublishInfos", "type": "array", "required": false, "description": "第三方平台发布信息列表。暂未正式对外，请勿使用。", "example": "无", "item_type": "object", "children": [ { "name": "ChannelMaterialId", "type": "string", "required": true, "description": "发布通道 ID。", "example": "9d64a35169404c4a250d" }, { "name": "PenguinMediaPlatformPublishInfo", "type": "object", "required": false, "description": "企鹅号发布信息，如果使用的发布通道为企鹅号时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Tags", "type": "array", "required": false, "description": "视频标签。", "example": "视频", "item_type": "string" }, { "name": "Category", "type": "integer", "required": false, "description": "视频分类，详见[企鹅号官网](https://open.om.qq.com/resources/resourcesCenter)视频分类。", "example": "64" } ] }, { "name": "WeiboPublishInfo", "type": "object", "required": false, "description": "新浪微博发布信息，如果使用的发布通道为新浪微博时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Visible", "type": "string", "required": false, "description": "微博可见性，可取值为： Public：公开，所有人可见； Private：私有，仅自己可见。 默认为 Public，所有人可见。", "example": "Public" } ] }, { "name": "KuaishouPublishInfo", "type": "object", "required": false, "description": "快手发布信息，如果使用的发布通道为快手时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题，限30个字符。", "example": "my_news" } ] }, { "name": "CosPublishInfo", "type": "object", "required": false, "description": "腾讯云对象存储发布信息， 如果使用的发布通道为腾讯云对象存储时必填。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "Video-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "VideoKey", "type": "string", "required": true, "description": "发布生成的视频在 COS 存储的对象键。对象键（ObjectKey）是对象（Object）在存储桶（Bucket）中的唯一标识。", "example": "fadd70539811.mp4" }, { "name": "CoverKey", "type": "string", "required": true, "description": "发布生成的封面在 COS 存储的对象键。", "example": "fadd70539812.png" } ] } ] } ] }, { "name": "VODExportInfo", "type": "object", "required": false, "description": "导出的云点播媒资信息。当导出目标为 VOD 时必填。", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "导出的媒资名称。", "example": "MaterialName" }, { "name": "ClassId", "type": "integer", "required": false, "description": "导出的媒资分类 Id。", "example": "9" }, { "name": "ThirdPartyPublishInfos", "type": "array", "required": false, "description": "第三方平台发布信息列表。暂未正式对外，请勿使用。", "example": "无", "item_type": "object", "children": [ { "name": "ChannelMaterialId", "type": "string", "required": true, "description": "发布通道 ID。", "example": "9d64a35169404c4a250d" }, { "name": "PenguinMediaPlatformPublishInfo", "type": "object", "required": false, "description": "企鹅号发布信息，如果使用的发布通道为企鹅号时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Tags", "type": "array", "required": false, "description": "视频标签。", "example": "视频", "item_type": "string" }, { "name": "Category", "type": "integer", "required": false, "description": "视频分类，详见[企鹅号官网](https://open.om.qq.com/resources/resourcesCenter)视频分类。", "example": "64" } ] }, { "name": "WeiboPublishInfo", "type": "object", "required": false, "description": "新浪微博发布信息，如果使用的发布通道为新浪微博时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Visible", "type": "string", "required": false, "description": "微博可见性，可取值为： Public：公开，所有人可见； Private：私有，仅自己可见。 默认为 Public，所有人可见。", "example": "Public" } ] }, { "name": "KuaishouPublishInfo", "type": "object", "required": false, "description": "快手发布信息，如果使用的发布通道为快手时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题，限30个字符。", "example": "my_news" } ] }, { "name": "CosPublishInfo", "type": "object", "required": false, "description": "腾讯云对象存储发布信息， 如果使用的发布通道为腾讯云对象存储时必填。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "Video-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "VideoKey", "type": "string", "required": true, "description": "发布生成的视频在 COS 存储的对象键。对象键（ObjectKey）是对象（Object）在存储桶（Bucket）中的唯一标识。", "example": "fadd70539811.mp4" }, { "name": "CoverKey", "type": "string", "required": true, "description": "发布生成的封面在 COS 存储的对象键。", "example": "fadd70539812.png" } ] } ] } ] }, { "name": "ExportExtensionArgs", "type": "object", "required": false, "description": "视频导出扩展参数。可以覆盖导出模板中的参数，灵活的指定导出规格及参数。", "example": "无", "children": [ { "name": "Container", "type": "string", "required": false, "description": "封装格式，可选值：mp4 mov 不填则使用视频导出编码配置。", "example": "mp4" }, { "name": "ShortEdge", "type": "integer", "required": false, "description": "视频短边尺寸，取值范围： [128, 4096]，单位：px。视频最后的分辨率，根据短边尺寸和宽高比进行计算。例如：项目的宽高比是 16：9 ：短边尺寸为 1080，则导出视频的分辨率为 1920 * 1080。短边尺寸为 720，则导出视频的分辨率为 1280 * 720不填则使用视频导出编码配置。", "example": "1080" }, { "name": "VideoBitrate", "type": "integer", "required": false, "description": "指定码率，单位 bps。当该参数为 0 时则不强制限定码率。不填则使用视频导出编码配置。", "example": "0" }, { "name": "FrameRate", "type": "float", "required": false, "description": "帧率。取值范围：[15, 60]，不填默认值为 25。单位：帧", "example": "0" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，可选值：0：保留；1：去除。不填则使用视频导出编码配置。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，可选值：0：保留；1：去除。不填则使用视频导出编码配置。", "example": "0" }, { "name": "StartTime", "type": "integer", "required": false, "description": "片段起始时间，单位：毫秒。", "example": "0" }, { "name": "EndTime", "type": "integer", "required": false, "description": "片段结束时间，单位：毫秒。", "example": "0" } ] }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，无权限限制。如果指定操作者，则操作者需要有替换媒体及剪辑模板的权限。", "example": "60097a8a8ea83d00017b484b" } ], "required": [ "Platform", "TemplateId", "Definition", "ExportDestination" ] }, { "name": "ExportVideoByVideoSegmentationData", "description": "使用视频智能拆条数据导出视频，将指定的视频拆条片段导出为一个视频(内测中，请勿使用)。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "default_platform" }, { "name": "ProjectId", "type": "string", "required": true, "description": "视频拆条项目 Id 。", "example": "cmepid_5fd1dfaf0e1b530001f5d9b0" }, { "name": "SegmentGroupId", "type": "string", "required": true, "description": "指定需要导出的智能拆条片段的组 Id 。", "example": "5fd6e20b0e1b530001f5daed" }, { "name": "SegmentIds", "type": "array", "required": true, "description": "指定需要导出的智能拆条片段 Id 集合。", "example": "[\"seg_5fd6e20b0e1b530001f5daee\\n\"]", "item_type": "string" }, { "name": "Definition", "type": "integer", "required": true, "description": "导出模板 Id，目前不支持自定义创建，只支持下面的预置模板 Id。 10：分辨率为 480P，输出视频格式为 MP4； 11：分辨率为 720P，输出视频格式为 MP4； 12：分辨率为 1080P，输出视频格式为 MP4。", "example": "10" }, { "name": "ExportDestination", "type": "string", "required": true, "description": "导出目标，指定导出视频的目标媒资库，可取值有： CME：多媒体创作引擎，即导出为多媒体创作引擎媒资库，此导出目标在云点播媒资库依然可见； VOD：云点播，即导出为云点播媒资库，此导出目标在多媒体创作引擎媒资库将不可见。", "example": "VOD" }, { "name": "CMEExportInfo", "type": "object", "required": false, "description": "导出的多媒体创作引擎媒体信息。当导出目标为 CME 时必填。", "example": "无", "children": [ { "name": "Owner", "type": "object", "required": true, "description": "导出媒体归属，个人或团队。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Name", "type": "string", "required": false, "description": "导出的媒体名称，不得超过30个字符。", "example": "素材" }, { "name": "Description", "type": "string", "required": false, "description": "导出的媒体信息，不得超过50个字符。", "example": "素材" }, { "name": "ClassPath", "type": "string", "required": false, "description": "导出的媒体分类路径，长度不能超过15字符。不存在默认创建。", "example": "/素材" }, { "name": "TagSet", "type": "array", "required": false, "description": "导出的媒体标签，单个标签不得超过10个字符。", "example": "[\"素材\"]", "item_type": "string" }, { "name": "ThirdPartyPublishInfos", "type": "array", "required": false, "description": "第三方平台发布信息列表。暂未正式对外，请勿使用。", "example": "无", "item_type": "object", "children": [ { "name": "ChannelMaterialId", "type": "string", "required": true, "description": "发布通道 ID。", "example": "9d64a35169404c4a250d" }, { "name": "PenguinMediaPlatformPublishInfo", "type": "object", "required": false, "description": "企鹅号发布信息，如果使用的发布通道为企鹅号时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Tags", "type": "array", "required": false, "description": "视频标签。", "example": "视频", "item_type": "string" }, { "name": "Category", "type": "integer", "required": false, "description": "视频分类，详见[企鹅号官网](https://open.om.qq.com/resources/resourcesCenter)视频分类。", "example": "64" } ] }, { "name": "WeiboPublishInfo", "type": "object", "required": false, "description": "新浪微博发布信息，如果使用的发布通道为新浪微博时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Visible", "type": "string", "required": false, "description": "微博可见性，可取值为： Public：公开，所有人可见； Private：私有，仅自己可见。 默认为 Public，所有人可见。", "example": "Public" } ] }, { "name": "KuaishouPublishInfo", "type": "object", "required": false, "description": "快手发布信息，如果使用的发布通道为快手时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题，限30个字符。", "example": "my_news" } ] }, { "name": "CosPublishInfo", "type": "object", "required": false, "description": "腾讯云对象存储发布信息， 如果使用的发布通道为腾讯云对象存储时必填。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "Video-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "VideoKey", "type": "string", "required": true, "description": "发布生成的视频在 COS 存储的对象键。对象键（ObjectKey）是对象（Object）在存储桶（Bucket）中的唯一标识。", "example": "fadd70539811.mp4" }, { "name": "CoverKey", "type": "string", "required": true, "description": "发布生成的封面在 COS 存储的对象键。", "example": "fadd70539812.png" } ] } ] } ] }, { "name": "VODExportInfo", "type": "object", "required": false, "description": "导出的云点播媒资信息。当导出目标为 VOD 时必填。", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "导出的媒资名称。", "example": "MaterialName" }, { "name": "ClassId", "type": "integer", "required": false, "description": "导出的媒资分类 Id。", "example": "9" }, { "name": "ThirdPartyPublishInfos", "type": "array", "required": false, "description": "第三方平台发布信息列表。暂未正式对外，请勿使用。", "example": "无", "item_type": "object", "children": [ { "name": "ChannelMaterialId", "type": "string", "required": true, "description": "发布通道 ID。", "example": "9d64a35169404c4a250d" }, { "name": "PenguinMediaPlatformPublishInfo", "type": "object", "required": false, "description": "企鹅号发布信息，如果使用的发布通道为企鹅号时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Tags", "type": "array", "required": false, "description": "视频标签。", "example": "视频", "item_type": "string" }, { "name": "Category", "type": "integer", "required": false, "description": "视频分类，详见[企鹅号官网](https://open.om.qq.com/resources/resourcesCenter)视频分类。", "example": "64" } ] }, { "name": "WeiboPublishInfo", "type": "object", "required": false, "description": "新浪微博发布信息，如果使用的发布通道为新浪微博时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Visible", "type": "string", "required": false, "description": "微博可见性，可取值为： Public：公开，所有人可见； Private：私有，仅自己可见。 默认为 Public，所有人可见。", "example": "Public" } ] }, { "name": "KuaishouPublishInfo", "type": "object", "required": false, "description": "快手发布信息，如果使用的发布通道为快手时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题，限30个字符。", "example": "my_news" } ] }, { "name": "CosPublishInfo", "type": "object", "required": false, "description": "腾讯云对象存储发布信息， 如果使用的发布通道为腾讯云对象存储时必填。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "Video-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "VideoKey", "type": "string", "required": true, "description": "发布生成的视频在 COS 存储的对象键。对象键（ObjectKey）是对象（Object）在存储桶（Bucket）中的唯一标识。", "example": "fadd70539811.mp4" }, { "name": "CoverKey", "type": "string", "required": true, "description": "发布生成的封面在 COS 存储的对象键。", "example": "fadd70539812.png" } ] } ] } ] }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以操作任意智能拆条项目。如果指定操作者，则操作者必须为项目所有。", "example": "16556266637489" } ], "required": [ "Platform", "ProjectId", "SegmentGroupId", "SegmentIds", "Definition", "ExportDestination" ] }, { "name": "ExportVideoEditProject", "description": "导出视频编辑项目，支持指定输出的模板。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。", "example": "1000000009" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目 Id。", "example": "cmepid_503f1c85000152217601dfa6" }, { "name": "Definition", "type": "integer", "required": true, "description": "视频编码配置 ID，支持自定义创建，推荐优先使用系统预置的导出配置。 10：分辨率为 480P，输出视频格式为 MP4； 11：分辨率为 720P，输出视频格式为 MP4； 12：分辨率为 1080P，输出视频格式为 MP4。", "example": "10" }, { "name": "ExportDestination", "type": "string", "required": true, "description": "导出目标，指定导出视频的目标媒资库，可取值有： CME：多媒体创作引擎，即导出为多媒体创作引擎媒资库，此导出目标在云点播媒资库依然可见； VOD：云点播，即导出为云点播媒资库，此导出目标在多媒体创作引擎媒资库将不可见。", "example": "CME" }, { "name": "CoverData", "type": "string", "required": false, "description": "视频封面图片文件（如 jpeg, png 等）进行 Base64 编码后的字符串，仅支持 gif、jpeg、png 三种图片格式，原图片文件不能超过2 M大 小。", "example": "Y292ZXJJbWFnZQ==" }, { "name": "CMEExportInfo", "type": "object", "required": false, "description": "导出的多媒体创作引擎媒体信息。当导出目标为 CME 时必填。", "example": "无", "children": [ { "name": "Owner", "type": "object", "required": true, "description": "导出媒体归属，个人或团队。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Name", "type": "string", "required": false, "description": "导出的媒体名称，不得超过30个字符。", "example": "素材" }, { "name": "Description", "type": "string", "required": false, "description": "导出的媒体信息，不得超过50个字符。", "example": "素材" }, { "name": "ClassPath", "type": "string", "required": false, "description": "导出的媒体分类路径，长度不能超过15字符。不存在默认创建。", "example": "/素材" }, { "name": "TagSet", "type": "array", "required": false, "description": "导出的媒体标签，单个标签不得超过10个字符。", "example": "[\"素材\"]", "item_type": "string" }, { "name": "ThirdPartyPublishInfos", "type": "array", "required": false, "description": "第三方平台发布信息列表。暂未正式对外，请勿使用。", "example": "无", "item_type": "object", "children": [ { "name": "ChannelMaterialId", "type": "string", "required": true, "description": "发布通道 ID。", "example": "9d64a35169404c4a250d" }, { "name": "PenguinMediaPlatformPublishInfo", "type": "object", "required": false, "description": "企鹅号发布信息，如果使用的发布通道为企鹅号时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Tags", "type": "array", "required": false, "description": "视频标签。", "example": "视频", "item_type": "string" }, { "name": "Category", "type": "integer", "required": false, "description": "视频分类，详见[企鹅号官网](https://open.om.qq.com/resources/resourcesCenter)视频分类。", "example": "64" } ] }, { "name": "WeiboPublishInfo", "type": "object", "required": false, "description": "新浪微博发布信息，如果使用的发布通道为新浪微博时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Visible", "type": "string", "required": false, "description": "微博可见性，可取值为： Public：公开，所有人可见； Private：私有，仅自己可见。 默认为 Public，所有人可见。", "example": "Public" } ] }, { "name": "KuaishouPublishInfo", "type": "object", "required": false, "description": "快手发布信息，如果使用的发布通道为快手时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题，限30个字符。", "example": "my_news" } ] }, { "name": "CosPublishInfo", "type": "object", "required": false, "description": "腾讯云对象存储发布信息， 如果使用的发布通道为腾讯云对象存储时必填。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "Video-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "VideoKey", "type": "string", "required": true, "description": "发布生成的视频在 COS 存储的对象键。对象键（ObjectKey）是对象（Object）在存储桶（Bucket）中的唯一标识。", "example": "fadd70539811.mp4" }, { "name": "CoverKey", "type": "string", "required": true, "description": "发布生成的封面在 COS 存储的对象键。", "example": "fadd70539812.png" } ] } ] } ] }, { "name": "VODExportInfo", "type": "object", "required": false, "description": "导出的云点播媒资信息。当导出目标为 VOD 时必填。", "example": "无", "children": [ { "name": "Name", "type": "string", "required": false, "description": "导出的媒资名称。", "example": "MaterialName" }, { "name": "ClassId", "type": "integer", "required": false, "description": "导出的媒资分类 Id。", "example": "9" }, { "name": "ThirdPartyPublishInfos", "type": "array", "required": false, "description": "第三方平台发布信息列表。暂未正式对外，请勿使用。", "example": "无", "item_type": "object", "children": [ { "name": "ChannelMaterialId", "type": "string", "required": true, "description": "发布通道 ID。", "example": "9d64a35169404c4a250d" }, { "name": "PenguinMediaPlatformPublishInfo", "type": "object", "required": false, "description": "企鹅号发布信息，如果使用的发布通道为企鹅号时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Tags", "type": "array", "required": false, "description": "视频标签。", "example": "视频", "item_type": "string" }, { "name": "Category", "type": "integer", "required": false, "description": "视频分类，详见[企鹅号官网](https://open.om.qq.com/resources/resourcesCenter)视频分类。", "example": "64" } ] }, { "name": "WeiboPublishInfo", "type": "object", "required": false, "description": "新浪微博发布信息，如果使用的发布通道为新浪微博时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题。", "example": "视频能力" }, { "name": "Description", "type": "string", "required": false, "description": "视频发布描述信息。", "example": "视频能力描述" }, { "name": "Visible", "type": "string", "required": false, "description": "微博可见性，可取值为： Public：公开，所有人可见； Private：私有，仅自己可见。 默认为 Public，所有人可见。", "example": "Public" } ] }, { "name": "KuaishouPublishInfo", "type": "object", "required": false, "description": "快手发布信息，如果使用的发布通道为快手时必填。", "example": "无", "children": [ { "name": "Title", "type": "string", "required": false, "description": "视频发布标题，限30个字符。", "example": "my_news" } ] }, { "name": "CosPublishInfo", "type": "object", "required": false, "description": "腾讯云对象存储发布信息， 如果使用的发布通道为腾讯云对象存储时必填。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "Video-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "发布生成的对象存储文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "VideoKey", "type": "string", "required": true, "description": "发布生成的视频在 COS 存储的对象键。对象键（ObjectKey）是对象（Object）在存储桶（Bucket）中的唯一标识。", "example": "fadd70539811.mp4" }, { "name": "CoverKey", "type": "string", "required": true, "description": "发布生成的封面在 COS 存储的对象键。", "example": "fadd70539812.png" } ] } ] } ] }, { "name": "ExportExtensionArgs", "type": "object", "required": false, "description": "视频导出扩展参数。可以覆盖导出模板中的参数，灵活的指定导出规格及参数。", "example": "无", "children": [ { "name": "Container", "type": "string", "required": false, "description": "封装格式，可选值：mp4 mov 不填则使用视频导出编码配置。", "example": "mp4" }, { "name": "ShortEdge", "type": "integer", "required": false, "description": "视频短边尺寸，取值范围： [128, 4096]，单位：px。视频最后的分辨率，根据短边尺寸和宽高比进行计算。例如：项目的宽高比是 16：9 ：短边尺寸为 1080，则导出视频的分辨率为 1920 * 1080。短边尺寸为 720，则导出视频的分辨率为 1280 * 720不填则使用视频导出编码配置。", "example": "1080" }, { "name": "VideoBitrate", "type": "integer", "required": false, "description": "指定码率，单位 bps。当该参数为 0 时则不强制限定码率。不填则使用视频导出编码配置。", "example": "0" }, { "name": "FrameRate", "type": "float", "required": false, "description": "帧率。取值范围：[15, 60]，不填默认值为 25。单位：帧", "example": "0" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，可选值：0：保留；1：去除。不填则使用视频导出编码配置。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，可选值：0：保留；1：去除。不填则使用视频导出编码配置。", "example": "0" }, { "name": "StartTime", "type": "integer", "required": false, "description": "片段起始时间，单位：毫秒。", "example": "0" }, { "name": "EndTime", "type": "integer", "required": false, "description": "片段结束时间，单位：毫秒。", "example": "0" } ] }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。填写用户的 Id，用于标识调用者及校验项目导出权限。", "example": "9b92a8e7-a5ef-4e28-d72e-4eff571fabf0" } ], "required": [ "Platform", "ProjectId", "Definition", "ExportDestination" ] }, { "name": "FlattenListMedia", "description": "平铺分类路径下及其子分类下的所有媒体基础信息，返回当前分类及子分类中的所有媒体的基础信息。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "ClassPath", "type": "string", "required": true, "description": "媒体分类路径，例如填写\"/a/b\"，则代表平铺该分类路径下及其子分类路径下的媒体信息。", "example": "/a/b" }, { "name": "Owner", "type": "object", "required": true, "description": "媒体分类的归属者。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：50。", "example": "10" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以平铺查询任意分类下的媒体信息。如果指定操作者，则操作者必须对当前分类有读权限。", "example": "cmeid_system" } ], "required": [ "Platform", "ClassPath", "Owner" ] }, { "name": "GenerateVideoSegmentationSchemeByAi", "description": "发起视频智能拆条任务，支持智能生成和平精英集锦、王者荣耀集锦、足球集锦、篮球集锦 、人物集锦、新闻拆条等任务。 和平精英集锦和王者荣耀集锦根据击杀场景进行拆条，足球集锦和篮球集锦根据进球场景进行拆条，人物集锦根据人物人脸特征进行拆条，新闻拆条根据导播进行拆条。 【本接口内测中，暂不建议使用】", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "ProjectId", "type": "string", "required": true, "description": "视频拆条项目 Id 。", "example": "60336ab29997a50001942xxx" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以对任务视频拆条项目发起拆条任务。如果指定操作者，则操作者必须为项目所有者。", "example": "cmeid_system" } ], "required": [ "Platform", "ProjectId" ] }, { "name": "GrantResourceAuthorization", "description": "资源归属者对个人或团队授予目标资源的相应权限。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "Owner", "type": "object", "required": true, "description": "资源归属者，个人或者团队。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Resources", "type": "array", "required": true, "description": "被授权资源。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： MATERIAL：素材。 CLASS：分类。", "example": "MATERIAL" }, { "name": "Id", "type": "string", "required": true, "description": "资源 Id，当 Type 为 MATERIAL 时，取值为素材 Id；当 Type 为 CLASS 时，取值为分类路径 ClassPath。", "example": "67e105de4fb8950001052fff" } ] }, { "name": "Authorizees", "type": "array", "required": true, "description": "被授权目标，个人或者团队。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Permissions", "type": "array", "required": true, "description": "详细授权值。 取值有： R：可读，可以浏览媒体，但不能使用该媒体文件（将其添加到 Project），或复制到自己的媒资库中 X：可用，可以使用该素材（将其添加到 Project），但不能将其复制到自己的媒资库中，意味着被授权者无法将该资源进一步扩散给其他个人或团队。 C：可复制，既可以使用该素材（将其添加到 Project），也可以将其复制到自己的媒资库中。 W：可修改、删\ufffd\ufffd...", "example": "[\"R\\n\"]", "item_type": "string" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以授权任意归属者的资源。如果指定操作者，则操作者必须对资源拥有写权限。", "example": "cmeid_system" } ], "required": [ "Platform", "Owner", "Resources", "Authorizees", "Permissions" ] }, { "name": "HandleMediaCastProject", "description": "对媒体转推项目进行操作。 ### 操作类型 - `AddSource`（添加输入源），项目状态为 Idle、Working 时均可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B6-.E6.B7.BB.E5.8A.A0.E8.BE.93.E5.85.A5.E6.BA.90)； - `DeleteSource`（删除输入源），项目状态为 Idle、Working 时均可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B3-.E5.88.A0.E9.99.A4.E8.BE.93.E5.85.A5.E6.BA.90)； - `SwitchSource`（切换当前播放的输入源），项目状态为 Working 时可以操...", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "ProjectId", "type": "string", "required": true, "description": "媒体转推项目 Id 。", "example": "67e105de4fb8950001052fff" }, { "name": "Operation", "type": "string", "required": true, "description": "请参考 [操作类型](#Operation)。", "example": "AddSource" }, { "name": "SourceInfos", "type": "array", "required": false, "description": "输入源信息。具体操作方式详见 [操作类型](#Operation) 及下文示例。 当 Operation 为 AddSource、DeleteSource、SwitchSource 时必填。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "输入源 Id，由系统分配。", "example": "fa98bf72ad3d334bb3a8" }, { "name": "Type", "type": "string", "required": false, "description": "输入源的媒体类型，取值有： CME：多媒体创作引擎的媒体文件； VOD：云点播的媒资文件。 EXTERNAL：非多媒体创建引擎或者云点播的媒资文件。", "example": "CME" }, { "name": "FileId", "type": "string", "required": false, "description": "云点播媒体文件 ID。当 Type = VOD 时必填。", "example": "a82b830e765aa979" }, { "name": "MaterialId", "type": "string", "required": false, "description": "多媒体创作引擎的媒体 ID。当 Type = CME 时必填。", "example": "7d7ac177781a48c14198" }, { "name": "Offset", "type": "float", "required": false, "description": "文件播放的起始位置，单位：秒。默认为0，从文件头开始播放。当 Type = CME 或者 VOD 时有效。", "example": "0" }, { "name": "Duration", "type": "float", "required": false, "description": "播放时长，单位：秒。默认播放整个文件。当 Type = CME 或者 VOD 时有效。", "example": "23" }, { "name": "Url", "type": "string", "required": false, "description": "外部文件的 Url， Type=EXTERNAL 时必填，可以是点播文件或者直播文件，支持的 Scheme 包括HTTP、HTTPS、RTMP。", "example": "rtmp://push.example.com/cme/live1" } ] }, { "name": "DestinationInfos", "type": "array", "required": false, "description": "输出源信息。具体操作方式详见 [操作类型](#Operation) 及下文示例。 当 Operation 为 AddDestination、DeleteDestination、EnableDestination、DisableDestination、ModifyDestination 时必填。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": false, "description": "输出源 Id。由系统进行分配。", "example": "fa3a12938b007acff7adb59a9e4ae7b9" }, { "name": "PushUrl", "type": "string", "required": false, "description": "输出直播流地址。支持的直播流类型为 RTMP 和 SRT。", "example": "rtmp://push.example.com/cme/live1" }, { "name": "Name", "type": "string", "required": false, "description": "输出源的名称。", "example": "输出" } ] }, { "name": "OutputMediaSetting", "type": "object", "required": false, "description": "输出媒体配置。具体操作方式详见 [操作类型](#Operation) 及下文示例。 当 Operation 为 ModifyOutputSetting 时必填。", "example": "无", "children": [ { "name": "VideoSetting", "type": "object", "required": true, "description": "视频配置。", "example": "无", "children": [ { "name": "Width", "type": "integer", "required": true, "description": "视频宽度，单位：px，默认值为1280。", "example": "1280" }, { "name": "Height", "type": "integer", "required": true, "description": "视频高度，单位：px，默认值为720。支持的视频分辨率最大为1920*1080。", "example": "720" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "视频码率，单位：kbps，默认值为2500。最大值为10000 kbps。", "example": "2000" }, { "name": "FrameRate", "type": "float", "required": false, "description": "视频帧率，单位：Hz，默认值为25。最大值为60。", "example": "25" } ] }, { "name": "FollowSourceInfo", "type": "boolean", "required": false, "description": "视频配置是否和第一个输入源的视频配置相同，默认值：false。如果 FollowSourceInfo 的值为 true，忽略 VideoSetting 参数。", "example": "false" } ] }, { "name": "PlaySetting", "type": "object", "required": false, "description": "播放控制参数。具体操作方式详见 [操作类型](#Operation) 及下文示例。 当 Operation 为 ModifyPlaySetting 时必填。", "example": "无", "children": [ { "name": "LoopCount", "type": "integer", "required": false, "description": "循环播放次数。LoopCount 和 EndTime 同时只能有一个生效。默认循环播放次数为一次。如果同时设置了 LoopCount 和 EndTime 参数，优先使用 LoopCount 参数。", "example": "1" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。", "example": "2022-12-10T15:00:00Z" }, { "name": "AutoStartTime", "type": "string", "required": false, "description": "自动启动时间，采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。", "example": "2022-12-10T15:00:00Z" } ] }, { "name": "Position", "type": "integer", "required": false, "description": "新添加的输入源位于输入源列表的位置，从0开始。默认加在输入源列表的后面。具体操作方式详见 [操作类型](#Operation) 及下文示例。 当 Operation 为 AddSource 时必填。", "example": "1" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以操作所有媒体转推项目。如果指定操作者，则操作者必须为项目所有者。", "example": "60097a8a8ea83d00017b484b" } ], "required": [ "Platform", "ProjectId", "Operation" ] }, { "name": "HandleStreamConnectProject", "description": "本接口废弃，可创建媒体转推项目替代，操作媒体转推项目可使用 [HandleMediaCastProject 接口](/document/product/1156/87841) 实现。 ### 操作类型 - `AddInput`（添加输入源），包括： - 添加直播拉流输入源，参见 [示例1](#.E7.A4.BA.E4.BE.8B1-.E6.B7.BB.E5.8A.A0.E7.9B.B4.E6.92.AD.E6.8B.89.E6.B5.81.E8.BE.93.E5.85.A5.E6.BA.90)； - 添加直播推流输入源，参见 [示例2](#.E7.A4.BA.E4.BE.8B2-.E6.B7.BB.E5.8A.A0.E7.9B.B4.E6.92.AD.E6.8E.A8.E6.B5...", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "ProjectId", "type": "string", "required": true, "description": "云转推项目 Id 。", "example": "67e105de4fb8950001052fff" }, { "name": "Operation", "type": "string", "required": true, "description": "请参考 [操作类型](#Operation)", "example": "AddInput" }, { "name": "InputInfo", "type": "object", "required": false, "description": "转推输入源操作参数。具体操作方式详见 [操作类型](#Operation) 及下文示例。", "example": "无", "children": [ { "name": "InputType", "type": "string", "required": true, "description": "流输入类型，取值： VodPull ： 点播拉流； LivePull ：直播拉流； RtmpPush ： 直播推流。", "example": "LivePull" }, { "name": "VodPullInputInfo", "type": "object", "required": false, "description": "点播拉流信息，当 InputType = VodPull 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InputUrls", "type": "array", "required": true, "description": "点播输入拉流 URL 。", "example": "[\"http://example.com/file1.mp4\"]", "item_type": "string" }, { "name": "LoopTimes", "type": "integer", "required": false, "description": "播放次数，取值有： -1 : 循环播放，直到转推结束； 0 : 不循环； 大于0 : 具体循环次数，次数和时间以先结束的为准。 默认不循环。", "example": "-1" } ] }, { "name": "LivePullInputInfo", "type": "object", "required": false, "description": "直播拉流信息，当 InputType = LivePull 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InputUrl", "type": "string", "required": true, "description": "直播拉流地址。", "example": "rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600c" } ] }, { "name": "RtmpPushInputInfo", "type": "object", "required": false, "description": "直播推流信息，当 InputType = RtmpPush 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ExpiredSecond", "type": "integer", "required": true, "description": "直播推流地址有效期，单位：秒 。", "example": "60" }, { "name": "PushUrl", "type": "string", "required": false, "description": "直播推流地址，入参不填默认由多媒体创作引擎生成。", "example": "rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600c" } ] } ] }, { "name": "InputEndpoint", "type": "string", "required": false, "description": "主备输入源标识，取值有： Main ：主源； Backup ：备源。", "example": "Main" }, { "name": "OutputInfo", "type": "object", "required": false, "description": "转推输出源操作参数。具体操作方式详见 [操作类型](#Operation) 及下文示例。", "example": "无", "children": [ { "name": "Id", "type": "string", "required": false, "description": "云转推输出源标识，转推项目级别唯一。若不填则由后端生成。", "example": "135ed54d55d" }, { "name": "Name", "type": "string", "required": false, "description": "云转推输出源名称。", "example": "MyStreamName" }, { "name": "Type", "type": "string", "required": false, "description": "云转推输出源类型，取值： URL ：URL类型 不填默认为URL类型。", "example": "URL" }, { "name": "PushUrl", "type": "string", "required": false, "description": "云转推推流地址。", "example": "rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600c" } ] }, { "name": "CurrentStopTime", "type": "string", "required": false, "description": "云转推当前预计结束时间，采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。具体操作方式详见 [操作类型](#Operation) 及下文示例。", "example": "2021-03-23T07:51:18.029Z" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以操作所有云转推项目。如果指定操作者，则操作者必须为项目所有者。", "example": "60097a8a8ea83d00017b484b" } ], "required": [ "Platform", "ProjectId", "Operation" ] }, { "name": "ImportMaterial", "description": "将云点播媒资文件导入到多媒体创作引擎媒体资源库。支持导入媒体归属团队或者个人。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "Owner", "type": "object", "required": true, "description": "媒体归属者，可支持归属团队或个人。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Name", "type": "string", "required": true, "description": "媒体名称，不能超过30个字符。", "example": "material_name" }, { "name": "SourceType", "type": "string", "required": false, "description": "导入媒资类型，取值： VOD：云点播文件； EXTERNAL：媒资绑定。 注意：如果不填默认为云点播文件，如果媒体存储在非腾讯云点播中，都需要使用媒资绑定。另外，导入云点播的文件，使用云点播的子应用 Id 必须与创建多媒体创作引擎平台时使用的云点播子应用一致。", "example": "VOD" }, { "name": "VodFileId", "type": "string", "required": false, "description": "云点播媒资 FileId，仅当 SourceType 为 VOD 时有效。", "example": "5285890796182734267" }, { "name": "ExternalMediaInfo", "type": "object", "required": false, "description": "原始媒资文件信息，当 SourceType 取值 EXTERNAL 的时候必填。", "example": "无", "children": [ { "name": "MediaKey", "type": "string", "required": true, "description": "目前仅支持绑定 COS 桶的媒体，请填写存储对象 Key 值，例如：`example-folder/example.mp4`。", "example": "www.qq.com/a.mp4" }, { "name": "StorageId", "type": "string", "required": false, "description": "媒资挂载的存储 Id。", "example": "60097a8a8ea83d00017b484b" } ] }, { "name": "ClassPath", "type": "string", "required": false, "description": "媒体分类路径，形如：\"/a/b\"，层级数不能超过10，每个层级长度不能超过15字符。若不填则默认为根路径。", "example": "/media" }, { "name": "PreProcessDefinition", "type": "integer", "required": false, "description": "媒体预处理任务参数 ID。可取值有： 10：进行编辑预处理。", "example": "10" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以向任意团队或者个人导入媒体。如果指定操作者，如果媒体归属为个人，则操作者必须与归属者一致；如果媒体归属为团队，则必须为团队可导入媒体的团队成员(如果没有特殊设置，所有团队成员可导入媒体)。", "example": "60097a8a8ea83d00017b484b" } ], "required": [ "Platform", "Owner", "Name" ] }, { "name": "ImportMediaToProject", "description": "将云点播中的媒资或者用户自有媒资文件添加到项目中与项目关联，供后续视频编辑使用。目前仅视频编辑项目和智能视频拆条项目有效。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目 Id。", "example": "600aae0bb1cc1c000129214b" }, { "name": "SourceType", "type": "string", "required": false, "description": "导入媒资类型，取值： VOD：云点播文件； EXTERNAL：媒资绑定。 注意：如果不填默认为云点播文件，如果媒体存储在非腾讯云点播中，都需要使用媒资绑定。", "example": "VOD" }, { "name": "VodFileId", "type": "string", "required": false, "description": "云点播媒资文件 Id，当 SourceType 取值 VOD 或者缺省的时候必填。", "example": "5285890813075978720" }, { "name": "ExternalMediaInfo", "type": "object", "required": false, "description": "原始媒资文件信息，当 SourceType 取值 EXTERNAL 的时候必填。", "example": "无", "children": [ { "name": "MediaKey", "type": "string", "required": true, "description": "目前仅支持绑定 COS 桶的媒体，请填写存储对象 Key 值，例如：`example-folder/example.mp4`。", "example": "www.qq.com/a.mp4" }, { "name": "StorageId", "type": "string", "required": false, "description": "媒资挂载的存储 Id。", "example": "60097a8a8ea83d00017b484b" } ] }, { "name": "Name", "type": "string", "required": false, "description": "媒体名称，不能超过30个字符。如果不填，则媒体名称为点播媒资文件名称。", "example": "素材一" }, { "name": "PreProcessDefinition", "type": "integer", "required": false, "description": "媒体预处理配置 ID，取值： 10：进行视频编辑预处理。 注意：如果填0或者不填则不进行处理，如果原始视频不可在浏览器直接播放将无法在编辑页面编辑。", "example": "10" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以向所有视频编辑项目导入媒体；如果指定操作者，则操作者必须为项目所有者。", "example": "abf00b8b-9482-4c34-b72c-bea5da0a27ce" } ], "required": [ "Platform", "ProjectId" ] }, { "name": "ListMedia", "description": "浏览当前分类路径下的资源，包括媒体文件和子分类，返回媒资基础信息和分类信息。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "ClassPath", "type": "string", "required": true, "description": "媒体分类路径，例如填写\"/a/b\"，则代表浏览该分类路径下的媒体和子分类信息。", "example": "/a/b" }, { "name": "Owner", "type": "object", "required": true, "description": "媒体和分类的归属者。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：50。", "example": "10" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以浏览任意分类的信息。如果指定操作者，则操作者必须对分类有读权限。", "example": "user_id" } ], "required": [ "Platform", "ClassPath", "Owner" ] }, { "name": "ModifyMaterial", "description": "修改媒体信息，支持修改媒体名称、分类路径、标签等信息。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "MaterialId", "type": "string", "required": true, "description": "要修改的媒体 Id。", "example": "67e0e02c1ac4270001501fff" }, { "name": "Owner", "type": "object", "required": false, "description": "媒体归属者。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Name", "type": "string", "required": false, "description": "媒体名称，不能超过30个字符，不填则不修改。", "example": "name_modify" }, { "name": "ClassPath", "type": "string", "required": false, "description": "媒体分类路径，例如填写\"/a/b\"，则代表该媒体存储的路径为\"/a/b\"。若修改分类路径，则 Owner 字段必填。", "example": "/a/b" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以修改任意媒体的信息。如果指定操作者，则操作者必须对媒体有写权限。", "example": "user_id" } ], "required": [ "Platform", "MaterialId" ] }, { "name": "ModifyProject", "description": "修改项目信息。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "ProjectId", "type": "string", "required": true, "description": "项目 Id。", "example": "67e105de4fb8950001052fff" }, { "name": "Name", "type": "string", "required": false, "description": "项目名称，不可超过30个字符。", "example": "first_project" }, { "name": "AspectRatio", "type": "string", "required": false, "description": "画布宽高比，值为视频编辑项目画布宽与高的像素值的比值，如 16:9、9:16 等。", "example": "16:9" }, { "name": "Owner", "type": "object", "required": false, "description": "项目所有者。目前仅支持个人项目，不支持团队项目。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Mode", "type": "string", "required": false, "description": "项目模式，一个项目可以有多种模式并相互切换。 当 Category 为 VIDEO_EDIT 时，可选模式有： Default：默认模式，即普通视频编辑项目。 VideoEditTemplate：剪辑模板制作模式，用于制作剪辑模板。", "example": "Default" } ], "required": [ "Platform", "ProjectId" ] }, { "name": "ModifyTeam", "description": "修改团队信息，目前支持修改的操作有： 修改团队名称。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "TeamId", "type": "string", "required": true, "description": "团队 ID。", "example": "997988688" }, { "name": "Name", "type": "string", "required": false, "description": "团队名称。团队名称不能置空，并且不能超过30个字符。", "example": "测试团队名称" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以修改所有团队的信息。如果指定操作者，则操作者必须为团队管理员或者所有者。", "example": "60097a8a8ea83d00017b484b" } ], "required": [ "Platform", "TeamId" ] }, { "name": "ModifyTeamMember", "description": "修改团队成员信息，包括成员备注、角色等。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "TeamId", "type": "string", "required": true, "description": "团队 ID。", "example": "1kdk882ddd88338ddd3k3" }, { "name": "MemberId", "type": "string", "required": true, "description": "团队成员 ID。", "example": "1kd3ej3okjdije3lejjdjk99" }, { "name": "Remark", "type": "string", "required": false, "description": "成员备注，长度不能超过15个字符。", "example": "主编辑李四" }, { "name": "Role", "type": "string", "required": false, "description": "成员角色，可取值有： Admin：团队管理员； Member：普通成员。", "example": "Admin" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以修改任意团队成员的信息。如果指定操作者，则操作者必须为团队的管理员或者所有者。", "example": "60097a8a8ea83d00017b484b" } ], "required": [ "Platform", "TeamId", "MemberId" ] }, { "name": "ModifyVideoEncodingPreset", "description": "修改视频编码配置信息。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "Id", "type": "integer", "required": true, "description": "配置 ID。", "example": "100048" }, { "name": "Name", "type": "string", "required": false, "description": "更改后的视频编码配置名，不填则不修改。", "example": "demo" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，可选值： 0：保留； 1：去除。 默认值：0。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，可选值： 0：保留； 1：去除。 默认值：0。", "example": "0" }, { "name": "VideoSetting", "type": "object", "required": false, "description": "更改后的编码配置的视频设置。", "example": "无", "children": [ { "name": "ShortEdge", "type": "integer", "required": false, "description": "视频短边尺寸，取值范围： [128, 4096]，单位：px。 视频最后的分辨率，根据短边尺寸和宽高比进行计算。 例：如果项目的宽高比是 16：9 ： 短边尺寸为 1080，则导出视频的分辨率为 1920 * 1080。 短边尺寸为 720，则导出视频的分辨率为 1280 * 720。 如果项目的宽高比是 9：16 ： 短边尺寸为 1080，则导出视频的分辨率为 1080 * 1920。 短边尺寸为 720，则导出视频的分辨率为 720 * 1280。 不\ufffd\ufffd...", "example": "1080" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "指定码率，单位 bps。当该参数为'0' 时则不强制限定码率。 不填则不修改。", "example": "0" }, { "name": "FrameRate", "type": "float", "required": false, "description": "指定帧率。单位 Hz。 不填则不修改。", "example": "25" } ] }, { "name": "AudioSetting", "type": "object", "required": false, "description": "更改后的编码配置的音频设置。", "example": "无", "children": [ { "name": "Bitrate", "type": "string", "required": false, "description": "音频码率，单位：bps。 不填则不修改。", "example": "0" }, { "name": "Channels", "type": "integer", "required": false, "description": "音频声道数，可选值： 1：单声道； 2：双声道。 不填则不修改。", "example": "2" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "音频流的采样率，目前仅支持： 16000； 32000； 44100； 48000。单位：Hz。 不填则不修改。", "example": "16000" } ] } ], "required": [ "Platform", "Id" ] }, { "name": "MoveClass", "description": "移动某一个分类到另外一个分类下，也可用于分类重命名。 如果 SourceClassPath = /素材/视频/NBA，DestinationClassPath = /素材/视频/篮球 当 DestinationClassPath 不存在时候，操作结果为重命名 ClassPath； 当 DestinationClassPath 存在时候，操作结果为产生新目录 /素材/视频/篮球/NBA", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "Owner", "type": "object", "required": true, "description": "归属者。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "SourceClassPath", "type": "string", "required": true, "description": "源分类路径。", "example": "/媒资" }, { "name": "DestinationClassPath", "type": "string", "required": true, "description": "目标分类路径。", "example": "/媒资/综艺" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。填写用户的 Id，用于标识调用者及校验操作权限。", "example": "9b92a8e7-a5ef-4e28-d72e-4eff571fabf0" } ], "required": [ "Platform", "Owner", "SourceClassPath", "DestinationClassPath" ] }, { "name": "MoveResource", "description": "移动资源，支持跨个人或团队移动媒体以及分类。如果填写了Operator，则需要校验用户对媒体和分类资源的访问以及写权限。 当原始资源为媒体时，该接口效果为将该媒体移动到目标分类下面； 当原始资源为分类时，该接口效果为将原始分类移动到目标分类或者是重命名。 如果 SourceResource.Resource.Id = /素材/视频/NBA，DestinationResource.Resource.Id= /素材/视频/篮球 当 DestinationResource.Re...", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "SourceResource", "type": "object", "required": true, "description": "待移动的原始资源信息，包含原始媒体或分类资源，以及资源归属。", "example": "无", "children": [ { "name": "Resource", "type": "object", "required": true, "description": "媒资和分类资源。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： MATERIAL：素材。 CLASS：分类。", "example": "MATERIAL" }, { "name": "Id", "type": "string", "required": true, "description": "资源 Id，当 Type 为 MATERIAL 时，取值为素材 Id；当 Type 为 CLASS 时，取值为分类路径 ClassPath。", "example": "67e105de4fb8950001052fff" } ] }, { "name": "Owner", "type": "object", "required": true, "description": "资源归属，个人或团队。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] } ] }, { "name": "DestinationResource", "type": "object", "required": true, "description": "目标信息，包含分类及归属，仅支持移动资源到分类。", "example": "无", "children": [ { "name": "Resource", "type": "object", "required": true, "description": "媒资和分类资源。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： MATERIAL：素材。 CLASS：分类。", "example": "MATERIAL" }, { "name": "Id", "type": "string", "required": true, "description": "资源 Id，当 Type 为 MATERIAL 时，取值为素材 Id；当 Type 为 CLASS 时，取值为分类路径 ClassPath。", "example": "67e105de4fb8950001052fff" } ] }, { "name": "Owner", "type": "object", "required": true, "description": "资源归属，个人或团队。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] } ] }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以移动任务资源。如果指定操作者，则操作者必须对源及目标资源有写权限。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ], "required": [ "Platform", "SourceResource", "DestinationResource" ] }, { "name": "ParseEvent", "description": "该接口接受多媒体创作引擎回调给业务的事件内容，将其转化为对应的 EventContent 结构。请不要实际调用该接口，只需要将接收到的事件内容直接使用 JSON 解析到 EventContent 结构即可使用。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台名称，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "EventContent", "type": "string", "required": true, "description": "回调事件内容。", "example": "{\"EventType\":\"Class.Created\",\"Operator\":\"3fa6b09e-05c6-433e-bc1e-6457d290d9d9\",\"MaterialImportedEvent\":{\"Owner\":{\"Id\":\"user_9949009d9d9\",\"Type\":\"PERSON\"},\"ClassPath\":\"/媒体\"}}" } ], "required": [ "Platform", "EventContent" ] }, { "name": "RevokeResourceAuthorization", "description": "资源所属实体对目标实体撤销目标资源的相应权限，若原本没有相应权限则不产生变更。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "Owner", "type": "object", "required": true, "description": "资源所属实体。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Resources", "type": "array", "required": true, "description": "被授权资源。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： MATERIAL：素材。 CLASS：分类。", "example": "MATERIAL" }, { "name": "Id", "type": "string", "required": true, "description": "资源 Id，当 Type 为 MATERIAL 时，取值为素材 Id；当 Type 为 CLASS 时，取值为分类路径 ClassPath。", "example": "67e105de4fb8950001052fff" } ] }, { "name": "Authorizees", "type": "array", "required": true, "description": "被授权目标实体。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "Permissions", "type": "array", "required": true, "description": "详细授权值。 取值有： R：可读，可以浏览素材，但不能使用该素材（将其添加到 Project），或复制到自己的媒资库中 X：可用，可以使用该素材（将其添加到 Project），但不能将其复制到自己的媒资库中，意味着被授权者无法将该资源进一步扩散给其他个人或团队。 C：可复制，既可以使用该素材（将其添加到 Project），也可以将其复制到自己的媒资库中。 W：可修改、删除媒\ufffd\ufffd...", "example": "[\"R\\r\\n\"]", "item_type": "string" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，撤销任意资源的授权权限。如果指定操作者，则操作者必须对被授权资源有写权限。", "example": "cmeid_system" } ], "required": [ "Platform", "Owner", "Resources", "Authorizees", "Permissions" ] }, { "name": "SearchMaterial", "description": "根据检索条件搜索媒体，返回媒体的基本信息。", "status": "online", "parameters": [ { "name": "Platform", "type": "string", "required": true, "description": "平台 Id，指定访问的平台。关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。", "example": "1000000009" }, { "name": "SearchScopes", "type": "array", "required": true, "description": "指定搜索空间，数组长度不得超过5。", "example": "无", "item_type": "object", "children": [ { "name": "Owner", "type": "object", "required": true, "description": "分类路径归属。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型，取值有： PERSON：个人。 TEAM：团队。", "example": "PERSON" }, { "name": "Id", "type": "string", "required": true, "description": "Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。", "example": "c9bf9e57-1685-4c89-bafb-ff5af830be8a" } ] }, { "name": "ClassPath", "type": "string", "required": false, "description": "按分类路径检索。 不填则默认按根分类路径检索。", "example": "/media" } ] }, { "name": "MaterialTypes", "type": "array", "required": false, "description": "媒体类型，可取值有： AUDIO：音频； VIDEO：视频 ； IMAGE：图片； VIDEO_EDIT_TEMPLATE：剪辑模板。", "example": "[\"VIDEO\"]", "item_type": "string" }, { "name": "Text", "type": "string", "required": false, "description": "搜索文本，模糊匹配媒体名称或描述信息，匹配项越多，匹配度越高，排序越优先。长度限制：15个字符。", "example": "综艺" }, { "name": "Resolution", "type": "string", "required": false, "description": "按画质检索，取值为：LD/SD/HD/FHD/2K/4K。", "example": "HD" }, { "name": "DurationRange", "type": "object", "required": false, "description": "按媒体时长检索，单位s。", "example": "无", "children": [ { "name": "LowerBound", "type": "integer", "required": true, "description": "按整形代表值的下限检索。", "example": "0" }, { "name": "UpperBound", "type": "integer", "required": true, "description": "按整形代表值的上限检索。", "example": "100" } ] }, { "name": "CreateTimeRange", "type": "object", "required": false, "description": "按照媒体创建时间检索。", "example": "无", "children": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。", "example": "2018-10-01T18:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。", "example": "2018-11-01T18:00:00+08:00" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "按标签检索，填入检索的标签名。", "example": "[\"zoo\"]", "item_type": "string" }, { "name": "Sort", "type": "object", "required": false, "description": "排序方式。Sort.Field 可选值：CreateTime。指定 Text 搜索时，将根据匹配度排序，该字段无效。", "example": "无", "children": [ { "name": "Field", "type": "string", "required": true, "description": "排序字段。", "example": "CreateTime" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，可选值：Asc（升序）、Desc（降序），默认降序。", "example": "Asc" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：50。", "example": "10" }, { "name": "Operator", "type": "string", "required": false, "description": "操作者。如不填，默认为 `cmeid_system`，表示平台管理员操作，可以搜索任意媒体的信息。如果指定操作者，则操作者必须对媒体有读权限。", "example": "user_id" } ], "required": [ "Platform", "SearchScopes" ] } ] }