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

文档中心

导航

下载本地录像文件

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

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

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=LocalMediaDownload&Version=2021-01-01

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

参数	类型	是否必选	示例值	描述
Action	String	是	`LocalMediaDownload`	接口名称。当前 API 的名称为 `LocalMediaDownload`。
Version	String	是	`2021-01-01`	接口版本。当前 API 的版本为 `2021-01-01`。
SpaceID	String	是	`a2d6ca94-334b-4f81-b89c-02d381xxxxxx`	空间 ID，可通过调用 ListSpaces 接口获取

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

参数	类型	是否必选	示例值	描述
M3U8Option	Object of M3U8Option	否	`-`	对下载的录像文件进行转换处理的选项；详细信息，参考以下 M3U8Option 结构说明
Subtitle	Object of Subtitle	否	`-`	对下载的录像文件进行水印处理的选项；详细信息，参考以下 Subtitle 结构说明

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
ToMp4	Boolean	否	`true`	是否将水印录像转换为 MP4 格式： true（转换） false（不转换）

ToMp4

Boolean

否

true

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

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

参数类型是否必选示例值描述

FontSize Integer 否 18 文字大小，默认值：16

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

参数	类型	是否必选	示例值	描述
FontSize	Integer	否	`18`	文字大小，默认值：16
PrimaryColor	String	否		文字颜色，可指定对应颜色的值，默认：黑底白字
Alignment	String	否	`6`	文字位置，默认值：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，中间靠右）

Alignment

String

否

6

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

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

参数	类型	示例值	描述
ID	String	`524c804d-0149-4b58-8209-2f17f6xxxxxx`	下载录像文件唯一 ID，可调用GetLocalDownload查询生成的地址，对应回调事件gb_media中的StreamID

您可访问公共错误码，获取更多错误码信息。