数据结构
更新时间:2024-11-19
CallbackConfig
事件回调设置
名称 | 类型 | 说明 |
---|---|---|
callbackUrl | string | HTTP回调地址 |
enableSign | boolean | 是否开启签名 |
signKey | string | 签名key |
enableMediaUploadCompleteEvent | boolean | 是否开启媒资上传完成事件通知 |
enableMediaFetchCompleteEvent | boolean | 是否开启媒资拉取完成事件通知 |
enableMediaTranscodeCompleteEvent | boolean | 是否开启媒资转码完成事件通知 |
enableMediaThumbnailCompleteEvent | boolean | 是否开启媒资截图完成事件通知 |
enableMediaAnalysisCompleteEvent | boolean | 是否开启媒资分析完成事件通知 |
enableMediaRegulationCompleteEvent | boolean | 是否开启媒资审核完成事件通知 |
enableComposeTaskStatusChangeEvent | boolean | 是否开启视频云剪辑任务状态变更事件通知 |
CallbackEvent
事件回调消息
名称 | 类型 | 说明 |
---|---|---|
eventId | string | 事件ID |
eventType | string | 事件类型 |
eventTime | string | 事件时间戳 |
mediaUploadCompleteEvent | MediaUploadCompleteEvent | 媒资上传完成回调事件内容 |
mediaFetchCompleteEvent | MediaFetchCompleteEvent | 媒资拉取完成回调事件内容 |
mediaTranscodeCompleteEvent | MediaTranscodeCompleteEvent | 媒资转码完成回调事件内容 |
mediaThumbnailCompleteEvent | MediaThumbnailCompleteEvent | 媒资截图完成回调事件内容 |
mediaAnalysisCompleteEvent | MediaAnalysisCompleteEvent | 媒资分析完成回调事件内容 |
mediaRegulationCompleteEvent | MediaRegulationCompleteEvent | 媒资审核完成回调事件内容 |
composeTaskStatusChangeEvent | ComposeTaskStatusChangeEvent | 视频云剪辑任务状态变更回调事件内容 |
ComposeTaskInfo
视频云剪辑任务信息
名称 | 类型 | 说明 |
---|---|---|
errMsg | string | 错误信息 |
mediaId | string | 媒资ID |
output | ComposeTaskOutput | 视频云剪辑任务输出参数 |
ComposeTaskOutput
视频云剪辑任务输出信息
名称 | 类型 | 说明 |
---|---|---|
mediaId | string | 视频云剪辑视频导入媒资库的媒资ID |
url | string | 视频云剪辑视频播放地址 |
ComposeTaskStatusChangeEvent
视频云剪辑任务状态变更回调事件内容
名称 | 类型 | 说明 |
---|---|---|
taskId | string | 任务ID |
status | string | 任务状态,SUCCESS/FAILED |
createTime | string | 任务创建时间 |
finishTime | string | 任务完成时间 |
beginProcessTime | string | 任务开始时间 |
composeTaskInfo | ComposeTaskInfo | 视频云剪辑任务信息 |
MediaAnalysisCompleteEvent
媒资AI分析完成回调事件内容
名称 | 类型 | 说明 |
---|---|---|
taskId | string | 任务ID |
status | string | 任务状态,SUCCESS/FAILED |
createTime | string | 任务创建时间 |
finishTime | string | 任务完成时间 |
beginProcessTime | string | 任务开始时间 |
analysisTaskInfo | MediaAnalysisTaskInfo | 拉取任务信息 |
MediaAnalysisTaskInfo
媒资AI分析任务信息
名称 | 类型 | 说明 |
---|---|---|
mediaId | string | 媒资ID |
errMsg | string | 错误信息 |
analysisInput | MediaAnalysisTaskInput | 分析任务输入参数 |
analysisOutput | MediAnalysisOutputInfo | 分析任务输出参数 |
MediaAnalysisTaskInput
媒资AI分析任务输入参数
名称 | 类型 | 说明 |
---|---|---|
presetId | string | AI分析模板ID |
MediAnalysisOutputInfo
媒资AI分析结果信息
名称 | 类型 | 说明 |
---|---|---|
id | string | AI分析模板ID |
results | MediaAnalysisOutputTypeResult[] | 分析场景列表 |
MediaAnalysisOutputTypeResult
媒资AI分析结果场景列表。AI分析结果一般有多个场景分类,这是一个场景结果的数据结构
名称 | 类型 | 说明 |
---|---|---|
type | string(MediaAnalysisOutputTypeEnum) | 分析场景,枚举 |
result | MediaAnalysisOutputTypeResultItem[] | 分析结果项 |
MediaAnalysisOutputTypeEnum
媒资AI分析结果的场景类型枚举
分析场景 | 描述 |
---|---|
figure | 人脸 |
keyword | 关键字 |
scenario | 场景 |
entity | 实体 |
logo | logo |
knowledge_graph | 知识图谱 |
MediaAnalysisOutputTypeResultItem
媒资AI分析结果分类中的某一个类型的结果。
名称 | 类型 | 说明 |
---|---|---|
attribute | string | 分析结果标签 |
source | string | 标签来源 |
MediaAudioCodec
媒资音频编码信息
名称 | 类型 | 说明 |
---|---|---|
codec | string | 音频编码规格 |
channels | int | 音频文件的声道信息 |
sampleRateInHz | int | 音频文件的采样率,单位:Hz |
bitRateInBps | int | 音频文件的码率,单位:bps |
MediaBasicInfo
媒资基本信息
名称 | 类型 | 说明 |
---|---|---|
mediaId | string | 媒资ID |
name | string | 媒资名称 |
description | string | 媒资描述 |
mediaType | string | 媒资类型,video/image/audio |
banStatus | string | 媒资封禁状态,NORMAL/BAN,分别表示正常/封禁状态 |
createTime | string | 创建时间 |
source | MediaSource | 媒资源信息 |
sourceMetadata | MediaSourceMetadata | 媒资源文件元信息 |
MediaBlackBorderArea
媒资视频黑边信息
名称 | 类型 | 说明 |
---|---|---|
x | int | 去黑边后的视频左偏移位置,单位:像素 |
y | int | 去黑边后的视频上偏移位置,单位:像素 |
width | int | 去黑边后的视频宽度,单位:像素 |
height | int | 去黑白后的视频高度,单位:像素 |
MediaFetchCompleteEvent
媒资拉取完成回调事件内容
名称 | 类型 | 说明 |
---|---|---|
taskId | string | 任务ID |
status | string | 任务状态,SUCCESS/FAILED |
createTime | string | 任务创建时间 |
finishTime | string | 任务完成时间 |
fetchTaskInfo | MediaFetchTaskInfo | 拉取任务信息 |
MediaFetchTaskInfo
拉取任务信息
名称 | 类型 | 说明 |
---|---|---|
errMsg | string | 错误信息 |
url | string | 拉取任务源文件地址。与拉取任务bucket/key二选一 |
bucket | string | 拉取任务源文件bucket |
key | string | 拉取任务源文件key |
coverUrl | string | 拉取任务源文件封面图地址 |
highlightProjectId | string | 拉取任务生成的媒资,需要导入的集锦项目ID |
mediaBasicInfo | MediaBasicInfo | 媒资基本信息 |
presetTaskId | string | 任务类型为模板处理的任务ID。若拉取上传时指定了媒资后续模版处理操作,当该模板处理时会生成一个新任务 |
workflowTaskId | string | 任务类型为工作流处理的任务ID。若拉取上传时指定了媒资后续工作流处理操作,当该工作流处理时会生成一个新任务 |
MediaRegulationCompleteEvent
媒资AI审核完成回调事件内容
名称 | 类型 | 说明 |
---|---|---|
taskId | string | 任务ID |
status | string | 任务状态,SUCCESS/FAILED |
createTime | string | 任务创建时间 |
finishTime | string | 任务完成时间 |
beginProcessTime | string | 任务开始转码时间 |
regulationTaskInfo | MediaRegulationTaskInfo | AI审核任务信息 |
MediaRegulationTaskInfo
AI审核任务信息
名称 | 类型 | 说明 |
---|---|---|
mediaId | string | 媒资ID |
errMsg | string | 错误信息 |
regulationInput | MediaRegulationTaskInput | AI审核任务输入信息 |
regulationOutput | MediaRegulationOutputInfo | AI审核任务输出信息 |
MediaRegulationTaskInput
AI审核任务输入信息
名称 | 类型 | 说明 |
---|---|---|
presetId | string | 审核模板ID |
MediaRegulationOutputInfo
AI审核结果信息
名称 | 类型 | 说明 |
---|---|---|
id | string | AI审核模板ID |
results | MediaRegulationOutputTypeResult[] | 审核类型结果列表 |
MediaRegulationOutputSubTypeEnum
审核结果中的subType表示”审核项”。每种审核类型下细分了不同审核项
审核场景 | 审核类型 | 审核项 | 审核项描述 |
---|---|---|---|
涉黄审核 | sexual_porn | behavior, sm, products, children, art | 性行为及露点及招嫖, SM, 性用品及性玩具, 儿童, 艺术品色情 |
涉黄审核 | sexual_sexy | male, female | 男性衣着暴露, 女性衣着暴露 |
涉黄审核 | sexual_intimacy | intimacy | 亲密行为 |
涉黄审核 | sexual_vulgar | vulgar | 低俗行为 |
涉黄审核 | sexual_special | pregnant | 孕肚裸露 |
暴恐审核 | terrorist_group | terrorist_group | 恐怖组织 |
暴恐审核 | terrorist | terrorist | 暴恐人物 |
暴恐审核 | terror_event | blood, corpse, murder, explosion, riot, weapon, police, traffic | 血腥, 尸体, 绑架及杀人, 爆炸火灾, 暴乱, 军事武器, 警察部队, 车祸 |
涉政审核 | politician | politician_positive, politician_negative, bad_artist | 涉政正面人物, 涉政负面人物, 劣迹艺人 |
涉政审核 | political_event | political_event_positive, political_event_negative | 涉政正面事件, 涉政负面事件 |
涉政审核 | political_group | political_group_positive, political_group_negative | 涉政正面组织, 涉政负面组织 |
广告审核 | ad_brand | brand | 品牌标识 |
广告审核 | ad_marketing | qrcode, contact, website, commercial, watermark | 二维码, 联系方式, 网址, 软文推广, 水印 |
广告审核 | ad_brand_negative | brand_negative_comment | 品牌负面评论 |
违禁审核 | bad_behavior | smoke, drink, bad_behavior_gamble, drug | 吸烟, 喝酒, 赌博, 毒品 |
违禁审核 | illegal_gamble | gamble | 赌博 |
违禁审核 | illegal_forgery | forgery | 假冒伪劣及造假盗窃 |
违禁审核 | illegal_trade | trade | 非法交易 |
违禁审核 | illegal_privacy | privacy | 非法获取私人信息 |
质量审核 | disgust | disgust_image | 恶心图 |
官方文本黑库 | official_text_black_lib | baidu_illegal_textlib | 违禁词库 |
官方图片黑库 | image_black_lib | default_image_black_lib | 百度云风控 |
MediaRegulationOutputTypeEnum
审核结果中的type表示”审核类型”。每类审核场景下包含着多种审核类型,不同审核类型支持的审核物料也不一样
审核场景 | 审核类型 | 描述 |
---|---|---|
涉黄审核 | sexual_porn | 色情审核 |
涉黄审核 | sexual_sexy | 性感审核 |
涉黄审核 | sexual_intimacy | 亲密行为审核 |
涉黄审核 | sexual_vulgar | 低俗行为 |
涉黄审核 | sexual_special | 特殊行为 |
暴恐审核 | terrorist_group | 暴恐组织审核 |
暴恐审核 | terrorist | 暴恐人物审核 |
暴恐审核 | terror_event | 暴力事件审核 |
涉政审核 | politician | 涉政人物审核 |
涉政审核 | political_event | 涉政事件审核 |
涉政审核 | political_group | 涉政组织审核 |
广告审核 | ad_brand | 品牌广告审核 |
广告审核 | ad_marketing | 欺诈及营销广告审核 |
广告审核 | ad_brand_negative | 品牌负面评论审核 |
违禁审核 | bad_behavior | 不良行为审核 |
违禁审核 | illegal_gamble | 赌博审核 |
违禁审核 | illegal_forgery | 假冒伪劣及造假盗窃审核 |
违禁审核 | illegal_trade | 非法交易审核 |
违禁审核 | illegal_privacy | 非法获取私人信息审核 |
质量审核 | disgust | 恶心 |
MediaRegulationOutputTypeResult
AI审核类型结果
名称 | 类型 | 说明 |
---|---|---|
type | string(MediaRegulationOutputTypeEnum) | 审核类型 |
items | MediaRegulationOutputTypeResultItem[] | 审核类型结果列表 |
MediaRegulationOutputTypeResultItem
AI审核类型结果项
名称 | 类型 | 说明 |
---|---|---|
subType | string(MediaRegulationOutputSubTypeEnum) | 审核项 |
timeInSeconds | int | 物料在视频中的秒数 |
startTimeInSeconds | int | 物料在视频中的起始秒数,和endTimeInSeconds同时存在 |
endTimeInSeconds | int | 物料在视频中的结束秒数,和startTimeInSeconds同时存在 |
confidence | double | 审核结果项的置信度,0~100的浮点数 |
label | string | 审核结果项标记 |
extra | string | 额外信息,如有;例如政治敏感人物识别出来的人名 |
evidence | MediaRegulationOutputTypeResultItemEvidence[] | 审核项证据列表 |
MediaRegulationOutputTypeResultItemEvidence
AI审核类型结果项证据
名称 | 类型 | 说明 |
---|---|---|
location | MediaRegulationOutputTypeResultItemEvidenceLocation | 证据位置信息 |
MediaRegulationOutputTypeResultItemEvidenceLocation
AI审核类型结果项证据位置信息
名称 | 类型 | 说明 |
---|---|---|
leftOffsetInPixel | int | 左偏移 |
topOffsetInPixel | int | 上偏移 |
widthInPixel | int | 宽度 |
heightInPixel | int | 高度 |
MediaSource
媒资源信息
名称 | 类型 | 说明 |
---|---|---|
sourceType | string | 媒资来源,UPLOAD/COMPOSE,分别表示上传/视频云剪辑 |
sourceUrl | string | 媒资源文件播放地址 |
coverUrl | string | 媒资封面图地址 |
MediaSourceMetadata
媒资源文件元信息
名称 | 类型 | 说明 |
---|---|---|
etag | string | 文件ETag,可用于校验文件是否被修改过 |
fileSizeInByte | int | 文件大小,单位:字节 |
type | string | 文件类型, video/audio,分别表示视频或图片/音频 |
container | string | 音视频文件的容器类型 |
durationInSecond | int | 音视频文件时长,单位:秒 |
durationInMillisecond | int | 音视频文件时长,单位:毫秒 |
video | MediaVideoCodec | 视频元信息 |
audio | MediaAudioCodec | 音频元信息 |
blackBorderArea | MediaBlackBorderArea | 视频黑边信息 |
MediaThumbnailCompleteEvent
媒资截图完成回调事件内容
名称 | 类型 | 说明 |
---|---|---|
taskId | string | 任务ID |
status | string | 任务状态,SUCCESS/FAILED |
createTime | string | 任务创建时间 |
finishTime | string | 任务完成时间 |
beginProcessTime | string | 任务开始转码时间 |
thumbnailTaskInfo | MediaThumbnailTaskInfo | 抽帧任务信息 |
MediaThumbnailTaskInfo
抽帧任务信息
名称 | 类型 | 说明 |
---|---|---|
mediaId | string | 媒资ID |
errMsg | string | 错误信息 |
thumbnailInput | MediaThumbnailTaskInput | 抽帧任务输入信息 |
thumbnailOutput | MediaThumbnailOutputInfo | 抽帧任务输出信息 |
MediaThumbnailTaskInput
抽帧任务输入信息
名称 | 类型 | 说明 |
---|---|---|
presetId | string | 抽帧模板ID |
MediaThumbnailOutputInfo
抽帧任务结果信息
名称 | 类型 | 说明 |
---|---|---|
id | string | 抽帧模板ID |
urls | string[] | 抽帧结果播放地址列表 |
MediaTranscodeCompleteEvent
媒资转码完成回调事件内容
名称 | 类型 | 说明 |
---|---|---|
taskId | string | 任务ID |
status | string | 任务状态,SUCCESS/FAILED |
createTime | string | 任务创建时间 |
finishTime | string | 任务完成时间 |
beginProcessTime | string | 任务开始转码时间 |
transcodeTaskInfo | MediaTranscodeTaskInfo | 转码任务信息 |
MediaTranscodeOutputInfo
转码结果信息
名称 | 类型 | 说明 |
---|---|---|
id | string | 转码模板ID |
url | string | 转码结果播放地址 |
meta | MediaTranscodeOutputMeta | 转码结果元信息 |
MediaTranscodeOutputMeta
转码结果元信息
名称 | 类型 | 说明 |
---|---|---|
video | MediaTranscodeOutputVideoCodec | 转码结果视频编码信息 |
audio | MediaTranscodeOutputAudioCodec | 转码结果音频编码信息 |
MediaTranscodeOutputAudioCodec
转码结果音频编码信息
名称 | 类型 | 说明 |
---|---|---|
channels | int | 音频文件的声道信息 |
sampleRateInHz | int | 音频文件的采样率,单位:Hz |
MediaTranscodeOutputVideoCodec
转码结果视频编码信息
名称 | 类型 | 说明 |
---|---|---|
durationInSeconds | int | 音视频文件时长,单位:秒 |
durationInMilliSeconds | int | 音视频文件时长,单位:毫秒 |
sizeInKiloByte | double | 音视频文件大小,单位:KB |
widthInPixel | int | 视频宽度 |
heightInPixel | int | 视频高度 |
frameRate | int | 视频媒体的帧率 |
gopAlign | bool | 是否开启gop对齐 |
mp4MoovSize | int | mp4文件moov块大小,单位:Byte |
MediaTranscodeTaskInfo
转码任务信息
名称 | 类型 | 说明 |
---|---|---|
mediaId | string | 媒资ID |
errMsg | string | 错误信息 |
transcodeInput | MediaTranscodeTaskInput | 转码任务输入信息 |
transcodeOutput | MediaTranscodeOutputInfo | 转码任务输出信息 |
MediaTranscodeTaskInput
转码任务输入信息
名称 | 类型 | 说明 |
---|---|---|
presetId | string | 转码模板ID |
watermarkIds | string[] | 明水印ID列表 |
MediaUploadCompleteEvent
媒资上传完成回调事件内容,结构与MediaBasicInfo一致
MediaVideoCodec
媒资视频编码信息
名称 | 类型 | 说明 |
---|---|---|
codec | string | 视频文件的编码规格 |
heightInPixel | int | 视频高度 |
widthInPixel | int | 视频宽度 |
bitRateInBps | int | 视频媒体的码率 |
frameRate | int | 视频媒体的帧率 |
rotate | int | 旋转角度(部分视频包含该参数) |
dar | string | 视频显示宽高比,如 "16:9" (部分视频包含该参数) |