全部产品

截图模版

本篇文档提供了Node.js SDK截图模板功能的API调用示例。包含添加截图模板、修改截图模板、删除截图模板、查询截图模板列表。

初始化客户端

使用前请先初始化客户端,请参见初始化

添加截图模板

调用AddVodTemplate接口,完成添加截图模板功能。

接口参数和返回字段请参见AddVodTemplate。调用示例如下:

// 调用样例
var client = initVodClient('<Your AccessKeyId>','<Your AccessKeySecret>');

var templateConfig = {
    //截图类型(存在雪碧图配置,该类型必须是"SpriteSnapshot",否则为"NormalSnapshot")
    SnapshotType: 'SpriteSnapshot',
    //普通截图配置(与雪碧图原始图配置共用该配置信息)
    SnapshotConfig:{
        Count: '50',
        Interval: '1',
        SpecifiedOffsetTime: '0',
        Width: '200',
        Height: '200',
        FrameType: 'normal',
        //雪碧图配置(雪碧图配置必须是建立在普通截图配置之上)
        SpriteSnapshotConfig:{
            CellWidth: '120',
            CellHeight: '68',
            Columns: '3',
            Lines: '10',
            Padding: '20',
            Margin: '50',
            KeepCellPic: 'keep',
            Color: 'tomato'
        }
    }
};
client.request("AddVodTemplate", {
    Name: '截图模板添加测试',     //模板名称
    TemplateType: 'Snapshot',   //模板类型,固定值为Snapshot
    TemplateConfig: JSON.stringify(templateConfig)   //截图模板配置数据生成
}, {}).then(function (response) {
    //截图模板ID
    console.log('SnapshotVodTemplateId = ' + response.VodTemplateId);
    console.log('RequestId = ' + response.RequestId);
}).catch(function (response) {
    console.log('ErrorCode = ' + response.data.Code);
    console.log('ErrorMessage = ' + response.data.Message);
    console.log('RequestId = ' + response.data.RequestId);
});

修改截图模板

调用UpdateVodTemplate接口,完成修改截图模板功能。

接口参数和返回字段请参见UpdateVodTemplate。调用示例如下:

// 调用样例
var client = initVodClient('<Your AccessKeyId>','<Your AccessKeySecret>');

var templateConfig = {
    //截图类型(存在雪碧图配置,该类型必须是"SpriteSnapshot",否则为"NormalSnapshot")
    SnapshotType: 'SpriteSnapshot',
    //普通截图配置(与雪碧图原始图配置共用该配置信息)
    SnapshotConfig:{
        Count: '50',
        Interval: '1',
        SpecifiedOffsetTime: '0',
        Width: '200',
        Height: '200',
        FrameType: 'normal',
        //雪碧图配置(雪碧图配置必须是建立在普通截图配置之上)
        SpriteSnapshotConfig:{
            CellWidth: '120',
            CellHeight: '68',
            Columns: '3',
            Lines: '10',
            Padding: '20',
            Margin: '50',
            KeepCellPic: 'keep',
            Color: 'tomato'
        }
    }
};
client.request("UpdateVodTemplate", {
    VodTemplateId: 'VodTemplateId',   //设置要修改的模板ID
    Name: '截图模板修改测试',   //模板名称
    TemplateConfig: JSON.stringify(templateConfig)   //截图模板配置数据生成
}, {}).then(function (response) {
    //截图模板ID
    console.log('SnapshotVodTemplateId = ' + response.VodTemplateId);
    console.log('RequestId = ' + response.RequestId);
}).catch(function (response) {
    console.log('ErrorCode = ' + response.data.Code);
    console.log('ErrorMessage = ' + response.data.Message);
    console.log('RequestId = ' + response.data.RequestId);
});

删除截图模板

调用DeleteVodTemplate接口,完成删除截图模板功能。

接口参数和返回字段请参见DeleteVodTemplate。调用示例如下:

// 调用样例
var client = initVodClient('<Your AccessKeyId>','<Your AccessKeySecret>');

client.request("DeleteVodTemplate", {
    VodTemplateId: 'VodTemplateId'   //设置要删除的模板ID
}, {}).then(function (response) {
    console.log('RequestId = ' + response.RequestId);
}).catch(function (response) {
    console.log('ErrorCode = ' + response.data.Code);
    console.log('ErrorMessage = ' + response.data.Message);
    console.log('RequestId = ' + response.data.RequestId);
});

查询截图模板列表

调用ListVodTemplate接口,完成查询截图模板列表功能。

接口参数和返回字段请参见ListVodTemplate。调用示例如下:

// 调用样例
var client = initVodClient('<Your AccessKeyId>','<Your AccessKeySecret>');

client.request("ListVodTemplate", {
    TemplateType: 'Snapshot'   //模板类型,固定值为Snapshot
}, {}).then(function (response) {
    //打印模板数目
    console.log('SnapshotVodTemplate Count = ' + response.VodTemplateInfoList.length);
    console.log('RequestId = ' + response.RequestId);
}).catch(function (response) {
    console.log('ErrorCode = ' + response.data.Code);
    console.log('ErrorMessage = ' + response.data.Message);
    console.log('RequestId = ' + response.data.RequestId);
});

查询截图模板

调用GetVodTemplate接口,完成查询截图模板功能。

接口参数和返回字段请参见GetVodTemplate。调用示例如下:

// 调用样例
var client = initVodClient('<Your AccessKeyId>','<Your AccessKeySecret>');

client.request("GetVodTemplate", {
    VodTemplateId: 'VodTemplateId'   //设置要查询的模板ID
}, {}).then(function (response) {
    // 打印返回信息中的截图模板ID
    if (response.VodTemplateInfo){
        console.log('SnapshotVodTemplateId = ' + response.VodTemplateInfo.VodTemplateId);
    }
    console.log('RequestId = ' + response.RequestId);
}).catch(function (response) {
    console.log('ErrorCode = ' + response.data.Code);
    console.log('ErrorMessage = ' + response.data.Message);
    console.log('RequestId = ' + response.data.RequestId);
});