AudioMaterial
音频媒体信息。
字段 | 类型 | 描述 |
MetaData | 元信息。 | |
MaterialUrl | String | 媒资地址。 |
CoverUrl | String | 封面地址。 |
OriginalUrl | String | 媒资原始地址。 |
AuthorizationInfo
字段 | 类型 | 描述 |
Platform | String | 平台。 |
Name | String | 模板名称。 |
PermissionSet | Array of Permission | 权限内容。 |
ClassInfo
分类信息。
字段 | 类型 | 描述 |
Owner | 分类归属。 | |
Name | String | 分类名称。 |
ClassPath | String | 分类路径。 |
ClassId | Integer | 分类 ID。 |
ParentClassId | Integer | 父类 ID。 |
CMEExportInfo
字段 | 类型 | 描述 |
Owner | 归属者。 | |
Name | String | 媒体名称。 |
Description | String | 媒体描述信息。 |
ClassPath | String | 媒体分类路径。 |
EffectMaterial
效果素材。
字段 | 类型 | 描述 |
Attribute | String | 属性。 |
CoverUrl | String | 媒体封面。 |
MaterialUrl | String | 媒体地址。 |
FaceInfo
任务识别结果。
字段 | 类型 | 描述 |
Version | String | 识别版本号。 |
FaceSet | Array of FaceItem | 人脸信息 |
FaceItem
人脸信息。
字段 | 类型 | 描述 |
Id | String | 人物唯一标识 ID。 |
Name | String | 人物名称。 |
Type | String | 人物库类型,表示识别出的人物来自哪个人物库。 Default:默认人物库。 UserDefine:用户自定义人物库。 |
FaceUrl | String | 人脸图片地址。 |
SegmentSet | Array of FaceSegmentItem | 人脸识别结果片段。 |
FaceSegmentItem
人脸识别结果片段。
字段 | 类型 | 描述 |
StartTimeOffset | Float | 识别片段起始的偏移时间,单位:秒。 |
EndTimeOffset | Float | 识别片段终止的偏移时间,单位:秒。 |
AreaCoordSet | Array of Integer | 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2] ,依次表示区域左上点、右下点的横纵坐标。 |
Confidence | Float | 识别片段置信度。取值:0~100。 |
FailedMaterialInfo
媒体信息,失败时返回。
字段 | 类型 | 描述 |
MaterialId | String | 素材 ID。 |
ErrorInfo | 错误信息。 |
FilterInfo
媒体过滤信息。
字段 | 类型 | 必填 | 描述 |
NeedImageSpriteInfo | Bool | 否 | 是否需要返回雪碧图信息。 |
FrameTagInfo
帧标签。
字段 | 类型 | 描述 |
Version | String | 帧标签版本标识。 |
FrameTagSet | Array of FrameTagItem | 帧标签。 |
LastTimeOffset | Float | 本次结果的最大偏移时间,返回值不为-1则下次从该时间开始查询,单位:秒。 |
FrameTagItem
帧标签项信息。
字段 | 类型 | 描述 |
ItemId | String | 标签项 ID。 |
StartTimeOffset | Float | 起始时间偏移量,单位:秒。 |
EndTimeOffset | Float | 结束时间偏移量,单位:秒。 |
Tags | Array of String | 帧标签。 |
ImageMaterial
图片媒体信息。
字段 | 类型 | 描述 |
Width | Integer | 图片宽,单位像素。 |
Height | Integer | 图片高,单位像素。 |
Size | Integer | 图片大小,单位字节。 |
MaterialUrl | String | 媒资地址。 |
OriginalUrl | String | 媒资原始地址。 |
Resolution | String |
LinkMaterial
媒体链接。
字段 | 类型 | 描述 |
LinkType | String | 链接类型,取值: MATERIAL:媒体 CLASS:目录 |
LinkStatus | String | 链接状态,取值: NOT FOUND:链接找不到 NORMAL:正常 FORBIDDEN:禁止访问 |
LinkMaterialInfo | 链接媒体信息。 | |
LinkClassInfo | 链接素材分类信息。 |
MaterialBasicInfo
媒体基础信息。
字段 | 类型 | 描述 |
MaterialId | String | 素材 ID。 |
MaterialType | String | 素材类型,取值如下: VIDEO:视频 AUDIO:音频 IMAGE:图片 STICKER:图片转场 SUBTITLE:字幕 TRANSITION:转场 FILTER:滤镜 TEXT:文本 TEXT_IMAGE:图文动效 LINK:链接 EFFECT_VIDEO:动效 STYLE:风格 WATERMARK:水印 SWITCHER_LAYOUT:导播台布局 SWITCHER_EFFECT_TEXT:导播台文字特效 THIRD_PARTY_PUBLISH_CHANNEL:第三方发布通道 VIDEO_EDIT_TEMPLATE:视频编辑模板 |
Name | String | 素材名称。 |
ClassPath | String | 素材 ID。 |
CreateTime | String | 创建时间 ,标准ISO格式。 |
UpdateTime | String | 更新时间 ,标准ISO格式。 |
TagInfoSet | Array of MaterialTagInfo | 素材预置标签信息。 |
TagSet | Array of String | 素材人工标签。 |
PreviewUrl | String | 素材人工标签。 |
MediaUrl | Array of String | 素材媒体 URL。 |
Owner | 素材归属。 |
MaterialInfo
媒体素材信息。
字段 | 类型 | 描述 |
BasicInfo | 媒体基础信息。 | |
MediaInfo | 媒体信息。 | |
MaterialStatus | 媒体状态信息。 | |
LinkMaterial | 链接媒体信息。 | |
AudioMaterial | 音频媒体信息。 | |
VideoMaterial | 视频媒体信息。 | |
ImageMaterial | 图片媒体信息。 | |
StickerMaterial | 贴图媒体信息。 | |
SubtitleMaterial | 字幕媒体信息。 | |
TransitionMaterial | 转场媒体信息。 | |
FilterMaterial | 滤镜媒体信息。 | |
TextMaterial | 文本媒体信息。 | |
TextImageMaterial | 文字图片信息。 | |
StyleMaterial | 风格媒体信息。 | |
VideoEditTemplateMaterial | 模板媒体信息。 | |
ThirdPartyPublishChannelMaterial | 发布通道媒体信息。 |
MaterialStatus
媒体状态。
字段 | 类型 | 描述 |
TranscodeStatus | String | 转码状态: NORMAL:正常 ABNORMAL:异常 PROCESSING:处理中 |
MaterialTagInfo
预置标签。
字段 | 类型 | 描述 |
Type | String | 标签类型,Preset:预置标签。 |
Id | String | 标签 ID。 |
Name | String | 标签名称。 |
ParentId | String | 父标签 ID。 |
MediaAudioStreamItem
媒体音频流信息。
字段 | 类型 | 描述 |
Bitrate | Integer | 视频流码率平均值与音频流码率平均值之和,单位:bps。 |
Codec | String | 视频的编码格式。 |
SamplingRate | Integer | 音频流的采样率,单位:hz。 |
MediaInfo
媒体宽高信息。
字段 | 类型 | 描述 |
Width | Integer | 视频或图片宽,单位像素。 |
Height | Integer | 视频或图片高,单位像素。 |
Size | Integer | 视频或图片大小,单位字节。 |
Duration | Float | 视频长度,单位秒。 |
MediaType | String | 媒体类型: VIDEO:视频 AUDIO:音频 IMAGE:图片 |
MediaMetaData
媒体元信息。
字段 | 类型 | 描述 |
Size | Integer | 上传的媒体文件大小(视频为 HLS 时,大小是 m3u8 和 ts 文件大小的总和),单位:字节。 |
Container | String | 容器类型,例如 m4a,mp4 等。 |
Bitrate | Integer | 视频流码率平均值与音频流码率平均值之和,单位:bps。 |
Height | Integer | 视频流高度的最大值,单位:px。 |
Width | Integer | 视频流宽度的最大值,单位:px。 |
Duration | Float | 视频时长,单位:秒。 |
Rotate | String | 视频拍摄时的选择角度,单位:度。 |
VideoStreamSet | Array of MediaVideoStreamItem | 视频流信息。 |
AudioStreamSet | Array of MediaAudioStreamItem | 音频流信息。 |
MediaVideoStreamItem
媒体视频流信息。
字段 | 类型 | 描述 |
Bitrate | Integer | 视频流码率平均值与音频流码率平均值之和,单位:bps。 |
Height | Integer | 视频流高度的最大值,单位:px。 |
Width | Integer | 视频流宽度的最大值,单位:px。 |
Codec | String | 视频的编码格式。 |
Fps | Integer | 视频帧率。 |
ObjectInfo
物体识别信息。
字段 | 类型 | 描述 |
Version | String | 物体识别版本号。 |
ObjectSet | Array of ObjectItem | 识别物体集合。 |
ObjectItem
物体识别结果。
字段 | 类型 | 描述 |
ItemId | String | 物体识别版本号。 |
Name | String | 识别的物体名称。 |
SegmentItemSet | Array of ObjectSegmentItem | 物体出现的片段列表。 |
ObjectSegmentItem
物体识别片段。
字段 | 类型 | 描述 |
StartTimeOffset | Float | 识别片段起始的偏移时间,单位:秒。 |
EndTimeOffset | Float | 识别片段终止的偏移时间,单位:秒。 |
Confidence | Float | 识别片段置信度。取值:0~100。 |
AreaCoordSet | Array of Integer | 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。 |
Permission
权限信息。
字段 | 类型 | 必填 | 描述 |
PrimeResource | String | 是 | 一级资源,取值: Material:素材 Class:分类 |
SubResource | String | 否 | 二级资源,对应各资源的属性。 |
PrimeRight | String | 是 | 一级权限,取值: Read:读 Write:写 Execute:导出 Copy:复制 |
SubRight | String | 否 | 二级权限,取值: Create:新建 Modify:修改 Delete:删除 Download:下载 |
PermissionTemplateInfo
字段 | 类型 | 描述 |
Id | String | 模板 ID。 |
Name | String | 模板名称。 |
Owner | 归属者。 | |
PermissionSet | Array Permission | 符合条件的权限集合。 |
CreateTime | String | 创建时间,格式按照 ISO 8601 标准表示。 |
UpdateTime | String | 最后更新时间,格式按照 ISO 8601 标准表示。 |
ProjectBasicInfo
字段 | 类型 | 描述 |
ProjectId | String | 项目 ID。 |
Name | String | 项目名称。 |
Owner | 归属者。 | |
Category | Array String | 项目类别,取值有: Default:编辑项目 Live:直播剪辑项目 StreamConnet:云转推项目 |
WHRatio | String | 宽高比。 |
CoverUrl | String | 项目封面URL。 |
CoverSource | String | 项目封面来源。 |
CreateTime | String | 创建时间,格式按照 ISO 8601 标准表示。 |
UpdateTime | String | 最后更新时间,格式按照 ISO 8601 标准表示。 |
ProjectInfo
字段 | 类型 | 描述 |
ProjectId | String | 项目 ID。 |
Name | String | 项目名称。 |
Owner | 归属者。 | |
Category | String | 项目类别,取值有: Default:编辑项目 Live:直播剪辑项目 StreamConnet:云转推项目 |
Description | String | 描述信息。 |
WHRatio | String | 宽高比。 |
CoverUrl | String | 项目封面 URL。 |
CoverSource | String | 项目封面来源。 |
FusionData | String | 轨道信息。 |
Version | Integer | 轨道信息版本号。 |
CreateTime | String | 创建时间,格式按照 ISO 8601 标准表示。 |
UpdateTime | String | 最后更新时间,格式按照 ISO 8601 标准表示。 |
Resource
资源。
字段 | 类型 | 必填 | 描述 |
Type | String | 是 | 资源类型,可选值: MATERIAL:素材; CLASS:分类。 |
Id | String | 是 | 资源 ID。 |
SearchScope
搜索空间。
字段 | 类型 | 必填 | 描述 |
Platform | String | 是 | 平台。 |
Owner | 是 | 归属。 | |
ClassId | String | 否 | 分类 ID,从该分类路径检索。 不填则默认按根分类路径检索。 |
SearchOneDepth | bool | 否 | 是否仅搜索 ClassId 这一级分类路径。 |
ShareRootInfo
字段 | 类型 | 描述 |
MaterialInfo | 媒体基础信息。 | |
ClassInfo | 分类信息。 |
StreamConnectInfoForUpdate
字段 | 类型 | 描述 |
StopTime | String | 云转推停止时间,格式按照 ISO 8601 标准表示。 |
SubtitleInfo
字幕识别结果。
字段 | 类型 | 描述 |
Version | String | 版本标识。 |
SubtitleSet | Array SubtitleItem | 语音识别结果。 |
LastTimeOffset | Float | 本次结果的最大偏移时间,下次查询起始时间从该时间开始。如果返回值为-1,则表明偏移时间已经到识别结果末尾,单位:秒。 |
SubtitleItem
字幕识别片段。
字段 | 类型 | 描述 |
ItemId | String | 结果 ID。 |
StartTimeOffset | Float | 起始偏移时间,单位:秒。 |
EndTimeOffset | Float | 起始偏移时间,单位:秒。 |
Text | String | 文本。 |
SwitcherInfoForUpdate
字段 | 类型 | 描述 |
StopTime | String | 导播台停止时间,格式按照 ISO 8601 标准表示。 |
PgmOutputConfig | pgm输出配置。 |
SwitcherPgmOutputConfigForUpdate
字段 | 类型 | 描述 |
TemplateId | Integer | 导播台输出的模板 ID。 |
Width | Integer | 导播台输出的宽,单位:像素。 |
Height | Integer | 导播台输出的高,单位:像素。 |
Fps | Integer | 导播台输出的帧率,单位:帧/秒。 |
BitRate | Integer | 导播台输出的码率,单位:bit/s。 |
TaskInfo
任务信息。
字段 | 类型 | 描述 |
TaskId | String | 任务 ID。 |
Status | String | 任务状态 ,取值: PROCESSING:处理中 SUCCESS:成功 FAIL:失败 |
Progress | Integer | 任务进度。 |
CreateTime | String | 创建时间,标准ISO格式。 |
TextInfo
文本信息。
字段 | 类型 | 描述 |
Version | String | 版本标识。 |
TextSet | Array TextItem | 文本识别结果。 |
LastTimeOffset | Float | 本次结果的最大偏移时间,下次查询起始时间从该时间开始。如果返回值为-1,则表明偏移时间已经到识别结果末尾。单位:秒。 |
TextItem
文本片段。
字段 | 类型 | 描述 |
ItemId | String | 结果 ID。 |
StartTimeOffset | Float | 起始偏移时间,单位:秒。 |
EndTimeOffset | Float | 起始偏移时间,单位:秒。 |
SegmentSet | Array of TextSegmentItem | 文本。 |
TextSegmentItem
文本片段。
字段 | 类型 | 描述 |
Text | String | 文本。 |
AreaCoordSet | Array of Integer | 坐标。 |
TfError
返回码和描述信息。
字段 | 类型 | 描述 |
Code | String | 返回码。 |
Message | String | 描述信息。 |
EnglishMessage | String | 英文描述。 |
ThirdPartyPublishChannelMaterial
第三方发布通道。
字段 | 类型 | 描述 |
ThirdPartyPublish | String | 第三方发布平台,取值: OM:企鹅号 WB:微博 KS:快手 |
OpenId | String | 平台 OpenId |
ValidTime | String | 有效期,标准 ISO 格式 |
VideoEditProjectInput
字段 | 类型 | 描述 |
ProjectId | String | 项目 ID。 |
Definition | Integer | 模板 ID。 |
ExportDestination | String | 导出目标。 |
VODExportInfo | VOD导出信息。 | |
CMEExportInfo | CME导出信息。 |
VideoEditProjectOutput
字段 | 类型 | 描述 |
MaterialId | String | 媒体 ID。 |
URL | String | 媒体 URL。 |
CoverURL | String | 媒体封面 URL。 |
VideoEditProjectTask
视频编辑任务信息。
字段 | 类型 | 描述 |
ErrCode | Integer | 返回码。 |
ErrMsg | String | 返回错误信息。 |
VideoEditProjectInput | 视频编辑导出任务输入信息。 | |
VideoEditProjectOutput | 视频编辑导出任务输出信息。 |
VideoEditTemplateMaterial
视频编辑模板素材。
字段 | 类型 | 描述 |
AspectRatio | String | 宽高比,取值16:9或9:16。 |
FusionData | String | 轨道数据。 |
VideoMaterial
视频媒体信息。
字段 | 类型 | 描述 |
MetaData | 元信息。 | |
ImageSpriteInfo | 视频雪碧图信息。 | |
MaterialUrl | String | 媒资地址。 |
CoverUrl | String | 封面地址。 |
OriginalUrl | String | 媒资原始地址。 |
VODExportInfo
字段 | 类型 | 描述 |
Name | String | 项目 ID。 |
ClassId | Integer | 模板 ID。 |