下载本地录像文件--慢直播-火山引擎

文档中心

立即注册

导航

下载本地录像文件

最近更新时间：2023.08.01 17:13:45首次发布时间：2023.08.01 17:13:45

开始下载设备本地录像文件。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	LocalMediaDownload
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
SpaceID	Query	String	是	空间 ID	可通过调用 ListSpaces 接口获取

Body 参数

字段	类型	必填	说明
DeviceNSID	String	是	设备国标 ID，可通过调用 ListDevices 接口获取
ChannelID	String	是	通道 ID，可通过调用 ListStreams 接口获取
StartTime	Int64	是	查询起始时间，秒级时间戳，例如：1686153600 注：查询起始和结束时间不能超过对应的设备存储卡存储的时间，可通过调用 GetRecordListV2 接口获取本地回放列表，选择有回放片段的时间开始下载
EndTime	Int64	是	查询结束时间，秒级时间戳，例如：1686182400
Version	String	是	接口功能版本： 2（支持 MediaProcess，对下载的录像文件进行水印和转换处理）
MediaProcess	Object	否	对下载的录像文件进行媒体处理的选项（Version的值必须指定为2）；详细信息，参考以下 MediaProcess 结构说明

MediaProcess 结构说明

字段	类型	必填	说明
Subtitle	Object	否	对下载的录像文件进行水印处理的选项；详细信息，参考以下 Subtitle 结构说明
M3U8Option	Object	否	对下载的录像文件进行转换处理的选项；详细信息，参考以下 M3U8Option 结构说明

Subtitle 结构说明

字段	类型	必填	说明
SubtitleList	Array of objects	否	水印设置列表，与 SubtitleSrc 二选一；详细信息，参考以下 SubtitleList 结构说明
SubtitleSrc	String	否	水印设置文件地址，与 SubtitleList 二选一；文件内容格式，参考以下 SubtitleSrc 格式示例
Font	Object	否	水印字体样式；详细信息，参考以下 Font 结构说明

SubtitleList 结构说明

字段	类型	必填	说明
Start	Int	是	水印开始时间，以视频开头为基准的相对时间，单位：毫秒
End	Int	是	水印结束时间，以视频开头为基准的相对时间，单位：毫秒
Content	String	是	水印文字

SubtitleSrc 格式示例

1
00:00:00,000 --> 00:00:05,000
Hello? (3-5s)

2
00:00:05,000 --> 00:00:13,000
Yes, this is a subtitle. Don't
you like it? (8-13s)

3
00:00:13,826 --> 00:01:02,886
Uh? What are you talking about?
I don't understand (18-62s)

Font 结构说明

字段	类型	必填	说明
FontSize	Int	否	文字大小，默认值：16
PrimaryColor	String	否	文字颜色，可指定对应颜色的值，默认：黑底白字
Alignment	String	否	文字位置，默认值：2（底部居中），可选项包括： 1（Bottom Left，底部靠左） 2（Bottom Center，底部居中） 3（Bottom Right，底部靠右） 5（Top Left，顶部靠左） 6（Top Center，顶部居中） 7（Top Right，顶部靠右） 9（Middle Left，中间靠左） 10（Middle Center，中间居中） 11（Middle Right，中间靠右）

字段

类型

必填

说明

FontSize

Int

否

文字大小，默认值：16

PrimaryColor

String

否

文字颜色，可指定对应颜色的值，默认：黑底白字

Alignment

String

否

文字位置，默认值：2（底部居中），可选项包括：

1（Bottom Left，底部靠左）
2（Bottom Center，底部居中）
3（Bottom Right，底部靠右）
5（Top Left，顶部靠左）
6（Top Center，顶部居中）
7（Top Right，顶部靠右）
9（Middle Left，中间靠左）
10（Middle Center，中间居中）
11（Middle Right，中间靠右）

M3U8Option 结构说明

字段	类型	必填	说明
ToMp4	Boolean	是	是否将水印录像转换为 MP4 格式： true（转换） false（不转换）

字段

类型

必填

说明

ToMp4

Boolean

是

是否将水印录像转换为 MP4 格式：

true（转换）
false（不转换）

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
Result	Boolean	录像文件下载结果： true（成功） false（失败）
ID	String	下载录像文件唯一 ID，可用于查询生成的地址

字段

类型

说明

Result

Boolean

录像文件下载结果：

true（成功）
false（失败）

String

下载录像文件唯一 ID，可用于查询生成的地址

示例

请求示例

POST https://open.volcengineapi.com?Action=LocalMediaDownload
&Version=2021-01-01
&SpaceID=a2d6ca94-334b-4f81-b89c-02d381xxxxxx
&<公共请求参数>
{
    "DeviceNSID": "340200379911xxxxxxxx",
    "ChannelID": "340200000013xxxxxxxx",
    "StartTime": 1686153600,
    "EndTime": 1686182400,
    "Version": "2",
    "MediaProcess"
    "MediaProcess": {
        "Subtitle":{
            "SubtitleList": [
                {
                    "Start": 00:00:00,000,
                    "End": 00:00:05,000,
                    "Content": "水印文字"
                }
            ],
            "Font": {
                "FontSize": 18,
                "Alignment": "6"
            }
        },
        "M3U8Option": {
            "ToMp4": true
        }
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202208101633120102250990080808695F",
        "Action": "LocalMediaDownload",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    }
    "Result": {
        "Result": true,
        "ID": "524c804d-0149-4b58-8209-2f17f6xxxxxx"
    }
}