类 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.
    • 构造器详细资料

      • 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.
        参数:
        clientConfiguration - The client configuration options controlling how this client connects to Media services (e.g. proxy settings, retry counts, etc).
    • 方法详细资料

      • createJob

        @Deprecated
        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.
        参数:
        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.
        返回:
        The newly created job ID.
      • createTranscodingJob

        public CreateTranscodingJobResponse createTranscodingJob​(String pipelineName,
                                                                 String sourceKey,
                                                                 String targetKey,
                                                                 String presetName)
        Creates a new transcoder job which converts media files in BOS buckets with specified preset.
        参数:
        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.
        返回:
        The newly created job ID.
      • createTranscodingJob

        public CreateTranscodingJobResponse createTranscodingJob​(String pipelineName,
                                                                 String sourceKey,
                                                                 String targetKey,
                                                                 String presetName,
                                                                 String watermarkId,
                                                                 Area delogoArea)
        Creates a new transcoder job which converts media files in BOS buckets with specified preset, watermarkId, and delogoArea.
        参数:
        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.
        watermarkId - Single watermarkId associated with the job.
        delogoArea - The delogo area (x, y, width, height).
        返回:
        The newly created job ID.
      • createTranscodingJob

        public CreateTranscodingJobResponse createTranscodingJob​(String pipelineName,
                                                                 List<SourceClip> clips,
                                                                 String targetKey,
                                                                 String presetName)
        Creates a new transcoder job which converts media files in BOS buckets with specified preset.
        参数:
        pipelineName - The name of pipeline used by this job.
        clips - The keys 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.
        返回:
        The newly created job ID.
      • createTranscodingJob

        public CreateTranscodingJobResponse createTranscodingJob​(String pipelineName,
                                                                 List<SourceClip> clips,
                                                                 String targetKey,
                                                                 String presetName,
                                                                 String watermarkId)
        Creates a new transcoder job which converts media files in BOS buckets with specified preset and watermarkId associated with the job.
        参数:
        pipelineName - The name of pipeline used by this job.
        clips - The keys 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.
        watermarkId - Single watermarkId associated with the job.
        返回:
        The newly created job ID.
      • createTranscodingJob

        public CreateTranscodingJobResponse createTranscodingJob​(String pipelineName,
                                                                 List<SourceClip> clips,
                                                                 String targetKey,
                                                                 String presetName,
                                                                 String watermarkId,
                                                                 Area delogoArea)
        Creates a new transcoder job which converts media files in BOS buckets with specified preset, watermarkId, and delogoArea.
        参数:
        pipelineName - The name of pipeline used by this job.
        clips - The keys 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.
        watermarkId - Single watermarkId associated with the job.
        delogoArea - The delogo area (x, y, width, height).
        返回:
        The newly created job ID.
      • createTranscodingJob

        public CreateTranscodingJobResponse createTranscodingJob​(String pipelineName,
                                                                 List<SourceClip> clips,
                                                                 String targetKey,
                                                                 String presetName,
                                                                 String watermarkId,
                                                                 Area delogoArea,
                                                                 Area crop,
                                                                 List<Insert> inserts)
        Creates a new transcoder job which converts media files in BOS buckets with specified preset, watermarkId, and delogoArea.
        参数:
        pipelineName - The name of pipeline used by this job.
        clips - The keys 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.
        watermarkId - Single watermarkId associated with the job.
        delogoArea - The delogo area (x, y, width, height).
        crop - The crop area (x, y, width, height).
        inserts - The list of Insert.
        返回:
        The newly created job ID.
      • createTranscodingJob

        public CreateTranscodingJobResponse createTranscodingJob​(CreateTranscodingJobRequest request)
        Creates a new transcoder job which converts media files in BOS buckets with specified preset.
        参数:
        request - The request object containing all options for creating a job.
        返回:
        The newly created job ID.
      • listTranscodingJobs

        public ListTranscodingJobsResponse listTranscodingJobs​(String pipelineName)
        List all transcoder jobs on specified pipeline.
        参数:
        pipelineName - The name of a pipeline.
        返回:
        The list of job IDs.
      • listTranscodingJobs

        public ListTranscodingJobsResponse listTranscodingJobs​(ListTranscodingJobsRequest request)
        List all transcoder jobs on specified pipeline.
        参数:
        request - The request object containing all options for list jobs.
        返回:
        The list of job IDs.
      • getTranscodingJob

        public GetTranscodingJobResponse getTranscodingJob​(String jobId)
        Retrieve the status of a job.
        参数:
        jobId - The ID of a job.
        返回:
        The status of a job.
      • getTranscodingJob

        public GetTranscodingJobResponse getTranscodingJob​(GetTranscodingJobRequest request)
        Retrieve the status of a job.
        参数:
        request - The request object containing all options for retrieving job status.
        返回:
        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.
        参数:
        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.
        参数:
        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.
        参数:
        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​(String pipelineName,
                                                     String description,
                                                     String sourceBucket,
                                                     String targetBucket,
                                                     int capacity,
                                                     String notification)
        Creates a pipeline which enable you to perform multiple transcodes in parallel.
        参数:
        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.
        notification - The name of notification
      • createPipeline

        public CreatePipelineResponse createPipeline​(CreatePipelineRequest request)
        Creates a pipeline which enable you to perform multiple transcodes in parallel.
        参数:
        request - The request object containing all options for creating new pipeline.
      • updatePipeline

        public UpdatePipelineResponse updatePipeline​(UpdatePipelineRequest request)
        Creates a pipeline which enable you to perform multiple transcodes in parallel.
        参数:
        request - The request object containing all options for creating new pipeline.
      • listPipelines

        public ListPipelinesResponse listPipelines()
        List all your pipelines.
        返回:
        The list of all your pipelines
      • listPipelines

        public ListPipelinesResponse listPipelines​(ListPipelinesRequest request)
        List all your pipelines.
        参数:
        request - The request object containing all options for listing all pipelines.
        返回:
        The list of all your pipelines
      • getPipeline

        public GetPipelineResponse getPipeline​(String pipelineName)
        Gets a pipeline with the specified pipeline name.
        参数:
        pipelineName - The name of your pipeline.
        返回:
        The information of your pipeline.
      • getPipeline

        public GetPipelineResponse getPipeline​(GetPipelineRequest request)
        Gets a pipeline with the specified pipeline name.
        参数:
        request - The request object containing all options for getting a pipelines.
        返回:
        The information of your pipeline.
      • deletePipeline

        public void deletePipeline​(String pipelineName)
        Gets a pipeline with the specified pipeline name.
        参数:
        pipelineName - The name of your pipeline.
      • deletePipeline

        public void deletePipeline​(DeletePipelineRequest request)
        Deletes a pipeline with the specified pipeline name.
        参数:
        request - The request object containing all options for deleting a pipelines.
      • createPreset

        public CreatePresetResponse createPreset​(String presetName,
                                                 String container,
                                                 Audio audio)
        Create a preset which help to convert audio files on be played in a wide range of devices.
        参数:
        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,
                                                 String description,
                                                 String container,
                                                 Audio audio)
        Create a preset which help to convert audio files on be played in a wide range of devices.
        参数:
        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.
        audio - Specify the audio format of target file.
      • createPreset

        public CreatePresetResponse createPreset​(String presetName,
                                                 String 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.
        参数:
        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,
                                                 String description,
                                                 String 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.
        参数:
        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.
        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,
                                                 String container,
                                                 Audio audio,
                                                 Video video)
        Create a preset which help to convert video files on be played in a wide range of devices.
        参数:
        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,
                                                 String description,
                                                 String container,
                                                 Audio audio,
                                                 Video video)
        Create a preset which help to convert video files on be played in a wide range of devices.
        参数:
        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.
        audio - Specify the audio format of target file.
        video - Specify the video format of target file.
      • createPreset

        public CreatePresetResponse createPreset​(String presetName,
                                                 String 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.
        参数:
        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,
                                                 String description,
                                                 String 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.
        参数:
        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.
        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,
                                                 String container,
                                                 Clip clip,
                                                 Audio audio,
                                                 Video video,
                                                 Encryption encryption,
                                                 String watermarkId)
        Create a preset which help to convert video files on be played in a wide range of devices.
        参数:
        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.
        watermarkId - Specify the watermarkId.
      • createPreset

        public CreatePresetResponse createPreset​(String presetName,
                                                 String description,
                                                 String container,
                                                 Clip clip,
                                                 Audio audio,
                                                 Video video,
                                                 Encryption encryption,
                                                 String watermarkId)
        Create a preset which help to convert video files on be played in a wide range of devices.
        参数:
        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.
        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.
        watermarkId - Specify the watermarkId.
      • createPreset

        public CreatePresetResponse createPreset​(String presetName,
                                                 String container)
        Create a preset which only convert source media file to a different container format without changing the file contents.
        参数:
        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,
                                                 String container)
        Create a preset which only convert source media file to a different container format without changing the file contents.
        参数:
        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.
      • createPreset

        public CreatePresetResponse createPreset​(String presetName,
                                                 String description,
                                                 String 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.
        参数:
        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​(String presetName,
                                                 String description,
                                                 String container,
                                                 boolean transmux,
                                                 Clip clip,
                                                 Audio audio,
                                                 Video video,
                                                 Encryption encryption,
                                                 String watermarkId)
        Create a preset which help to convert media files on be played in a wide range of devices.
        参数:
        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.
        watermarkId - Specify the watermarkId.
      • createPreset

        public CreatePresetResponse createPreset​(String presetName,
                                                 String description,
                                                 String container,
                                                 boolean transmux,
                                                 Clip clip,
                                                 Audio audio,
                                                 Video video,
                                                 Encryption encryption,
                                                 Watermarks watermarks,
                                                 TransCfg transCfg,
                                                 ExtraCfg extraCfg)
        Create a preset which help to convert media files on be played in a wide range of devices. This version contains all parameters for creating a preset except watermarkId, since watermarks and watermarkId is conflict.
        参数:
        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.
        watermarks - Specify the watermarks.
        transCfg - Specify the transcoding configuration.
        extraCfg - Specify the extra configuration.
      • createPreset

        public CreatePresetResponse createPreset​(CreatePresetRequest request)
        Create a preset which help to convert media files on be played in a wide range of devices.
        参数:
        request - The request object containing all options for deleting presets.
      • listPresets

        public ListPresetsResponse listPresets()
        List all system and user's preset.
        返回:
        The list of all available preset.
      • listPresets

        public ListPresetsResponse listPresets​(ListPresetsRequest request)
        List all system and user's preset.
        参数:
        request - The request object containing all options for listing presets.
        返回:
        The list of all available preset.
      • getPreset

        public GetPresetResponse getPreset​(String presetName)
        Gets a preset with specified name.
        参数:
        presetName - The name of a preset.
        返回:
        The information of the preset.
      • getPreset

        public GetPresetResponse getPreset​(GetPresetRequest request)
        Gets a preset with specified name.
        参数:
        request - The request object containing all options for getting a preset.
        返回:
        The information of the preset.
      • deletePreset

        public void deletePreset​(String presetName)
        Deletes a preset with specified name.
        参数:
        presetName - The name of a preset.
      • deletePreset

        public void deletePreset​(DeletePresetRequest request)
        Deletes a preset with specified name.
        参数:
        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.
        参数:
        bucket - The bucket name of Bos object which you want to read.
        key - The key name of Bos object which your want to read.
        返回:
        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.
        参数:
        request - The request object containing all options for retrieving media information.
        返回:
        The media information of an object in Bos bucket.
      • createWaterMark

        @Deprecated
        public CreateWaterMarkResponse createWaterMark​(String bucket,
                                                       String key,
                                                       int horizontalOffsetInPixel,
                                                       int verticalOffsetInPixel)
        已过时。
        Creates a watermark and return water mark ID.
        参数:
        bucket - The bucket name of Bos object which you want to read.
        key - The key name of Bos object which your want to read.
        horizontalOffsetInPixel - The horizontal offset in pixels.
        verticalOffsetInPixel - The vertical offset in pixels.
        返回:
        watermarkId the unique ID of the new water mark.
      • createWaterMark

        public CreateWaterMarkResponse createWaterMark​(String bucket,
                                                       String key,
                                                       String horizontalAlignment,
                                                       String verticalAlignment)
        Creates a watermark and return water mark ID.
        参数:
        bucket - The bucket name of Bos object which you want to read.
        key - The key name of Bos object which your want to read.
        horizontalAlignment - The horizontal alignment, includes left, center, right.
        verticalAlignment - The vertical alignment, includes top, center, bottom.
        返回:
        watermarkId the unique ID of the new water mark.
      • createWaterMark

        public CreateWaterMarkResponse createWaterMark​(String bucket,
                                                       String key,
                                                       String horizontalAlignment,
                                                       String verticalAlignment,
                                                       int horizontalOffsetInPixel,
                                                       int verticalOffsetInPixel)
        Creates a watermark and return water mark ID.
        参数:
        bucket - The bucket name of Bos object which you want to read.
        key - The key name of Bos object which your want to read.
        horizontalAlignment - The horizontal alignment, includes left, center, right.
        verticalAlignment - The vertical alignment, includes top, center, bottom.
        horizontalOffsetInPixel - The horizontal offset in pixels.
        verticalOffsetInPixel - The vertical offset in pixels.
        返回:
        watermarkId the unique ID of the new water mark.
      • createWaterMark

        public CreateWaterMarkResponse createWaterMark​(String bucket,
                                                       String key,
                                                       String horizontalAlignment,
                                                       String verticalAlignment,
                                                       String dx,
                                                       String dy)
        Creates a watermark and return water mark ID.
        参数:
        bucket - The bucket name of Bos object which you want to read.
        key - The key name of Bos object which your want to read.
        horizontalAlignment - The horizontal alignment, includes left, center, right.
        verticalAlignment - The vertical alignment, includes top, center, bottom.
        dx - The horizontal offset.
        dy - The vertical offset.
        返回:
        watermarkId the unique ID of the new water mark.
      • createWaterMark

        public CreateWaterMarkResponse createWaterMark​(String bucket,
                                                       String key,
                                                       String horizontalAlignment,
                                                       String verticalAlignment,
                                                       String dx,
                                                       String dy,
                                                       String width,
                                                       String height)
        Creates a watermark and return water mark ID.
        参数:
        bucket - The bucket name of Bos object which you want to read.
        key - The key name of Bos object which your want to read.
        horizontalAlignment - The horizontal alignment, includes left, center, right.
        verticalAlignment - The vertical alignment, includes top, center, bottom.
        dx - The horizontal offset.
        dy - The vertical offset.
        width - The width of watermark.
        height - The height of watermark.
        返回:
        watermarkId the unique ID of the new water mark.
      • createWaterMark

        public CreateWaterMarkResponse createWaterMark​(String bucket,
                                                       String key,
                                                       String horizontalAlignment,
                                                       String verticalAlignment,
                                                       int horizontalOffsetInPixel,
                                                       int verticalOffsetInPixel,
                                                       Timeline timeline,
                                                       Integer repeated,
                                                       Boolean allowScaling)
        Creates a watermark and return water mark ID.
        参数:
        bucket - The bucket name of Bos object which you want to read.
        key - The key name of Bos object which your want to read.
        horizontalAlignment - The horizontal alignment, includes left, center, right.
        verticalAlignment - The vertical alignment, includes top, center, bottom.
        horizontalOffsetInPixel - The horizontal offset in pixels.
        verticalOffsetInPixel - The vertical offset in pixels.
        timeline - The vertical offset in pixels.
        repeated - The vertical offset in pixels.
        allowScaling - The vertical offset in pixels.
        返回:
        watermarkId the unique ID of the new water mark.
      • createWaterMark

        public CreateWaterMarkResponse createWaterMark​(String bucket,
                                                       String key,
                                                       String horizontalAlignment,
                                                       String verticalAlignment,
                                                       String dx,
                                                       String dy,
                                                       String width,
                                                       String height,
                                                       Timeline timeline,
                                                       Integer repeated)
        Creates a watermark and return water mark ID.
        参数:
        bucket - The bucket name of Bos object which you want to read.
        key - The key name of Bos object which your want to read.
        horizontalAlignment - The horizontal alignment, includes left, center, right.
        verticalAlignment - The vertical alignment, includes top, center, bottom.
        dx - The horizontal offset.
        dy - The vertical offset.
        width - The width of watermark.
        height - The height of watermark.
        timeline - The vertical offset in pixels.
        repeated - The vertical offset in pixels.
        返回:
        watermarkId the unique ID of the new water mark.
      • createWaterMark

        public CreateWaterMarkResponse createWaterMark​(CreateWaterMarkRequest request)
        Creates a water mark and return water mark ID
        参数:
        request - The request object containing all options for creating new water mark.
        返回:
        watermarkId the unique ID of the new water mark.
      • getWaterMark

        public GetWaterMarkResponse getWaterMark​(String watermarkId)
        Get a water mark for a given water mark ID.
        参数:
        watermarkId - The ID of water mark.
        返回:
        The information of the water mark.
      • getWaterMark

        public GetWaterMarkResponse getWaterMark​(GetWaterMarkRequest request)
        Get a water mark for a given water mark ID.
        参数:
        request - The request object containing all options for getting water mark.
        返回:
        The information of the water mark.
      • listWaterMark

        public ListWaterMarkResponse listWaterMark()
        List all water mark.
        返回:
        The list of all user's water mark.
      • deleteWaterMark

        public void deleteWaterMark​(String watermarkId)
        Delete a water mark.
        参数:
        watermarkId - The ID of water mark.
      • deleteWaterMark

        public void deleteWaterMark​(DeleteWaterMarkRequest request)
        Delete a water mark.
        参数:
        request - The request object containing all options for deleting water mark.
      • createThumbnailJob

        public CreateThumbnailJobResponse createThumbnailJob​(String pipelineName,
                                                             String sourceKey,
                                                             ThumbnailTarget target,
                                                             ThumbnailCapture capture)
        Creates a thumbnail job and return job ID.
        参数:
        pipelineName - The name of a pipeline.
        sourceKey - The key of source object.
        target - The property container of target object.
        capture - The property container of thumbnail generating policies.
        返回:
        the unique ID of the new thumbnail job.
      • createThumbnailJob

        public CreateThumbnailJobResponse createThumbnailJob​(String pipelineName,
                                                             String presetName,
                                                             String sourceKey,
                                                             String targetKeyPrefix)
        Creates a thumbnail job and return job ID.
        参数:
        pipelineName - The name of a pipeline.
        presetName - The name of a thumbnail preset.
        sourceKey - The key of source object.
        targetKeyPrefix - The property container of target object.
        返回:
        the unique ID of the new thumbnail job.
      • createThumbnailJob

        public CreateThumbnailJobResponse createThumbnailJob​(String pipelineName,
                                                             String presetName,
                                                             String sourceKey,
                                                             String targetKeyPrefix,
                                                             Area delogoArea)
        Creates a thumbnail job and return job ID.
        参数:
        pipelineName - The name of a pipeline.
        presetName - The name of a thumbnail preset.
        sourceKey - The key of source object.
        targetKeyPrefix - The property container of target object.
        delogoArea - The property container of delogo Area.
        返回:
        the unique ID of the new thumbnail job.
      • createThumbnailJob

        public CreateThumbnailJobResponse createThumbnailJob​(String pipelineName,
                                                             String presetName,
                                                             String sourceKey,
                                                             String targetKeyPrefix,
                                                             Area delogoArea,
                                                             Area crop)
        Creates a thumbnail job and return job ID.
        参数:
        pipelineName - The name of a pipeline.
        presetName - The name of a thumbnail preset.
        sourceKey - The key of source object.
        targetKeyPrefix - The property container of target object.
        delogoArea - The property container of delogo Area.
        crop - The property container of crop Area.
        返回:
        the unique ID of the new thumbnail job.
      • createThumbnailJob

        public CreateThumbnailJobResponse createThumbnailJob​(String pipelineName,
                                                             String sourceKey,
                                                             ThumbnailTarget target,
                                                             ThumbnailCapture capture,
                                                             Area delogoArea)
        Creates a thumbnail job and return job ID.
        参数:
        pipelineName - The name of a pipeline.
        sourceKey - The key of source object.
        target - The property container of target object.
        capture - The property container of thumbnail generating policies.
        delogoArea - The property container of delogo Area.
        返回:
        the unique ID of the new thumbnail job.
      • createThumbnailJob

        public CreateThumbnailJobResponse createThumbnailJob​(String pipelineName,
                                                             String sourceKey,
                                                             ThumbnailTarget target,
                                                             ThumbnailCapture capture,
                                                             Area delogoArea,
                                                             Area crop)
        Creates a thumbnail job and return job ID.
        参数:
        pipelineName - The name of a pipeline.
        sourceKey - The key of source object.
        target - The property container of target object.
        capture - The property container of thumbnail generating policies.
        delogoArea - The property container of delogo Area.
        crop - The property container of crop Area.
        返回:
        the unique ID of the new thumbnail job.
      • createThumbnailJob

        public CreateThumbnailJobResponse createThumbnailJob​(String pipelineName,
                                                             String sourceKey)
        Creates a thumbnail job and return job ID.
        参数:
        pipelineName - The name of a pipeline.
        sourceKey - The key of source object.
        返回:
        the unique ID of the new thumbnail job.
      • createThumbnailJob

        public CreateThumbnailJobResponse createThumbnailJob​(CreateThumbnailJobRequest request)
        Creates a thumbnail job and return job ID.
        参数:
        request - The request object containing all options for creating new water mark.
        返回:
        the unique ID of the new thumbnail job.
      • getThumbnailJob

        public GetThumbnailJobResponse getThumbnailJob​(String jobId)
        Get information of thumbnail job.
        参数:
        jobId - The unique ID of thumbnail job.
        返回:
        The information of the thumbnail job.
      • getThumbnailJob

        public GetThumbnailJobResponse getThumbnailJob​(GetThumbnailJobRequest request)
        Get information of thumbnail job.
        参数:
        request - The request object containing all options for creating new water mark.
        返回:
        The information of the thumbnail job.
      • listThumbnailJobs

        public ListThumbnailJobsResponse listThumbnailJobs​(String pipelineName)
        List thumbnail jobs for a given pipeline.
        参数:
        pipelineName - The name of a pipeline.
        返回:
        List of thumbnail jobs.
      • listThumbnailJobs

        public ListThumbnailJobsResponse listThumbnailJobs​(ListThumbnailJobsRequest request)
        List thumbnail jobs for a given pipeline.
        参数:
        request - The request object containing all options for creating new water mark.
        返回:
        List of thumbnail jobs.
      • createNotification

        public CreateNotificationResponse createNotification​(String name,
                                                             String endpoint)
        Create a notification.
        参数:
        name - notification name
        endpoint - notification endpoint
      • createThumbnailPreset

        public CreateThumbnailPresetResponse createThumbnailPreset​(String presetName,
                                                                   String description,
                                                                   ThumbnailPresetTarget target,
                                                                   ThumbnailPresetCapture capture)
        Create a thumbnail preset which help to convert video files to be pictures.
        参数:
        presetName - The name of the new preset.
        description - The description of the new preset
        target - The output config of the preset.
        capture - The capture mode of the preset;
      • deleteThumbnailPreset

        public void deleteThumbnailPreset​(String presetName)
        Delete a thumbnail preset with specified name.
        参数:
        presetName - The name of a preset.
      • deleteThumbnailPreset

        public void deleteThumbnailPreset​(DeleteThumbnailPresetRequest request)
        Delete a thumbnail preset with specified name.
        参数:
        request - The request object containing all options for deleting a preset.
      • getThumbnailPreset

        public GetThumbnailPresetResponse getThumbnailPreset​(String presetName)
        Get a thumbnail preset with specified name.
        参数:
        presetName - The name of a preset.
        返回:
        The information of the preset.
      • getThumbnailPreset

        public GetThumbnailPresetResponse getThumbnailPreset​(GetThumbnailPresetRequest request)
        Get a thumbnail preset with specified name.
        参数:
        request - The request object containing all options for getting a thumbnail preset.
        返回:
        The information of the thumbnail preset.
      • listThumbnailPresets

        public ListThumbnailPresetsResponse listThumbnailPresets()
        List all user's thumbnail preset.
        返回:
        The list of all available thumbnail preset.
      • listThumbnailPresets

        public ListThumbnailPresetsResponse listThumbnailPresets​(ListThumbnailPresetsRequest request)
        List all user's thumbnail preset.
        参数:
        request - The request object containing all options for listing presets.
        返回:
        The list of all available thumbnail preset.
      • createSubtitleJob

        public CreateSubtitleJobResponse createSubtitleJob​(CreateSubtitleJobRequest request)
        Creates a subtitle job and return job ID.
        参数:
        request - The request object containing all options for creating new subtitle job.
        返回:
        the unique ID of the new subtitle job.
      • createSubtitleJob

        public CreateSubtitleJobResponse createSubtitleJob​(String pipelineName,
                                                           String sourceKey,
                                                           String targetKeyPrefix)
        Creates a subtitle job and return job ID.
        参数:
        pipelineName - The name of a pipeline.
        sourceKey - The key of source object.
        targetKeyPrefix - The key prefix of target subtitle file in bos.
        返回:
        the unique ID of the new subtitle job.
      • createSubtitleJob

        public CreateSubtitleJobResponse createSubtitleJob​(String pipelineName,
                                                           String sourceKey,
                                                           String targetKeyPrefix,
                                                           String format)
        Creates a subtitle job and return job ID.
        参数:
        pipelineName - The name of a pipeline.
        sourceKey - The key of source object.
        targetKeyPrefix - The key prefix of target subtitle file in bos.
        format - The format of subtitle file, can be json / srt.
        返回:
        the unique ID of the new subtitle job.
      • createSubtitleJob

        public CreateSubtitleJobResponse createSubtitleJob​(String pipelineName,
                                                           String sourceKey,
                                                           String targetKeyPrefix,
                                                           List<String> formats)
        Creates a subtitle job and return job ID.
        参数:
        pipelineName - The name of a pipeline.
        sourceKey - The key of source object.
        targetKeyPrefix - The key prefix of target subtitle file in bos.
        formats - The format of subtitle file, can be json / srt.
        返回:
        the unique ID of the new subtitle job.
      • getSubtitleJob

        public GetSubtitleJobResponse getSubtitleJob​(String jobId)
        Get information of subtitle job.
        参数:
        jobId - The unique ID of subtitle job.
        返回:
        The information of the subtitle job.
      • getSubtitleJob

        public GetSubtitleJobResponse getSubtitleJob​(GetSubtitleJobRequest request)
        Get information of subtitle job.
        参数:
        request - The request object containing all options for getting a subtitle job.
        返回:
        The information of the subtitle job.
      • listSubtitleJobs

        public ListSubtitleJobsResponse listSubtitleJobs​(String pipelineName)
        List subtitle jobs for a given pipeline.
        参数:
        pipelineName - The name of a pipeline.
        返回:
        List of subtitle jobs.
      • listSubtitleJobs

        public ListSubtitleJobsResponse listSubtitleJobs​(ListSubtitleJobsRequest request)
        List subtitle jobs for a given pipeline.
        参数:
        request - The request object containing all options for getting subtitle jobs.
        返回:
        List of subtitle jobs.
      • getTranscodingEncryptionKey

        public GetTranscodingEncryptionKeyResponse getTranscodingEncryptionKey​(String jobId)
        Get transcoding job encryption key
        参数:
        jobId - The job ID want to query transcoding encryption key.
        返回:
        Response Object contains transcoding encryption Aes keyl.