public class VodClient extends AbstractBceClient
config, DEFAULT_CONTENT_TYPE, DEFAULT_ENCODING, DEFAULT_SERVICE_DOMAIN, URL_PREFIX| Constructor and Description |
|---|
VodClient(BceClientConfiguration vodConfig)
Constructs a new client using the client configuration.
|
VodClient(BceClientConfiguration vodConfig,
BosClientConfiguration bosConfig)
Constructs a new client using the client configuration.
|
| Modifier and Type | Method and Description |
|---|---|
GenerateMediaIdResponse |
applyMedia() |
GenerateMediaIdResponse |
applyMedia(String mode) |
CreateMediaResourceResponse |
createMediaResource(String title,
String description,
File file,
String transcodingPresetGroupName,
int priority)
Uploads the specified file to Bos under the specified bucket and key name.
|
CreateMediaResourceResponse |
createMediaResource(String title,
String description,
File file,
String transcodingPresetGroupName,
int priority,
String mode)
Uploads the specified file to Bos under the specified bucket and key name.
|
CreateMediaResourceResponse |
createMediaResource(String title,
String description,
File file,
String transcodingPresetGroupName,
int priority,
String mode,
ActionAttributes actionAttributes)
Uploads the specified file to Bos under the specified bucket and key name.
|
CreateMediaResourceResponse |
createMediaResource(String sourceUrl,
String title,
String description,
String transcodingPresetGroupName,
int priority)
Load a media resource from URL to VOD.
|
CreateMediaResourceResponse |
createMediaResource(String sourceUrl,
String title,
String description,
String transcodingPresetGroupName,
int priority,
String mode)
Load a media resource from URL to VOD.
|
CreateMediaResourceResponse |
createMediaResource(String sourceUrl,
String title,
String description,
String transcodingPresetGroupName,
int priority,
String mode,
ActionAttributes actionAttributes)
Load a media resource from URL to VOD.
|
CreateMediaResourceResponse |
createMediaResource(String sourceBucket,
String sourceKey,
String title,
String description,
String transcodingPresetGroupName,
int priority)
Load a media resource from BOS to VOD.
|
CreateMediaResourceResponse |
createMediaResource(String sourceBucket,
String sourceKey,
String title,
String description,
String transcodingPresetGroupName,
int priority,
String mode)
Load a media resource from BOS to VOD.
|
CreateMediaResourceResponse |
createMediaResource(String sourceBucket,
String sourceKey,
String title,
String description,
String transcodingPresetGroupName,
int priority,
String mode,
ActionAttributes actionAttributes)
Load a media resource from BOS to VOD.
|
CreateNotificationResponse |
createNotification(CreateNotificationRequest request)
Create a doc notification in the doc stream service.
|
CreateNotificationResponse |
createNotification(String name,
String endpoint)
Create a doc notification in the doc stream service.
|
DeleteMediaResourceResponse |
deleteMediaResource(DeleteMediaResourceRequest request)
Delete the specific media resource managed by VOD service.
|
DeleteMediaResourceResponse |
deleteMediaResource(String mediaId)
Delete the specific media resource managed by VOD service.
|
DeleteNotificationResponse |
deleteNotification(DeleteNotificationRequest request)
Delete your doc notification by doc notification name.
|
DeleteNotificationResponse |
deleteNotification(String name)
Delete your doc notification by doc notification name.
|
GenerateMediaDeliveryInfoResponse |
generateMediaDeliveryInfo(GenerateMediaDeliveryInfoRequest request)
Delete the specific media resource managed by VOD service.
|
GenerateMediaDeliveryInfoResponse |
generateMediaDeliveryInfo(String mediaId,
String transcodingPresetName)
Generate media delivery info by media ID.
|
GenerateMediaPlayerCodeResponse |
generateMediaPlayerCode(GenerateMediaPlayerCodeRequest request)
Get the HTML5 code snippet (encoded in Base64) to play the specific media resource.
|
GenerateMediaPlayerCodeResponse |
generateMediaPlayerCode(String mediaId,
int width,
int height,
boolean autoStart,
String transcodingPresetName)
Get the HTML5 code snippet (encoded in Base64) to play the specific media resource.
|
GetMediaResourceResponse |
getMediaResource(GetMediaResourceRequest request)
Gets the properties of specific media resource managed by VOD service.
|
GetMediaResourceResponse |
getMediaResource(String mediaId)
Gets the properties of specific media resource managed by VOD service.
|
GetMediaSourceDownloadResponse |
getMediaSourceDownload(GetMediaSourceDownloadRequest request)
Transcode the media again.
|
GetMediaSourceDownloadResponse |
getMediaSourceDownload(String mediaId,
long expiredInSeconds)
get media source download url.
|
GetMediaStatisticResponse |
getMediaStatistic(GetMediaStatisticRequest request)
get media statistic info.
|
GetMediaStatisticResponse |
getMediaStatistic(String mediaId,
Date startTime,
Date endTime,
boolean aggregate)
get media statistic info.
|
GetNotificationResponse |
getNotification(GetNotificationRequest request)
Get your doc notification by doc notification name.
|
GetNotificationResponse |
getNotification(String name)
Get your doc notification by doc notification name.
|
GetPartMediaResourceResponse |
getPartMediaResource(GetPartMediaResourceRequest request)
Gets the properties of specific media resource managed by VOD service.
|
GetPartMediaResourceResponse |
getPartMediaResource(String mediaId,
String scope,
String taskId)
Gets a part of properties of specific media resource managed by VOD service.
|
boolean |
isRegionSupported()
Returns true if the target service supports regions.
|
ListMediaResourceResponse |
listMediaResources(int pageNo,
int pageSize,
String status,
Date begin,
Date end,
String title)
List the properties of all media resource managed by VOD service.
|
ListMediaResourceResponse |
listMediaResources(ListMediaResourceRequest request)
List the properties of all media resource managed by VOD service.
|
ListMediaResourceByMarkerResponse |
listMediaResourcesByMarker(ListMediaResourceByMarkerRequest request)
List the properties of all media resource managed by VOD service.
|
ListMediaResourceByMarkerResponse |
listMediaResourcesByMarker(String marker,
int maxSize,
String status,
Date begin,
Date end,
String title)
Use marker mode to List the properties of all media resource managed by VOD service.
|
ListNotificationsResponse |
listNotifications()
List all your doc notifications.
|
InternalCreateMediaResponse |
processMedia(InternalCreateMediaRequest request) |
InternalCreateMediaResponse |
processMedia(String mediaId,
String title,
String description,
String sourceExtension,
String transcodingPresetGroupName,
int priority) |
InternalCreateMediaResponse |
processMedia(String mediaId,
String title,
String description,
String sourceExtension,
String transcodingPresetGroupName,
int priority,
ActionAttributes actionAttributes) |
PublishMediaResourceResponse |
publishMediaResource(PublishMediaResourceRequest request)
Publish the specific media resource managed by VOD service, so that it can be access and played.
|
PublishMediaResourceResponse |
publishMediaResource(String mediaId)
Publish the specific media resource managed by VOD service, so that it can be access and played.
|
ReTranscodeResponse |
reTranscode(ReTranscodeRequest request)
Transcode the media again.
|
ReTranscodeResponse |
reTranscode(String mediaId)
Transcode the media again.
|
StopMediaResourceResponse |
stopMediaResource(StopMediaResourceRequest request)
Stop the specific media resource managed by VOD service, so that it can not be access and played.
|
StopMediaResourceResponse |
stopMediaResource(String mediaId)
Stop the specific media resource managed by VOD service, so that it can not be access and played.
|
UpdateMediaResourceResponse |
updateMediaResource(String mediaId,
String title,
String description)
Update the title and description for the specific media resource managed by VOD service.
|
UpdateMediaResourceResponse |
updateMediaResource(UpdateMediaResourceRequest request)
Update the title and description for the specific media resource managed by VOD service.
|
computeServiceId, getClient, getEndpoint, getServiceId, invokeHttpClient, setClient, shutdownpublic VodClient(BceClientConfiguration vodConfig)
vodConfig - The client configuration options controlling how this client connects to Vod services
(e.g. proxy settings, retry counts, etc).public VodClient(BceClientConfiguration vodConfig, BosClientConfiguration bosConfig)
vodConfig - The client configuration options controlling how this client connects to Vod services
(e.g. proxy settings, retry counts, etc).public CreateMediaResourceResponse createMediaResource(String title, String description, File file, String transcodingPresetGroupName, int priority) throws FileNotFoundException
title - media title.description - media description.file - The file containing the data to be uploaded to VOD.transcodingPresetGroupName - set transcoding presetgroup name, if NULL, use defaultpriority - set transcoding priority[0,9], lowest priority is 0. Only effect your own taskFileNotFoundExceptionpublic CreateMediaResourceResponse createMediaResource(String title, String description, File file, String transcodingPresetGroupName, int priority, String mode) throws FileNotFoundException
title - media title.description - media description.file - The file containing the data to be uploaded to VOD.transcodingPresetGroupName - set transcoding presetgroup name, if NULL, use defaultpriority - set transcoding priority[0,9], lowest priority is 0. Only effect your own taskmode - the mode of the media resourceFileNotFoundExceptionpublic CreateMediaResourceResponse createMediaResource(String title, String description, File file, String transcodingPresetGroupName, int priority, String mode, ActionAttributes actionAttributes) throws FileNotFoundException
title - media title.description - media description.file - The file containing the data to be uploaded to VOD.transcodingPresetGroupName - set transcoding presetgroup name, if NULL, use defaultpriority - set transcoding priority[0,9], lowest priority is 0. Only effect your own taskmode - the mode of the media resourceactionAttributes - the action attributesFileNotFoundExceptionpublic CreateMediaResourceResponse createMediaResource(String sourceBucket, String sourceKey, String title, String description, String transcodingPresetGroupName, int priority)
sourceBucket - The bucket name of the media resource in BOSsourceKey - The key name of the media resource in BOStitle - The title string of the media resourcedescription - The description string of the media resourcetranscodingPresetGroupName - set transcoding presetgroup name, if NULL, use defaultpriority - set transcoding priority[0,9], lowest priority is 0. Only effect your own jobspublic CreateMediaResourceResponse createMediaResource(String sourceBucket, String sourceKey, String title, String description, String transcodingPresetGroupName, int priority, String mode)
sourceBucket - The bucket name of the media resource in BOSsourceKey - The key name of the media resource in BOStitle - The title string of the media resourcedescription - The description string of the media resourcetranscodingPresetGroupName - set transcoding presetgroup name, if NULL, use defaultpriority - set transcoding priority[0,9], lowest priority is 0. Only effect your own jobsmode - the mode of the media resourcepublic CreateMediaResourceResponse createMediaResource(String sourceBucket, String sourceKey, String title, String description, String transcodingPresetGroupName, int priority, String mode, ActionAttributes actionAttributes)
sourceBucket - The bucket name of the media resource in BOSsourceKey - The key name of the media resource in BOStitle - The title string of the media resourcedescription - The description string of the media resourcetranscodingPresetGroupName - set transcoding presetgroup name, if NULL, use defaultpriority - set transcoding priority[0,9], lowest priority is 0. Only effect your own jobsmode - the mode of the media resourceactionAttributes - the action attributespublic CreateMediaResourceResponse createMediaResource(String sourceUrl, String title, String description, String transcodingPresetGroupName, int priority)
sourceUrl - The source url of the media resourcetitle - The title string of the media resourcedescription - The description string of the media resourcetranscodingPresetGroupName - set transcoding presetgroup name, if NULL, use defaultpriority - set transcoding priority[0,9], lowest priority is 0. Only effect your own jobspublic CreateMediaResourceResponse createMediaResource(String sourceUrl, String title, String description, String transcodingPresetGroupName, int priority, String mode)
sourceUrl - The source url of the media resourcetitle - The title string of the media resourcedescription - The description string of the media resourcetranscodingPresetGroupName - set transcoding presetgroup name, if NULL, use defaultpriority - set transcoding priority[0,9], lowest priority is 0. Only effect your own jobsmode - the mode of the media resourcepublic CreateMediaResourceResponse createMediaResource(String sourceUrl, String title, String description, String transcodingPresetGroupName, int priority, String mode, ActionAttributes actionAttributes)
sourceUrl - The source url of the media resourcetitle - The title string of the media resourcedescription - The description string of the media resourcetranscodingPresetGroupName - set transcoding presetgroup name, if NULL, use defaultpriority - set transcoding priority[0,9], lowest priority is 0. Only effect your own jobsmode - the mode of the media resourceactionAttributes - the action attributespublic InternalCreateMediaResponse processMedia(InternalCreateMediaRequest request)
public InternalCreateMediaResponse processMedia(String mediaId, String title, String description, String sourceExtension, String transcodingPresetGroupName, int priority, ActionAttributes actionAttributes)
public InternalCreateMediaResponse processMedia(String mediaId, String title, String description, String sourceExtension, String transcodingPresetGroupName, int priority)
public GenerateMediaIdResponse applyMedia()
public GenerateMediaIdResponse applyMedia(String mode)
public GetMediaResourceResponse getMediaResource(String mediaId)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
mediaId - The unique ID for each media resourcepublic GetMediaResourceResponse getMediaResource(GetMediaResourceRequest request)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
request - The request wrapper object containing all options.public GetPartMediaResourceResponse getPartMediaResource(String mediaId, String scope, String taskId)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
mediaId - The unique ID for each media resourcescope - The scope of query, such as 'thumbnail'taskId - The sign of scope, when scope is thumbnail, taskId can be: default second wonderfulpublic GetPartMediaResourceResponse getPartMediaResource(GetPartMediaResourceRequest request)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
request - The request wrapper object containing all options.public ListMediaResourceResponse listMediaResources(int pageNo, int pageSize, String status, Date begin, Date end, String title)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
pageNo - The pageNo need to list, must be greater than 0pageSize - The pageSize ,must in range [LIST_MIN_PAGESIZE,LIST_MAX_PAGESIZE]status - The media status, can be nullbegin - The media create date after beginend - The media create date before endtitle - The media title, use prefix searchpublic ListMediaResourceResponse listMediaResources(ListMediaResourceRequest request)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
request - The request wrapper object containing all options.public ListMediaResourceByMarkerResponse listMediaResourcesByMarker(String marker, int maxSize, String status, Date begin, Date end, String title)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
marker - The marker labels the query begining; first query use NULL.maxSize - The maxSize returned ,must in range [LIST_MIN_PAGESIZE,LIST_MAX_PAGESIZE]status - The media status, can be nullbegin - The media create date after beginend - The media create date before endtitle - The media title, use prefix searchpublic ListMediaResourceByMarkerResponse listMediaResourcesByMarker(ListMediaResourceByMarkerRequest request)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
request - The request wrapper object containing all options.public UpdateMediaResourceResponse updateMediaResource(String mediaId, String title, String description)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
mediaId - The unique ID for each media resourcetitle - New title stringdescription - New description stringpublic UpdateMediaResourceResponse updateMediaResource(UpdateMediaResourceRequest request)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
request - The request wrapper object containing all options.public StopMediaResourceResponse stopMediaResource(String mediaId)
publishMediaResource() later.
The caller must authenticate with a valid BCE Access Key / Private Key pair.
mediaId - The unique ID for each media resourcepublic StopMediaResourceResponse stopMediaResource(StopMediaResourceRequest request)
publishMediaResource() later.
The caller must authenticate with a valid BCE Access Key / Private Key pair.
request - The request object containing all the options on how topublic PublishMediaResourceResponse publishMediaResource(String mediaId)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
mediaId - The unique ID for each media resourcepublic PublishMediaResourceResponse publishMediaResource(PublishMediaResourceRequest request)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
request - The request object containing all the options on how topublic DeleteMediaResourceResponse deleteMediaResource(String mediaId)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
mediaId - The unique ID for each media resourcepublic DeleteMediaResourceResponse deleteMediaResource(DeleteMediaResourceRequest request)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
request - The request object containing all the options on how topublic GenerateMediaDeliveryInfoResponse generateMediaDeliveryInfo(String mediaId, String transcodingPresetName)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
mediaId - The unique ID for each media resourcepublic GenerateMediaDeliveryInfoResponse generateMediaDeliveryInfo(GenerateMediaDeliveryInfoRequest request)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
request - The request object containing all the options on how topublic GenerateMediaPlayerCodeResponse generateMediaPlayerCode(String mediaId, int width, int height, boolean autoStart, String transcodingPresetName)
mediaId - The unique ID for each media resourcewidth - The width of player viewheight - The height of player viewautoStart - Indicate whether or not play the media resource automatically when web page is loaded.public GenerateMediaPlayerCodeResponse generateMediaPlayerCode(GenerateMediaPlayerCodeRequest request)
request - The request object containing all the options on how topublic GetMediaStatisticResponse getMediaStatistic(String mediaId, Date startTime, Date endTime, boolean aggregate)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
startTime, - query media start time, default:2016-04-30T16:00:00ZendTime, - query media end time, default:nowaggregate, - if need aggregate, default: truepublic GetMediaStatisticResponse getMediaStatistic(GetMediaStatisticRequest request)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
request - The request wrapper object containing all options.public ReTranscodeResponse reTranscode(String mediaId)
mediaId - The unique ID for each media resourcepublic ReTranscodeResponse reTranscode(ReTranscodeRequest request)
request - The request object containing mediaidpublic GetMediaSourceDownloadResponse getMediaSourceDownload(String mediaId, long expiredInSeconds)
mediaId - The unique ID for each media resourceexpiredInSeconds - The expire timepublic GetMediaSourceDownloadResponse getMediaSourceDownload(GetMediaSourceDownloadRequest request)
request - The request object containing mediaidpublic ListNotificationsResponse listNotifications()
public DeleteNotificationResponse deleteNotification(String name)
name - doc notification name.public DeleteNotificationResponse deleteNotification(DeleteNotificationRequest request)
request - The request object containing all parameters for deleting dco notification.public GetNotificationResponse getNotification(String name)
name - doc notification name.public GetNotificationResponse getNotification(GetNotificationRequest request)
request - The request object containing all parameters for getting doc notification.public CreateNotificationResponse createNotification(String name, String endpoint)
name - The name of notification.endpoint - The address to receive notification message.public CreateNotificationResponse createNotification(CreateNotificationRequest request)
request - The request object containing all options for creating doc notification.public boolean isRegionSupported()
AbstractBceClientThe result will impact the construction of default service endpoint.
isRegionSupported in class AbstractBceClientCopyright © 2020. All rights reserved.