Overview
This document provides an overview of APIs and SDK code samples for media processing jobs in CI, with the animated image job as an example.
Basic Operations
Creating template
Feature description
This API is used to create a template.
Method prototype
public MediaTemplateResponse createMediaTemplate(MediaTemplateRequest request);
Parameter description
Request has the following sub-nodes:
|
| | Template type: Animation (animated image); Snapshot (screenshot); Transcode (transcoding); Watermark (watermark); SmartCover (intelligent thumbnail) | | |
| | Template name, which can contain letters, digits, underscores (_), hyphens (-), and asterisks (*). | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | | | |
| | Transcoding configuration | | |
Container has the following sub-nodes:
|
| | Container format. Valid values: gif, hgif (hgif indicates higher-definition gif), webp | | |
Video has the following sub-nodes:
|
| | | | | | |
| | | | | | Value range: [128, 4096] Unit: px If only Width is set, Height is calculated according to the original video aspect ratio. |
| | | | | | Value range: [128, 4096] Unit: px If only Height is set, Width is calculated according to the original video aspect ratio. |
| | | | | Original video frame rate | Value range: (0, 60] Unit: fps This parameter is optional. If it is not set, the video is played at the speed as per the original timestamp. This parameter specifies the frame rate for animated image playback. |
AnimateOnly KeepKeyFrame | | Keep only keyframes for animated images | | | | Valid values: true, false Specifies whether to keep only keyframes for animated images |
AnimateTime IntervalOfFrame | | Frame sampling interval for animated images | | | | (0, video duration] Frame sampling interval for animated images The value of this parameter must be less than the value of TimeInterval.Duration if TimeInterval.Duration is set. |
AnimateFrames PerSecond | | Number of frames sampled per second for animated images | | | | (0, video frame rate) Frame sampling frequency for animated images Priority: AnimateFramesPerSecond > AnimateOnlyKeepKeyFrame > AnimateTimeIntervalOfFrame |
| | | | | | [1, 100) This parameter is valid for WEBP images and is not available for GIF images. |
TimeInterval has the following sub-nodes:
|
| | | | | | [0, video duration] Unit: second Supports the float format, accurate to the millisecond. |
| | | | | | [0, video duration] Unit: second Supports the float format, accurate to the millisecond. |
Snapshot has the following sub-nodes:
|
| | | | | | Valid values: {Interval, Average} Interval: Interval mode. Average: Average mode Interval mode: The Start, TimeInterval, and Count parameters are valid. If Count is set and TimeInterval is not set, all frames will be captured, and the total number of images captured is specified by Count. Average mode: The Start and Count parameters are valid, indicating to capture a total of Count images at an average interval from Start to the end of the video. |
| | | | | | [0, video duration] Unit: second Supports the float format, accurate to the millisecond. |
| | | | | | (0, 3600] Unit: second Supports the float format, accurate to the millisecond. |
| | | | | | |
| | | | | | Value range: [128, 4096] Unit: px If only Width is set, Height is calculated according to the original video aspect ratio. |
| | | | | | Value range: [128, 4096] Unit: px If only Height is set, Width is calculated according to the original video aspect ratio. |
Watermark has the following sub-nodes:
|
| | | | | | Text: text watermark. Image: image watermark |
| | | | | | TopRight, TopLeft, BottomRight, BottomLeft |
| | | | | | Relativity: proportionally. Absolute: fixed position. |
| | | | | | If locMode is Relativity, the unit is %, and the value range is [0, 100] If locMode is Absolute, the unit is px, and the value range is [0, 4096]. |
| | | | | | If locMode is Relativity, the unit is %, and the value range is [0, 100] If locMode is Absolute, the unit is px, and the value range is [0, 4096]. |
| | | | | | [0, video duration] Unit: second Supports the float format, accurate to the millisecond. |
| | | | | | [0, video duration] Unit: second Supports the float format, accurate to the millisecond. |
| | | | | | |
| | | | | | |
Image has the following sub-nodes:
|
| | | | | | Same as the watermark image address of the bucket. |
| | | | | | Original: original size Proportion: scaled proportionally Fixed: fixed size |
| | | | | | If Mode is Original, this parameter is the watermark image width. If Mode is Proportion, the unit is %, and the value range is [1, 100]. If Mode is Fixed, the unit is px, and the value range is [1, 4096]. If only Width is set, Height is calculated according to the original video aspect ratio. |
| | | | | | If Mode is Original, this parameter is the watermark image height. If Mode is Proportion, the unit is %, and the value range is [1, 100]. If Mode is Fixed, the unit is px, and the value range is [1, 4096]. If only Height is set, Width is calculated according to the original video aspect ratio. |
| | | | | | Value range: [1, 100]. Unit: % |
Watermark position description:
Text has the following sub-nodes:
|
| | | | | | Value range: [5, 100]. Unit: px |
| | | | | | |
| | | | | | |
| | | | | | Value range: [1, 100]. Unit: % |
| | | | | | The value can be up to 64 letters, digits, underscores (_), hyphens (-), and asterisks (*). |
FontType has the following sub-nodes:
Audio/Video formats supported by different container formats are as follows:
Audio has the following sub-nodes:
|
| | | | | | |
| | | | | | Unit: Hz Valid values: 11025, 22050, 32000, 44100, 48000, 96000 Different container formats support different MP3 sample rates, as shown in the table below. |
| | | | | | Unit: Kbps Value range: [8, 1000] |
| | | | | | If Codec is aac, the value can be 1, 2, 4, 5, 6, or If Codec is mp3, the value can be 1 or 2. |
| | Whether to delete the audio stream | | | | Valid values: true, false |
Y indicates supported, and N indicates unsupported.
TransConfig has the following sub-nodes:
|
| | Resolution adjustment method | | | | Valid values: scale, crop, pad, none If the aspect ratio of the output video is different from that of the original video, the resolution needs to be adjusted according to this parameter. |
| | Whether to check the resolution | | | | Valid values: true, false If the value is false, transcoding is performed based on settings. |
| | Resolution adjustment method | | | | Valid values: 0, 1. 0 indicates to use the original video resolution. 1 indicates to return the transcoding failure message. This parameter is valid only when IsCheckReso is true. |
| | Whether to check the video bitrate | | | | true, false If the value is false, transcoding is performed based on settings. |
| | Video bitrate adjustment method | | | | Valid values: 0, 1. 0 indicates to use the original video bitrate. 1 indicates to return the transcoding failure message. This parameter is valid only when IsCheckVideoBitrate is true. |
| | Whether to check the audio bitrate | | | | true, false If the value is false, transcoding is performed based on settings. |
| | Audio bitrate adjustment method | | | | Valid values: 0, 1. 0 indicates to use the original audio bitrate. 1 indicates to return the transcoding failure message. This parameter is valid only when IsCheckAudioBitrate is true. |
Video has the following sub-nodes:
|
| | | | | | |
| | | | | | Value range: [128, 4096] Unit: px If only Width is set, Height is calculated according to the original video aspect ratio. |
| | | | | | Value range: [128, 4096] Unit: px If only Height is set, Width is calculated according to the original video aspect ratio. |
| | | | | | Value range: (0, 60] Unit: fps |
| | Whether to delete the video stream | | | | |
| | | | | | Valid values: baseline, main, high baseline: Suitable for mobile devices. main: Suitable for standard resolution devices. high: Suitable for high resolution devices. Only H.264 supports this parameter. |
| | Bitrate of the video output file | | | | Value range: [10, 50000] Unit: Kbps |
| | Bitrate, which is a quality control factor | | | | Value range: (0, 51] If Crf is set, the setting of Bitrate becomes invalid. |
| | Maximum number of frames between two keyframes | | | | |
| | | | | | Only H.264 supports this parameter. Valid values: veryfast, fast, medium, slow, slower |
| | | | | | Value range: [1000, 128000] Unit: Kb |
| | | | | | Value range: [10, 50000] Unit: Kbps |
| | | | | | (0, video duration] Unit: second |
| | | | | | Valid values: yuv420p, yuv422p, yuv444p, yuvj420p, yuvj422p, yuvj444p |
Response description
Success: The MediaTemplateResponse object response information is returned, which contains the details of the created template.
Failure: An error (such as the bucket does not exist) occurs, throwing the CosClientException or CosServiceException exception. For more information, see Troubleshooting. Sample request
MediaTemplateRequest request = new MediaTemplateRequest();
request.setBucketName("examplebucket-1250000000");
request.setTag("Animation");
request.setName("TestTemplate40");
request.getContainer().setFormat("gif");
request.getVideo().setCodec("gif");
request.getVideo().setWidth("1280");
request.getVideo().setFps("15");
request.getVideo().setAnimateOnlyKeepKeyFrame("true");
request.getTimeInterval().setStart("0");
request.getTimeInterval().setDuration("60");
MediaTemplateResponse response = client.createMediaTemplate(request);
Deleting template
Feature description
This API is used to delete a template.
Method prototype
public Boolean deleteMediaTemplate(MediaTemplateRequest request);
Parameter description
|
| Bucket name in the format of BucketName-APPID. For more information, see Bucket Overview. | | |
| ID of the template to be deleted | | |
Response description
Success: A boolean type is returned, which is true upon deletion success.
Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, see Troubleshooting. Sample request
MediaTemplateRequest request = new MediaTemplateRequest();
request.setBucketName("examplebucket-1250000000");
request.setTemplateId("t19c4a60ae1a694621a01f0c7130c*****");
Boolean response = client.deleteMediaTemplate(request);
Querying template list
Feature description
This API is used to query the template list.
Method prototype
public MediaJobResponse describeMediaJob(MediaJobsRequest req);
Parameter description
|
| Bucket name in the format of BucketName-APPID. For more information, see Bucket Overview. | | |
| Template tag: Animation (animated image); Snapshot (screenshot); Transcode (transcoding); Watermark (watermark); SmartCover (intelligent thumbnail) | | |
| Template category. Valid values: Custom (default), Official | | |
| Template ID. If you enter multiple IDs, separate them with commas (,). | | |
| | | |
| | | |
| Number of entries per page | | |
Response description
Success: A template response wrapper class is returned, which contains the template details set templateList.
Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, see Troubleshooting. Sample request
MediaTemplateRequest request = new MediaTemplateRequest();
request.setBucketName("examplebucket-1250000000");
MediaListTemplateResponse response = client.describeMediaTemplates(request);
List<MediaTemplateObject> templateList = response.getTemplateList();
Modifying template
Feature description
This API is used to modify a template.
Method prototype
public Boolean updateMediaTemplate(MediaTemplateRequest request);
Parameter description
|
| Bucket name in the format of BucketName-APPID. For more information, see Bucket Overview. | | |
| ID of the template to be modified | | |
Note:
Other parameters are the same as those of the template creation API.
Response description
Success: true is returned upon modification success.
Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, see Troubleshooting. Sample request
MediaTemplateRequest request = new MediaTemplateRequest();
request.setBucketName("examplebucket-1250000000");
request.setTemplateId("t19c4a60ae1a694621a01f0c7130*****");
request.setTag("Animation");
request.setName("updateName");
request.getContainer().setFormat("gif");
Boolean aBoolean = client.updateMediaTemplate(request);
