This document provides an overview of APIs and SDK code samples for media processing queues in CI.
API | Operation | Description |
---|---|---|
DescribeMediaQueues | Querying queues | Queries the information of queues under the current account |
UpdateMediaQueue | Updating queue | Updates queue and modifies its callback information |
This API is used to query the information of queues under the current account.
public MediaListQueueResponse describeMediaQueues(MediaQueueRequest mediaQueueRequest);
Parameter | Description | Type | Required |
---|---|---|---|
bucketName | Bucket name in the format of BucketName-APPID . For more information, see Bucket Overview. |
String | Yes |
queueIds | Queue ID. If you enter multiple IDs, separate them with commas (,). | string | No |
state | Paused status, and the jobs being transcoded will continue to be transcoded without being affected. |
string | No |
pageNumber | Page number. | string | No |
pageSize | Number of entries per page. | string | No |
CosClientException
or CosServiceException
exception. For more information, see Troubleshooting.MediaQueueRequest request = new MediaQueueRequest();
request.setBucketName("examplebucket-1250000000");
MediaListQueueResponse response = client.describeMediaQueues(request);
The API is used to update a queue and modify its callback information.
public MediaQueueResponse updateMediaQueue(MediaQueueRequest mediaQueueRequest);
Parameter | Description | Type | Required |
---|---|---|---|
bucketName | Bucket name in the format of BucketName-APPID . For more information, see Bucket Overview. |
String | Yes |
Name | Template name, which can contain up to 100 characters. | string | Yes |
state | Paused status, and the jobs being transcoded will continue to be transcoded without being affected. |
string | Yes |
QueueID | Queue ID | string | Yes |
NotifyConfig | Notification channel, i.e., third-party callback URL | Container | Yes |
NotifyConfig
has the following sub-nodes:
Parameter | Description | Type | Required |
---|---|---|---|
Url | Callback URL | String | No |
Type | Callback type. General callback: Url | String | No |
Event | Callback event. Video transcoding completion: TransCodingFinish | String | No |
State | Callback switch: Off, On | String | No |
MediaQueueRequest request = new MediaQueueRequest();
request.setBucketName("examplebucket-1250000000");
request.setQueueId("p9900025e4ec44b5e8225e70a521*****");
request.getNotifyConfig().setUrl("cloud.tencent.com");
request.setState("Active");
request.setName("testQueue");
MediaQueueResponse response = client.updateMediaQueue(request);
Was this page helpful?