com.baidubce.services.bvw

Class BvwClient

java.lang.Object

com.baidubce.AbstractBceClient

com.baidubce.services.bvw.BvwClient

public class BvwClient
extends AbstractBceClient

Provides the client for accessing the Baidu VideoWorks(BVW).

Field Summary

Fields inherited from class com.baidubce.AbstractBceClient

config, DEFAULT_CONTENT_TYPE, DEFAULT_ENCODING, DEFAULT_SERVICE_DOMAIN, URL_PREFIX

Constructor Summary

Constructors

Constructor and Description
BvwClient(BceClientConfiguration config) Constructs a new bvw client using the client configuration to access bvw.

Method Summary

Modifier and Type	Method and Description
void	addKeyFrameDesc(String instanceId, KeyFrameDescAddRequest keyFrameDescAddRequest) add keyframe for workflowInstance
MediaBaseResponse	banMedia(MediaBaseRequest banRequest) Ban media with specified banning media request.
MediaBaseResponse	banMedia(String mediaId) Ban media with specified media id.
MediaBaseResponse	batchDeleteMedia(List<String> mediaIds) Batch delete media with specified media id list.
MediaBaseResponse	batchDeleteMedia(MediaBatchDeleteRequest batchDeleteRequest) Batch delete media with specified batch deleting media request.
MatlibTaskResponse	createDraft(MatlibTaskRequest matlibTaskRequest) create draft
MatlibConfigBaseResponse	createMatlibConfig(MatlibConfigBaseRequest baseRequest) Create matlib config.
NotificationBaseResponse	createNotification(NotificationCreateRequest createRequest) Create notification with specified creating notification request.
NotificationBaseResponse	createNotification(String name, String endpoint) Create notification with specified parameters.(No authentication)
NotificationBaseResponse	createNotification(String name, String endpoint, String token, AuthType authType) Create notification with specified parameters.
VideoEditCreateResponse	createVideoEdit(VideoEditCreateRequest videoEditCreateRequest) create a task of video edit The cmd Object in VideoEditCreateRequest 1> do not need to modify it by your self, you only put the json string to Map to it(From web FE) 2> if you want to construct it by yourself, make object by Map
VideoGenerationResponse	createVideoGenerationTask(VideoGenerationRequest videoGenerationRequest) create a video with materials and subtitles
WorkflowBaseResponse	createWorkflow(WorkflowCreateRequest workflowCreateRequest) Create workflow with specified parameter.
MaterialBaseResponse	deleteMaterial(String materialId) Delete material from material library.
MaterialBaseResponse	deleteMaterialPreset(String id) Delete material from material library.
MediaBaseResponse	deleteMedia(MediaBaseRequest deleteRequest) Delete media with specified deleting media request.
MediaBaseResponse	deleteMedia(String mediaId) Delete media with specified media id.
NotificationBaseResponse	deleteNotification(NotificationBaseRequest deleteRequest) Delete notification with specified deleting request.
NotificationBaseResponse	deleteNotification(String name) Delete notification with specified notification name.
WorkflowBaseResponse	deleteWorkflow(String workflowName) Delete workflow with specified workflow name.
WorkflowBaseResponse	deleteWorkflow(WorkflowBaseRequest deleteRequest) Get workflow with specified deleting workflow request.
NotificationBaseResponse	disableNotification(NotificationBaseRequest disableRequest) Disable notification with specified enabling request.
NotificationBaseResponse	disableNotification(String name) Enable notification with specified notification name.
WorkflowBaseResponse	disableWorkflow(String workflowName) Disable workflow with specified workflow name.
WorkflowBaseResponse	disableWorkflow(WorkflowBaseRequest disableRequest) Disable workflow with specified enabling workflow request.
NotificationBaseResponse	enableNotification(NotificationBaseRequest enableRequest) Enable notification with specified enabling request.
NotificationBaseResponse	enableNotification(String name) Enable notification with specified notification name.
WorkflowBaseResponse	enableWorkflow(String workflowName) Enable workflow with specified workflow name.
WorkflowBaseResponse	enableWorkflow(WorkflowBaseRequest enableRequest) Enable workflow with specified enabling workflow request.
ListByPageResponse<MatlibTaskGetResponse>	getDraftList(DraftListRequest listRequest) List all of the draft.
InstanceGetResponse	getInstance(InstanceBaseRequest getRequest) Get instance with specified getting instance request.
InstanceGetResponse	getInstance(String instanceId) Get instance with specified instance id.
InstanceGetTaskUrlsResponse	getInstanceTaskUrls(InstanceBaseRequest getRequest) Get url resource from a instance with specified getting request.
InstanceGetTaskUrlsResponse	getInstanceTaskUrls(String instanceId) Get url resource from a instance with specified instance id.
MaterialGetResponse	getMaterial(String materialId) Get material from material library.
MaterialPresetGetResponse	getMaterialPreset(String id) Get material preset from material library.
MatlibConfigGetResponse	getMatlibConfig() Get matlib config.
MediaGetResponse	getMedia(MediaBaseRequest getRequest) Get media with specified getting media request.
MediaGetResponse	getMedia(String mediaId) Get media with specified media id.
MediaInstanceListResponse	getMediaInstanceList(MediaBaseRequest getRequest) Get instance list of media.
MediaInstanceListResponse	getMediaInstanceList(String mediaId) Get instance list of media.
NotificationGetResponse	getNotification(NotificationBaseRequest getRequest) Get notification with specified parameters.
NotificationGetResponse	getNotification(String name) Get notification with specified notification name.
GetDraftResponse	getSingleDraft(long id) Get a single draft.
TaskGetResponse	getTask(String taskId) Get task with specified task id.
TaskGetResponse	getTask(TaskBaseRequest getRequest) Get task with specified getting task request.
WorkflowGetResponse	getWorkflow(String workflowName) Get workflow with specified workflow name.
WorkflowGetResponse	getWorkflow(WorkflowBaseRequest getRequest) Get workflow with specified getting workflow request.
ListByPageResponse<MediaListResponse>	listMedia(MediaListRequest listRequest) List media with specified listing media request.
NotificationListResponse	listNotification() List all of the notifications.
NotificationListResponse	listNotification(NotificationListRequest listRequest) List notification with specified listing request.
NotificationListResponse	listNotification(NotificationStatus status) List notification with specified notification status.
ListByPageResponse<WorkflowListResponse>	listWorkflow(WorkflowListRequest listRequest) List workflow with specified listing workflow request.
VideoEditPollingResponse	pollingVideoEdit(long editId) get edit job status
MediaProcessResponse	processMedia(MediaProcessRequest processRequest) Process media with specified processing media request.
KeyFrameDescGetResponse	queryKeyFrameDescList(String instanceId) get keyframe list from the transcoding task or no transcoding task in the instance
KeyFrameUrlResponse	queryKeyFrameUrlList(String instanceId) get target bos key's preSign url
MaterialSearchResponse	searchMaterial(MaterialSearchRequest materialSearchRequest) Search material from material library.
MaterialPresetSearchResponse	searchMaterialPreset(MaterialPresetSearchRequest materialPresetSearchRequest) Search material preset from material library.
Text2AudioResponse	text2Audio(Text2AudioRequest text2AudioRequest) Transfer a list of text to audio.
MediaBaseResponse	unbanMedia(MediaBaseRequest unbanRequest) Unban media with specified unbanning media request.
MediaBaseResponse	unbanMedia(String mediaId) Unban media with specified media id.
void	updateDraft(long draftId, MatlibTaskRequest matlibTaskRequest) update draft
MatlibConfigBaseResponse	updateMatlibConfig(MatlibConfigBaseRequest baseRequest) Update matlib config.
MediaBaseResponse	updateMedia(MediaUpdateRequest updateRequest) Update media with specified updating media request.
NotificationBaseResponse	updateNotification(NotificationUpdateRequest updateRequest) Update notification with specified updating request.
NotificationBaseResponse	updateNotification(String name, String endpoint) Update notification with specified parameters.
NotificationBaseResponse	updateNotification(String name, String endpoint, String token, AuthType authType) Update notification with specified parameters.
WorkflowBaseResponse	updateWorkflow(WorkflowUpdateRequest updateRequest) Update workflow with specified updating workflow request.
MatlibUploadResponse	upload2Material(MatlibUploadRequest matlibUploadRequest) Upload media to material library.
MaterialPresetUploadResponse	uploadMaterialPreset(String type, MatlibUploadRequest matlibUploadRequest) Upload media preset to material library.

Methods inherited from class com.baidubce.AbstractBceClient

computeBktVirEndpoint, computeServiceId, getBktVirEndpoint, getClient, getEndpoint, getServiceId, invokeHttpClient, isRegionSupported, setClient, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BvwClient

public BvwClient(BceClientConfiguration config)

Constructs a new bvw client using the client configuration to access bvw.

Parameters:

config - The bvw client configuration options controlling how this client connects to bvw (e.g. proxy settings, retry counts, etc).

Method Detail

createWorkflow

public WorkflowBaseResponse createWorkflow(WorkflowCreateRequest workflowCreateRequest)

Create workflow with specified parameter.

Parameters:

workflowCreateRequest - The creating workflow request

Returns:

A creating workflow response

getWorkflow

public WorkflowGetResponse getWorkflow(String workflowName)

Get workflow with specified workflow name.

Parameters:

workflowName - The workflow name

Returns:

A getting workflow response

getWorkflow

public WorkflowGetResponse getWorkflow(WorkflowBaseRequest getRequest)

Get workflow with specified getting workflow request.

Parameters:

getRequest - The getting workflow request

Returns:

A getting workflow response

deleteWorkflow

public WorkflowBaseResponse deleteWorkflow(String workflowName)

Delete workflow with specified workflow name.

Parameters:

workflowName - The workflow name

Returns:

A deleting workflow response

deleteWorkflow

public WorkflowBaseResponse deleteWorkflow(WorkflowBaseRequest deleteRequest)

Get workflow with specified deleting workflow request.

Parameters:

deleteRequest - The deleting workflow request

Returns:

A deleting workflow response

updateWorkflow

public WorkflowBaseResponse updateWorkflow(WorkflowUpdateRequest updateRequest)

Update workflow with specified updating workflow request.

Parameters:

updateRequest - The updating workflow request

Returns:

A updating workflow response

listWorkflow

public ListByPageResponse<WorkflowListResponse> listWorkflow(WorkflowListRequest listRequest)

List workflow with specified listing workflow request.

Parameters:

listRequest - The listing workflow request

Returns:

A listing workflow response

enableWorkflow

public WorkflowBaseResponse enableWorkflow(WorkflowBaseRequest enableRequest)

Enable workflow with specified enabling workflow request.

Parameters:

enableRequest - Enabling workflow request

Returns:

A enabling workflow response

enableWorkflow

public WorkflowBaseResponse enableWorkflow(String workflowName)

Enable workflow with specified workflow name.

Parameters:

workflowName - Workflow name

Returns:

A enabling workflow response

disableWorkflow

public WorkflowBaseResponse disableWorkflow(WorkflowBaseRequest disableRequest)

Disable workflow with specified enabling workflow request.

Parameters:

disableRequest - Disabling workflow request

Returns:

A disabling workflow response

disableWorkflow

public WorkflowBaseResponse disableWorkflow(String workflowName)

Disable workflow with specified workflow name.

Parameters:

workflowName - Workflow name

Returns:

A disabling workflow response

processMedia

public MediaProcessResponse processMedia(MediaProcessRequest processRequest)

Process media with specified processing media request.

Parameters:

processRequest - processing media request

Returns:

A processing media response

getMedia

public MediaGetResponse getMedia(MediaBaseRequest getRequest)

Get media with specified getting media request.

Parameters:

getRequest - getting media request

Returns:

A getting media response

getMedia

public MediaGetResponse getMedia(String mediaId)

Get media with specified media id.

Parameters:

mediaId - Media id

Returns:

A getting media response

updateMedia

public MediaBaseResponse updateMedia(MediaUpdateRequest updateRequest)

Update media with specified updating media request.

Parameters:

updateRequest - The updating media request

Returns:

A updating media response

getMediaInstanceList

public MediaInstanceListResponse getMediaInstanceList(MediaBaseRequest getRequest)

Get instance list of media.

Parameters:

getRequest - The getting instance list of media request

Returns:

A getting instance list of media response

getMediaInstanceList

public MediaInstanceListResponse getMediaInstanceList(String mediaId)

Get instance list of media.

Parameters:

mediaId - The media id

Returns:

A getting instance list of media response

banMedia

public MediaBaseResponse banMedia(MediaBaseRequest banRequest)

Ban media with specified banning media request.

Parameters:

banRequest - The banning media request

Returns:

A banning media response

banMedia

public MediaBaseResponse banMedia(String mediaId)

Ban media with specified media id.

Parameters:

mediaId - The media id

Returns:

A banning media response

unbanMedia

public MediaBaseResponse unbanMedia(MediaBaseRequest unbanRequest)

Unban media with specified unbanning media request.

Parameters:

unbanRequest - The unbanning media request

Returns:

A unbanning media response

unbanMedia

public MediaBaseResponse unbanMedia(String mediaId)

Unban media with specified media id.

Parameters:

mediaId - The media id

Returns:

A unbanning media response

listMedia

public ListByPageResponse<MediaListResponse> listMedia(MediaListRequest listRequest)

List media with specified listing media request.

Parameters:

listRequest - The listing media request

Returns:

A listing media response

deleteMedia

public MediaBaseResponse deleteMedia(MediaBaseRequest deleteRequest)

Delete media with specified deleting media request.

Parameters:

deleteRequest - The deleting media request

Returns:

A deleting media response

deleteMedia

public MediaBaseResponse deleteMedia(String mediaId)

Delete media with specified media id.

Parameters:

mediaId - The media id

Returns:

A deleting media response

batchDeleteMedia

public MediaBaseResponse batchDeleteMedia(MediaBatchDeleteRequest batchDeleteRequest)

Batch delete media with specified batch deleting media request.

Parameters:

batchDeleteRequest - The batch deleting media request

Returns:

A batch deleting media response

batchDeleteMedia

public MediaBaseResponse batchDeleteMedia(List<String> mediaIds)

Batch delete media with specified media id list.

Parameters:

mediaIds - The media id list

Returns:

A batch deleting media response

getInstance

public InstanceGetResponse getInstance(InstanceBaseRequest getRequest)

Get instance with specified getting instance request.

Parameters:

getRequest - The getting instance request

Returns:

A getting instance response

getInstance

public InstanceGetResponse getInstance(String instanceId)

Get instance with specified instance id.

Parameters:

instanceId - The instance id

Returns:

A getting instance response

getInstanceTaskUrls

public InstanceGetTaskUrlsResponse getInstanceTaskUrls(InstanceBaseRequest getRequest)

Get url resource from a instance with specified getting request.

Parameters:

getRequest - The getting instance task urls request

Returns:

A getting instance task urls response

getInstanceTaskUrls

public InstanceGetTaskUrlsResponse getInstanceTaskUrls(String instanceId)

Get url resource from a instance with specified instance id.

Parameters:

instanceId - The instance id

Returns:

A getting instance task urls response

getTask

public TaskGetResponse getTask(TaskBaseRequest getRequest)

Get task with specified getting task request.

Parameters:

getRequest - The getting task request

Returns:

A getting task request

getTask

public TaskGetResponse getTask(String taskId)

Get task with specified task id.

Parameters:

taskId - The task id

Returns:

A getting task request

createNotification

public NotificationBaseResponse createNotification(NotificationCreateRequest createRequest)

Create notification with specified creating notification request.

Parameters:

createRequest - The creating notification request

Returns:

A creating notification response

createNotification

public NotificationBaseResponse createNotification(String name,
                                                   String endpoint)

Create notification with specified parameters.(No authentication)

Parameters:

name - The notification name

endpoint - The notification endpoint

Returns:

A creating notification response

createNotification

public NotificationBaseResponse createNotification(String name,
                                                   String endpoint,
                                                   String token,
                                                   AuthType authType)

Create notification with specified parameters.

Parameters:

name - The notification name

endpoint - The notification endpoint

token - The notification authentication token

authType - The notification auth type

Returns:

A creating notification response

getNotification

public NotificationGetResponse getNotification(NotificationBaseRequest getRequest)

Get notification with specified parameters.

Parameters:

getRequest - The getting notification request

Returns:

A getting notification response

getNotification

public NotificationGetResponse getNotification(String name)

Get notification with specified notification name.

Parameters:

name - The notification name

Returns:

A getting notification response

listNotification

public NotificationListResponse listNotification(NotificationListRequest listRequest)

List notification with specified listing request.

Parameters:

listRequest - The listing notification request.

Returns:

A listing notification response.

listNotification

public NotificationListResponse listNotification(NotificationStatus status)

List notification with specified notification status.

Parameters:

status - The notification status

Returns:

A listing notification response.

listNotification

public NotificationListResponse listNotification()

List all of the notifications.

Returns:

A listing notification response.

updateNotification

public NotificationBaseResponse updateNotification(NotificationUpdateRequest updateRequest)

Update notification with specified updating request.

Parameters:

updateRequest - The updating notification request

Returns:

A updating notification response

updateNotification

public NotificationBaseResponse updateNotification(String name,
                                                   String endpoint)

Update notification with specified parameters.

Parameters:

name - The notification name

endpoint - The notification endpoint to update

Returns:

A updating notification response

updateNotification

public NotificationBaseResponse updateNotification(String name,
                                                   String endpoint,
                                                   String token,
                                                   AuthType authType)

Update notification with specified parameters.

Parameters:

name - The notification name

endpoint - The notification endpoint to update

token - The notification token to update

authType - The notification authentication type to update

Returns:

A updating notification response

enableNotification

public NotificationBaseResponse enableNotification(NotificationBaseRequest enableRequest)

Enable notification with specified enabling request.

Parameters:

enableRequest - The enabling notification request

Returns:

A enabling notification response

enableNotification

public NotificationBaseResponse enableNotification(String name)

Enable notification with specified notification name.

Parameters:

name - The notification name

Returns:

A enabling notification response

disableNotification

public NotificationBaseResponse disableNotification(NotificationBaseRequest disableRequest)

Disable notification with specified enabling request.

Parameters:

disableRequest - The disabling notification request

Returns:

A disabling notification response

disableNotification

public NotificationBaseResponse disableNotification(String name)

Enable notification with specified notification name.

Parameters:

name - The notification name

Returns:

A disabling notification response

deleteNotification

public NotificationBaseResponse deleteNotification(NotificationBaseRequest deleteRequest)

Delete notification with specified deleting request.

Parameters:

deleteRequest - The deleting notification request

Returns:

A deleting notification response

deleteNotification

public NotificationBaseResponse deleteNotification(String name)

Delete notification with specified notification name.

Parameters:

name - The notification name

Returns:

A deleting notification response

upload2Material

public MatlibUploadResponse upload2Material(MatlibUploadRequest matlibUploadRequest)

Upload media to material library.

Parameters:

matlibUploadRequest - The uploading request

Returns:

A uploading response

getMaterial

public MaterialGetResponse getMaterial(String materialId)

Get material from material library.

Parameters:

materialId - The material id

Returns:

A getting material response

deleteMaterial

public MaterialBaseResponse deleteMaterial(String materialId)

Delete material from material library.

Parameters:

materialId - The material id

Returns:

A deleting material response

searchMaterial

public MaterialSearchResponse searchMaterial(MaterialSearchRequest materialSearchRequest)

Search material from material library.

Parameters:

materialSearchRequest - search parameters

Returns:

material list response

uploadMaterialPreset

public MaterialPresetUploadResponse uploadMaterialPreset(String type,
                                                         MatlibUploadRequest matlibUploadRequest)

Upload media preset to material library.

Parameters:

matlibUploadRequest - The uploading request

Returns:

A uploading response

getMaterialPreset

public MaterialPresetGetResponse getMaterialPreset(String id)

Get material preset from material library.

Parameters:

id - The material preset id

Returns:

A getting material preset response

deleteMaterialPreset

public MaterialBaseResponse deleteMaterialPreset(String id)

Delete material from material library.

Parameters:

id - The material preset id

Returns:

A deleting material preset response

searchMaterialPreset

public MaterialPresetSearchResponse searchMaterialPreset(MaterialPresetSearchRequest materialPresetSearchRequest)

Search material preset from material library.

Parameters:

materialPresetSearchRequest - search parameters

Returns:

material list response

createMatlibConfig

public MatlibConfigBaseResponse createMatlibConfig(MatlibConfigBaseRequest baseRequest)

Create matlib config.

Parameters:

baseRequest - The creating matlib config request.

Returns:

A creating matlib config response.

updateMatlibConfig

public MatlibConfigBaseResponse updateMatlibConfig(MatlibConfigBaseRequest baseRequest)

Update matlib config.

Parameters:

baseRequest - The updating matlib config request.

Returns:

A updating matlib config response.

getMatlibConfig

public MatlibConfigGetResponse getMatlibConfig()

Get matlib config.

Returns:

A matlib config response.

text2Audio

public Text2AudioResponse text2Audio(Text2AudioRequest text2AudioRequest)

Transfer a list of text to audio. If you want to use this function, please set matlib bucket config first,

Parameters:

text2AudioRequest - The text to audio request

Returns:

A text to audio response

createVideoEdit

public VideoEditCreateResponse createVideoEdit(VideoEditCreateRequest videoEditCreateRequest)

create a task of video edit The cmd Object in VideoEditCreateRequest 1> do not need to modify it by your self, you only put the json string to Map to it(From web FE) 2> if you want to construct it by yourself, make object by Map

Parameters:

videoEditCreateRequest -

Returns:

A response of job create result

pollingVideoEdit

public VideoEditPollingResponse pollingVideoEdit(long editId)

get edit job status

Parameters:

editId -

Returns:

A job desc of this editId

createVideoGenerationTask

public VideoGenerationResponse createVideoGenerationTask(VideoGenerationRequest videoGenerationRequest)

create a video with materials and subtitles

Parameters:

videoGenerationRequest - videoGenerationResponse

Returns:

VideoGenerationResponse

queryKeyFrameDescList

public KeyFrameDescGetResponse queryKeyFrameDescList(String instanceId)

get keyframe list from the transcoding task or no transcoding task in the instance

Parameters:

instanceId - workflowInstanceId

Returns:

keyframe list

addKeyFrameDesc

public void addKeyFrameDesc(String instanceId,
                            KeyFrameDescAddRequest keyFrameDescAddRequest)

add keyframe for workflowInstance

Parameters:

instanceId - workflowInstanceId

keyFrameDescAddRequest - keyframe desc

queryKeyFrameUrlList

public KeyFrameUrlResponse queryKeyFrameUrlList(String instanceId)

get target bos key's preSign url

Parameters:

instanceId - workflowInstanceId

Returns:

keyFrame info list

createDraft

public MatlibTaskResponse createDraft(MatlibTaskRequest matlibTaskRequest)

create draft

Parameters:

matlibTaskRequest -

Returns:

updateDraft

public void updateDraft(long draftId,
                        MatlibTaskRequest matlibTaskRequest)

update draft

getDraftList

public ListByPageResponse<MatlibTaskGetResponse> getDraftList(DraftListRequest listRequest)

List all of the draft.

getSingleDraft

public GetDraftResponse getSingleDraft(long id)

Get a single draft.