获取转码结果--视频点播-火山引擎

文档中心

立即注册

导航

获取转码结果

最近更新时间：2024.10.08 19:55:20首次发布时间：2022.06.27 21:04:56

此接口用于指定视频 Vid 、预期获取结果类型 ResultType 参数，获取转码结果。

请求说明

请求方式：GET
请求地址：https://vod.volcengineapi.com?Action=RetrieveTranscodeResult&Version=2020-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`RetrieveTranscodeResult`	接口名称。当前 API 的名称为 `RetrieveTranscodeResult`。
Version	String	是	`2020-08-01`	接口版本。当前 API 的版本为 `2020-08-01`。
Vid	String	是	`v0c2dfg7007***212h1nscckh79h0`	视频 ID。音视频上传后，获取的方式如下：通过 GetMediaList 接口查询音视频 Vid。如果设置了媒资上传完成的回调事件，会在 FileUploadComplete 中返回 `Vid` 的值。
ResultType	String	是	`inspection`	预期获取的结果类型。取值如下： `inspection`：片源检测结果。 `category_tags`：视频分类结果。说明支持多选，则以 `,` 分隔，例如 `inspection,category_tags`。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Vid	String	`v0c2dfg7007***212h1nscckh79h0`	视频 ID。
Inspection	Object	`-`	片源检测结果。
Quality	Object	`-`	视频检测质量。说明若无，则为空。
Visual	Object	`-`	片源检测参数。
VQScore	Double	`55.56`	画质检测-VQScore 视频质量评分，取值范围为 [0,100]。
Contrast	Double	`90.38`	对比度，取值范围为 [0,100]。
Colorfulness	Double	`67.17`	色彩，取值范围为 [0,100]。
Brightness	Double	`134.03`	亮度，取值范围为 [0,100]。
Texture	Double	`12.04`	纹理，取值范围为 [0,100]。
Noise	Double	`86`	噪声，取值范围为 [0,100]。
VolumeInfo	Object	`-`	音量。
Loudness	Double	`-37.5`	响度。单位为 LUFS。
Peak	Double	`0.0912`	峰值。取值范围为（0, 1.0]，峰值归一化。
MeanVolume	Double	`-40.8`	均值。单位为 dB。
MaxVolume	Double	`-20.8`	最大值。单位为 dB。
DeLogo	Object[]	`-`	水印检测结果。说明若无，则为 []。
AnchorWidth	Integer	`671`	Anchor 基准宽度，单位为 px。
AnchorHeight	Integer	`893`	Anchor 基准高度，单位为 px。
PosX	Integer	`462`	水印左上角 X 坐标，单位为 px。
PosY	Integer	`654`	水印左上角 Y 坐标，单位为 px。
SizeX	Integer	`601`	水印宽度，单位为 px。
SizeY	Integer	`451`	水印高度，单位为 px。
CategoryTags	Object[]	`-`	视频分类结果。说明视频点播系统自定义的分类标准。若无，则为 []。
TagId	Integer	`10101`	标签 ID。
Prob	Double	`0.022`	置信度即视频分类结果返回的概率，取值范围为 [0,1]。
TagName	String	`军事`	标签名称。
Level	Integer	`3`	标签分类。取值如下： `1`：一级分类 `2`：二级分类 `3`：三级分类
ParentInfo	JSONMap	`{"01":"转码任务"}`	父节点标签信息。格式为 `"key":"value"`。 "key" 为 String 类型，父分类级别。 "value" 为 String 类型，父分类内容。

请求示例

GET https://vod.volcengineapi.com?Action=RetrieveTranscodeResult&Version=2020-08-01&Vid=v0c2dfg7007***212h1nscckh79h0&ResultType=inspection

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220612154735010225243125076AA124",
        "Action": "RetrieveTranscodeResult",
        "Version": "2020-08-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Vid": "v0c2dfg7007acafl9212h1nscckh79h0",
        "Inspection": {
            "Quality": {
                "Visual": {
                    "VQScore": 55.56,
                    "Contrast": 90.38,
                    "Colorfulness": 67.17,
                    "Brightness": 134.03,
                    "Texture": 12.04,
                    "Noise": 86
                },
                "VolumeInfo": {
                    "Loudness": -37.5,
                    "Peak": 0.0912,
                    "MeanVolume": -40.8,
                    "MaxVolume": -20.8
                }
            },
            "DeLogo": []
        },
        "CategoryTags": [
            {
                "TagId": 10101,
                "Prob": 0.022,
                "TagName": "军事",
                "Level": 3,
                "ParentInfo": {
                    "1": "社会",
                    "2": "政务"
                }
            },
            {
                "TagId": 10101,
                "Prob": 0.022,
                "TagName": "军事",
                "Level": 3,
                "ParentInfo": {
                    "1": "社会",
                    "2": "政务"
                }
            },
            {
                "TagId": 10101,
                "Prob": 0.022,
                "TagName": "军事",
                "Level": 3,
                "ParentInfo": {
                    "1": "社会",
                    "2": "政务"
                }
            }
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：