智能创作
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>智能创作>服务端 API>数据结构

数据结构

最近更新时间：2024-09-25 01:13:36

我的收藏

本页目录：

AccountInfo

制作云用户账号信息。

被如下接口引用：DescribeAccounts。

名称 类型 描述
UserId String 用户 Id。
示例值：1000000001
Phone String 用户手机号码。
示例值：15515555055
Nick String 用户昵称。
示例值：Nick
Status String 账号状态，取值：
  • Normal：有效；
  • Stopped：无效。

    • 示例值：Normal

    AddMemberInfo

    添加的团队成员信息

    被如下接口引用：AddTeamMember。

    名称 类型 必选 描述
    MemberId String 是 团队成员 ID。
    Remark String 否 团队成员备注。
    Role String 否 团队成员角色，不填则默认添加普通成员。可选值：
  • Admin：团队管理员；
  • Member：普通成员。
    		•

    AudioMaterial

    音频素材信息

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    MetaData MediaMetaData 素材元信息。
    MaterialUrl String 素材媒体文件的播放 URL 地址。
    CoverUrl String 素材媒体文件的封面图片地址。
    MaterialStatus MaterialStatus 素材状态。
    注意：此字段可能返回 null，表示取不到有效值。
    OriginalUrl String 素材媒体文件的原始 URL 地址。
    VodFileId String 云点播媒资 FileId。

    AudioStreamInfo

    音频流信息。

    被如下接口引用：DescribeTaskDetail。

    名称 类型 描述
    Bitrate Integer 码率，单位：bps。
    SamplingRate Integer 采样率，单位：hz。
    Codec String 编码格式。

    AudioTrackItem

    音频轨道上的音频片段信息。

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    SourceType String 是 音频媒体来源类型，取值有：

    • VOD ：素材来源于云点播文件 ；
    • CME ：视频来源于制作云媒体文件 ；
    • EXTERNAL ：视频来源于媒资绑定，如果媒体不是存储在腾讯云点播中或者云创中，都需要使用媒资绑定。


    示例值：EXTERNAL
    SourceMedia String 是 音频媒体，可取值为：

    • 当 SourceType 为 VOD 时，参数填云点播 FileId ；
    • 当 SourceType 为 CME 时，参数填多媒体创作引擎媒体 Id；
    • 当 SourceType 为 EXTERNAL 时，目前仅支持外部媒体 URL(如https://www.example.com/a.mp3)，参数填写规则请参见注意事项。



    注意：
  • 当 SourceType 为 EXTERNAL 并且媒体 URL Scheme 为 https 时(如：https://www.example.com/a.mp3)，参数为：1000000:www.example.com/a.mp3。
  • 当 SourceType 为 EXTERNAL 并且媒体 URL Scheme 为 http 时(如：http://www.example.com/b.mp3)，参数为：1000001:www.example.com/b.mp3。

    • 示例值：1000000:www.qq.com/a.mp4
    SourceMediaStartTime Float 否 音频片段取自媒体文件的起始时间，单位为秒。0 表示从媒体开始位置截取。默认为0。
    示例值：0
    Duration Float 否 音频片段的时长，单位为秒。默认和媒体本身长度一致，表示截取全部媒体。
    示例值：20

    AuthorizationInfo

    资源权限信息

    被如下接口引用：DescribeResourceAuthorization。

    名称 类型 描述
    Authorizee Entity 被授权者实体。
    PermissionSet Array of String 详细授权值。 取值有：
  • R：可读，可以浏览素材，但不能使用该素材（将其添加到 Project），或复制到自己的媒资库中。
  • X：可用，可以使用该素材（将其添加到 Project），但不能将其复制到自己的媒资库中，意味着被授权者无法将该资源进一步扩散给其他个人或团队。
  • C：可复制，既可以使用该素材（将其添加到 Project），也可以将其复制到自己的媒资库中。
  • W：可修改、删除媒资。
    		•

    Authorizer

    授权者

    被如下接口引用：DescribeSharedSpace。

    名称 类型 必选 描述
    Type String 是 授权者类型，取值有：
  • PERSON：个人。
  • TEAM：团队。
    		•
    Id String 是 Id，当 Type=PERSON，取值为用户 Id。当Type=TEAM，取值为团队 ID。

    CMEExportInfo

    多媒体创作引擎导出信息。

    被如下接口引用：ExportVideoByEditorTrackData, ExportVideoByTemplate, ExportVideoByVideoSegmentationData, ExportVideoEditProject。

    名称 类型 必选 描述
    Owner Entity 是 导出媒体归属，个人或团队。
    Name String 否 导出的媒体名称，不得超过30个字符。
    示例值：素材
    Description String 否 导出的媒体信息，不得超过50个字符。
    示例值：素材
    ClassPath String 否 导出的媒体分类路径，长度不能超过15字符。不存在默认创建。
    示例值：/素材
    TagSet Array of String 否 导出的媒体标签，单个标签不得超过10个字符。
    示例值：["素材"]
    ThirdPartyPublishInfos Array of ThirdPartyPublishInfo 否 第三方平台发布信息列表。暂未正式对外，请勿使用。

    ClassCreatedEvent

    分类创建事件。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    Owner Entity 分类归属。
    ClassPath String 分类路径。
    示例值：/媒体

    ClassDeletedEvent

    分类删除事件。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    Owner Entity 删除的分类归属。
    ClassPathSet Array of String 删除的分类路径列表。

    ClassInfo

    分类信息

    被如下接口引用：DescribeClass, DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    Owner Entity 归属者。
    ClassPath String 分类路径。

    ClassMovedEvent

    分类移动事件。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    SourceOwner Entity 源分类归属。
    SourceClassPathSet Array of String 源分类路径列表。
    DestinationOwner Entity 目标分类归属。
    DestinationClassPath String 目标分类归属。
    示例值：/媒体

    CosPublishInputInfo

    COS 发布信息。

    被如下接口引用：ExportVideoByEditorTrackData, ExportVideoByTemplate, ExportVideoByVideoSegmentationData, ExportVideoEditProject。

    名称 类型 必选 描述
    Bucket String 是 发布生成的对象存储文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。
    示例值：Video-125xxx88
    Region String 是 发布生成的对象存储文件所在的 COS Bucket 所属园区，如 ap-chongqing。
    示例值：ap-chongqing
    VideoKey String 是 发布生成的视频在 COS 存储的对象键。对象键（ObjectKey）是对象（Object）在存储桶（Bucket）中的唯一标识。
    示例值：fadd70539811.mp4
    CoverKey String 是 发布生成的封面在 COS 存储的对象键。
    示例值：fadd70539812.png

    EmptyTrackItem

    空的轨道片段，用来进行时间轴的占位。如需要两个音频片段之间有一段时间的静音，可以用 EmptyTrackItem 来进行占位。

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    Duration Float 是 持续时间，单位为秒。

    Entity

    用于描述资源的归属，归属者为个人或者团队。

    被如下接口引用：CopyProject, CreateClass, CreateLink, CreateProject, DeleteClass, DescribeClass, DescribeMaterials, DescribeProjects, DescribeResourceAuthorization, DescribeSharedSpace, ExportVideoByEditorTrackData, ExportVideoByTemplate, ExportVideoByVideoSegmentationData, ExportVideoEditProject, FlattenListMedia, GrantResourceAuthorization, ImportMaterial, ListMedia, ModifyMaterial, ModifyProject, MoveClass, MoveResource, ParseEvent, RevokeResourceAuthorization, SearchMaterial。

    名称 类型 必选 描述
    Type String 是 类型，取值有：
  • PERSON：个人。
  • TEAM：团队。
    		•
    Id String 是 Id，当 Type=PERSON，取值为用户 Id，当 Type=TEAM，取值为团队 Id。

    EventContent

    回调事件内容。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    EventType String 事件类型，可取值有：
  • Storage.NewFileCreated：新文件产生事件；
  • Project.StreamConnect.StatusChanged：云转推项目状态变更事件；
  • Project.Switcher.StatusChanged：导播台项目状态变更事件；
  • Material.Imported：媒体导入事件；
  • Material.Added：媒体添加事件；
  • Material.Moved：媒体移动事件；
  • Material.Modified：媒体变更事件；
  • Material.Deleted：媒体删除事件；
  • Class.Created：分类新增事件；
  • Class.Moved：分类移动事件；
  • Class.Deleted：分类删除事件；
  • Task.VideoExportCompleted：视频导出完成事件；
  • Project.MediaCast.StatusChanged：点播转直播项目状态变更事件。

    • 示例值：Storage.NewFileCreated
    Operator String 操作者，表示触发事件的操作者。如果是 cmeid_system 表示平台管理员操作。
    StorageNewFileCreatedEvent StorageNewFileCreatedEvent 新文件产生事件。仅当 EventType 为 Storage.NewFileCreated 时有效。
    ProjectStreamConnectStatusChangedEvent ProjectStreamConnectStatusChangedEvent 云转推项目状态变更事件。仅当 EventType 为 Project.StreamConnect.StatusChanged 时有效。
    ProjectSwitcherStatusChangedEvent ProjectSwitcherStatusChangedEvent 导播台项目状态变更事件。仅当 EventType 为 Project.Switcher.StatusChanged 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    MaterialImportedEvent MaterialImportedEvent 媒体导入事件。仅当 EventType 为 Material.Imported 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    MaterialAddedEvent MaterialAddedEvent 媒体添加事件。仅当 EventType 为 Material.Added 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    MaterialMovedEvent MaterialMovedEvent 媒体移动事件。仅当 EventType 为 Material.Moved 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    MaterialModifiedEvent MaterialModifiedEvent 媒体更新事件。仅当 EventType 为 Material.Modified 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    MaterialDeletedEvent MaterialDeletedEvent 媒体删除事件。仅当 EventType 为 Material.Deleted 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    ClassCreatedEvent ClassCreatedEvent 分类创建事件。仅当 EventType 为 Class.Created 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    ClassMovedEvent ClassMovedEvent 分类移动事件。仅当 EventType 为 Class.Moved 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    ClassDeletedEvent ClassDeletedEvent 分类删除事件。仅当 EventType 为 Class.Deleted 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    VideoExportCompletedEvent VideoExportCompletedEvent 视频导出完成事件。仅当 EventType 为 Task.VideoExportCompleted 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    ProjectMediaCastStatusChangedEvent ProjectMediaCastStatusChangedEvent 点播转直播项目状态变更事件。仅当 EventType 为 Project.MediaCast.StatusChanged 时有效。
    注意：此字段可能返回 null，表示取不到有效值。

    ExternalMediaInfo

    媒资绑定资源信息，包含媒资绑定模板 ID 和文件信息。

    被如下接口引用：ImportMaterial, ImportMediaToProject。

    名称 类型 必选 描述
    MediaKey String 是 目前仅支持绑定 COS 桶的媒体，请填写存储对象 Key 值，例如：example-folder/example.mp4。
    示例值：www.qq.com/a.mp4
    Definition Integer 否 该字段废弃，请勿使用。
    示例值：1000000
    StorageId String 否 媒资挂载的存储 Id。
    示例值：60097a8a8ea83d00017b484b

    ImageMaterial

    图片素材信息

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    Height Integer 图片高度，单位：px。
    Width Integer 图片宽度，单位：px。
    MaterialUrl String 素材媒体文件的展示 URL 地址。
    Size Integer 图片大小，单位：字节。
    OriginalUrl String 素材媒体文件的原始 URL 地址。
    VodFileId String 云点播媒资 FileId。

    ImportMediaInfo

    导入媒资信息

    被如下接口引用：ParseEvent。

    名称 类型 描述
    FileId String 云点播文件 FileId。
    示例值：362565566555118451552
    MaterialId String 媒体 Id。
    示例值：60097a8a8ea83d00017b484b

    IntegerRange

    整型范围

    被如下接口引用：SearchMaterial。

    名称 类型 必选 描述
    LowerBound Integer 是 按整形代表值的下限检索。
    UpperBound Integer 是 按整形代表值的上限检索。

    JoinTeamInfo

    加入的团队信息

    被如下接口引用：DescribeJoinTeams。

    名称 类型 描述
    TeamId String 团队 ID。
    示例值：teamid
    Name String 团队名称。
    示例值：test
    MemberCount Integer 团队成员个数。
    示例值：10
    Role String 成员在团队中的角色，取值有：
  • Owner：团队所有者，添加团队成员及修改团队成员解决时不能填此角色；
  • Admin：团队管理员；
  • Member：普通成员。

    • 示例值：Member

    KuaishouPublishInfo

    快手视频发布信息。

    被如下接口引用：ExportVideoByEditorTrackData, ExportVideoByTemplate, ExportVideoByVideoSegmentationData, ExportVideoEditProject。

    名称 类型 必选 描述
    Title String 否 视频发布标题，限30个字符。

    LinkMaterial

    链接类型的素材信息

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    LinkType String 链接类型取值:
  • CLASS: 分类链接;
  • MATERIAL：素材链接。
    		•
    LinkStatus String 链接状态取值：
  • Normal：正常 ；
  • NotFound：链接目标不存在；
  • Forbidden：无权限。
    		•
    LinkMaterialInfo LinkMaterialInfo 素材链接详细信息，当LinkType="MATERIAL"时有值。
    注意：此字段可能返回 null，表示取不到有效值。
    LinkClassInfo ClassInfo 分类链接目标信息，当LinkType=“CLASS”时有值。
    注意：此字段可能返回 null，表示取不到有效值。

    LinkMaterialInfo

    链接素材信息

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    BasicInfo MaterialBasicInfo 素材基本信息。
    VideoMaterial VideoMaterial 视频素材信息。
    注意：此字段可能返回 null，表示取不到有效值。
    AudioMaterial AudioMaterial 音频素材信息。
    注意：此字段可能返回 null，表示取不到有效值。
    ImageMaterial ImageMaterial 图片素材信息。
    注意：此字段可能返回 null，表示取不到有效值。

    LivePullInputInfo

    直播拉流信息

    被如下接口引用：CreateProject, HandleStreamConnectProject。

    名称 类型 必选 描述
    InputUrl String 是 直播拉流地址。
    示例值：rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600c

    LiveStreamClipProjectInput

    直播剪辑项目输入参数。

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    Url String 是 直播流播放地址，目前仅支持 HLS 和 FLV 格式。
    StreamRecordDuration Integer 是 直播流录制时长，单位为秒，最大值为 7200。

    LoginStatusInfo

    登录态信息

    被如下接口引用：DescribeLoginStatus。

    名称 类型 描述
    UserId String 用户 Id。
    Status String 用户登录状态。
  • Online：在线；
  • Offline：离线。
    		•

    MaterialAddedEvent

    媒体添加事件。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    MaterialIdSet Array of String 添加的媒体 Id 列表。
    Owner Entity 添加的媒体归属。
    ClassPath String 添加的媒体分类路径。
    示例值：/媒体

    MaterialBasicInfo

    媒体基本信息。

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    MaterialId String 媒体 Id。
    MaterialType String 媒体类型，取值为：
  • AUDIO :音频;
  • VIDEO :视频;
  • IMAGE :图片;
  • LINK :链接.
  • OTHER : 其他.
    		•
    Owner Entity 媒体归属实体。
    Name String 媒体名称。
    CreateTime String 媒体文件的创建时间，使用 ISO 日期格式。
    UpdateTime String 媒体文件的最近更新时间（如修改视频属性、发起视频处理等会触发更新媒体文件信息的操作），使用 ISO 日期格式。
    ClassPath String 媒体的分类路径。
    PresetTagSet Array of PresetTagInfo 预置标签列表。
    TagSet Array of String 人工标签列表。
    PreviewUrl String 媒体文件的预览图。
    TagInfoSet Array of MaterialTagInfo 媒体绑定的标签信息列表 。
    该字段已废弃。
    注意：此字段可能返回 null，表示取不到有效值。

    MaterialDeletedEvent

    媒体删除事件。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    MaterialIdSet Array of String 删除的媒体 Id 列表。

    MaterialImportedEvent

    媒体导入事件

    被如下接口引用：ParseEvent。

    名称 类型 描述
    MediaInfoSet Array of ImportMediaInfo 导入的媒体信息列表。
    Owner Entity 媒体归属。
    ClassPath String 媒体分类路径。
    示例值：/媒体

    MaterialInfo

    媒体详情信息

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    BasicInfo MaterialBasicInfo 媒体基本信息。
    VideoMaterial VideoMaterial 视频媒体信息。
    注意：此字段可能返回 null，表示取不到有效值。
    AudioMaterial AudioMaterial 音频媒体信息。
    注意：此字段可能返回 null，表示取不到有效值。
    ImageMaterial ImageMaterial 图片媒体信息。
    注意：此字段可能返回 null，表示取不到有效值。
    LinkMaterial LinkMaterial 链接媒体信息。
    注意：此字段可能返回 null，表示取不到有效值。
    VideoEditTemplateMaterial VideoEditTemplateMaterial 模板媒体信息。
    注意：此字段可能返回 null，表示取不到有效值。
    OtherMaterial OtherMaterial 其他类型媒体信息。
    注意：此字段可能返回 null，表示取不到有效值。

    MaterialModifiedEvent

    媒体更新事件。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    MaterialId String 媒体 Id。
    示例值：60097a8a8ea83d00017b484b
    Name String 更新后的媒体名称。如未更新则为空。
    示例值：test
    PresetTagIdSet Array of String 更新后的媒体预置标签列表。如未更新媒体预置标签，则该字段为空数组。
    TagSet Array of String 更新后的媒体自定义标签列表。如未更新媒体自定义标签，则该字段为空数组。

    MaterialMovedEvent

    媒体移动事件

    被如下接口引用：ParseEvent。

    名称 类型 描述
    MaterialIdSet Array of String 要移动的媒体 Id 列表。
    SourceOwner Entity 源媒体归属。
    SourceClassPath String 源媒体分类路径。
    示例值：/媒体
    DestinationOwner Entity 目标媒体分类归属。
    示例值：0
    DestinationClassPath String 目标媒体分类路径。
    示例值：/媒体/视频

    MaterialStatus

    素材的状态，目前仅包含素材编辑可用状态。

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    EditorUsableStatus String 素材编辑可用状态，取值有：
  • NORMAL：正常，可直接用于编辑；
  • ABNORMAL : 异常，不可用于编辑；
  • PROCESSING：处理中，暂不可用于编辑。
    		•

    MaterialTagInfo

    素材标签信息

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 必选 描述
    Type String 是 标签类型，取值为：
  • PRESET：预置标签；
    		•
    Id String 是 标签 Id 。当标签类型为 PRESET 时，标签 Id 为预置标签 Id 。
    Name String 是 标签名称。

    MediaCastDestinationInfo

    点播转直播输出信息。

    被如下接口引用：CreateProject, DescribeProjects, HandleMediaCastProject, ParseEvent。

    名称 类型 必选 描述
    Id String 否 输出源 Id。由系统进行分配。
    PushUrl String 否 输出直播流地址。支持的直播流类型为 RTMP 和 SRT。
    Name String 否 输出源的名称。

    MediaCastDestinationInterruptInfo

    点播转直播输出断流信息。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    DestinationInfo MediaCastDestinationInfo 发生断流的输出源信息。
    Reason String 输出源断流原因，取值有：
  • SystemError：系统错误；
  • Unknown：未知错误。

    • 示例值：SystemError

    MediaCastDestinationStatus

    点播转直播输出源状态信息。

    被如下接口引用：HandleMediaCastProject。

    名称 类型 描述
    Id String 输出源 Id，由系统分配。
    PushUrl String 输出源直播地址。
    Status String 输出源的状态。取值有：
  • Working ：运行中；
  • Stopped：停止输出；
  • Failed：输出失败。

    • 示例值：Working

    MediaCastOutputMediaSetting

    点播转直播输出媒体配置。

    被如下接口引用：CreateProject, DescribeProjects, HandleMediaCastProject。

    名称 类型 必选 描述
    VideoSetting MediaCastVideoSetting 是 视频配置。
    FollowSourceInfo Boolean 否 视频配置是否和第一个输入源的视频配置相同，默认值：false。如果 FollowSourceInfo 的值为 true，忽略 VideoSetting 参数。

    MediaCastPlayInfo

    点播转直播播放信息。

    被如下接口引用：HandleMediaCastProject。

    名称 类型 描述
    Status String 点播转直播项目运行状态，取值有：
  • Working : 运行中；
  • Idle: 空闲状态。

    • 示例值：Working
    CurrentSourceId String 当前播放的输入源 Id。
    CurrentSourcePosition Float 当前播放的输入源的播放位置，单位：秒。
    示例值：100
    CurrentSourceDuration Float 当前播放的输入源时长，单位：秒。
    示例值：100
    DestinationStatusSet Array of MediaCastDestinationStatus 输出源状态信息。
    LoopCount Integer 已经循环播放的次数。
    示例值：1

    MediaCastPlaySetting

    播放控制参数。

    被如下接口引用：CreateProject, DescribeProjects, HandleMediaCastProject。

    名称 类型 必选 描述
    LoopCount Integer 否 循环播放次数。LoopCount 和 EndTime 同时只能有一个生效。默认循环播放次数为一次。如果同时设置了 LoopCount 和 EndTime 参数，优先使用 LoopCount 参数。
    示例值：1
    EndTime String 否 结束时间，采用 ISO 日期格式。
    示例值：2022-12-10T15:00:00Z
    AutoStartTime String 否 自动启动时间，采用 ISO 日期格式。
    示例值：2022-12-10T15:00:00Z

    MediaCastProjectInfo

    点播转直播项目信息。

    被如下接口引用：DescribeProjects。

    名称 类型 描述
    Status String 点播转直播项目状态，取值有：
  • Working ：运行中；
  • Idle ：空闲。

    • 示例值：Working
    SourceInfos Array of MediaCastSourceInfo 输入源列表。
    DestinationInfos Array of MediaCastDestinationInfo 输出源列表。
    OutputMediaSetting MediaCastOutputMediaSetting 输出媒体配置。
    PlaySetting MediaCastPlaySetting 播放参数。
    StartTime String 项目启动时间。采用 ISO 日期格式。
    示例值：2021-03-23T07:51:18.029Z
    StopTime String 项目结束时间。采用 ISO 日期格式。如果项目还在运行中，该字段为空。
    示例值：2021-03-23T07:51:18.029Z
    Duration Float 推流时长，单位：秒。项目结束后，返回上次项目运行时的推流时长。如果项目是 Working 状态，返回的时长是0。

    MediaCastProjectInput

    点播转直播项目输入信息。

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    SourceInfos Array of MediaCastSourceInfo 否 输入源列表。输入源列表最大个数为100.
    DestinationInfos Array of MediaCastDestinationInfo 否 输出源列表。输出源列表最大个数为10.
    OutputMediaSetting MediaCastOutputMediaSetting 否 输出媒体配置。
    PlaySetting MediaCastPlaySetting 否 播放控制参数。

    MediaCastSourceInfo

    点播转直播输入源信息。

    被如下接口引用：CreateProject, DescribeProjects, HandleMediaCastProject, ParseEvent。

    名称 类型 必选 描述
    Id String 否 输入源 Id，由系统分配。
    注意：此字段可能返回 null，表示取不到有效值。
    Type String 否 输入源的媒体类型，取值有：
  • CME：多媒体创作引擎的媒体文件；
  • VOD：云点播的媒资文件。
  • EXTERNAL：非多媒体创建引擎或者云点播的媒资文件。

    • 示例值：CME
    FileId String 否 云点播媒体文件 ID。当 Type = VOD 时必填。
    MaterialId String 否 多媒体创作引擎的媒体 ID。当 Type = CME 时必填。
    Offset Float 否 文件播放的起始位置，单位：秒。默认为0，从文件头开始播放。当 Type = CME 或者 VOD 时有效。
    Duration Float 否 播放时长，单位：秒。默认播放整个文件。当 Type = CME 或者 VOD 时有效。
    Url String 否 外部文件的 Url， Type=EXTERNAL 时必填，可以是点播文件或者直播文件，支持的 Scheme 包括HTTP、HTTPS、RTMP。

    MediaCastSourceInterruptInfo

    点播转直播输入断流信息。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    SourceInfo MediaCastSourceInfo 发生断流的输入源信息。
    Reason String 输入源断开原因。取值有：
  • SystemError：系统错误；
  • Unknown：未知错误。

    • 示例值：SystemError

    MediaCastVideoSetting

    点播转直播视频配置

    被如下接口引用：CreateProject, HandleMediaCastProject。

    名称 类型 必选 描述
    Width Integer 是 视频宽度，单位：px，默认值为1280。
    示例值：1280
    Height Integer 是 视频高度，单位：px，默认值为720。支持的视频分辨率最大为1920*1080。
    示例值：720
    Bitrate Integer 否 视频码率，单位：kbps，默认值为2500。最大值为10000 kbps。
    示例值：2000
    FrameRate Float 否 视频帧率，单位：Hz，默认值为25。最大值为60。
    示例值：25

    MediaImageSpriteInfo

    雪碧图

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    Height Integer 雪碧图小图的高度。
    Width Integer 雪碧图小图的宽度。
    TotalCount Integer 雪碧图小图的总数量。
    ImageUrlSet Array of String 截取雪碧图输出的地址。
    WebVttUrl String 雪碧图子图位置与时间关系的 WebVtt 文件地址。WebVtt 文件表明了各个雪碧图小图对应的时间点，以及在雪碧大图里的坐标位置，一般被播放器用于实现预览。

    MediaMetaData

    文件元信息。

    被如下接口引用：DescribeMaterials, DescribeTaskDetail, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    Size Integer 大小。
    Container String 容器类型。
    Bitrate Integer 视频流码率平均值与音频流码率平均值之和，单位：bps。
    Height Integer 视频流高度的最大值，单位：px。
    Width Integer 视频流宽度的最大值，单位：px。
    Duration Float 时长，单位：秒。
    Rotate Integer 视频拍摄时的选择角度，单位：度
    VideoStreamInfoSet Array of VideoStreamInfo 视频流信息。
    AudioStreamInfoSet Array of AudioStreamInfo 音频流信息。

    MediaPreprocessOperation

    媒体处理视频合成任务的预处理操作。

    被如下接口引用：ExportVideoByTemplate。

    名称 类型 必选 描述
    Type String 是 预处理操作的类型，取值范围：
  • ImageTextMask：图片文字遮罩。

    • 示例值：ImageTextMask
    Args Array of String 否 预处理操作参数。
    当 Type 取值 ImageTextMask 时，参数为要保留的文字。
    示例值：["文字"]

    MediaReplacementInfo

    媒体替换信息。

    被如下接口引用：ExportVideoByTemplate。

    名称 类型 必选 描述
    MediaType String 否 替换的媒体类型，取值有：
  • CMEMaterialId：替换的媒体类型为媒体 ID；
  • ImageUrl：替换的媒体类型为图片 URL；


    • 注：默认为 CMEMaterialId 。
    示例值：ImageUrl
    MaterialId String 否 媒体 ID。
    当媒体类型取值为 CMEMaterialId 时有效。
    示例值：60097a8a8ea83d00017b484b
    MediaUrl String 否 媒体 URL。
    当媒体类型取值为 ImageUrl 时有效，
    图片仅支持 jpg、png 格式，且大小不超过 2M 。
    示例值：http://cme.vod2.myqcloud.com/123/f0.jpg
    StartTimeOffset Float 否 替换媒体选取的开始时间，单位为秒，默认为 0。
    示例值：0
    PreprocessOperation MediaPreprocessOperation 否 预处理操作。
    注：目前该功能暂不支持，请勿使用。

    MediaTrack

    轨道信息

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    Type String 是 轨道类型，取值有：

    • Video ：视频轨道。视频轨道由以下 Item 组成：
      • VideoTrackItem
      • EmptyTrackItem
      • MediaTransitionItem
    • Audio ：音频轨道。音频轨道由以下 Item 组成：
      • AudioTrackItem
      • EmptyTrackItem


    示例值：Video
    TrackItems Array of MediaTrackItem 是 轨道上的媒体片段列表。

    MediaTrackItem

    媒体轨道的片段信息

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    Type String 是 片段类型。取值有：
  • Video：视频片段；
  • Audio：音频片段；
  • Empty：空白片段；
  • Transition：转场。

    • 示例值：Video
    VideoItem VideoTrackItem 否 视频片段，当 Type = Video 时有效。
    AudioItem AudioTrackItem 否 音频片段，当 Type = Audio 时有效。
    EmptyItem EmptyTrackItem 否 空白片段，当 Type = Empty 时有效。空片段用于时间轴的占位。
  • 如需要两个音频片段之间有一段时间的静音，可以用 EmptyTrackItem 来进行占位。
  • 使用 EmptyTrackItem 进行占位，来定位某个Item。
    		•
    TransitionItem MediaTransitionItem 否 转场，当 Type = Transition 时有效。
    示例值：b64e98advodcq198uje890

    MediaTransitionItem

    转场信息

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    TransitionId String 是 转场 Id 。暂只支持一个转场。
    示例值：60097a8a8ea83d00017b484b
    Duration Float 否 转场持续时间，单位为秒，默认为2秒。进行转场处理的两个媒体片段，第二个片段在轨道上的起始时间会自动进行调整，设置为前面一个片段的结束时间减去转场的持续时间。
    示例值：2.0

    OtherMaterial

    其他类型素材

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    MaterialUrl String 素材媒体文件的播放 URL 地址。
    VodFileId String 云点播媒资 FileId。

    PenguinMediaPlatformPublishInfo

    企鹅号发布信息。

    被如下接口引用：ExportVideoByEditorTrackData, ExportVideoByTemplate, ExportVideoByVideoSegmentationData, ExportVideoEditProject。

    名称 类型 必选 描述
    Title String 否 视频发布标题。
    Description String 否 视频发布描述信息。
    Tags Array of String 否 视频标签。
    Category Integer 否 视频分类，详见企鹅号官网视频分类。

    PlatformInfo

    平台信息。

    被如下接口引用：DescribePlatforms。

    名称 类型 描述
    Platform String 平台标识。
    示例值：test
    Description String 平台描述。
    示例值：describetion
    VodSubAppId Integer 云点播子应用 Id。
    示例值：1402233125
    LicenseId String 平台绑定的 license Id。
    示例值：60097a8a8ea83d00017b484b
    Status String 平台状态，可取值为：
  • Normal：正常，可使用。；
  • Stopped：已停用，暂无法使用；
  • Expired：已过期，需要重新购买会员包。

    • 示例值：Normal
    CreateTime String 创建时间，格式按照 ISO 8601 标准表示。
    示例值：2021-09-02T03:13:08Z
    UpdateTime String 更新时间，格式按照 ISO 8601 标准表示。
    示例值：2021-09-02T03:13:08Z

    PresetTagInfo

    预置标签信息

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 必选 描述
    Id String 是 标签 Id 。
    Name String 是 标签名称。
    ParentTagId String 否 父级预设 Id。

    ProjectInfo

    项目信息。

    被如下接口引用：DescribeProjects。

    名称 类型 描述
    ProjectId String 项目 Id。
    示例值：project_id
    Name String 项目名称。
    示例值：新建
    AspectRatio String 画布宽高比。
    Category String 项目类别，取值有：
  • VIDEO_EDIT：视频编辑。
  • SWITCHER：导播台。
  • VIDEO_SEGMENTATION：视频拆条。
  • STREAM_CONNECT：云转推。
  • RECORD_REPLAY：录制回放。

    • 示例值：STREAM_CONNECT
    Owner Entity 归属者。
    CoverUrl String 项目封面图片地址。
    StreamConnectProjectInfo StreamConnectProjectInfo 云转推项目信息，仅当项目类别取值 STREAM_CONNECT 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    MediaCastProjectInfo MediaCastProjectInfo 点播转直播项目信息，仅当项目类别取值为 MEDIA_CAST 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    UpdateTime String 项目更新时间，格式按照 ISO 8601 标准表示。
    示例值：2021-03-23T07:51:18.029Z
    CreateTime String 项目创建时间，格式按照 ISO 8601 标准表示。
    示例值：2021-03-23T07:51:18.029Z

    ProjectMediaCastStatusChangedEvent

    点播转直播项目状态变更事件。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    ProjectId String 项目 Id。
    示例值：60097a8a8ea83d00017b484b
    Status String 项目状态，取值有：
  • Started：点播转直播开始；
  • Stopped：点播转直播结束；
  • SourceInterrupted：点播转直播输入断流；
  • DestinationInterrupted：点播转直播输出断流。

    • 示例值：Started
    SourceInterruptInfo MediaCastSourceInterruptInfo 点播转直播输入断流信息，仅当 Status 取值 SourceInterrupted 时有效。
    DestinationInterruptInfo MediaCastDestinationInterruptInfo 点播转直播输出断流信息，仅当 Status 取值 DestinationInterrupted 时有效。

    ProjectStreamConnectStatusChangedEvent

    云转推项目状态变更事件。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    ProjectId String 项目 Id。
    示例值：60097a8a8ea83d00017b484b
    Status String 项目状态，取值有：
  • Working：云转推推流开始；
  • Stopped：云转推推流结束；
  • InputInterrupted：云转推输入断流；
  • OutputInterrupted：云转推输出断流。

    • 示例值：PushStreamFinish
    InputInterruptInfo StreamConnectInputInterruptInfo 云转推输入断流信息，仅当 Status 取值 InputInterrupted 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    OutputInterruptInfo StreamConnectOutputInterruptInfo 云转推输出断流信息，仅当 Status 取值 OutputInterrupted 时有效。
    注意：此字段可能返回 null，表示取不到有效值。

    ProjectSwitcherStatusChangedEvent

    导播台项目状态变更事件

    被如下接口引用：ParseEvent。

    名称 类型 描述
    ProjectId String 导播台项目 Id。
    示例值：60097a8a8ea83d00017b484b
    Status String 导播台项目状态，可取值有：
  • Started：导播台启动；
  • Stopped：导播台停止；
  • PvwStarted：导播台 PVW 开启；
  • PgmStarted：导播台 PGM 开启，输出推流开始；
  • PvwStopped：导播台 PVW 停止；
  • PgmStopped：导播台 PGM 停止，输出推流结束。

    • 示例值：Started

    RecordReplayProjectInput

    录制回放项目输入信息。

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    PullStreamUrl String 是 录制拉流地址。
    MaterialOwner Entity 是 录制文件归属者。
    MaterialClassPath String 是 录制文件存储分类路径。
    PushStreamUrl String 是 回放推流地址。

    Resource

    用于描述资源

    被如下接口引用：DescribeResourceAuthorization, GrantResourceAuthorization, MoveResource, RevokeResourceAuthorization。

    名称 类型 必选 描述
    Type String 是 类型，取值有：
  • MATERIAL：素材。
  • CLASS：分类。
    		•
    Id String 是 资源 Id，当 Type 为 MATERIAL 时，取值为素材 Id；当 Type 为 CLASS 时，取值为分类路径 ClassPath。

    ResourceInfo

    资源信息，包含资源以及归属信息

    被如下接口引用：MoveResource。

    名称 类型 必选 描述
    Resource Resource 是 媒资和分类资源。
    Owner Entity 是 资源归属，个人或团队。

    RtmpPushInputInfo

    直播推流信息，包括推流地址有效时长，多媒体创作引擎后端生成直播推流地址。

    被如下接口引用：CreateProject, HandleStreamConnectProject。

    名称 类型 必选 描述
    ExpiredSecond Integer 是 直播推流地址有效期，单位：秒 。
    示例值：60
    PushUrl String 否 直播推流地址，入参不填默认由多媒体创作引擎生成。
    示例值：rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600c

    SearchScope

    搜索空间

    被如下接口引用：SearchMaterial。

    名称 类型 必选 描述
    Owner Entity 是 分类路径归属。
    ClassPath String 否 按分类路径检索。 不填则默认按根分类路径检索。

    SlotInfo

    卡槽信息。

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    Id Integer 卡槽 Id。
    示例值：0
    Type String 卡槽类型，可取值有：
  • AUDIO：音频卡槽，可替换素材类型为 AUDIO 的音频素材;
  • VIDEO：视频卡槽，可替换素材类型为 VIDEO 的视频素材;
  • IMAGE：图片卡槽，可替换素材类型为 IMAGE 的图片素材;
  • TEXT：文本卡槽，可替换文本内容。

    • 示例值：VIDEO
    DefaultMaterialId String 默认素材ID。当卡槽类型为 AUDIO，VIDEO，或 IMAGE 中的一种时有效。
    示例值：60097a8a8ea83d00017b484b
    DefaultTextSlotInfo TextSlotInfo 默认文本卡槽信息。当卡槽类型为 TEXT 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    Duration Float 素材时长，单位秒。
    示例值：100
    StartTime Float 卡槽起始时间，单位秒。
    示例值：0

    SlotReplacementInfo

    卡槽替换信息。

    被如下接口引用：ExportVideoByTemplate。

    名称 类型 必选 描述
    Id Integer 是 卡槽 Id。
    示例值：0
    ReplacementType String 是 替换类型，可取值有：
  • AUDIO ：音频；
  • VIDEO ：视频；
  • IMAGE ：图片；
  • TEXT ：文本。

    • 注意：这里必须保证替换的素材类型与模板轨道数据的素材类型一致。如果替换的类型为Text,，则必须保证模板轨道数据中相应卡槽的位置标记的是文本。
    示例值：VIDEO
    MediaReplacementInfo MediaReplacementInfo 否 媒体替换信息，仅当要替换的媒体类型为音频、视频、图片时有效。
    示例值： 无
    TextReplacementInfo TextReplacementInfo 否 文本替换信息，仅当要替换的卡槽类型为文本时有效。

    SortBy

    排序

    被如下接口引用：DescribeMaterials, DescribeProjects, SearchMaterial。

    名称 类型 必选 描述
    Field String 是 排序字段。
    Order String 否 排序方式，可选值：Asc（升序）、Desc（降序），默认降序。

    StorageNewFileCreatedEvent

    新文件生成事件

    被如下接口引用：ParseEvent。

    名称 类型 描述
    FileId String 云点播文件 Id。
    示例值：5285890818667693889292992
    MaterialId String 媒体 Id。
    示例值：60a75c1c30fcbe0001cc8990d0
    Operator String 操作者 Id。（废弃，请勿使用）
    示例值：3fa6b09e-05c6-433e-bc1e-6457d264f1dd
    OperationType String 操作类型，可取值有：
  • Upload：本地上传；
  • PullUpload：拉取上传；
  • VideoEdit：视频剪辑；
  • LiveStreamClip：直播流剪辑；
  • LiveStreamRecord：直播流录制。

    • 示例值：Upload
    Owner Entity 媒体归属。
    ClassPath String 媒体分类路径。
    示例值：/媒体
    TaskId String 生成文件的任务 Id。当生成新文件是拉取上传、视频剪辑、直播流剪辑时为任务 Id。
    示例值：125000800-PullUpload-6fdaf790821a36dbe95ec8f557366c71t
    SourceContext String 来源上下文信息。视频剪辑生成新文件时此字段为项目 Id；直播流剪辑或者直播流录制生成新文件则为原始流地址。
    示例值：60097a8a8ea83d00017b484b

    StreamConnectInputInterruptInfo

    云转推输入断流信息。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    EndPoint String 云转推输入源标识，取值有：
  • Main：主源；
  • Backup：备源。

    • 示例值：Main

    StreamConnectOutput

    云转推输出源。

    被如下接口引用：CreateProject, DescribeProjects, HandleStreamConnectProject。

    名称 类型 必选 描述
    Id String 否 云转推输出源标识，转推项目级别唯一。若不填则由后端生成。
    示例值：135ed54d55d
    Name String 否 云转推输出源名称。
    示例值：test
    Type String 否 云转推输出源类型，取值：
  • URL ：URL类型

    • 不填默认为URL类型。
    示例值：URL
    PushUrl String 否 云转推推流地址。
    示例值：rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600c

    StreamConnectOutputInfo

    云转推输出源信息，包含输出源和输出源转推状态。

    被如下接口引用：DescribeProjects。

    名称 类型 描述
    StreamConnectOutput StreamConnectOutput 输出源。
    注意：此字段可能返回 null，表示取不到有效值。
    PushSwitch String 输出流状态：
  • On ：开；
  • Off ：关 。

    • 示例值：On

    StreamConnectOutputInterruptInfo

    云转推输出断流信息

    被如下接口引用：ParseEvent。

    名称 类型 描述
    Id String 云转推输出标识。
    示例值：outputId
    Name String 云转推输出名称。
    示例值：test
    Url String 云转推输出地址。
    示例值：rtmp://livepush.video-studio.myqcloud.com/output/1250000001-600c

    StreamConnectProjectInfo

    云转推项目信息，包含输入源、输出源、当前转推开始时间等信息。

    被如下接口引用：DescribeProjects。

    名称 类型 描述
    Status String 转推项目状态，取值有：
  • Working ：转推中；
  • Idle ：空闲中。

    • 示例值：Working
    CurrentInputEndpoint String 当前转推输入源，取值有：
  • Main ：主输入源；
  • Backup ：备输入源。

    • 示例值：Main
    CurrentStartTime String 当前转推开始时间， 采用 ISO 日期格式。仅 Status 取值 Working 时有效。
    示例值：2021-03-23T07:51:18.029Z
    CurrentStopTime String 当前转推计划结束时间， 采用 ISO 日期格式。仅 Status 取值 Working 时有效。
    示例值：2021-03-23T08:51:18.029Z
    LastStopTime String 上一次转推结束时间， 采用 ISO 日期格式。仅 Status 取值 Idle 时有效。
    示例值：2021-03-22T08:51:18.029Z
    MainInput StreamInputInfo 云转推主输入源。
    注意：此字段可能返回 null，表示取不到有效值。
    BackupInput StreamInputInfo 云转推备输入源。
    注意：此字段可能返回 null，表示取不到有效值。
    OutputSet Array of StreamConnectOutputInfo 云转推输出源。

    StreamConnectProjectInput

    云转推项目输入信息。

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    MainInput StreamInputInfo 否 云转推主输入源信息。
    BackupInput StreamInputInfo 否 云转推备输入源信息。
    Outputs Array of StreamConnectOutput 否 云转推输出源信息。

    StreamInputInfo

    输入流信息。

    被如下接口引用：CreateProject, DescribeProjects, HandleStreamConnectProject。

    名称 类型 必选 描述
    InputType String 是 流输入类型，取值：
  • VodPull ： 点播拉流；
  • LivePull ：直播拉流；
  • RtmpPush ： 直播推流。

    • 示例值：LivePull
    VodPullInputInfo VodPullInputInfo 否 点播拉流信息，当 InputType = VodPull 时必填。
    注意：此字段可能返回 null，表示取不到有效值。
    LivePullInputInfo LivePullInputInfo 否 直播拉流信息，当 InputType = LivePull 时必填。
    注意：此字段可能返回 null，表示取不到有效值。
    RtmpPushInputInfo RtmpPushInputInfo 否 直播推流信息，当 InputType = RtmpPush 时必填。
    注意：此字段可能返回 null，表示取不到有效值。

    SwitcherPgmOutputConfig

    导播台主监输出配置信息

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    TemplateId Integer 否 导播台输出模板 ID，可取值：
  • 10001：分辨率为1080 P；
  • 10002：分辨率为720 P；
  • 10003：分辨率为480 P。
    		•
    Width Integer 否 导播台输出宽，单位：像素。
    Height Integer 否 导播台输出高，单位：像素。
    Fps Integer 否 导播台输出帧率，单位：帧/秒
    BitRate Integer 否 导播台输出码率， 单位：bit/s。

    SwitcherProjectInput

    导播台项目输入信息

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    StopTime String 否 导播台停止时间，格式按照 ISO 8601 标准表示。若不填，该值默认为当前时间加七天。
    PgmOutputConfig SwitcherPgmOutputConfig 否 导播台主监输出配置信息。若不填，默认输出 720P。

    TaskBaseInfo

    任务基础信息。

    被如下接口引用：DescribeTasks。

    名称 类型 描述
    TaskId String 任务 Id。
    TaskType String 任务类型，取值有：
  • VIDEO_EDIT_PROJECT_EXPORT：项目导出。
    		•
    Status String 任务状态，取值有：
  • PROCESSING：处理中：
  • SUCCESS：成功；
  • FAIL：失败。
    		•
    Progress Integer 任务进度，取值为：0~100。
    ErrCode Integer 错误码。
  • 0：成功；
  • 其他值：失败。
    		•
    ErrMsg String 错误信息。
    CreateTime String 创建时间，格式按照 ISO 8601 标准表示。

    TeamInfo

    团队信息

    被如下接口引用：DescribeTeams。

    名称 类型 描述
    TeamId String 团队 ID。
    Name String 团队名称。
    MemberCount Integer 团队成员个数
    CreateTime String 团队创建时间，格式按照 ISO 8601 标准表示。
    UpdateTime String 团队最后更新时间，格式按照 ISO 8601 标准表示。

    TeamMemberInfo

    团队成员信息

    被如下接口引用：DescribeTeamMembers。

    名称 类型 必选 描述
    MemberId String 是 团队成员 ID。
    Remark String 否 团队成员备注。
    Role String 否 团队成员角色，取值：
  • Owner：团队所有者，添加团队成员及修改团队成员解决时不能填此角色；
  • Admin：团队管理员；
  • Member：普通成员。
    		•

    TextReplacementInfo

    模板插槽文本替换信息。

    被如下接口引用：ExportVideoByTemplate。

    名称 类型 必选 描述
    Text String 是 替换的文本信息。
    示例值：文字

    TextSlotInfo

    文本类型卡槽信息。

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    Text String 文本内容。
    示例值：智能创作

    ThirdPartyPublishInfo

    第三方平台视频发布信息。

    被如下接口引用：ExportVideoByEditorTrackData, ExportVideoByTemplate, ExportVideoByVideoSegmentationData, ExportVideoEditProject。

    名称 类型 必选 描述
    ChannelMaterialId String 是 发布通道 ID。
    示例值：9d64a35169404c4a250d
    PenguinMediaPlatformPublishInfo PenguinMediaPlatformPublishInfo 否 企鹅号发布信息，如果使用的发布通道为企鹅号时必填。
    WeiboPublishInfo WeiboPublishInfo 否 新浪微博发布信息，如果使用的发布通道为新浪微博时必填。
    KuaishouPublishInfo KuaishouPublishInfo 否 快手发布信息，如果使用的发布通道为快手时必填。
    CosPublishInfo CosPublishInputInfo 否 腾讯云对象存储发布信息， 如果使用的发布通道为腾讯云对象存储时必填。

    TimeRange

    时间范围

    被如下接口引用：SearchMaterial。

    名称 类型 必选 描述
    StartTime String 是 开始时间，使用 ISO 日期格式。
    EndTime String 是 结束时间，使用 ISO 日期格式。

    VODExportInfo

    云点播导出信息。

    被如下接口引用：ExportVideoByEditorTrackData, ExportVideoByTemplate, ExportVideoByVideoSegmentationData, ExportVideoEditProject。

    名称 类型 必选 描述
    Name String 否 导出的媒资名称。
    ClassId Integer 否 导出的媒资分类 Id。
    ThirdPartyPublishInfos Array of ThirdPartyPublishInfo 否 第三方平台发布信息列表。暂未正式对外，请勿使用。

    VideoEditProjectInput

    视频编辑项目输入参数

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    AspectRatio String 否 画布宽高比，取值有：
  • 16:9；
  • 9:16；
  • 2:1。

    • 默认值 16:9 。
    示例值：16:9
    VideoEditTemplateId String 否 视频编辑模板媒体 ID ，通过模板媒体导入项目轨道数据时填写。
    InitTracks Array of MediaTrack 否 输入的媒体轨道列表，包括视频、音频，等媒体组成的多个轨道信息。其中：
  • 输入的多个轨道在时间轴上和输出媒体文件的时间轴对齐；
  • 时间轴上相同时间点的各个轨道的素材进行重叠，视频或者图片按轨道顺序进行图像的叠加，轨道顺序高的素材叠加在上面，音频素材进行混音；
  • 视频、音频，每一种类型的轨道最多支持10个。

    • 注：当从模板导入项目时（即 VideoEditTemplateId 不为空时），该参数无效。

    VideoEditProjectOutput

    项目导出信息。

    被如下接口引用：DescribeTaskDetail, ParseEvent。

    名称 类型 描述
    MaterialId String 导出的多媒体创作引擎媒体 Id，仅当导出目标为多媒体创作引擎媒体时有效。
    示例值：5f73f8ad54953bce323f
    VodFileId String 云点播媒资 FileId。
    示例值：2c65f425b86ad532
    URL String 导出的媒资 URL。
    示例值：http://cme.vod2.myqcloud.com/123/f0.mp4
    MetaData MediaMetaData 元信息。
    注意：此字段可能返回 null，表示取不到有效值。
    CoverURL String 导出视频的封面图片 URL。
    示例值：http://cme.vod2.myqcloud.com/123/f0.jpg

    VideoEditTemplateMaterial

    视频编辑模板素材信息。

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    AspectRatio String 视频编辑模板宽高比。
    示例值：16:9
    SlotSet Array of SlotInfo 卡槽信息。
    PreviewVideoUrl String 模板预览视频 URL 地址 。

    VideoEncodingPreset

    视频编码配置

    被如下接口引用：DescribeVideoEncodingPresets。

    名称 类型 描述
    Id Integer 配置 ID。
    Name String 配置名。
    Container String 封装格式，可选值：
  • mp4 ；
  • mov 。
    		•
    RemoveVideo Integer 是否去除视频数据，可选值：
  • 0：保留；
  • 1：去除。

    • 默认值：0。
    RemoveAudio Integer 是否去除音频数据，可选值：
  • 0：保留；
  • 1：去除。

    • 默认值：0。
    VideoSetting VideoEncodingPresetVideoSetting 视频编码配置中的视频设置。
    AudioSetting VideoEncodingPresetAudioSetting 视频编码配置中的音频设置。

    VideoEncodingPresetAudioSetting

    视频编码配置中的音频设置

    被如下接口引用：CreateVideoEncodingPreset, DescribeVideoEncodingPresets。

    名称 类型 必选 描述
    Codec String 否 音频流的编码格式，可选值：
    AAC：AAC 编码。

    默认值：AAC。
    示例值：AAC
    Bitrate Integer 否 音频码率，单位：bps。
    默认值：64K。
    示例值：0
    Channels Integer 否 音频声道数，可选值：
  • 1：单声道；
  • 2：双声道。

    • 默认值：2。
    示例值：2
    SampleRate Integer 否 音频流的采样率，仅支持 16000； 32000； 44100； 48000。单位：Hz。
    默认值：16000。
    示例值：16000

    VideoEncodingPresetAudioSettingForUpdate

    视频编码配置中的音频设置更新信息

    被如下接口引用：ModifyVideoEncodingPreset。

    名称 类型 必选 描述
    Bitrate String 否 音频码率，单位：bps。
    不填则不修改。
    示例值：0
    Channels Integer 否 音频声道数，可选值：
  • 1：单声道；
  • 2：双声道。

    • 不填则不修改。
    示例值：2
    SampleRate Integer 否 音频流的采样率，目前仅支持： 16000； 32000； 44100； 48000。单位：Hz。
    不填则不修改。
    示例值：16000

    VideoEncodingPresetVideoSetting

    视频编码配置中的视频设置信息

    被如下接口引用：CreateVideoEncodingPreset, DescribeVideoEncodingPresets。

    名称 类型 必选 描述
    Codec String 否 视频流的编码格式，可选值：
  • H264：H.264 编码。

    • 示例值：H264
    ShortEdge Integer 否 视频短边尺寸，取值范围： [128, 4096]，单位：px。
    视频最后的分辨率，根据短边尺寸和宽高比进行计算。
    例：如果项目的宽高比是 16：9 ：
  • 短边尺寸为 1080，则导出视频的分辨率为 1920 * 1080。
  • 短边尺寸为 720，则导出视频的分辨率为 1280 * 720。

    • 如果项目的宽高比是 9：16 ：
  • 短边尺寸为 1080，则导出视频的分辨率为 1080 * 1920。
  • 短边尺寸为 720，则导出视频的分辨率为 720 * 1280。

    • 默认值：1080。
    示例值：1080
    Bitrate Integer 否 指定码率，单位 bps。当该参数为'0'时则不强制限定码率。
    默认值：0。
    示例值：0

    VideoEncodingPresetVideoSettingForUpdate

    视频编码配置的视频设置更新信息

    被如下接口引用：ModifyVideoEncodingPreset。

    名称 类型 必选 描述
    ShortEdge Integer 否 视频短边尺寸，取值范围： [128, 4096]，单位：px。
    视频最后的分辨率，根据短边尺寸和宽高比进行计算。
    例：如果项目的宽高比是 16：9 ：
  • 短边尺寸为 1080，则导出视频的分辨率为 1920 * 1080。
  • 短边尺寸为 720，则导出视频的分辨率为 1280 * 720。

    • 如果项目的宽高比是 9：16 ：
  • 短边尺寸为 1080，则导出视频的分辨率为 1080 * 1920。
  • 短边尺寸为 720，则导出视频的分辨率为 720 * 1280。

    • 不填则不修改。
    示例值：1080
    Bitrate Integer 否 指定码率，单位 bps。当该参数为'0' 时则不强制限定码率。
    不填则不修改。
    示例值：0
    FrameRate Float 否 指定帧率。单位 Hz。
    不填则不修改。
    示例值：25

    VideoExportCompletedEvent

    视频导出完成事件。

    被如下接口引用：ParseEvent。

    名称 类型 描述
    TaskId String 任务 Id。
    示例值：123-FusionCME-391d2d669d70952a99e3be240e0acf11t
    Status String 任务状态，取值有：
  • SUCCESS：成功；
  • FAIL：失败。

    • 示例值：SUCCESS
    ErrCode Integer 错误码，取值有：
  • 0：成功；
  • 其他值：失败。

    • 示例值：0
    ErrMsg String 错误信息。
    示例值：fail
    Output VideoEditProjectOutput 任务输出。
    注意：此字段可能返回 null，表示取不到有效值。

    VideoExportExtensionArgs

    视频导出扩展参数

    被如下接口引用：ExportVideoByEditorTrackData, ExportVideoByTemplate, ExportVideoEditProject。

    名称 类型 必选 描述
    Container String 否 封装格式，可选值：
  • mp4
  • mov

    • 不填则使用视频导出编码配置。
    示例值：mp4
    ShortEdge Integer 否 视频短边尺寸，取值范围： [128, 4096]，单位：px。
    视频最后的分辨率，根据短边尺寸和宽高比进行计算。
    例如：项目的宽高比是 16：9 ：
  • 短边尺寸为 1080，则导出视频的分辨率为 1920 * 1080。
  • 短边尺寸为 720，则导出视频的分辨率为 1280 * 720

    • 不填则使用视频导出编码配置。
    示例值：1080
    VideoBitrate Integer 否 指定码率，单位 bps。当该参数为 0 时则不强制限定码率。
    不填则使用视频导出编码配置。
    示例值：0
    FrameRate Float 否 帧率。取值范围：[15, 60]，不填默认值为 25。
    示例值：0
    RemoveVideo Integer 否 是否去除视频数据，可选值：
  • 0：保留；
  • 1：去除。

    • 不填则使用视频导出编码配置。
    示例值：0
    RemoveAudio Integer 否 是否去除音频数据，可选值：
  • 0：保留；
  • 1：去除。

    • 不填则使用视频导出编码配置。
    示例值：0
    StartTime Integer 否 片段起始时间，单位：毫秒。
    示例值：0
    EndTime Integer 否 片段结束时间，单位：毫秒。
    示例值：0

    VideoMaterial

    视频素材信息

    被如下接口引用：DescribeMaterials, FlattenListMedia, ListMedia, SearchMaterial。

    名称 类型 描述
    MetaData MediaMetaData 素材元信息。
    ImageSpriteInfo MediaImageSpriteInfo 雪碧图信息。
    MaterialUrl String 素材媒体文件的播放 URL 地址。
    CoverUrl String 素材媒体文件的封面图片地址。
    Resolution String 媒体文件分辨率。取值为：LD/SD/HD/FHD/2K/4K。
    MaterialStatus MaterialStatus 素材状态。
    注意：此字段可能返回 null，表示取不到有效值。
    OriginalUrl String 素材媒体文件的原始 URL 地址。
    VodFileId String 云点播媒资 FileId。

    VideoSegmentationProjectInput

    视频拆条项目的输入信息。

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    AspectRatio String 否 画布宽高比，取值有：
  • 16:9；
  • 9:16；
  • 2:1。

    • 默认值 16:9 。
    示例值：16:9
    ProcessModel String 否 视频拆条处理模型，不填则默认为手工分割视频。取值 ：
  • AI.GameHighlights.PUBG：和平精英集锦 ;
  • AI.GameHighlights.Honor OfKings：王者荣耀集锦 ;
  • AI.SportHighlights.Football：足球集锦
  • AI.SportHighlights.Basketball：篮球集锦 ；
  • AI.PersonSegmentation：人物集锦 ;
  • AI.NewsSegmentation：新闻拆条。
    		•

    VideoStreamInfo

    视频流信息。

    被如下接口引用：DescribeTaskDetail。

    名称 类型 描述
    Bitrate Integer 码率，单位：bps。
    Height Integer 高度，单位：px。
    Width Integer 宽度，单位：px。
    Codec String 编码格式。
    Fps Integer 帧率，单位：hz。

    VideoTrackItem

    视频轨的视频片段信息。

    被如下接口引用：CreateProject。

    名称 类型 必选 描述
    SourceType String 是 视频媒体来源类型，取值有：

    • VOD ：媒体来源于云点播文件 。
    • CME ：视频来源制作云媒体文件。
    • EXTERNAL ：视频来源于媒资绑定，如果媒体不是存储在腾讯云点播中或者云创中，都需要使用媒资绑定。


    示例值：VOD
    SourceMedia String 是 视频媒体，可取值为：

    • 当 SourceType 为 VOD 时，参数填云点播 FileId ；
    • 当 SourceType 为 CME 时，参数填多媒体创作引擎媒体 Id；
    • 当 SourceType 为 EXTERNAL 时，目前仅支持外部媒体 URL(如https://www.example.com/a.mp4)，参数填写规则请参见注意事项。



    注意：
  • 当 SourceType 为 EXTERNAL 并且媒体 URL Scheme 为 https 时(如：https://www.example.com/a.mp4)，参数为：1000000:www.example.com/a.mp4。
  • 当 SourceType 为 EXTERNAL 并且媒体 URL Scheme 为 http 时(如：http://www.example.com/b.mp4)，参数为：1000001:www.example.com/b.mp4。

    • 示例值：60097a8a8ea83d00017b484b
    SourceMediaStartTime Float 否 视频片段取自媒体文件的起始时间，单位为秒。默认为0。
    示例值：0
    Duration Float 否 视频片段时长，单位为秒。默认取视频媒体文件本身长度，表示截取全部媒体文件。如果源文件是图片，Duration需要大于0。
    示例值：20
    XPos String 否 视频片段原点距离画布原点的水平位置。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示视频片段 XPos 为画布宽度指定百分比的位置，如 10% 表示 XPos 为画布口宽度的 10%。
  • 当字符串以 px 结尾，表示视频片段 XPos 单位为像素，如 100px 表示 XPos 为100像素。

    • 默认值：0px。
    示例值：10px
    YPos String 否 视频片段原点距离画布原点的垂直位置。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示视频片段 YPos 为画布高度指定百分比的位置，如 10% 表示 YPos 为画布高度的 10%。
  • 当字符串以 px 结尾，表示视频片段 YPos 单位为像素，如 100px 表示 YPos 为100像素。

    • 默认值：0px。
    示例值：20px
    CoordinateOrigin String 否 视频原点位置，取值有：
  • Center：坐标原点为中心位置，如画布中心。

    • 默认值 ：Center。
    示例值：Center
    Height String 否 视频片段的高度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示视频片段 Height 为画布高度的百分比大小，如 10% 表示 Height 为画布高度的 10%；
  • 当字符串以 px 结尾，表示视频片段 Height 单位为像素，如 100px 表示 Height 为100像素；
  • 当 Width、Height 均为空，则 Width 和 Height 取视频媒体文件本身的 Width、Height；
  • 当 Width 为空，Height 非空，则 Width 按比例缩放；
  • 当 Width 非空，Height 为空，则 Height 按比例缩放。

    • 示例值：1080px
    Width String 否 视频片段的宽度。支持 %、px 两种格式：
  • 当字符串以 % 结尾，表示视频片段 Width 为画布宽度的百分比大小，如 10% 表示 Width 为画布宽度的 10%；
  • 当字符串以 px 结尾，表示视频片段 Width 单位为像素，如 100px 表示 Width 为100像素；
  • 当 Width、Height 均为空，则 Width 和 Height 取视频媒体文件本身的 Width、Height；
  • 当 Width 为空，Height 非空，则 Width 按比例缩放；
  • 当 Width 非空，Height 为空，则 Height 按比例缩放。

    • 示例值：1920px

    VodPullInputInfo

    点播拉流信息，包括输入拉流地址和播放次数。

    被如下接口引用：CreateProject, HandleStreamConnectProject。

    名称 类型 必选 描述
    InputUrls Array of String 是 点播输入拉流 URL 。
    LoopTimes Integer 否 播放次数，取值有：
  • -1 : 循环播放，直到转推结束；
  • 0 : 不循环；
  • 大于0 : 具体循环次数，次数和时间以先结束的为准。

    • 默认不循环。
    示例值：-1

    VodPullInputPlayInfo

    点播文件播放信息，包含当前在播地址和该地址已播时长 。

    被如下接口引用：HandleStreamConnectProject。

    名称 类型 描述
    Url String 当前正在播放文件 Url 。
    示例值：http://playdomain/patch/file.m3u8
    TimeOffset Float 点播文件已播放时长，单位：秒。
    示例值：10

    WeiboPublishInfo

    微博发布信息。

    被如下接口引用：ExportVideoByEditorTrackData, ExportVideoByTemplate, ExportVideoByVideoSegmentationData, ExportVideoEditProject。

    名称 类型 必选 描述
    Title String 否 视频发布标题。
    Description String 否 视频发布描述信息。
    Visible String 否 微博可见性，可取值为：
  • Public：公开，所有人可见；
  • Private：私有，仅自己可见。


    • 默认为 Public，所有人可见。
    中国站
    文档反馈
    文档活动
    message-icon联系我们
    目录