Package com.google.cloud.video.transcoder.v1 (1.28.0)

A client to Transcoder API

The interfaces provided are listed below, along with usage samples.

TranscoderServiceClient

Service Description: Using the Transcoder API, you can queue asynchronous jobs for transcoding media into various output formats. Output formats may include different streaming standards such as HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can also customize jobs using advanced features such as Digital Rights Management (DRM), audio equalization, content concatenation, and digital ad-stitch ready content generation.

Sample for TranscoderServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Job job = Job.newBuilder().build();
   Job response = transcoderServiceClient.createJob(parent, job);
 }

Classes

AdBreak

Ad break.

Protobuf type google.cloud.video.transcoder.v1.AdBreak

AdBreak.Builder

Ad break.

Protobuf type google.cloud.video.transcoder.v1.AdBreak

AudioStream

Audio stream resource.

Protobuf type google.cloud.video.transcoder.v1.AudioStream

AudioStream.AudioMapping

The mapping for the Job.edit_list atoms with audio EditAtom.inputs.

Protobuf type google.cloud.video.transcoder.v1.AudioStream.AudioMapping

AudioStream.AudioMapping.Builder

The mapping for the Job.edit_list atoms with audio EditAtom.inputs.

Protobuf type google.cloud.video.transcoder.v1.AudioStream.AudioMapping

AudioStream.Builder

Audio stream resource.

Protobuf type google.cloud.video.transcoder.v1.AudioStream

CreateJobRequest

Request message for TranscoderService.CreateJob.

Protobuf type google.cloud.video.transcoder.v1.CreateJobRequest

CreateJobRequest.Builder

Request message for TranscoderService.CreateJob.

Protobuf type google.cloud.video.transcoder.v1.CreateJobRequest

CreateJobTemplateRequest

Request message for TranscoderService.CreateJobTemplate.

Protobuf type google.cloud.video.transcoder.v1.CreateJobTemplateRequest

CreateJobTemplateRequest.Builder

Request message for TranscoderService.CreateJobTemplate.

Protobuf type google.cloud.video.transcoder.v1.CreateJobTemplateRequest

DeleteJobRequest

Request message for TranscoderService.DeleteJob.

Protobuf type google.cloud.video.transcoder.v1.DeleteJobRequest

DeleteJobRequest.Builder

Request message for TranscoderService.DeleteJob.

Protobuf type google.cloud.video.transcoder.v1.DeleteJobRequest

DeleteJobTemplateRequest

Request message for TranscoderService.DeleteJobTemplate.

Protobuf type google.cloud.video.transcoder.v1.DeleteJobTemplateRequest

DeleteJobTemplateRequest.Builder

Request message for TranscoderService.DeleteJobTemplate.

Protobuf type google.cloud.video.transcoder.v1.DeleteJobTemplateRequest

EditAtom

Edit atom.

Protobuf type google.cloud.video.transcoder.v1.EditAtom

EditAtom.Builder

Edit atom.

Protobuf type google.cloud.video.transcoder.v1.EditAtom

ElementaryStream

Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.

Protobuf type google.cloud.video.transcoder.v1.ElementaryStream

ElementaryStream.Builder

Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.

Protobuf type google.cloud.video.transcoder.v1.ElementaryStream

Encryption

Encryption settings.

Protobuf type google.cloud.video.transcoder.v1.Encryption

Encryption.Aes128Encryption

Configuration for AES-128 encryption.

Protobuf type google.cloud.video.transcoder.v1.Encryption.Aes128Encryption

Encryption.Aes128Encryption.Builder

Configuration for AES-128 encryption.

Protobuf type google.cloud.video.transcoder.v1.Encryption.Aes128Encryption

Encryption.Builder

Encryption settings.

Protobuf type google.cloud.video.transcoder.v1.Encryption

Encryption.Clearkey

Clearkey configuration.

Protobuf type google.cloud.video.transcoder.v1.Encryption.Clearkey

Encryption.Clearkey.Builder

Clearkey configuration.

Protobuf type google.cloud.video.transcoder.v1.Encryption.Clearkey

Encryption.DrmSystems

Defines configuration for DRM systems in use.

Protobuf type google.cloud.video.transcoder.v1.Encryption.DrmSystems

Encryption.DrmSystems.Builder

Defines configuration for DRM systems in use.

Protobuf type google.cloud.video.transcoder.v1.Encryption.DrmSystems

Encryption.Fairplay

Fairplay configuration.

Protobuf type google.cloud.video.transcoder.v1.Encryption.Fairplay

Encryption.Fairplay.Builder

Fairplay configuration.

Protobuf type google.cloud.video.transcoder.v1.Encryption.Fairplay

Encryption.MpegCommonEncryption

Configuration for MPEG Common Encryption (MPEG-CENC).

Protobuf type google.cloud.video.transcoder.v1.Encryption.MpegCommonEncryption

Encryption.MpegCommonEncryption.Builder

Configuration for MPEG Common Encryption (MPEG-CENC).

Protobuf type google.cloud.video.transcoder.v1.Encryption.MpegCommonEncryption

Encryption.Playready

Playready configuration.

Protobuf type google.cloud.video.transcoder.v1.Encryption.Playready

Encryption.Playready.Builder

Playready configuration.

Protobuf type google.cloud.video.transcoder.v1.Encryption.Playready

Encryption.SampleAesEncryption

Configuration for SAMPLE-AES encryption.

Protobuf type google.cloud.video.transcoder.v1.Encryption.SampleAesEncryption

Encryption.SampleAesEncryption.Builder

Configuration for SAMPLE-AES encryption.

Protobuf type google.cloud.video.transcoder.v1.Encryption.SampleAesEncryption

Encryption.SecretManagerSource

Configuration for secrets stored in Google Secret Manager.

Protobuf type google.cloud.video.transcoder.v1.Encryption.SecretManagerSource

Encryption.SecretManagerSource.Builder

Configuration for secrets stored in Google Secret Manager.

Protobuf type google.cloud.video.transcoder.v1.Encryption.SecretManagerSource

Encryption.Widevine

Widevine configuration.

Protobuf type google.cloud.video.transcoder.v1.Encryption.Widevine

Encryption.Widevine.Builder

Widevine configuration.

Protobuf type google.cloud.video.transcoder.v1.Encryption.Widevine

GetJobRequest

Request message for TranscoderService.GetJob.

Protobuf type google.cloud.video.transcoder.v1.GetJobRequest

GetJobRequest.Builder

Request message for TranscoderService.GetJob.

Protobuf type google.cloud.video.transcoder.v1.GetJobRequest

GetJobTemplateRequest

Request message for TranscoderService.GetJobTemplate.

Protobuf type google.cloud.video.transcoder.v1.GetJobTemplateRequest

GetJobTemplateRequest.Builder

Request message for TranscoderService.GetJobTemplate.

Protobuf type google.cloud.video.transcoder.v1.GetJobTemplateRequest

Input

Input asset.

Protobuf type google.cloud.video.transcoder.v1.Input

Input.Builder

Input asset.

Protobuf type google.cloud.video.transcoder.v1.Input

Job

Transcoding job resource.

Protobuf type google.cloud.video.transcoder.v1.Job

Job.Builder

Transcoding job resource.

Protobuf type google.cloud.video.transcoder.v1.Job

JobConfig

Job configuration

Protobuf type google.cloud.video.transcoder.v1.JobConfig

JobConfig.Builder

Job configuration

Protobuf type google.cloud.video.transcoder.v1.JobConfig

JobName

JobName.Builder

Builder for projects/{project}/locations/{location}/jobs/{job}.

JobTemplate

Transcoding job template resource.

Protobuf type google.cloud.video.transcoder.v1.JobTemplate

JobTemplate.Builder

Transcoding job template resource.

Protobuf type google.cloud.video.transcoder.v1.JobTemplate

JobTemplateName

JobTemplateName.Builder

Builder for projects/{project}/locations/{location}/jobTemplates/{job_template}.

ListJobTemplatesRequest

Request message for TranscoderService.ListJobTemplates.

Protobuf type google.cloud.video.transcoder.v1.ListJobTemplatesRequest

ListJobTemplatesRequest.Builder

Request message for TranscoderService.ListJobTemplates.

Protobuf type google.cloud.video.transcoder.v1.ListJobTemplatesRequest

ListJobTemplatesResponse

Response message for TranscoderService.ListJobTemplates.

Protobuf type google.cloud.video.transcoder.v1.ListJobTemplatesResponse

ListJobTemplatesResponse.Builder

Response message for TranscoderService.ListJobTemplates.

Protobuf type google.cloud.video.transcoder.v1.ListJobTemplatesResponse

ListJobsRequest

Request message for TranscoderService.ListJobs. The parent location from which to retrieve the collection of jobs.

Protobuf type google.cloud.video.transcoder.v1.ListJobsRequest

ListJobsRequest.Builder

Request message for TranscoderService.ListJobs. The parent location from which to retrieve the collection of jobs.

Protobuf type google.cloud.video.transcoder.v1.ListJobsRequest

ListJobsResponse

Response message for TranscoderService.ListJobs.

Protobuf type google.cloud.video.transcoder.v1.ListJobsResponse

ListJobsResponse.Builder

Response message for TranscoderService.ListJobs.

Protobuf type google.cloud.video.transcoder.v1.ListJobsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

Manifest

Manifest configuration.

Protobuf type google.cloud.video.transcoder.v1.Manifest

Manifest.Builder

Manifest configuration.

Protobuf type google.cloud.video.transcoder.v1.Manifest

Manifest.DashConfig

DASH manifest configuration.

Protobuf type google.cloud.video.transcoder.v1.Manifest.DashConfig

Manifest.DashConfig.Builder

DASH manifest configuration.

Protobuf type google.cloud.video.transcoder.v1.Manifest.DashConfig

MuxStream

Multiplexing settings for output stream.

Protobuf type google.cloud.video.transcoder.v1.MuxStream

MuxStream.Builder

Multiplexing settings for output stream.

Protobuf type google.cloud.video.transcoder.v1.MuxStream

Output

Location of output file(s) in a Cloud Storage bucket.

Protobuf type google.cloud.video.transcoder.v1.Output

Output.Builder

Location of output file(s) in a Cloud Storage bucket.

Protobuf type google.cloud.video.transcoder.v1.Output

Overlay

Overlay configuration.

Protobuf type google.cloud.video.transcoder.v1.Overlay

Overlay.Animation

Animation types.

Protobuf type google.cloud.video.transcoder.v1.Overlay.Animation

Overlay.Animation.Builder

Animation types.

Protobuf type google.cloud.video.transcoder.v1.Overlay.Animation

Overlay.AnimationEnd

End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video.

Protobuf type google.cloud.video.transcoder.v1.Overlay.AnimationEnd

Overlay.AnimationEnd.Builder

End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video.

Protobuf type google.cloud.video.transcoder.v1.Overlay.AnimationEnd

Overlay.AnimationFade

Display overlay object with fade animation.

Protobuf type google.cloud.video.transcoder.v1.Overlay.AnimationFade

Overlay.AnimationFade.Builder

Display overlay object with fade animation.

Protobuf type google.cloud.video.transcoder.v1.Overlay.AnimationFade

Overlay.AnimationStatic

Display static overlay object.

Protobuf type google.cloud.video.transcoder.v1.Overlay.AnimationStatic

Overlay.AnimationStatic.Builder

Display static overlay object.

Protobuf type google.cloud.video.transcoder.v1.Overlay.AnimationStatic

Overlay.Builder

Overlay configuration.

Protobuf type google.cloud.video.transcoder.v1.Overlay

Overlay.Image

Overlaid image.

Protobuf type google.cloud.video.transcoder.v1.Overlay.Image

Overlay.Image.Builder

Overlaid image.

Protobuf type google.cloud.video.transcoder.v1.Overlay.Image

Overlay.NormalizedCoordinate

2D normalized coordinates. Default: {0.0, 0.0}

Protobuf type google.cloud.video.transcoder.v1.Overlay.NormalizedCoordinate

Overlay.NormalizedCoordinate.Builder

2D normalized coordinates. Default: {0.0, 0.0}

Protobuf type google.cloud.video.transcoder.v1.Overlay.NormalizedCoordinate

PreprocessingConfig

Preprocessing configurations.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig

PreprocessingConfig.Audio

Audio preprocessing configuration.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Audio

PreprocessingConfig.Audio.Builder

Audio preprocessing configuration.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Audio

PreprocessingConfig.Builder

Preprocessing configurations.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig

PreprocessingConfig.Color

Color preprocessing configuration.

Note: This configuration is not supported.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Color

PreprocessingConfig.Color.Builder

Color preprocessing configuration.

Note: This configuration is not supported.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Color

PreprocessingConfig.Crop

Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Crop

PreprocessingConfig.Crop.Builder

Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Crop

PreprocessingConfig.Deblock

Deblock preprocessing configuration.

Note: This configuration is not supported.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Deblock

PreprocessingConfig.Deblock.Builder

Deblock preprocessing configuration.

Note: This configuration is not supported.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Deblock

PreprocessingConfig.Deinterlace

Deinterlace configuration for input video.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Deinterlace

PreprocessingConfig.Deinterlace.Builder

Deinterlace configuration for input video.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Deinterlace

PreprocessingConfig.Deinterlace.BwdifConfig

Bob Weaver Deinterlacing Filter Configuration.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Deinterlace.BwdifConfig

PreprocessingConfig.Deinterlace.BwdifConfig.Builder

Bob Weaver Deinterlacing Filter Configuration.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Deinterlace.BwdifConfig

PreprocessingConfig.Deinterlace.YadifConfig

Yet Another Deinterlacing Filter Configuration.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Deinterlace.YadifConfig

PreprocessingConfig.Deinterlace.YadifConfig.Builder

Yet Another Deinterlacing Filter Configuration.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Deinterlace.YadifConfig

PreprocessingConfig.Denoise

Denoise preprocessing configuration.

Note: This configuration is not supported.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Denoise

PreprocessingConfig.Denoise.Builder

Denoise preprocessing configuration.

Note: This configuration is not supported.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Denoise

PreprocessingConfig.Pad

Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Pad

PreprocessingConfig.Pad.Builder

Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution.

Protobuf type google.cloud.video.transcoder.v1.PreprocessingConfig.Pad

PubsubDestination

A Pub/Sub destination.

Protobuf type google.cloud.video.transcoder.v1.PubsubDestination

PubsubDestination.Builder

A Pub/Sub destination.

Protobuf type google.cloud.video.transcoder.v1.PubsubDestination

ResourcesProto

SegmentSettings

Segment settings for ts, fmp4 and vtt.

Protobuf type google.cloud.video.transcoder.v1.SegmentSettings

SegmentSettings.Builder

Segment settings for ts, fmp4 and vtt.

Protobuf type google.cloud.video.transcoder.v1.SegmentSettings

ServicesProto

SpriteSheet

Sprite sheet configuration.

Protobuf type google.cloud.video.transcoder.v1.SpriteSheet

SpriteSheet.Builder

Sprite sheet configuration.

Protobuf type google.cloud.video.transcoder.v1.SpriteSheet

TextStream

Encoding of a text stream. For example, closed captions or subtitles.

Protobuf type google.cloud.video.transcoder.v1.TextStream

TextStream.Builder

Encoding of a text stream. For example, closed captions or subtitles.

Protobuf type google.cloud.video.transcoder.v1.TextStream

TextStream.TextMapping

The mapping for the Job.edit_list atoms with text EditAtom.inputs.

Protobuf type google.cloud.video.transcoder.v1.TextStream.TextMapping

TextStream.TextMapping.Builder

The mapping for the Job.edit_list atoms with text EditAtom.inputs.

Protobuf type google.cloud.video.transcoder.v1.TextStream.TextMapping

TranscoderServiceClient

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (TranscoderServiceClient transcoderServiceClient = TranscoderServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Job job = Job.newBuilder().build();
   Job response = transcoderServiceClient.createJob(parent, job);
 }

Note: close() needs to be called on the TranscoderServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of TranscoderServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TranscoderServiceSettings transcoderServiceSettings =
     TranscoderServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TranscoderServiceClient transcoderServiceClient =
     TranscoderServiceClient.create(transcoderServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TranscoderServiceSettings transcoderServiceSettings =
     TranscoderServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TranscoderServiceClient transcoderServiceClient =
     TranscoderServiceClient.create(transcoderServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TranscoderServiceSettings transcoderServiceSettings =
     TranscoderServiceSettings.newHttpJsonBuilder().build();
 TranscoderServiceClient transcoderServiceClient =
     TranscoderServiceClient.create(transcoderServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

TranscoderServiceClient.ListJobTemplatesFixedSizeCollection

TranscoderServiceClient.ListJobTemplatesPage

TranscoderServiceClient.ListJobTemplatesPagedResponse

TranscoderServiceClient.ListJobsFixedSizeCollection

TranscoderServiceClient.ListJobsPage

TranscoderServiceClient.ListJobsPagedResponse

TranscoderServiceGrpc

Using the Transcoder API, you can queue asynchronous jobs for transcoding media into various output formats. Output formats may include different streaming standards such as HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can also customize jobs using advanced features such as Digital Rights Management (DRM), audio equalization, content concatenation, and digital ad-stitch ready content generation.

The default service address (transcoder.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createJob to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TranscoderServiceSettings.Builder transcoderServiceSettingsBuilder =
     TranscoderServiceSettings.newBuilder();
 transcoderServiceSettingsBuilder
     .createJobSettings()
     .setRetrySettings(
         transcoderServiceSettingsBuilder
             .createJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TranscoderServiceSettings transcoderServiceSettings = transcoderServiceSettingsBuilder.build();

Package com.google.cloud.video.transcoder.v1 (1.28.0)

TranscoderServiceClient

Classes

Interfaces