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

文档中心

立即注册

导航

下载本地录像文件V3

最近更新时间：2025.02.14 16:31:52首次发布时间：2025.02.14 16:31:52

下载本地录像文件

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DownloadLocalMedia`	接口名称。当前 API 的名称为 `DownloadLocalMedia`。
Version	String	是	`2023-10-01`	接口版本。当前 API 的版本为 `2023-10-01`。

Body

参数	类型	是否必选	示例值	描述
StreamID	String	是	`254c804d-0169-4b58-8209-2f17f6xxxxxx`	通道 ID，可通过调用 ListStreams 接口获取
StartTime	Integer	是	`1686153600`	查询起始时间，秒级时间戳，例如：1686153600 注：查询起始和结束时间不能超过对应的设备存储卡存储的时间，可通过调用 GetRecordListV2 接口获取本地回放列表，选择有回放片段的时间开始下载
EndTime	Integer	是	`1686182400`	查询结束时间，秒级时间戳，例如：1686182400
MediaProcess	Object of MediaProcess	是		对下载的录像文件进行媒体处理的选项（Version的值必须指定为2）；详细信息，参考以下 MediaProcess 结构说明
Version	String	是	`2`	填2即可
Expire	Integer	否	`3600`	过期时间，单位秒，默认180天

MediaProcess

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

Subtitle

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

M3U8Option

参数	类型	是否必选	示例值	描述
ToMp4	Boolean	是	`true`	水印视频是否转MP4，默认转

SubtitleList

参数	类型	是否必选	示例值	描述
StartTime	Integer	否		水印开始时间，以视频开头为基准的相对时间，单位：毫秒
EndTime	Integer	否	`5000`	水印结束时间，以视频开头为基准的相对时间，单位：毫秒
Content	String	否	`水印文字`	水印文字
Font	Object of Font	是

Font

参数	类型	是否必选	示例值	描述
FontSize	Integer	是	`18`
Alignment	String	是	`6`

返回参数

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

参数	类型	示例值	描述
DownloadID	String	`524c804d-0149-4b58-8209-2f17f6xxxxxx`	524c804d-0149-4b58-8209-2f17f6xxxxxx

请求示例

POST https://open.volcengineapi.com?Action=DownloadLocalMedia&Version=2023-10-01
{
  "StreamID": "254c804d-0169-4b58-8209-2f17f6xxxxxx",
  "StartTime": 1686153600,
  "EndTime": 1686182400,
  "MediaProcess": {
    "Subtitle": {
      "SubtitleList": [
        {
          "StartTime": 215,
          "Content": "水印文字",
          "EndTime": 5000
        }
      ],
      "Font": {
        "FontSize": 18,
        "Alignment": "6"
      },
      "SubtitleSrc": "间年名算种元"
    },
    "M3U8Option": {
      "ToMp4": true
    }
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "DownloadLocalMedia",
    "Version": "2023-10-01",
    "Service": "aiotvideo",
    "Region": "cn-north-1"
  },
  "Result": {
    "DownloadID": "524c804d-0149-4b58-8209-2f17f6xxxxxx"
  }
}

错误码

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