Submits a job for adding a copyright watermark to a video.
Operation description
- You can call this operation to add a copyright watermark to a video that lasts at least 3 minutes. If the video is too short, the call may fail, or no output may be returned. To add a copyright watermark to a video shorter than 3 minutes, specify the Params parameter to change the algorithm.
- Each API call supports processing only one video.
- This API is supported only in the China (Shanghai) and China (Beijing) regions.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ice:SubmitCopyrightJob | none | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Input | string | Yes | The source video file that you want to add a watermark to. Note
The OSS object or media asset must reside in the same region as the IMS service region.
| {"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.mp4"} |
| Output | string | Yes | The URL of the output file. Note
The OSS bucket must reside in the same region as the IMS service region.
| {"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example_result.mp4"} |
| Message | string | Yes | The information about the watermark to be added. | Test |
| StartTime | string | No | The start time of the watermark. Unit: seconds. If you do not specify this parameter, the default value 0 is used. | 0 |
| TotalTime | string | No | The end time of the watermark. Unit: seconds. If you do not specify this parameter, the default value is the video duration. | 10 |
| Level | long | No | The watermark level, which specifies the channel to embed watermarks. Valid values: 0 specifies the 0u channel, 1 specifies the 1uv channel, and 2 specifies the 2yuv channel. | 0 |
| Description | string | No | The description of the watermark. | Description |
| UserData | string | No | The custom data, which can be up to 1,024 bytes in size. | 123 |
| Params | string | No | The parameters related to watermark jobs. The value is a JSON string. Supported parameter:
| {"algoType":"v2"} |
Response parameters
Examples
Sample success responses
JSONformat
{
"Data": {
"JobId": "bfb786c63****f4d80648792021eff90"
},
"Message": "ok",
"RequestId": "FA258E67-09B8-4EAA-8F33-BA567834A2C3\n",
"StatusCode": 200
}Error codes
For a list of error codes, visit the Service error codes.