类 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).
-
-
字段概要
-
从类继承的字段 com.baidubce.AbstractBceClient
config, DEFAULT_CONTENT_TYPE, DEFAULT_ENCODING, DEFAULT_SERVICE_DOMAIN, URL_PREFIX
-
-
构造器概要
构造器 构造器 说明 BvwClient(BceClientConfiguration config)Constructs a new bvw client using the client configuration to access bvw.
-
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 voidaddKeyFrameDesc(String instanceId, KeyFrameDescAddRequest keyFrameDescAddRequest)add keyframe for workflowInstanceMediaBaseResponsebanMedia(MediaBaseRequest banRequest)Ban media with specified banning media request.MediaBaseResponsebanMedia(String mediaId)Ban media with specified media id.MediaBaseResponsebatchDeleteMedia(MediaBatchDeleteRequest batchDeleteRequest)Batch delete media with specified batch deleting media request.MediaBaseResponsebatchDeleteMedia(List<String> mediaIds)Batch delete media with specified media id list.MatlibTaskResponsecreateDraft(MatlibTaskRequest matlibTaskRequest)create draftMatlibConfigBaseResponsecreateMatlibConfig(MatlibConfigBaseRequest baseRequest)Create matlib config.NotificationBaseResponsecreateNotification(NotificationCreateRequest createRequest)Create notification with specified creating notification request.NotificationBaseResponsecreateNotification(String name, String endpoint)Create notification with specified parameters.(No authentication)NotificationBaseResponsecreateNotification(String name, String endpoint, String token, AuthType authType)Create notification with specified parameters.VideoEditCreateResponsecreateVideoEdit(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 Mapto it(From web FE) 2> if you want to construct it by yourself, make object by Map VideoGenerationResponsecreateVideoGenerationTask(VideoGenerationRequest videoGenerationRequest)create a video with materials and subtitlesWorkflowBaseResponsecreateWorkflow(WorkflowCreateRequest workflowCreateRequest)Create workflow with specified parameter.MaterialBaseResponsedeleteMaterial(String materialId)Delete material from material library.MaterialBaseResponsedeleteMaterialPreset(String id)Delete material from material library.MediaBaseResponsedeleteMedia(MediaBaseRequest deleteRequest)Delete media with specified deleting media request.MediaBaseResponsedeleteMedia(String mediaId)Delete media with specified media id.NotificationBaseResponsedeleteNotification(NotificationBaseRequest deleteRequest)Delete notification with specified deleting request.NotificationBaseResponsedeleteNotification(String name)Delete notification with specified notification name.WorkflowBaseResponsedeleteWorkflow(WorkflowBaseRequest deleteRequest)Get workflow with specified deleting workflow request.WorkflowBaseResponsedeleteWorkflow(String workflowName)Delete workflow with specified workflow name.NotificationBaseResponsedisableNotification(NotificationBaseRequest disableRequest)Disable notification with specified enabling request.NotificationBaseResponsedisableNotification(String name)Enable notification with specified notification name.WorkflowBaseResponsedisableWorkflow(WorkflowBaseRequest disableRequest)Disable workflow with specified enabling workflow request.WorkflowBaseResponsedisableWorkflow(String workflowName)Disable workflow with specified workflow name.NotificationBaseResponseenableNotification(NotificationBaseRequest enableRequest)Enable notification with specified enabling request.NotificationBaseResponseenableNotification(String name)Enable notification with specified notification name.WorkflowBaseResponseenableWorkflow(WorkflowBaseRequest enableRequest)Enable workflow with specified enabling workflow request.WorkflowBaseResponseenableWorkflow(String workflowName)Enable workflow with specified workflow name.ListByPageResponse<MatlibTaskGetResponse>getDraftList(DraftListRequest listRequest)List all of the draft.InstanceGetResponsegetInstance(InstanceBaseRequest getRequest)Get instance with specified getting instance request.InstanceGetResponsegetInstance(String instanceId)Get instance with specified instance id.InstanceGetTaskUrlsResponsegetInstanceTaskUrls(InstanceBaseRequest getRequest)Get url resource from a instance with specified getting request.InstanceGetTaskUrlsResponsegetInstanceTaskUrls(String instanceId)Get url resource from a instance with specified instance id.MaterialGetResponsegetMaterial(String materialId)Get material from material library.MaterialPresetGetResponsegetMaterialPreset(String id)Get material preset from material library.MatlibConfigGetResponsegetMatlibConfig()Get matlib config.MediaGetResponsegetMedia(MediaBaseRequest getRequest)Get media with specified getting media request.MediaGetResponsegetMedia(String mediaId)Get media with specified media id.MediaInstanceListResponsegetMediaInstanceList(MediaBaseRequest getRequest)Get instance list of media.MediaInstanceListResponsegetMediaInstanceList(String mediaId)Get instance list of media.NotificationGetResponsegetNotification(NotificationBaseRequest getRequest)Get notification with specified parameters.NotificationGetResponsegetNotification(String name)Get notification with specified notification name.GetDraftResponsegetSingleDraft(long id)Get a single draft.TaskGetResponsegetTask(TaskBaseRequest getRequest)Get task with specified getting task request.TaskGetResponsegetTask(String taskId)Get task with specified task id.WorkflowGetResponsegetWorkflow(WorkflowBaseRequest getRequest)Get workflow with specified getting workflow request.WorkflowGetResponsegetWorkflow(String workflowName)Get workflow with specified workflow name.ListByPageResponse<MediaListResponse>listMedia(MediaListRequest listRequest)List media with specified listing media request.NotificationListResponselistNotification()List all of the notifications.NotificationListResponselistNotification(NotificationListRequest listRequest)List notification with specified listing request.NotificationListResponselistNotification(NotificationStatus status)List notification with specified notification status.ListByPageResponse<WorkflowListResponse>listWorkflow(WorkflowListRequest listRequest)List workflow with specified listing workflow request.VideoEditPollingResponsepollingVideoEdit(long editId)get edit job statusMediaProcessResponseprocessMedia(MediaProcessRequest processRequest)Process media with specified processing media request.KeyFrameDescGetResponsequeryKeyFrameDescList(String instanceId)get keyframe list from the transcoding task or no transcoding task in the instanceKeyFrameUrlResponsequeryKeyFrameUrlList(String instanceId)get target bos key's preSign urlMaterialSearchResponsesearchMaterial(MaterialSearchRequest materialSearchRequest)Search material from material library.MaterialPresetSearchResponsesearchMaterialPreset(MaterialPresetSearchRequest materialPresetSearchRequest)Search material preset from material library.Text2AudioResponsetext2Audio(Text2AudioRequest text2AudioRequest)Transfer a list of text to audio.MediaBaseResponseunbanMedia(MediaBaseRequest unbanRequest)Unban media with specified unbanning media request.MediaBaseResponseunbanMedia(String mediaId)Unban media with specified media id.voidupdateDraft(long draftId, MatlibTaskRequest matlibTaskRequest)update draftMatlibConfigBaseResponseupdateMatlibConfig(MatlibConfigBaseRequest baseRequest)Update matlib config.MediaBaseResponseupdateMedia(MediaUpdateRequest updateRequest)Update media with specified updating media request.NotificationBaseResponseupdateNotification(NotificationUpdateRequest updateRequest)Update notification with specified updating request.NotificationBaseResponseupdateNotification(String name, String endpoint)Update notification with specified parameters.NotificationBaseResponseupdateNotification(String name, String endpoint, String token, AuthType authType)Update notification with specified parameters.WorkflowBaseResponseupdateWorkflow(WorkflowUpdateRequest updateRequest)Update workflow with specified updating workflow request.MatlibUploadResponseupload2Material(MatlibUploadRequest matlibUploadRequest)Upload media to material library.MaterialPresetUploadResponseuploadMaterialPreset(String type, MatlibUploadRequest matlibUploadRequest)Upload media preset to material library.-
从类继承的方法 com.baidubce.AbstractBceClient
computeBktVirEndpoint, computeServiceId, getBktVirEndpoint, getClient, getEndpoint, getServiceId, invokeHttpClient, isRegionSupported, setClient, shutdown
-
-
-
-
构造器详细资料
-
BvwClient
public BvwClient(BceClientConfiguration config)
Constructs a new bvw client using the client configuration to access bvw.- 参数:
config- The bvw client configuration options controlling how this client connects to bvw (e.g. proxy settings, retry counts, etc).
-
-
方法详细资料
-
createWorkflow
public WorkflowBaseResponse createWorkflow(WorkflowCreateRequest workflowCreateRequest)
Create workflow with specified parameter.- 参数:
workflowCreateRequest- The creating workflow request- 返回:
- A creating workflow response
-
getWorkflow
public WorkflowGetResponse getWorkflow(String workflowName)
Get workflow with specified workflow name.- 参数:
workflowName- The workflow name- 返回:
- A getting workflow response
-
getWorkflow
public WorkflowGetResponse getWorkflow(WorkflowBaseRequest getRequest)
Get workflow with specified getting workflow request.- 参数:
getRequest- The getting workflow request- 返回:
- A getting workflow response
-
deleteWorkflow
public WorkflowBaseResponse deleteWorkflow(String workflowName)
Delete workflow with specified workflow name.- 参数:
workflowName- The workflow name- 返回:
- A deleting workflow response
-
deleteWorkflow
public WorkflowBaseResponse deleteWorkflow(WorkflowBaseRequest deleteRequest)
Get workflow with specified deleting workflow request.- 参数:
deleteRequest- The deleting workflow request- 返回:
- A deleting workflow response
-
updateWorkflow
public WorkflowBaseResponse updateWorkflow(WorkflowUpdateRequest updateRequest)
Update workflow with specified updating workflow request.- 参数:
updateRequest- The updating workflow request- 返回:
- A updating workflow response
-
listWorkflow
public ListByPageResponse<WorkflowListResponse> listWorkflow(WorkflowListRequest listRequest)
List workflow with specified listing workflow request.- 参数:
listRequest- The listing workflow request- 返回:
- A listing workflow response
-
enableWorkflow
public WorkflowBaseResponse enableWorkflow(WorkflowBaseRequest enableRequest)
Enable workflow with specified enabling workflow request.- 参数:
enableRequest- Enabling workflow request- 返回:
- A enabling workflow response
-
enableWorkflow
public WorkflowBaseResponse enableWorkflow(String workflowName)
Enable workflow with specified workflow name.- 参数:
workflowName- Workflow name- 返回:
- A enabling workflow response
-
disableWorkflow
public WorkflowBaseResponse disableWorkflow(WorkflowBaseRequest disableRequest)
Disable workflow with specified enabling workflow request.- 参数:
disableRequest- Disabling workflow request- 返回:
- A disabling workflow response
-
disableWorkflow
public WorkflowBaseResponse disableWorkflow(String workflowName)
Disable workflow with specified workflow name.- 参数:
workflowName- Workflow name- 返回:
- A disabling workflow response
-
processMedia
public MediaProcessResponse processMedia(MediaProcessRequest processRequest)
Process media with specified processing media request.- 参数:
processRequest- processing media request- 返回:
- A processing media response
-
getMedia
public MediaGetResponse getMedia(MediaBaseRequest getRequest)
Get media with specified getting media request.- 参数:
getRequest- getting media request- 返回:
- A getting media response
-
getMedia
public MediaGetResponse getMedia(String mediaId)
Get media with specified media id.- 参数:
mediaId- Media id- 返回:
- A getting media response
-
updateMedia
public MediaBaseResponse updateMedia(MediaUpdateRequest updateRequest)
Update media with specified updating media request.- 参数:
updateRequest- The updating media request- 返回:
- A updating media response
-
getMediaInstanceList
public MediaInstanceListResponse getMediaInstanceList(MediaBaseRequest getRequest)
Get instance list of media.- 参数:
getRequest- The getting instance list of media request- 返回:
- A getting instance list of media response
-
getMediaInstanceList
public MediaInstanceListResponse getMediaInstanceList(String mediaId)
Get instance list of media.- 参数:
mediaId- The media id- 返回:
- A getting instance list of media response
-
banMedia
public MediaBaseResponse banMedia(MediaBaseRequest banRequest)
Ban media with specified banning media request.- 参数:
banRequest- The banning media request- 返回:
- A banning media response
-
banMedia
public MediaBaseResponse banMedia(String mediaId)
Ban media with specified media id.- 参数:
mediaId- The media id- 返回:
- A banning media response
-
unbanMedia
public MediaBaseResponse unbanMedia(MediaBaseRequest unbanRequest)
Unban media with specified unbanning media request.- 参数:
unbanRequest- The unbanning media request- 返回:
- A unbanning media response
-
unbanMedia
public MediaBaseResponse unbanMedia(String mediaId)
Unban media with specified media id.- 参数:
mediaId- The media id- 返回:
- A unbanning media response
-
listMedia
public ListByPageResponse<MediaListResponse> listMedia(MediaListRequest listRequest)
List media with specified listing media request.- 参数:
listRequest- The listing media request- 返回:
- A listing media response
-
deleteMedia
public MediaBaseResponse deleteMedia(MediaBaseRequest deleteRequest)
Delete media with specified deleting media request.- 参数:
deleteRequest- The deleting media request- 返回:
- A deleting media response
-
deleteMedia
public MediaBaseResponse deleteMedia(String mediaId)
Delete media with specified media id.- 参数:
mediaId- The media id- 返回:
- A deleting media response
-
batchDeleteMedia
public MediaBaseResponse batchDeleteMedia(MediaBatchDeleteRequest batchDeleteRequest)
Batch delete media with specified batch deleting media request.- 参数:
batchDeleteRequest- The batch deleting media request- 返回:
- A batch deleting media response
-
batchDeleteMedia
public MediaBaseResponse batchDeleteMedia(List<String> mediaIds)
Batch delete media with specified media id list.- 参数:
mediaIds- The media id list- 返回:
- A batch deleting media response
-
getInstance
public InstanceGetResponse getInstance(InstanceBaseRequest getRequest)
Get instance with specified getting instance request.- 参数:
getRequest- The getting instance request- 返回:
- A getting instance response
-
getInstance
public InstanceGetResponse getInstance(String instanceId)
Get instance with specified instance id.- 参数:
instanceId- The instance id- 返回:
- A getting instance response
-
getInstanceTaskUrls
public InstanceGetTaskUrlsResponse getInstanceTaskUrls(InstanceBaseRequest getRequest)
Get url resource from a instance with specified getting request.- 参数:
getRequest- The getting instance task urls request- 返回:
- A getting instance task urls response
-
getInstanceTaskUrls
public InstanceGetTaskUrlsResponse getInstanceTaskUrls(String instanceId)
Get url resource from a instance with specified instance id.- 参数:
instanceId- The instance id- 返回:
- A getting instance task urls response
-
getTask
public TaskGetResponse getTask(TaskBaseRequest getRequest)
Get task with specified getting task request.- 参数:
getRequest- The getting task request- 返回:
- A getting task request
-
getTask
public TaskGetResponse getTask(String taskId)
Get task with specified task id.- 参数:
taskId- The task id- 返回:
- A getting task request
-
createNotification
public NotificationBaseResponse createNotification(NotificationCreateRequest createRequest)
Create notification with specified creating notification request.- 参数:
createRequest- The creating notification request- 返回:
- A creating notification response
-
createNotification
public NotificationBaseResponse createNotification(String name, String endpoint)
Create notification with specified parameters.(No authentication)- 参数:
name- The notification nameendpoint- The notification endpoint- 返回:
- A creating notification response
-
createNotification
public NotificationBaseResponse createNotification(String name, String endpoint, String token, AuthType authType)
Create notification with specified parameters.- 参数:
name- The notification nameendpoint- The notification endpointtoken- The notification authentication tokenauthType- The notification auth type- 返回:
- A creating notification response
-
getNotification
public NotificationGetResponse getNotification(NotificationBaseRequest getRequest)
Get notification with specified parameters.- 参数:
getRequest- The getting notification request- 返回:
- A getting notification response
-
getNotification
public NotificationGetResponse getNotification(String name)
Get notification with specified notification name.- 参数:
name- The notification name- 返回:
- A getting notification response
-
listNotification
public NotificationListResponse listNotification(NotificationListRequest listRequest)
List notification with specified listing request.- 参数:
listRequest- The listing notification request.- 返回:
- A listing notification response.
-
listNotification
public NotificationListResponse listNotification(NotificationStatus status)
List notification with specified notification status.- 参数:
status- The notification status- 返回:
- A listing notification response.
-
listNotification
public NotificationListResponse listNotification()
List all of the notifications.- 返回:
- A listing notification response.
-
updateNotification
public NotificationBaseResponse updateNotification(NotificationUpdateRequest updateRequest)
Update notification with specified updating request.- 参数:
updateRequest- The updating notification request- 返回:
- A updating notification response
-
updateNotification
public NotificationBaseResponse updateNotification(String name, String endpoint)
Update notification with specified parameters.- 参数:
name- The notification nameendpoint- The notification endpoint to update- 返回:
- A updating notification response
-
updateNotification
public NotificationBaseResponse updateNotification(String name, String endpoint, String token, AuthType authType)
Update notification with specified parameters.- 参数:
name- The notification nameendpoint- The notification endpoint to updatetoken- The notification token to updateauthType- The notification authentication type to update- 返回:
- A updating notification response
-
enableNotification
public NotificationBaseResponse enableNotification(NotificationBaseRequest enableRequest)
Enable notification with specified enabling request.- 参数:
enableRequest- The enabling notification request- 返回:
- A enabling notification response
-
enableNotification
public NotificationBaseResponse enableNotification(String name)
Enable notification with specified notification name.- 参数:
name- The notification name- 返回:
- A enabling notification response
-
disableNotification
public NotificationBaseResponse disableNotification(NotificationBaseRequest disableRequest)
Disable notification with specified enabling request.- 参数:
disableRequest- The disabling notification request- 返回:
- A disabling notification response
-
disableNotification
public NotificationBaseResponse disableNotification(String name)
Enable notification with specified notification name.- 参数:
name- The notification name- 返回:
- A disabling notification response
-
deleteNotification
public NotificationBaseResponse deleteNotification(NotificationBaseRequest deleteRequest)
Delete notification with specified deleting request.- 参数:
deleteRequest- The deleting notification request- 返回:
- A deleting notification response
-
deleteNotification
public NotificationBaseResponse deleteNotification(String name)
Delete notification with specified notification name.- 参数:
name- The notification name- 返回:
- A deleting notification response
-
upload2Material
public MatlibUploadResponse upload2Material(MatlibUploadRequest matlibUploadRequest)
Upload media to material library.- 参数:
matlibUploadRequest- The uploading request- 返回:
- A uploading response
-
getMaterial
public MaterialGetResponse getMaterial(String materialId)
Get material from material library.- 参数:
materialId- The material id- 返回:
- A getting material response
-
deleteMaterial
public MaterialBaseResponse deleteMaterial(String materialId)
Delete material from material library.- 参数:
materialId- The material id- 返回:
- A deleting material response
-
searchMaterial
public MaterialSearchResponse searchMaterial(MaterialSearchRequest materialSearchRequest)
Search material from material library.- 参数:
materialSearchRequest- search parameters- 返回:
- material list response
-
uploadMaterialPreset
public MaterialPresetUploadResponse uploadMaterialPreset(String type, MatlibUploadRequest matlibUploadRequest)
Upload media preset to material library.- 参数:
matlibUploadRequest- The uploading request- 返回:
- A uploading response
-
getMaterialPreset
public MaterialPresetGetResponse getMaterialPreset(String id)
Get material preset from material library.- 参数:
id- The material preset id- 返回:
- A getting material preset response
-
deleteMaterialPreset
public MaterialBaseResponse deleteMaterialPreset(String id)
Delete material from material library.- 参数:
id- The material preset id- 返回:
- A deleting material preset response
-
searchMaterialPreset
public MaterialPresetSearchResponse searchMaterialPreset(MaterialPresetSearchRequest materialPresetSearchRequest)
Search material preset from material library.- 参数:
materialPresetSearchRequest- search parameters- 返回:
- material list response
-
createMatlibConfig
public MatlibConfigBaseResponse createMatlibConfig(MatlibConfigBaseRequest baseRequest)
Create matlib config.- 参数:
baseRequest- The creating matlib config request.- 返回:
- A creating matlib config response.
-
updateMatlibConfig
public MatlibConfigBaseResponse updateMatlibConfig(MatlibConfigBaseRequest baseRequest)
Update matlib config.- 参数:
baseRequest- The updating matlib config request.- 返回:
- A updating matlib config response.
-
getMatlibConfig
public MatlibConfigGetResponse getMatlibConfig()
Get matlib config.- 返回:
- 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,- 参数:
text2AudioRequest- The text to audio request- 返回:
- 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 Mapto it(From web FE) 2> if you want to construct it by yourself, make object by Map - 参数:
videoEditCreateRequest-- 返回:
- A response of job create result
-
pollingVideoEdit
public VideoEditPollingResponse pollingVideoEdit(long editId)
get edit job status- 参数:
editId-- 返回:
- A job desc of this editId
-
createVideoGenerationTask
public VideoGenerationResponse createVideoGenerationTask(VideoGenerationRequest videoGenerationRequest)
create a video with materials and subtitles- 参数:
videoGenerationRequest- videoGenerationResponse- 返回:
- VideoGenerationResponse
-
queryKeyFrameDescList
public KeyFrameDescGetResponse queryKeyFrameDescList(String instanceId)
get keyframe list from the transcoding task or no transcoding task in the instance- 参数:
instanceId- workflowInstanceId- 返回:
- keyframe list
-
addKeyFrameDesc
public void addKeyFrameDesc(String instanceId, KeyFrameDescAddRequest keyFrameDescAddRequest)
add keyframe for workflowInstance- 参数:
instanceId- workflowInstanceIdkeyFrameDescAddRequest- keyframe desc
-
queryKeyFrameUrlList
public KeyFrameUrlResponse queryKeyFrameUrlList(String instanceId)
get target bos key's preSign url- 参数:
instanceId- workflowInstanceId- 返回:
- keyFrame info list
-
createDraft
public MatlibTaskResponse createDraft(MatlibTaskRequest matlibTaskRequest)
create draft- 参数:
matlibTaskRequest-- 返回:
-
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.
-
-