视频监控

  • 视频监控 > API Reference > 模板管理相关接口 >创建模板

    创建模板

    最近更新时间:2020-05-06 15:31:33

    描述

    本接口用于创建新的模版。

    • 接口请求域名:qvs.qiniuapi.com
    • 请求方式:POST
    • 接口路径:/v1/templates

    请求参数

    Body

    参数名称 必填 字段类型 说明
    name string 模版名称,格式为 1 ~ 100个字符,可包含小写字母、数字、中划线
    desc string 模版描述
    bucket string 模版对应的对象存储的bucket
    deleteAfterDays integer 存储过期时间,默认永久不过期
    fileType integer 文件存储类型,取值:0(普通存储),1(低频存储)
    recordFileFormat integer 录制文件存储格式,取值:0(m3u8格式存储)
    templateType integer 模板类型,取值:0(录制模版), 1(截图模版)
    recordType templateType为0时必须 integer 录制模式, 0(不录制),1(实时录制)
    jpgOverwriteStatus templateType为1时须指定 boolean 开启覆盖式截图(一般用于流封面)
    jpgSequenceStatus templateType为1时须指定 boolean 开启序列式截图
    jpgOnDemandStatus templateType为1时须指定 boolean 开启按需截图
    recordInterval integer 录制文件时长 单位为秒,600~3600
    snapInterval integer 截图间隔, 单位为秒, 10~600

    说明:当templateType为1时,jpgOverwriteStatus,jpgSequenceStatus,jpgOnDemandStatus三个参数至少指定一项

    响应参数

    参数名称 类型 说明
    name string 模版名称
    desc string 模版描述
    bucket string 模版对应的对象存储的bucket
    deleteAfterDays integer 存储过期时间,默认永久不过期
    fileType integer 文件存储类型,取值:0(普通存储),1(低频存储)
    recordFileFormat integer 录制文件存储格式,取值:0(ts格式存储)
    templateType integer 模板类型,取值:0(录制模版), 1(截图模版)
    recordType integer 录制模式, 0(不录制),1(实时录制)
    jpgOverwriteStatus boolean 开启覆盖式截图(一般用于流封面)
    jpgSequenceStatus boolean 开启序列式截图
    jpgOnDemandStatus boolean 开启按需截图
    tsFileNameTemplate string ts文件命名格式
    m3u8FileNameTemplate string m3u8文件命名格式
    jpgOverwriteFileNameTemplate string 覆盖式截图文件命名格式
    jpgSequenceFileNameTemplate string 序列式截图文件命名格式
    recordInterval integer 录制文件时长(单位为秒)
    snapInterval integer 截图间隔(单位为秒)
    createdAt integer 模板创建时间
    updatedAt integer 模板更新时间

    示例

    请求示例

    curl --request POST \
      --url http://qvs.qiniuapi.com/v1/templates \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
      --header 'content-type: application/json' \
      --data '{
        "name":"test0013",
        "desc":"this is a test",
        "delateAfterDays":6,
        "interval":5,
        "templateType":1,
        "bucket":"bucket-test1",
        "jpgOverwriteStatus": true,
      "jpgSequenceStatus": true,
      "jpgOnDemandStatus": true
    }'
    

    响应示例

    {
      "id": "2akrars59hm2l",
      "name": "test0013",
      "desc": "this is a test",
      "bucket": "bucket-test1",
      "deleteAfterDays": 0,
      "templateType": 1,
      "fileType": 0,
      "recordType": 0,
      "recordFileFormat": 0,
      "jpgOverwriteStatus": true,
      "jpgSequenceStatus": true,
      "jpgOnDemandStatus": true,
      "jpgOverwriteFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}.jpg",
      "jpgSequenceFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}/${startMs}.jpg",
      "jpgOnDemandFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}/ondemand/${startMs}.jpg",
      "snapInterval": 10,
      "createdAt": 1586847620,
      "updatedAt": 1586847620
    }
    
    以上内容是否对您有帮助?
  • Icon free helper
    Close