Types overview

AdBreak

Ad break.

Fields

Fields
`startTimeOffset`	`string (Duration format)` Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.

startTimeOffset

string (Duration format)

Start time in seconds for the ad break, relative to the output file timeline. The default is 0s.

Animation

Animation types.

Fields

Fields
`animationEnd`	`object (AnimationEnd)` End previous animation.
`animationFade`	`object (AnimationFade)` Display overlay object with fade animation.
`animationStatic`	`object (AnimationStatic)` Display static overlay object.

animationEnd

object (AnimationEnd)

End previous animation.

animationFade

object (AnimationFade)

Display overlay object with fade animation.

animationStatic

object (AnimationStatic)

Display static overlay object.

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.

Fields

Fields
`startTimeOffset`	`string (Duration format)` The time to end overlay object, in seconds. Default: 0

startTimeOffset

string (Duration format)

The time to end overlay object, in seconds. Default: 0

AnimationFade

Display overlay object with fade animation.

Fields
`endTimeOffset`	`string (Duration format)` The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s
`fadeType`	`enum` Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.
Enum type. Can be one of the following:
`FADE_TYPE_UNSPECIFIED`	The fade type is not specified.
`FADE_IN`	Fade the overlay object into view.
`FADE_OUT`	Fade the overlay object out of view.

`startTimeOffset`	`string (Duration format)` The time to start the fade animation, in seconds. Default: 0
`xy`	`object (NormalizedCoordinate)` Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.

AnimationStatic

Display static overlay object.

Fields

Fields
`startTimeOffset`	`string (Duration format)` The time to start displaying the overlay object, in seconds. Default: 0
`xy`	`object (NormalizedCoordinate)` Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.

startTimeOffset

string (Duration format)

The time to start displaying the overlay object, in seconds. Default: 0

xy

object (NormalizedCoordinate)

Normalized coordinates based on output video resolution. Valid values: 0.0–1.0. xy is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.

Audio

Audio preprocessing configuration.

Fields

Fields
`highBoost`	`boolean` Enable boosting high frequency components. The default is `false`. Note: This field is not supported.
`lowBoost`	`boolean` Enable boosting low frequency components. The default is `false`. Note: This field is not supported.
`lufs`	`number (double format)` Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization

highBoost

boolean

Enable boosting high frequency components. The default is false. Note: This field is not supported.

lowBoost

boolean

Enable boosting low frequency components. The default is false. Note: This field is not supported.

lufs

number (double format)

Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where: * -24 is the Advanced Television Systems Committee (ATSC A/85) standard * -23 is the EU R128 broadcast standard * -19 is the prior standard for online mono audio * -18 is the ReplayGain standard * -16 is the prior standard for stereo audio * -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo * 0 disables normalization

AudioMapping

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

Fields
`atomKey`	`string` Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.
`gainDb`	`number (double format)` Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
`inputChannel`	`integer (int32 format)` Required. The zero-based index of the channel in the input audio stream.
`inputKey`	`string` Required. The `Input.key` that identifies the input file.
`inputTrack`	`integer (int32 format)` Required. The zero-based index of the track in the input file.
`outputChannel`	`integer (int32 format)` Required. The zero-based index of the channel in the output audio stream.

AudioStream

Audio stream resource.

Fields
`bitrateBps`	`integer (int32 format)` Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
`channelCount`	`integer (int32 format)` Number of audio channels. Must be between 1 and 6. The default is 2.
`channelLayout[]`	`string` A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `["fl", "fr"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency
`codec`	`string` The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3`
`mapping[]`	`object (AudioMapping)` The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.
`sampleRateHertz`	`integer (int32 format)` The audio sample rate in Hertz. The default is 48000 Hertz.

BwdifConfig

Bob Weaver Deinterlacing Filter Configuration.

Fields

deinterlaceAllFrames

boolean

Deinterlace all frames rather than just the frames identified as interlaced. The default is false.

mode

string

Specifies the deinterlacing mode to adopt. The default is send_frame. Supported values: - send_frame: Output one frame for each frame - send_field: Output one frame for each field

parity

string

The picture field parity assumed for the input interlaced video. The default is auto. Supported values: - tff: Assume the top field is first - bff: Assume the bottom field is first - auto: Enable automatic detection of field parity

Color

Color preprocessing configuration. Note: This configuration is not supported.

Fields

Fields
`brightness`	`number (double format)` Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.
`contrast`	`number (double format)` Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.
`saturation`	`number (double format)` Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.

brightness

number (double format)

Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.

contrast

number (double format)

Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.

saturation

number (double format)

Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.

Crop

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

Fields
`bottomPixels`	`integer (int32 format)` The number of pixels to crop from the bottom. The default is 0.
`leftPixels`	`integer (int32 format)` The number of pixels to crop from the left. The default is 0.
`rightPixels`	`integer (int32 format)` The number of pixels to crop from the right. The default is 0.
`topPixels`	`integer (int32 format)` The number of pixels to crop from the top. The default is 0.

Deblock

Deblock preprocessing configuration. Note: This configuration is not supported.

Fields

Fields
`enabled`	`boolean` Enable deblocker. The default is `false`.
`strength`	`number (double format)` Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.

enabled

boolean

Enable deblocker. The default is false.

strength

number (double format)

Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.

Deinterlace

Deinterlace configuration for input video.

Fields

Fields
`bwdif`	`object (BwdifConfig)` Specifies the Bob Weaver Deinterlacing Filter Configuration.
`yadif`	`object (YadifConfig)` Specifies the Yet Another Deinterlacing Filter Configuration.

bwdif

object (BwdifConfig)

Specifies the Bob Weaver Deinterlacing Filter Configuration.

yadif

object (YadifConfig)

Specifies the Yet Another Deinterlacing Filter Configuration.

Denoise

Denoise preprocessing configuration. Note: This configuration is not supported.

Fields

Fields
`strength`	`number (double format)` Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.
`tune`	`string` Set the denoiser mode. The default is `standard`. Supported denoiser modes: - `standard` - `grain`

strength

number (double format)

Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.

tune

string

Set the denoiser mode. The default is standard. Supported denoiser modes: - standard - grain

EditAtom

Edit atom.

Fields
`endTimeOffset`	`string (Duration format)` End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.
`inputs[]`	`string` List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.
`key`	`string` A unique key for this atom. Must be specified when using advanced mapping.
`startTimeOffset`	`string (Duration format)` Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.

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.

Fields
`audioStream`	`object (AudioStream)` Encoding of an audio stream.
`key`	`string` A unique key for this elementary stream.
`textStream`	`object (TextStream)` Encoding of a text stream. For example, closed captions or subtitles.
`videoStream`	`object (VideoStream)` Encoding of a video stream.

H264CodecSettings

H264 codec settings.

Fields
`allowOpenGop`	`boolean` Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
`aqStrength`	`number (double format)` Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
`bFrameCount`	`integer (int32 format)` The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
`bPyramid`	`boolean` Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
`bitrateBps`	`integer (int32 format)` Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
`crfLevel`	`integer (int32 format)` Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
`enableTwoPass`	`boolean` Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
`entropyCoder`	`string` The entropy coder to use. The default is `cabac`. Supported entropy coders: - `cavlc` - `cabac`
`frameRate`	`number (double format)` Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See Calculating frame rate for more information.
`gopDuration`	`string (Duration format)` Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to `segmentDuration`, and `segmentDuration` must be divisible by `gopDuration`.
`gopFrameCount`	`integer (int32 format)` Select the GOP size based on the specified frame count. Must be greater than zero.
`heightPixels`	`integer (int32 format)` The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used. For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.
`pixelFormat`	`string` Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
`preset`	`string` Enforces the specified codec preset. The default is `veryfast`. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
`profile`	`string` Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
`rateControlMode`	`string` Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
`tune`	`string` Enforces the specified codec tune. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.
`vbvFullnessBits`	`integer (int32 format)` Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
`vbvSizeBits`	`integer (int32 format)` Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
`widthPixels`	`integer (int32 format)` The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used. For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.

H265CodecSettings

H265 codec settings.

Fields
`allowOpenGop`	`boolean` Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.
`aqStrength`	`number (double format)` Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.
`bFrameCount`	`integer (int32 format)` The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.
`bPyramid`	`boolean` Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.
`bitrateBps`	`integer (int32 format)` Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
`crfLevel`	`integer (int32 format)` Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.
`enableTwoPass`	`boolean` Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `vbr`. The default is `false`.
`frameRate`	`number (double format)` Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See Calculating frame rate for more information.
`gopDuration`	`string (Duration format)` Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to `segmentDuration`, and `segmentDuration` must be divisible by `gopDuration`.
`gopFrameCount`	`integer (int32 format)` Select the GOP size based on the specified frame count. Must be greater than zero.
`heightPixels`	`integer (int32 format)` The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used. For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.
`pixelFormat`	`string` Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
`preset`	`string` Enforces the specified codec preset. The default is `veryfast`. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
`profile`	`string` Enforces the specified codec profile. The following profiles are supported: * 8-bit profiles * `main` (default) * `main-intra` * `mainstillpicture` * 10-bit profiles * `main10` (default) * `main10-intra` * `main422-10` * `main422-10-intra` * `main444-10` * `main444-10-intra` * 12-bit profiles * `main12` (default) * `main12-intra` * `main422-12` * `main422-12-intra` * `main444-12` * `main444-12-intra` The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
`rateControlMode`	`string` Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor
`tune`	`string` Enforces the specified codec tune. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.
`vbvFullnessBits`	`integer (int32 format)` Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.
`vbvSizeBits`	`integer (int32 format)` Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.
`widthPixels`	`integer (int32 format)` The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used. For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.

Image

Overlaid jpeg image.

Fields

Fields
`alpha`	`number (double format)` Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`.
`resolution`	`object (NormalizedCoordinate)` Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`.
`uri`	`string` Required. URI of the JPEG image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`. JPEG is the only supported image type.

alpha

number (double format)

Target image opacity. Valid values are from 1.0 (solid, default) to 0.0 (transparent), exclusive. Set this to a value greater than 0.0.

resolution

object (NormalizedCoordinate)

Normalized image resolution, based on output video resolution. Valid values: 0.0–1.0. To respect the original image aspect ratio, set either x or y to 0.0. To use the original image resolution, set both x and y to 0.0.

uri

string

Required. URI of the JPEG image in Cloud Storage. For example, gs://bucket/inputs/image.jpeg. JPEG is the only supported image type.

Input

Input asset.

Fields

Fields
`key`	`string` A unique key for this input. Must be specified when using advanced mapping and edit lists.
`preprocessingConfig`	`object (PreprocessingConfig)` Preprocessing configurations.
`uri`	`string` URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value is populated from `Job.input_uri`. See Supported input and output formats.

key

string

A unique key for this input. Must be specified when using advanced mapping and edit lists.

preprocessingConfig

object (PreprocessingConfig)

Preprocessing configurations.

uri

string

URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, gs://bucket/inputs/file.mp4). If empty, the value is populated from Job.input_uri. See Supported input and output formats.

Job

Transcoding job resource.

Fields
`config`	`object (JobConfig)` The configuration for this job.
`createTime`	`string (Timestamp format)` Output only. The time the job was created.
`endTime`	`string (Timestamp format)` Output only. The time the transcoding finished.
`error`	`object (Status)` Output only. An error object that describes the reason for the failure. This property is always present when `state` is `FAILED`.
`inputUri`	`string` Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). See Supported input and output formats.
`labels`	`map (key: string, value: string)` The labels associated with this job. You can use these to organize and group your jobs.
`name`	`string` The resource name of the job. Format: `projects/{project_number}/locations/{location}/jobs/{job}`
`outputUri`	`string` Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`. See Supported input and output formats.
`startTime`	`string (Timestamp format)` Output only. The time the transcoding started.
`state`	`enum` Output only. The current state of the job.
Enum type. Can be one of the following:
`PROCESSING_STATE_UNSPECIFIED`	The processing state is not specified.
`PENDING`	The job is enqueued and will be picked up for processing soon.
`RUNNING`	The job is being processed.
`SUCCEEDED`	The job has been completed successfully.
`FAILED`	The job has failed. For additional information, see `failure_reason` and `failure_details`

`templateId`	`string` Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`
`ttlAfterCompletionDays`	`integer (int32 format)` Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.

JobConfig

Job configuration

Fields
`adBreaks[]`	`object (AdBreak)` List of ad breaks. Specifies where to insert ad break tags in the output manifests.
`editList[]`	`object (EditAtom)` List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.
`elementaryStreams[]`	`object (ElementaryStream)` List of elementary streams.
`inputs[]`	`object (Input)` List of input assets stored in Cloud Storage.
`manifests[]`	`object (Manifest)` List of output manifests.
`muxStreams[]`	`object (MuxStream)` List of multiplexing settings for output streams.
`output`	`object (Output)` Output configuration.
`overlays[]`	`object (Overlay)` List of overlays on the output video, in descending Z-order.
`pubsubDestination`	`object (PubsubDestination)` Destination on Pub/Sub.
`spriteSheets[]`	`object (SpriteSheet)` List of output sprite sheets. Spritesheets require at least one VideoStream in the Jobconfig.

JobTemplate

Transcoding job template resource.

Fields

Fields
`config`	`object (JobConfig)` The configuration for this template.
`labels`	`map (key: string, value: string)` The labels associated with this job template. You can use these to organize and group your job templates.
`name`	`string` The resource name of the job template. Format: `projects/{project_number}/locations/{location}/jobTemplates/{job_template}`

config

object (JobConfig)

The configuration for this template.

labels

map (key: string, value: string)

The labels associated with this job template. You can use these to organize and group your job templates.

name

string

The resource name of the job template. Format: projects/{project_number}/locations/{location}/jobTemplates/{job_template}

ListJobTemplatesResponse

Response message for TranscoderService.ListJobTemplates.

Fields

Fields
`jobTemplates[]`	`object (JobTemplate)` List of job templates in the specified region.
`nextPageToken`	`string` The pagination token.
`unreachable[]`	`string` List of regions that could not be reached.

jobTemplates[]

object (JobTemplate)

List of job templates in the specified region.

nextPageToken

string

The pagination token.

unreachable[]

string

List of regions that could not be reached.

ListJobsResponse

Response message for TranscoderService.ListJobs.

Fields

Fields
`jobs[]`	`object (Job)` List of jobs in the specified region.
`nextPageToken`	`string` The pagination token.
`unreachable[]`	`string` List of regions that could not be reached.

jobs[]

object (Job)

List of jobs in the specified region.

nextPageToken

string

The pagination token.

unreachable[]

string

List of regions that could not be reached.

Manifest

Manifest configuration.

Fields
`fileName`	`string` The name of the generated file. The default is `manifest` with the extension suffix corresponding to the `Manifest.type`.
`muxStreams[]`	`string` Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.
`type`	`enum` Required. Type of the manifest, can be `HLS` or `DASH`.
Enum type. Can be one of the following:
`MANIFEST_TYPE_UNSPECIFIED`	The manifest type is not specified.
`HLS`	Create `HLS` manifest. The corresponding file extension is `.m3u8`.
`DASH`	Create `DASH` manifest. The corresponding file extension is `.mpd`.

MuxStream

Multiplexing settings for output stream.

Fields
`container`	`string` The container format. The default is `mp4` Supported container formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` - `mp4` - `vtt` See also: Supported input and output formats
`elementaryStreams[]`	`string` List of `ElementaryStream.key`s multiplexed in this stream.
`fileName`	`string` The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `mux_stream0000000123.ts`.
`key`	`string` A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `.m3u8` extension suffix.
`segmentSettings`	`object (SegmentSettings)` Segment settings for `ts`, `fmp4` and `vtt`.

NormalizedCoordinate

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

Fields

Fields
`x`	`number (double format)` Normalized x coordinate.
`y`	`number (double format)` Normalized y coordinate.

x

number (double format)

Normalized x coordinate.

y

number (double format)

Normalized y coordinate.

Output

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

Fields

Fields
`uri`	`string` URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty, the value is populated from `Job.output_uri`. See Supported input and output formats.

uri

string

URI for the output file(s). For example, gs://my-bucket/outputs/. If empty, the value is populated from Job.output_uri. See Supported input and output formats.

Overlay

Overlay configuration.

Fields

Fields
`animations[]`	`object (Animation)` List of Animations. The list should be chronological, without any time overlap.
`image`	`object (Image)` Image overlay.

animations[]

object (Animation)

List of Animations. The list should be chronological, without any time overlap.

image

object (Image)

Image overlay.

Pad

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

Fields
`bottomPixels`	`integer (int32 format)` The number of pixels to add to the bottom. The default is 0.
`leftPixels`	`integer (int32 format)` The number of pixels to add to the left. The default is 0.
`rightPixels`	`integer (int32 format)` The number of pixels to add to the right. The default is 0.
`topPixels`	`integer (int32 format)` The number of pixels to add to the top. The default is 0.

PreprocessingConfig

Preprocessing configurations.

Fields
`audio`	`object (Audio)` Audio preprocessing configuration.
`color`	`object (Color)` Color preprocessing configuration.
`crop`	`object (Crop)` Specify the video cropping configuration.
`deblock`	`object (Deblock)` Deblock preprocessing configuration.
`deinterlace`	`object (Deinterlace)` Specify the video deinterlace configuration.
`denoise`	`object (Denoise)` Denoise preprocessing configuration.
`pad`	`object (Pad)` Specify the video pad filter configuration.

PubsubDestination

A Pub/Sub destination.

Fields

Fields
`topic`	`string` The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.

topic

string

The name of the Pub/Sub topic to publish job completion notification to. For example: projects/{project}/topics/{topic}.

SegmentSettings

Segment settings for ts, fmp4 and vtt.

Fields

Fields
`individualSegments`	`boolean` Required. Create an individual segment file. The default is `false`.
`segmentDuration`	`string (Duration format)` Duration of the segments in seconds. The default is `6.0s`. Note that `segmentDuration` must be greater than or equal to `gopDuration`, and `segmentDuration` must be divisible by `gopDuration`.

individualSegments

boolean

Required. Create an individual segment file. The default is false.

segmentDuration

string (Duration format)

Duration of the segments in seconds. The default is 6.0s. Note that segmentDuration must be greater than or equal to gopDuration, and segmentDuration must be divisible by gopDuration.

SpriteSheet

Sprite sheet configuration.

Fields
`columnCount`	`integer (int32 format)` The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
`endTimeOffset`	`string (Duration format)` End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.
`filePrefix`	`string` Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `sprite_sheet0000000123.jpeg`.
`format`	`string` Format type. The default is `jpeg`. Supported formats: - `jpeg`
`interval`	`string (Duration format)` Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.
`quality`	`integer (int32 format)` The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.
`rowCount`	`integer (int32 format)` The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.
`spriteHeightPixels`	`integer (int32 format)` Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field). For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.
`spriteWidthPixels`	`integer (int32 format)` Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field). For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.
`startTimeOffset`	`string (Duration format)` Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.
`totalCount`	`integer (int32 format)` Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Fields

Fields
`code`	`integer (int32 format)` The status code, which should be an enum value of google.rpc.Code.
`details[]`	`object` A list of messages that carry the error details. There is a common set of message types for APIs to use.
`message`	`string` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code

integer (int32 format)

The status code, which should be an enum value of google.rpc.Code.

details[]

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message

string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

TextMapping

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

Fields

Fields
`atomKey`	`string` Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.
`inputKey`	`string` Required. The `Input.key` that identifies the input file.
`inputTrack`	`integer (int32 format)` Required. The zero-based index of the track in the input file.

atomKey

string

Required. The EditAtom.key that references atom with text inputs in the Job.edit_list.

inputKey

string

Required. The Input.key that identifies the input file.

inputTrack

integer (int32 format)

Required. The zero-based index of the track in the input file.

TextStream

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

Fields

Fields
`codec`	`string` The codec for this text stream. The default is `webvtt`. Supported text codecs: - `srt` - `ttml` - `cea608` - `cea708` - `webvtt`
`mapping[]`	`object (TextMapping)` The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.

codec

string

The codec for this text stream. The default is webvtt. Supported text codecs: - srt - ttml - cea608 - cea708 - webvtt

mapping[]

object (TextMapping)

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

VideoStream

Video stream resource.

Fields

Fields
`h264`	`object (H264CodecSettings)` H264 codec settings.
`h265`	`object (H265CodecSettings)` H265 codec settings.
`vp9`	`object (Vp9CodecSettings)` VP9 codec settings.

h264

object (H264CodecSettings)

H264 codec settings.

h265

object (H265CodecSettings)

H265 codec settings.

vp9

object (Vp9CodecSettings)

VP9 codec settings.

Vp9CodecSettings

VP9 codec settings.

Fields
`bitrateBps`	`integer (int32 format)` Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.
`crfLevel`	`integer (int32 format)` Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21. Note: This field is not supported.
`frameRate`	`number (double format)` Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See Calculating frame rate for more information.
`gopDuration`	`string (Duration format)` Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to `segmentDuration`, and `segmentDuration` must be divisible by `gopDuration`.
`gopFrameCount`	`integer (int32 format)` Select the GOP size based on the specified frame count. Must be greater than zero.
`heightPixels`	`integer (int32 format)` The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used. For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.
`pixelFormat`	`string` Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format
`profile`	`string` Enforces the specified codec profile. The following profiles are supported: * `profile0` (default) * `profile1` * `profile2` * `profile3` The available options are WebM-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `Vp9CodecSettings` message.
`rateControlMode`	`string` Specify the `rate_control_mode`. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate
`widthPixels`	`integer (int32 format)` The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used. For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.

YadifConfig

Yet Another Deinterlacing Filter Configuration.

Fields
`deinterlaceAllFrames`	`boolean` Deinterlace all frames rather than just the frames identified as interlaced. The default is `false`.
`disableSpatialInterlacing`	`boolean` Disable spacial interlacing. The default is `false`.
`mode`	`string` Specifies the deinterlacing mode to adopt. The default is `send_frame`. Supported values: - `send_frame`: Output one frame for each frame - `send_field`: Output one frame for each field
`parity`	`string` The picture field parity assumed for the input interlaced video. The default is `auto`. Supported values: - `tff`: Assume the top field is first - `bff`: Assume the bottom field is first - `auto`: Enable automatic detection of field parity