查询媒体帧标签

最近更新时间:2022-03-23 17:12:33

我的收藏

接口描述

接口名称:/Material/DescribeMaterialFrameTag
接口功能:查询媒体帧标签。

调用方式

具体调用方式参见 客户端 API 调用方式综述,您也可以使用 CME 客户端 API 调试工具 快速进行调试。

输入参数

字段
类型
必填
描述
MaterialId
String
媒体 ID。
StartTimeOffset
Float
需要返回记录的起始偏移时间,单位:秒。
EndTimeOffset
Float
需要返回记录的结束偏移时间,单位:秒。
OnlyManual
bool
是否仅人工标签。

输出参数

接口输出参数由 公共返回参数 和接口自身返回参数两部分组成。接口自身返回参数详情如下。
字段
类型
描述
FrameTagInfo
帧标签信息。

示例

示例1:查询媒体帧标签成功

查询媒体 ID 为38192156030633420589帧标签,返回帧标签信息。

输入示例

{
"MaterialId": "38192156030633420589",
"StartTimeOffset": 0.0,
"EndTimeOffset": 100.0
}

输出示例

{
"Code": "Success",
"Message": "成功",
"EnglishMessage": "success",
"Data": {
"FrameTagInfo": {
"Version": "manual",
"FrameTagSet": [
{
"ItemId": "5fd977677a23b40001ca3aff",
"StartTimeOffset": 1.0,
"EndTimeOffset": 2.0,
"Tags": [
"游戏"
]
},
{
"ItemId": "5fd977677a23b40001ca4aff",
"StartTimeOffset": 3.0,
"EndTimeOffset": 5.0,
"Tags": [
"游戏"
]
}
],
"LastTimeOffset": 5.0
}
}
}

示例2:查询媒体帧标签失败

查询媒体 ID 为38192156030633420589帧标签,返回失败。

输入示例

{
"MaterialId": "38192156030633420589",
"StartTimeOffset": 0.0,
"EndTimeOffset": 100.0
}

输出示例

{
"Code": "ResourceNotFound",
"Message": "资源不存在",
"EnglishMessage": "resource not found : no frameTag index"
}