模板接口

录制模板接口

此接口用于配置直播过程中视频录制功能的参数集合。通过录制模板可以配置录制视频的存储模式,存储到BOS或存储到VOD、录制视频格式(MP4/M3U8)、单个录制文件时长等。

目前API仅支持查询指定录制模板和查询模板列表接口,用户如需新建录制模板,请在控制台创建,参见录制模板

查询录制模板

接口描述

查询用户指定录制模板的详情。

请求语法

GET /v{version}/recording/{name} HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: {bce-authorization-string}

请求头域

无特殊Header参数

请求参数

请求示例

GET /v5/recording/demo_recording HTTP/1.1

响应头域

无特殊Header参数

响应参数

参数 类型 描述
name String 录制模板名称
description String 录制模板描述
bos Object 录制到BOS的配置信息,与“录制到VOD”互斥
+ bucket String 录制文件存储的bos bucket名称
+ region String 录制文件存储的bos bucket区域
vod Object 录制到VOD的配置信息,与“录制到BOS”互斥
+ enabled Boolean 是否录制到VOD
format String 录制文件格式。录制到BOS时,有效值:mp4、m3u8,默认值:mp4;录制到VOD时,有效值:m3u8
pattern String 录制文件名模式
periodInMinute Number 单个录制文件时长,1~360分钟
createTime Date 录制模板创建时间

响应示例

HTTP/1.1 200 OK

{
    "name": "lss_demo_recording",
    "createTime": "2016-03-10T08:13:15Z",
    "description": "api_recording_test",
    "bos": {
        "bucket": "live-bucket",
        "region": "bj"
    },
    "format": "m3u8",
    "periodInMinute": 60
}

录制模板列表

接口描述

查询用户已创建的所有录制模板详情。

请求语法

GET /v{version}/recording HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: {bce-authorization-string}

请求头域

无特殊Header参数

请求参数

请求示例

GET /v5/recording HTTP/1.1

响应头域

无特殊Header参数

响应参数

参数 类型 描述
recordings Array 录制模板列表
+ name String 录制模板名称
+ description String 录制模板描述
+ bos Object 录制到BOS的配置信息,与“录制到VOD”互斥
++ bucket String 录制文件存储的bos bucket名称
++ region String 录制文件存储的bos bucket区域
+vod Object 录制到VOD的配置信息,与“录制到BOS”互斥
++ enabled Boolean 是否录制到VOD
+format String 录制文件格式。录制到BOS时,有效值:mp4、m3u8,默认值:mp4;录制到VOD时,有效值:m3u8
+ pattern String 录制文件名模式
+ periodInMinute Number 单个录制文件时长
+ createTime Date 录制模板创建时间
  • 响应示例:
HTTP/1.1 200 OK

{
    "recordings": [
        {
            "name": "lss_api_recordingdemo01",
            "createTime": "2016-03-10T08:13:15Z",
            "description": "api_recording_test",
            "bos": {
                "bucket": "live-bucket",
                "region": "bj"
            },
            "format": "m3u8",
            "periodInMinute": 10
        },
        {
            "name": "lss_api_recordingdemo02",
            "createTime": "2016-03-10T08:13:15Z",
            "description": "api_recording_test",
            "bos": {
                "bucket": "live-bucket",
                "region": "gz"
            },
            "format": "m3u8",
            "periodInMinute": 10
        },    
    ]
}

水印模板接口

在直播过程中,可以通过水印模板接口对输出视频添加水印,水印模版中定义水印的详细参数集合用于完成水印添加,包括水印类型(图片、时间戳)、水印大小、位置等。

创建图片水印模板

通过定义水印的详细参数集合(大小、位置等)来创建图片水印模板。

请求语法

POST /v<version>/watermark/image HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

参数 类型 描述 是否必须
name String 水印名称
content String 图片文件base64编码后字符串
size Object 水印尺寸
+maxWidthInPixel Number 水印最大宽度,size子参数。有效值:[10-4096]间的偶数。不设置时,如果设置了最大高度则会根据原始图片宽高比计算水印宽度,否则和原始图片宽度保持一致
+maxHeightInPixel Number 水印最大高度,size子参数。有效值:[10-3072]间的偶数。不设置时,如果设置了最大宽度则会根据原始图片宽高比计算水印高度,否则和原始图片高度保持一致
+sizingPolicy String 水印的尺寸伸缩策略,size子参数。有效值:keep
position Object 水印位置
+verticalAlignment String 垂直对齐,position子参数。可选值:top、center、bottom,默认值:top
+horizontalAlignment String 水平对齐,position子参数。可选值:left、center、right,默认值:left
+verticalOffsetInPixel Number 垂直偏移量,position子参数,与verticalAlignment配合,仅当verticalAlignment设置为topbottom时有效。单位:像素,有效值:[0-3072],默认值:10
+horizontalOffsetInPixel Number 水平偏移量,position子参数,与horizontalAlignment配合,仅当horizontalAlignment设置为leftright时有效。单位:像素,有效值:[0-4096],默认值:10

请求示例

POST /v5/watermark/image HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: bce-auth-v1/e8e4a9ced6794355a9a1b8a20b58d37b/2015-07-03T09:28:13Z/1800/content-type;host/4a1692dc4bab84f5801f79ea0c1fece3601cf73ecd94409d2a94b3942b971715

{
    "name": "demo_watermark",
    "content": "<demo_watermark_content>"
    "size": {
         "maxWidthInPixel": 200,
         "maxHeightInPixel": 200,
         "sizingPolicy": "keep"
    "position": {
         "verticalAlignment": "top",
         "horizontalAlignment": "left",
         "verticalOffsetInPixel": 10,
         "horizontalOffsetInPixel": 10
    },
}

响应头域

无特殊响应头域。

响应参数

N/A

响应示例

HTTP/1.1 200 OK

查询图片水印

通过指定水印名称查询特定图片水印的详细信息,包括图片URL、大小、位置、创建时间等。

请求语法

GET /v<version>/watermark/image/<name> HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

参数 类型 描述 是否必须
name String 水印名称

请求示例

GET /v5/watermark/image/demo_watermark HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: bce-auth-v1/e8e4a9ced6794355a9a1b8a20b58d37b/2015-07-03T09:28:13Z/1800/content-type;host/4a1692dc4bab84f5801f79ea0c1fece3601cf73ecd94409d2a94b3942b971715

响应头域

无特殊响应头域。

响应参数

参数 类型 描述
name String 水印名称
imageUrl String 存于BOS Bucket中的图片文件URL
size Object 水印尺寸
+maxWidthInPixel Number 水印最大宽度,size子参数
+maxHeightInPixel Number 水印最大高度,size子参数
+sizingPolicy String 水印的尺寸伸缩策略,size子参数
position Object 水印位置
+verticalAlignment String 垂直对齐,position子参数
+horizontalAlignment String 水平对齐,position子参数
+verticalOffsetInPixel Number 垂直偏移量,position子参数,与verticalAlignment配合,仅当verticalAlignment设置为topbottom时有效。单位:像素
+horizontalOffsetInPixel Number 水平偏移量,position子参数,与horizontalAlignment配合,仅当horizontalAlignment设置为leftright时有效。单位:像素
createTime Date 水印模板创建时间

响应示例

{
    "success": true,
    "result" : {
        "name": "demo_image_watermark",
        "imageUrl": "http://lss-watermarks.bos.bce.baidu.com/wmk-gdwmcbvs7f1igmjs.jpg"
        "size": {
            "maxWidthInPixel": 200,
            "maxHeightInPixel": 200,
            "sizingPolicy": "keep"
       },
       "position": {
            "verticalAlignment": "top",
            "horizontalAlignment": "left",
            "verticalOffsetInPixel": 10,
            "horizontalOffsetInPixel": 10
        },
       "createTime": "2016-04-22T12:51:34Z"
    }
}

查询图片水印列表

查询用户的所有图片水印模板的详细信息。

请求语法

GET /v<version>/watermark/image HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

N/A

请求示例

GET /v5/watermark/image HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: bce-auth-v1/e8e4a9ced6794355a9a1b8a20b58d37b/2015-07-03T09:28:13Z/1800/content-type;host/4a1692dc4bab84f5801f79ea0c1fece3601cf73ecd94409d2a94b3942b971715

响应头域

无特殊响应头域。

响应参数

参数 类型 描述
watermarks Array 水印模板列表
+name String 水印名称
+imageUrl String 存于BOS Bucket中的图片文件URL
+size Object 水印尺寸
++maxWidthInPixel Number 水印最大宽度,size子参数
++maxHeightInPixel Number 水印最大高度,size子参数
++sizingPolicy String 水印的尺寸伸缩策略,size子参数
+position Object 水印位置
++verticalAlignment String 垂直对齐,position子参数
++horizontalAlignment String 水平对齐,position子参数
++verticalOffsetInPixel Number 垂直偏移量,position子参数,与verticalAlignment配合,仅当verticalAlignment设置为topbottom时有效。单位:像素
++horizontalOffsetInPixel Number 水平偏移量,position子参数,与horizontalAlignment配合,仅当horizontalAlignment设置为leftright时有效。单位:像素
+createTime Date 水印模板创建时间

响应示例

{
    "success": true,
    "page": {
        "orderBy": "id",
        "order" : "desc",
        "pageNo" : 1,
        "pageSize" : 20,
        "totalCount" : 2,
        "result" : [     
            {   
                "name": "demo_image_watermark",
                "imageUrl": "http://lss-watermarks.bos.bce.baidu.com/wmk-gdwmcbvs7f1igmjs.jpg"
                "size": {
                    "maxWidthInPixel": 200,
                    "maxHeightInPixel": 200,
                    "sizingPolicy": "keep"
            },
                "position": {
                    "verticalAlignment": "top",
                    "horizontalAlignment": "left",
                    "verticalOffsetInPixel": 10,
                    "horizontalOffsetInPixel": 10
                },
            "createTime": "2016-04-22T12:51:34Z" 
            },
            {   
                "name": "demo_image_watermark_2",
                "imageUrl": "http://lss-watermarks.bos.bce.baidu.com/wmk-gdwmcbvs7f1igmjs.jpg"
                "size": {
                    "maxWidthInPixel": 200,
                    "maxHeightInPixel": 200,
                    "sizingPolicy": "keep"
            },
                "position": {
                    "verticalAlignment": "top",
                    "horizontalAlignment": "left",
                    "verticalOffsetInPixel": 10,
                    "horizontalOffsetInPixel": 10
                },
            "createTime": "2016-04-22T12:51:34Z" 
            },   
        ]
    }
}

删除图片水印

通过指定水印名称删除特定图片水印模板。

请求语法

DELETE /v<version>/watermark/image/<name> HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

参数 类型 描述 是否必须
name String 水印名称

请求示例

DELETE /v5/watermark/image/{name} HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: bce-auth-v1/e8e4a9ced6794355a9a1b8a20b58d37b/2015-07-03T09:28:13Z/1800/content-type;host/4a1692dc4bab84f5801f79ea0c1fece3601cf73ecd94409d2a94b3942b971715

响应头域

无特殊响应头域。

响应参数

N/A

响应示例

HTTP/1.1 200 OK

创建时间戳水印

通过定义水印的详细参数集合(时区、文字、背景、位置等)来创建时间戳水印模板。

请求语法

POST /v<version>/watermark/timestamp HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

参数 类型 描述 是否必须
name String 水印名称
timezone String 时区。有效值:UTC、CST,默认值:CST
alpha String 水印透明度。有效值:[0-1]间的小数,小数点后最多保留两位,0表示完全透明,1表示完全不透明
font Object 水印文字
+family String 文字字体,font子参数。有效值:Arial
+sizeInPoint Number 文字大小,font子参数。有效值:[1-72],默认值:16
+color String 文字颜色,font子参数。有效值:#开头的十六进制颜色代码,默认值:#FFFFFF
background Object 水印背景
+color String 背景颜色,background子参数。有效值:#开头的十六进制颜色代码,默认值:#000000
position Object 水印位置
+verticalAlignment String 垂直对齐,position子参数。可选值:top、center、bottom,默认值:top
+horizontalAlignment String 水平对齐,position子参数。可选值:left、center、right,默认值:left
+verticalOffsetInPixel Number 垂直偏移量,position子参数,与verticalAlignment配合,仅当verticalAlignment设置为topbottom时有效。单位:像素,有效值:[0-3072],默认值:10
+horizontalOffsetInPixel Number 水平偏移量,position子参数,与horizontalAlignment配合,仅当horizontalAlignment设置为leftright时有效。单位:像素,有效值:[0-4096],默认值:10

请求示例

POST /v5/watermark/timestamp HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: bce-auth-v1/e8e4a9ced6794355a9a1b8a20b58d37b/2015-07-03T09:28:13Z/1800/content-type;host/4a1692dc4bab84f5801f79ea0c1fece3601cf73ecd94409d2a94b3942b971715

{
    "name": "demo_timestamp_watermark",
    "timezone": "CST",
    "alpha": 1
    "font": {
        "family": "Arial",
        "sizeInPoint": 16,
        "color": "#FFFFFFF"
    },
    "background": {
        "color": "#000000"
    }
    "position": {
         "verticalAlignment": "top",
         "horizontalAlignment": "left",
         "verticalOffsetInPixel": 10
         "horizontalOffsetInPixel": 10
    },
}

响应头域

无特殊响应头域。

响应参数

N/A

响应示例

HTTP/1.1 200 OK

查询时间戳水印

通过指定水印名称查询特定时间戳水印的详细信息,包括时间戳的时区、文字、位置、创建时间等。

请求语法

GET /v<version>/watermark/timestamp/<name> HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

参数 类型 描述 是否必须
name String 水印名称

请求示例

GET /v5/watermark/timestamp/demo_watermark HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: bce-auth-v1/e8e4a9ced6794355a9a1b8a20b58d37b/2015-07-03T09:28:13Z/1800/content-type;host/4a1692dc4bab84f5801f79ea0c1fece3601cf73ecd94409d2a94b3942b971715

响应头域

无特殊响应头域。

响应参数

参数 类型 描述
name String 水印名称
timezone String 时区
alpha String 水印透明度
font Object 水印文字
+family String 文字字体,font子参数
+sizeInPoint Number 文字大小,font子参数
+color String 文字颜色,font子参数
background Object 水印背景
+color String 背景颜色,background子参数
position Object 水印位置
+verticalAlignment String 垂直对齐,position子参数
+horizontalAlignment String 水平对齐,position子参数
+verticalOffsetInPixel Number 垂直偏移量,position子参数,与verticalAlignment配合,仅当verticalAlignment设置为topbottom时有效。单位:像素
+horizontalOffsetInPixel Number 水平偏移量,position子参数,与horizontalAlignment配合,仅当horizontalAlignment设置为leftright时有效。单位:像素
createTime Date 水印模板创建时间

响应示例

{
    "success": true,
    "result" : {
    {
       "name": "demo_timestamp_watermark",
       "timezone": "CST",
       "alpha": 1
       "font": {
           "family": "Arial",
           "sizeInPoint": 16,
           "color": "#FFFFFFF"
       },
       "background": {
           "color": "#000000"
       },
       "position": {
           "verticalAlignment": "top",
           "horizontalAlignment": "left",
           "verticalOffsetInPixel": 10
           "horizontalOffsetInPixel": 10
       },
       "createTime": "2016-04-22T12:51:34Z"
    }
}

查询时间戳列表

查询用户的所有时间戳水印模板的详细信息。

请求语法

GET /v<version>/watermark/timestamp HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

N/A

请求示例

GET /v5/watermark/timestamp HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: bce-auth-v1/e8e4a9ced6794355a9a1b8a20b58d37b/2015-07-03T09:28:13Z/1800/content-type;host/4a1692dc4bab84f5801f79ea0c1fece3601cf73ecd94409d2a94b3942b971715

响应头域

无特殊响应头域。

响应参数

参数 类型 描述
watermarks Array 水印模板列表
+name String 水印名称
+timezone String 时区
+alpha String 水印透明度
+font Object 水印文字
++family String 文字字体,font子参数
++sizeInPoint Number 文字大小,font子参数
++color String 文字颜色,font子参数
+background Object 水印背景
++color String 背景颜色,background子参数
+position Object 水印位置
++verticalAlignment String 垂直对齐,position子参数
++horizontalAlignment String 水平对齐,position子参数
++verticalOffsetInPixel Number 垂直偏移量,position子参数,与verticalAlignment配合,仅当verticalAlignment设置为topbottom时有效。单位:像素
++horizontalOffsetInPixel Number 水平偏移量,position子参数,与horizontalAlignment配合,仅当horizontalAlignment设置为leftright时有效。单位:像素
+createTime Date 水印模板创建时间

响应示例

{
    "success": true,
    "page": {
        "orderBy": "id",
        "order" : "desc",
        "pageNo" : 1,
        "pageSize" : 20,
        "totalCount" : 2,
        "result" : [     
            {
            "name": "demo_timestamp_watermark",
            "timezone": "CST",
            "alpha": 1
            "font": {
                "family": "Arial",
                "sizeInPoint": 16,
                "color": "#FFFFFFF"
            },
            "background": {
                "color": "#000000"
            }
            "position": {
                "verticalAlignment": "top",
                "horizontalAlignment": "left",
                "verticalOffsetInPixel": 10
                "horizontalOffsetInPixel": 10
            },
            "createTime": "2016-04-22T12:51:34Z" 
            },
            {
            "name": "demo_timestamp_watermark_2",
            "timezone": "CST",
            "alpha": 1
            "font": {
                "family": "Arial",
                "sizeInPoint": 16,
                "color": "#FFFFFFF"
            },
            "background": {
                "color": "#000000"
            },
            "position": {
                "verticalAlignment": "top",
                "horizontalAlignment": "left",
                "verticalOffsetInPixel": 10
                "horizontalOffsetInPixel": 10
            },
            "createTime": "2016-04-22T12:51:34Z" 
            }       
        ]
    }
}

删除时间戳

通过指定水印名称删除特定时间戳水印模板。

请求语法

DELETE /v<version>/watermark/timestamp/<name> HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

参数 类型 描述 是否必须
name String 水印名称

请求示例

DELETE /v5/watermark/timestamp/<name> HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: bce-auth-v1/e8e4a9ced6794355a9a1b8a20b58d37b/2015-07-03T09:28:13Z/1800/content-type;host/4a1692dc4bab84f5801f79ea0c1fece3601cf73ecd94409d2a94b3942b971715

响应头域

无特殊响应头域。

响应参数

N/A

响应示例

HTTP/1.1 200 OK

缩略图模板接口

查询缩略图模板

请求语法

GET /v<version>/thumbnail/<name> HTTP/1.1
host:lss.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

参数 类型 描述 是否必须
name String 缩略图模板名称

请求示例

GET /v5/thumbnail/demo_thumbnail HTTP/1.1
host: lss.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

响应头域

无特殊响应头域。

响应参数

参数 类型 描述
name String 缩略图模板名称
description String 缩略图模板描述
bos Object 缩略图文件存储至BOS的配置信息
+bucket String 存储缩略图文件的BOS Bucket名称
+region String 存储缩略图文件的BOS区域
target Object 缩略图目标信息
+format String 缩略图文件格式
+sizingPolicy String 缩略图拉伸策略
+maxWidthInPixel Number 缩略图宽度尺寸
+maxHeightInPixel Number 缩略图高度尺寸
capture Object 缩略图生成规则
+mode String 缩略图生成模式
+startTimeInSecond Number 缩略图开始时间
+endTimeInSecond Number 缩略图结束时间
+intervalInSecond Number 缩略图截图间隔,有效值:[1-21600]
createTime Date 缩略图模版创建时间

响应示例

{
    "success": true,
    "result": {
        "name": "demo_thumbnail",
        "description": "this is a demo thumbnail",
        "bos": {
            "bucket": "demo_thumbnail_bucket",
            "region": "bj"
        },
        "target": {
            "format": "jpg",
            "sizePolicy”: “stretch",
            "maxWidthInPixel": 1080"maxHeightInPixel": 720
        },
        "capture": {
            "mode": auto,
            "startTimeInSecond": 0,
            "endTimeInSecond": 1000,
            "intervalInSecond": 5
        }
    }
}

缩略图列表

请求语法

GET /v<version>/thumbnail HTTP/1.1
host:lss.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

请求头域

无特殊请求头域。

请求参数

N/A

请求示例

GET /v5/thumbnail HTTP/1.1
host:lss.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>

响应头域

无特殊响应头域。

响应参数

参数 类型 描述
thumbnails Array 缩略图模板列表
+name String 缩略图模板名称
+description String 缩略图模板描述
+bos Object 缩略图文件存储至BOS的配置信息
++bucket String 存储缩略图文件的BOS Bucket名称
++region String 存储缩略图文件的BOS区域
+target Object 缩略图目标信息
++format String 缩略图文件格式
++sizingPolicy String 缩略图拉伸策略
++maxWidthInPixel Number 缩略图宽度尺寸
++maxHeightInPixel Number 缩略图高度尺寸
+capture Object 缩略图生成规则
++mode String 缩略图生成模式
++startTimeInSecond Number 缩略图开始时间
++endTimeInSecond Number 缩略图结束时间
++intervalInSecond Number 缩略图截图间隔,有效值:[1-21600]
+createTime Date 缩略图模版创建时间

响应示例

{
    "success": true,
    "page": {
        "orderBy": "id",
        "order": "desc",
        "pageNo": 1,
        "pageSize": 20,
        "totalCount": 2,
        "result": [
            {
                "name": "demo_thumbnail",
                "description": "this is a demo thumbnail",
                "bos": {
                    "bucket": "demo_thumbnail_bucket",
                    "region": "bj"
                },
                "target": {
                    "format": "jpg",
                    "sizePolicy”: “stretch",
                    "maxWidthInPixel": 1080"maxHeightInPixel": 720
                },
                "capture": {
                    "mode": auto,
                    "startTimeInSecond": 0,
                    "endTimeInSecond": 1000,
                    "intervalInSecond": 5
                }
            }
        ]
    }
}