|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.baidubce.AbstractBceClient
com.baidubce.services.vod.VodClient
public class VodClient
Provides the client for accessing the Baidu MediaResource-On-Demand Service.
Field Summary |
---|
Fields inherited from class com.baidubce.AbstractBceClient |
---|
config, DEFAULT_CONTENT_TYPE, DEFAULT_ENCODING, DEFAULT_SERVICE_DOMAIN, URL_PREFIX |
Constructor Summary | |
---|---|
VodClient(BceClientConfiguration vodConfig)
Constructs a new client using the client configuration. |
Method Summary | |
---|---|
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 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 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. |
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. |
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)
|
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. |
Methods inherited from class com.baidubce.AbstractBceClient |
---|
getClient, getEndpoint, getServiceId, invokeHttpClient, setClient, shutdown |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public VodClient(BceClientConfiguration vodConfig)
vodConfig
- The client configuration options controlling how this client connects to Vod services
(e.g. proxy settings, retry counts, etc).Method Detail |
---|
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 task
FileNotFoundException
public 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 resource
FileNotFoundException
public 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 jobs
public 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 resource
public 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 jobs
public 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 resource
public InternalCreateMediaResponse processMedia(InternalCreateMediaRequest request)
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 resource
public 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 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 search
public 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 search
public 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 string
public 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 resource
public 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 to
public PublishMediaResourceResponse publishMediaResource(String mediaId)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
mediaId
- The unique ID for each media resource
public 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 to
public DeleteMediaResourceResponse deleteMediaResource(String mediaId)
The caller must authenticate with a valid BCE Access Key / Private Key pair.
mediaId
- The unique ID for each media resource
public 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 to
public 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 resource
public 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 to
public 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 to
public 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: true
public 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 resource
public ReTranscodeResponse reTranscode(ReTranscodeRequest request)
request
- The request object containing mediaid
public GetMediaSourceDownloadResponse getMediaSourceDownload(String mediaId, long expiredInSeconds)
mediaId
- The unique ID for each media resourceexpiredInSeconds
- The expire time
public GetMediaSourceDownloadResponse getMediaSourceDownload(GetMediaSourceDownloadRequest request)
request
- The request object containing mediaid
public 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()
AbstractBceClient
The result will impact the construction of default service endpoint.
isRegionSupported
in class AbstractBceClient
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |