com.baidubce.services.media

Class MediaClient

java.lang.Object

com.baidubce.AbstractBceClient

com.baidubce.services.media.MediaClient

public class MediaClient
extends AbstractBceClient

Client for accessing Media Transcoder Services. All service calls made using this client are blocking, and will not return until the service call completes. Created by xuchuan on 2015/4/20.

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
MediaClient() Constructs a new Media client to invoke service methods on Media Transcoder.
MediaClient(BceClientConfiguration clientConfiguration) Constructs a new client using the client configuration to access Media Transcoder services.

Method Summary

Methods

Modifier and Type	Method and Description
CreateJobResponse	createJob(CreateJobRequest request) Creates a new transcoder job which converts media files in BOS buckets with specified preset.
CreateJobResponse	createJob(String pipelineName, String sourceKey, String targetKey, String presetName) Creates a new transcoder job which converts media files in BOS buckets with specified preset.
CreatePipelineResponse	createPipeline(CreatePipelineRequest request) Creates a pipeline which enable you to perform multiple transcodes in parallel.
CreatePipelineResponse	createPipeline(String pipelineName, String sourceBucket, String targetBucket) Creates a pipeline which enable you to perform multiple transcodes in parallel.
CreatePipelineResponse	createPipeline(String pipelineName, String sourceBucket, String targetBucket, int capacity) Creates a pipeline which enable you to perform multiple transcodes in parallel.
CreatePipelineResponse	createPipeline(String pipelineName, String description, String sourceBucket, String targetBucket, int capacity) Creates a pipeline which enable you to perform multiple transcodes in parallel.
CreatePresetResponse	createPreset(CreatePresetRequest request) Create a preset which help to convert media files on be played in a wide range of devices.
CreatePresetResponse	createPreset(String presetName, Container container) Create a preset which only convert source media file to a different container format without changing the file contents.
CreatePresetResponse	createPreset(String presetName, Container container, Audio audio) Create a preset which help to convert audio files on be played in a wide range of devices.
CreatePresetResponse	createPreset(String presetName, Container container, Audio audio, Video video) Create a preset which help to convert video files on be played in a wide range of devices.
CreatePresetResponse	createPreset(String presetName, Container container, Clip clip, Audio audio, Encryption encryption) Create a preset which help to convert audio files on be played in a wide range of devices.
CreatePresetResponse	createPreset(String presetName, Container container, Clip clip, Audio audio, Video video, Encryption encryption) Create a preset which help to convert video files on be played in a wide range of devices.
CreatePresetResponse	createPreset(String presetName, String description, Container container, boolean transmux, Clip clip, Audio audio, Video video, Encryption encryption) Create a preset which help to convert media files on be played in a wide range of devices.
void	deletePipeline(DeletePipelineRequest request) Deletes a pipeline with the specified pipeline name.
void	deletePipeline(String pipelineName) Gets a pipeline with the specified pipeline name.
void	deletePreset(DeletePresetRequest request) Deletes a preset with specified name.
void	deletePreset(String presetName) Deletes a preset with specified name.
GetJobResponse	getJob(GetJobRequest request) Retrieve the status of a job.
GetJobResponse	getJob(String jobId) Retrieve the status of a job.
GetMediaInfoOfFileResponse	getMediaInfoOfFile(GetMediaInfoOfFileRequest request) Retrieve the media information of an object in Bos bucket.
GetMediaInfoOfFileResponse	getMediaInfoOfFile(String bucket, String key) Retrieve the media information of an object in Bos bucket.
GetPipelineResponse	getPipeline(GetPipelineRequest request) Gets a pipeline with the specified pipeline name.
GetPipelineResponse	getPipeline(String pipelineName) Gets a pipeline with the specified pipeline name.
GetPresetResponse	getPreset(GetPresetRequest request) Gets a preset with specified name.
GetPresetResponse	getPreset(String presetName) Gets a preset with specified name.
ListJobsResponse	listJobs(ListJobsRequest request) List all transcoder jobs on specified pipeline.
ListJobsResponse	listJobs(String pipelineName) List all transcoder jobs on specified pipeline.
ListPipelinesResponse	listPipelines() List all your pipelines.
ListPipelinesResponse	listPipelines(ListPipelinesRequest request) List all your pipelines.
ListPresetsResponse	listPresets() List all system and user's preset.
ListPresetsResponse	listPresets(ListPresetsRequest request) List all system and user's preset.

Methods inherited from class com.baidubce.AbstractBceClient

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

MediaClient

public MediaClient()

Constructs a new Media client to invoke service methods on Media Transcoder.

MediaClient

public MediaClient(BceClientConfiguration clientConfiguration)

Constructs a new client using the client configuration to access Media Transcoder services.

Parameters:

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

Method Detail

createJob

public CreateJobResponse createJob(String pipelineName,
                          String sourceKey,
                          String targetKey,
                          String presetName)

Creates a new transcoder job which converts media files in BOS buckets with specified preset.

Parameters:

pipelineName - The name of pipeline used by this job.

sourceKey - The key of the source media file in the bucket specified in the pipeline.

targetKey - The key of the target media file in the bucket specified in the pipeline.

presetName - The name of the preset used by this job.

Returns:

The newly created job ID.

createJob

public CreateJobResponse createJob(CreateJobRequest request)

Creates a new transcoder job which converts media files in BOS buckets with specified preset.

Parameters:

request - The request object containing all options for creating a job.

Returns:

The newly created job ID.

listJobs

public ListJobsResponse listJobs(String pipelineName)

List all transcoder jobs on specified pipeline.

Parameters:

pipelineName - The name of a pipeline.

Returns:

The list of job IDs.

listJobs

public ListJobsResponse listJobs(ListJobsRequest request)

List all transcoder jobs on specified pipeline.

Parameters:

request - The request object containing all options for list jobs.

Returns:

The list of job IDs.

getJob

public GetJobResponse getJob(String jobId)

Retrieve the status of a job.

Parameters:

jobId - The ID of a job.

Returns:

The status of a job.

getJob

public GetJobResponse getJob(GetJobRequest request)

Retrieve the status of a job.

Parameters:

request - The request object containing all options for retrieving job status.

Returns:

The status of a job.

createPipeline

public CreatePipelineResponse createPipeline(String pipelineName,
                                    String sourceBucket,
                                    String targetBucket,
                                    int capacity)

Creates a pipeline which enable you to perform multiple transcodes in parallel.

Parameters:

pipelineName - The name of the new pipeline.

sourceBucket - The name of source bucket in Bos.

targetBucket - The name of target bucket in Bos.

capacity - The concurrent capability of the new pipeline.

createPipeline

public CreatePipelineResponse createPipeline(String pipelineName,
                                    String sourceBucket,
                                    String targetBucket)

Creates a pipeline which enable you to perform multiple transcodes in parallel.

Parameters:

pipelineName - The name of the new pipeline.

sourceBucket - The name of source bucket in Bos.

targetBucket - The name of target bucket in Bos.

createPipeline

public CreatePipelineResponse createPipeline(String pipelineName,
                                    String description,
                                    String sourceBucket,
                                    String targetBucket,
                                    int capacity)

Creates a pipeline which enable you to perform multiple transcodes in parallel.

Parameters:

pipelineName - The name of new pipeline.

description - The optional description of the new pipeline.

sourceBucket - The name of source bucket in Bos.

targetBucket - The name of target bucket in Bos.

capacity - The concurrent capability of the new pipeline.

createPipeline

public CreatePipelineResponse createPipeline(CreatePipelineRequest request)

Creates a pipeline which enable you to perform multiple transcodes in parallel.

Parameters:

request - The request object containing all options for creating new pipeline.

listPipelines

public ListPipelinesResponse listPipelines()

List all your pipelines.

Returns:

The list of all your pipelines

listPipelines

public ListPipelinesResponse listPipelines(ListPipelinesRequest request)

List all your pipelines.

Parameters:

request - The request object containing all options for listing all pipelines.

Returns:

The list of all your pipelines

getPipeline

public GetPipelineResponse getPipeline(String pipelineName)

Gets a pipeline with the specified pipeline name.

Parameters:

pipelineName - The name of your pipeline.

Returns:

The information of your pipeline.

getPipeline

public GetPipelineResponse getPipeline(GetPipelineRequest request)

Gets a pipeline with the specified pipeline name.

Parameters:

request - The request object containing all options for getting a pipelines.

Returns:

The information of your pipeline.

deletePipeline

public void deletePipeline(String pipelineName)

Gets a pipeline with the specified pipeline name.

Parameters:

pipelineName - The name of your pipeline.

deletePipeline

public void deletePipeline(DeletePipelineRequest request)

Deletes a pipeline with the specified pipeline name.

Parameters:

request - The request object containing all options for deleting a pipelines.

createPreset

public CreatePresetResponse createPreset(String presetName,
                                Container container,
                                Audio audio)

Create a preset which help to convert audio files on be played in a wide range of devices.

Parameters:

presetName - The name of the new preset.

container - The container type for the output file. Valid values include mp4, flv, hls, mp3, m4a.

audio - Specify the audio format of target file.

createPreset

public CreatePresetResponse createPreset(String presetName,
                                Container container,
                                Clip clip,
                                Audio audio,
                                Encryption encryption)

Create a preset which help to convert audio files on be played in a wide range of devices.

Parameters:

presetName - The name of the new preset.

container - The container type for the output file. Valid values include mp4, flv, hls, mp3, m4a.

clip - The clip property of the preset.

audio - Specify the audio format of target file.

encryption - Specify the encryption property of target file.

createPreset

public CreatePresetResponse createPreset(String presetName,
                                Container container,
                                Audio audio,
                                Video video)

Create a preset which help to convert video files on be played in a wide range of devices.

Parameters:

presetName - The name of the new preset.

container - The container type for the output file. Valid values include mp4, flv, hls, mp3, m4a.

audio - Specify the audio format of target file.

video - Specify the video format of target file.

createPreset

public CreatePresetResponse createPreset(String presetName,
                                Container container,
                                Clip clip,
                                Audio audio,
                                Video video,
                                Encryption encryption)

Create a preset which help to convert video files on be played in a wide range of devices.

Parameters:

presetName - The name of the new preset.

container - The container type for the output file. Valid values include mp4, flv, hls, mp3, m4a.

clip - The clip property of the preset.

audio - Specify the audio format of target file.

video - Specify the video format of target file.

encryption - Specify the encryption property of target file.

createPreset

public CreatePresetResponse createPreset(String presetName,
                                Container container)

Create a preset which only convert source media file to a different container format without changing the file contents.

Parameters:

presetName - The name of the new preset.

container - The container type for the output file. Valid values include mp4, flv, hls, mp3, m4a.

createPreset

public CreatePresetResponse createPreset(String presetName,
                                String description,
                                Container container,
                                boolean transmux,
                                Clip clip,
                                Audio audio,
                                Video video,
                                Encryption encryption)

Create a preset which help to convert media files on be played in a wide range of devices.

Parameters:

presetName - The name of the new preset.

description - The description of the new preset

container - The container type for the output file. Valid values include mp4, flv, hls, mp3, m4a.

transmux - If true, means only convert source media file to a different container format without changing the file contents.

clip - The clip property of the preset.

audio - Specify the audio format of target file.

video - Specify the video format of target file.

encryption - Specify the encryption property of target file.

createPreset

public CreatePresetResponse createPreset(CreatePresetRequest request)

Create a preset which help to convert media files on be played in a wide range of devices.

Parameters:

request - The request object containing all options for deleting presets.

listPresets

public ListPresetsResponse listPresets()

List all system and user's preset.

Returns:

The list of all available preset.

listPresets

public ListPresetsResponse listPresets(ListPresetsRequest request)

List all system and user's preset.

Parameters:

request - The request object containing all options for listing presets.

Returns:

The list of all available preset.

getPreset

public GetPresetResponse getPreset(String presetName)

Gets a preset with specified name.

Parameters:

presetName - The name of a preset.

Returns:

The information of the preset.

getPreset

public GetPresetResponse getPreset(GetPresetRequest request)

Gets a preset with specified name.

Parameters:

request - The request object containing all options for getting a preset.

Returns:

The information of the preset.

deletePreset

public void deletePreset(String presetName)

Deletes a preset with specified name.

Parameters:

presetName - The name of a preset.

deletePreset

public void deletePreset(DeletePresetRequest request)

Deletes a preset with specified name.

Parameters:

request - The request object containing all options for deleting a preset.

getMediaInfoOfFile

public GetMediaInfoOfFileResponse getMediaInfoOfFile(String bucket,
                                            String key)

Retrieve the media information of an object in Bos bucket.

Parameters:

bucket - The bucket name of Bos object which you want to read.

key - The key name of Bos object which your want to read.

Returns:

The media information of an object in Bos bucket.

getMediaInfoOfFile

public GetMediaInfoOfFileResponse getMediaInfoOfFile(GetMediaInfoOfFileRequest request)

Retrieve the media information of an object in Bos bucket.

Parameters:

request - The request object containing all options for retrieving media information.

Returns:

The media information of an object in Bos bucket.