You need to enable JavaScript to run this app.
导航

查询可下载的本地录像文件

最近更新时间2023.08.01 17:13:45

首次发布时间2023.08.01 17:13:45

查询可下载的本地录像文件列表。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考「公共参数」。

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称GetLocalDownload
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01
IDQueryString开始上传返回的 ID可通过调用 LocalMediaDownload 接口获取

返回结果

返回参数说明

通用返回参数,请参考 ResponseMetadata 结构体说明

Result 字段包含以下参数:

字段
类型
说明
GBMediasArray of objects可下载的设备本地录像文件列表;详细信息,参考以下 GBMedias 结构说明

GBMedias 结构说明

字段
类型
说明
IDString录像文件 ID
StartTimeInt64录像开始时间,Unix 时间戳,单位:秒
EndTimeInt64录像结束时间,Unix 时间戳,单位:秒
CallIDString本地录像请求的 ID

Status

String

录像文件状态:

  • init

  • uploaded

  • done

  • error

UrlString原始视频的 hls 直播地址
SubtitleUrlString直播水印地址(当调用 LocalMediaDownload 接口时,设置了 M3U8Option,并且 ToMp4 设置为 true,转换完成后会替换为水印视频的 mp4 地址)
FileSizeInt64录像文件大小
MsgString发生错误时(status 为 error 时),返回错误信息
FileStreamLengthString录像文件时长,单位:毫秒
FileNameString录像文件名称

示例

请求示例

POST https://open.volcengineapi.com?Action=LocalMediaDownload
&Version=2021-01-01
&ID=a2d6ca94-334b-4f81-b89c-02d381xxxxxx
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202208101633120102250990080808695F",
        "Action": "LocalMediaDownload",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    }
        "Result": {
            "PageNumber":  
            "PageSize": 
            "TotalCount": 
            "GBMedias":[{
                "ID": "",
                "StartTime": 1686153600,     
                "EndTime": 1686182400,   
                "CallID": "",   
                "Status": "done",
                "Url": "",
                "SubtitleUrl": "",
                "FileSize": 1200,
                "Msg": "",
                "FileStreamLength": 23000, 
                "FileName": "file01"     
            }
        ]
    }
}