Release Notes
Announcements
API | Operation | Description |
Creating job | Creates media processing job | |
Deleting job | Deletes media processing job (ongoing jobs cannot be deleted) | |
Querying job | Queries job | |
Querying job list | Queries the list of jobs in queue |
public MediaJobResponse createMediaJobs(MediaJobsRequest req);
Request has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type | Required |
Tag | Request | Job type: Animation (animated image job), Snapshot (screenshot job), Transcode (transcoding job), SmartCover (intelligent thumbnail job) | String | Yes |
Input | Request | Information of the media file to be processed | Container | Yes |
Operation | Request | Operation rule | Container | Yes |
QueueId | Request | Queue ID of the job | String | Yes |
Input has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type | Required |
Object | Request.Input | Media filename | String | Yes |
Operation has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type | Required |
Animation | Request.Operation | Job type parameter. Same as Request.Animation in the animated image template creation API CreateMediaTemplate. | Container | No |
Snapshot | Request.Operation | Job type parameter. Same as Request.Snapshot in the screenshot template creation API CreateMediaTemplate. | Container | No |
Transcode | Request.Operation | Job type parameter. Same as Request.Transcode in the transcoding template creation API CreateMediaTemplate. | Container | No |
Watermark | Request.Operation | Job type parameter. Same as Request.Watermark in the watermark template creation API CreateMediaTemplate. | Container | No |
SmartCover | Request.Operation | This node is valid only when Tag is SmartCover. Currently, it is null. | Container | No |
TemplateId | Request.Operation | Template ID | String | No |
Output | Request.Operation | Result output address | Container | Yes |
TemplateId is used with priority. If TemplateId is unavailable, the corresponding job type parameter is used.Animation has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type | Required |
Container | Request.Operation.Animation | Container | No | |
Video | Request.Operation.Animation | Container | No | |
TimeInterval | Request.Operation.Animation | Container | No |
Output has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type | Required |
Region | Request.Operation.Output | Bucket region | String | Yes |
Bucket | Request.Operation.Output | Result storage bucket | String | Yes |
Object | Request.Operation.Output | Result filename. | String | Yes |
CosClientException or CosServiceException exception. For more information, see Troubleshooting.//1. Create a job request objectMediaJobsRequest request = new MediaJobsRequest();//2. Add request parameters as detailed in the API documentationrequest.setBucketName("examplebucket-1250000000");request.setTag("Transcode");request.getInput().setObject("1.mp4");request.getOperation().setTemplateId("t0e09a9456d4124542b1f0e44d501*****");request.getOperation().getOutput().setBucket("examplebucket-1250000000");request.getOperation().getOutput().setRegion("ap-chongqing");request.getOperation().getOutput().setObject("2.mp4");request.setQueueId("p9900025e4ec44b5e8225e70a52170834");//3. Call the API to get the job response objectMediaJobResponse response = client.createMediaJobs(request);
public Boolean cancelMediaJob(MediaJobsRequest req);
Parameter | Description | Type | Required |
bucketName | String | Yes | |
jobId | ID of the job to be deleted. | String | Yes |
true upon success.MediaJobsRequest request = new MediaJobsRequest();request.setBucketName("examplebucket-1250000000");request.setJobId("jae776cb4ec3011eab2cdd3817d4*****");Boolean response = client.cancelMediaJob(request);
public MediaJobResponse describeMediaJob(MediaJobsRequest req);
Parameter | Description | Type | Required |
bucketName | String | Yes | |
jobId | ID of the job to be queried. | String | Yes |
MediaJobObject. //1. Create a job request objectMediaJobsRequest request = new MediaJobsRequest();//2. Add request parameters as detailed in the API documentationrequest.setBucketName("examplebucket-1250000000");request.setJobId("j29a82fea08ba11ebb54bc9d1c05*****");//3. Call the API to get the job response objectMediaJobResponse response = client.describeMediaJob(request);
public MediaListJobResponse describeMediaJobs(MediaJobsRequest cIMediaJobsRequest);
Node Name (Keyword) | Description | Type | Required |
bucketName | String | Yes | |
queueId | ID of the queue from which jobs are pulled | String | Yes |
tag | Job type: Animation | String | Yes |
orderByTime | Desc (default) or Asc | String | No |
nextToken | Context token for pagination | String | No |
size | Maximum number of jobs that can be pulled. The default value is 10. The maximum value is 100. | Integer | No |
states | Status of the jobs to pull. If you enter multiple job statuses, separate them with commas (,). Valid values: All (default), Submitted, Running, Success, Failed, Pause, Cancel | String | No |
startCreationTime | Start time of the time range for job pulling in the format of %Y-%m-%dT%H:%m:%S%z. | String | No |
endCreationTime | End time of the time range for job pulling in the format of %Y-%m-%dT%H:%m:%S%z. | String | No |
MediaJobsRequest request = new MediaJobsRequest();request.setBucketName("examplebucket-1250000000");request.setQueueId("p9900025e4ec44b5e8225e70a521*****");request.setTag("Transcode");MediaListJobResponse response = client.describeMediaJobs(request);List<MediaJobObject> jobsDetail = response.getJobsDetail();
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback