Protect Video IP by Adding Invisible Watermarks via SubmitCopyrightJob - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Submits a job for adding a copyright watermark to a video.

Operation description

Adds 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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:SubmitCopyrightJob

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Input	object	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"}
Type	string	Yes	The type of the source file. Valid values: OSS: an OSS object. Media: a media asset.	OSS
Media	string	Yes	The URL of the source file. You can specify the path of an OSS object in one of the following formats: 1. oss://bucket/object 2. http(s)://bucket.oss-[regionId].aliyuncs.com/object where bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object path in OSS.	oss://bucket/object
Output	object	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"}
Type	string	Yes	The type of the output file. Valid value: OSS: an OSS object.	OSS
Media	string	Yes	The OSS path where the output file is saved. You can specify the path in one of the following formats: 1. oss://bucket/object 2. http(s)://bucket.oss-[regionId].aliyuncs.com/object where bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object path in OSS.	oss://test-bucket/output.mp4
Message	string	Yes	The information about the watermark to be added.	Copyright watermark test
StartTime	integer	No	The start time of the watermark. Unit: seconds. If you do not specify this parameter, the default value 0 is used.	0
TotalTime	integer	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	integer	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.	Task 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: the algorithm type. Default value: v1. v1: watermarking for long videos that last at least 3 minutes. v2: watermarking for videos shorter than 3 minutes.	{"algoType":"v2"}

Response elements

Element	Type	Description	Example
	object	Schema of Response
Data	object	The data returned.
JobId	string	The job ID.	bfb786c63****f4d80648792021eff90
Message	string	The message returned.	ok
RequestId	string	The ID of the request.	FA258E67-09B8-4EAA-8F33-BA567834A2C3
StatusCode	integer	The status code.	200

Examples

Success response

JSON format

{
  "Data": {
    "JobId": "bfb786c63****f4d80648792021eff90"
  },
  "Message": "ok",
  "RequestId": "FA258E67-09B8-4EAA-8F33-BA567834A2C3\n",
  "StatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.