Package google.cloud.video.transcoder.v1

Index

TranscoderService

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.

CreateJob

rpc CreateJob(CreateJobRequest) returns (Job)

Creates a job in the specified region.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateJobTemplate

rpc CreateJobTemplate(CreateJobTemplateRequest) returns (JobTemplate)

Creates a job template in the specified region.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteJob

rpc DeleteJob(DeleteJobRequest) returns (Empty)

Deletes a job.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteJobTemplate

rpc DeleteJobTemplate(DeleteJobTemplateRequest) returns (Empty)

Deletes a job template.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetJob

rpc GetJob(GetJobRequest) returns (Job)

Returns the job data.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetJobTemplate

rpc GetJobTemplate(GetJobTemplateRequest) returns (JobTemplate)

Returns the job template data.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListJobTemplates

rpc ListJobTemplates(ListJobTemplatesRequest) returns (ListJobTemplatesResponse)

Lists job templates in the specified region.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListJobs

rpc ListJobs(ListJobsRequest) returns (ListJobsResponse)

Lists jobs in the specified region.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

AdBreak

Ad break.

Fields
start_time_offset

Duration

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

AudioStream

Audio stream resource.

Fields
codec

string

The codec for this audio stream. The default is aac.

Supported audio codecs:

  • aac
  • aac-he
  • aac-he-v2
  • mp3
  • ac3
  • eac3
bitrate_bps

int32

Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.

channel_count

int32

Number of audio channels. Must be between 1 and 6. The default is 2.

channel_layout[]

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
mapping[]

AudioMapping

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

sample_rate_hertz

int32

The audio sample rate in Hertz. The default is 48000 Hertz.

AudioMapping

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

Fields
atom_key

string

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

input_key

string

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

input_track

int32

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

input_channel

int32

Required. The zero-based index of the channel in the input audio stream.

output_channel

int32

Required. The zero-based index of the channel in the output audio stream.

gain_db

double

Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.

CreateJobRequest

Request message for TranscoderService.CreateJob.

Fields
parent

string

Required. The parent location to create and process this job. Format: projects/{project}/locations/{location}

Authorization requires the following IAM permission on the specified resource parent:

  • transcoder.jobs.create
job

Job

Required. Parameters for creating transcoding job.

CreateJobTemplateRequest

Request message for TranscoderService.CreateJobTemplate.

Fields
parent

string

Required. The parent location to create this job template. Format: projects/{project}/locations/{location}

Authorization requires the following IAM permission on the specified resource parent:

  • transcoder.jobTemplates.create
job_template

JobTemplate

Required. Parameters for creating job template.

job_template_id

string

Required. The ID to use for the job template, which will become the final component of the job template's resource name.

This value should be 4-63 characters, and valid characters must match the regular expression [a-zA-Z][a-zA-Z0-9_-]*.

DeleteJobRequest

Request message for TranscoderService.DeleteJob.

Fields
name

string

Required. The name of the job to delete. Format: projects/{project}/locations/{location}/jobs/{job}

Authorization requires the following IAM permission on the specified resource name:

  • transcoder.jobs.delete
allow_missing

bool

If set to true, and the job is not found, the request will succeed but no action will be taken on the server.

DeleteJobTemplateRequest

Request message for TranscoderService.DeleteJobTemplate.

Fields
name

string

Required. The name of the job template to delete. projects/{project}/locations/{location}/jobTemplates/{job_template}

Authorization requires the following IAM permission on the specified resource name:

  • transcoder.jobTemplates.delete
allow_missing

bool

If set to true, and the job template is not found, the request will succeed but no action will be taken on the server.

EditAtom

Edit atom.

Fields
key

string

A unique key for this atom. Must be specified when using advanced mapping.

inputs[]

string

List of Input.keys identifying files that should be used in this atom. The listed inputs must have the same timeline.

end_time_offset

Duration

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.

start_time_offset

Duration

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
key

string

A unique key for this elementary stream.

Union field elementary_stream. Encoding of an audio, video, or text track. elementary_stream can be only one of the following:
video_stream

VideoStream

Encoding of a video stream.

audio_stream

AudioStream

Encoding of an audio stream.

text_stream

TextStream

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

GetJobRequest

Request message for TranscoderService.GetJob.

Fields
name

string

Required. The name of the job to retrieve. Format: projects/{project}/locations/{location}/jobs/{job}

Authorization requires the following IAM permission on the specified resource name:

  • transcoder.jobs.get

GetJobTemplateRequest

Request message for TranscoderService.GetJobTemplate.

Fields
name

string

Required. The name of the job template to retrieve. Format: projects/{project}/locations/{location}/jobTemplates/{job_template}

Authorization requires the following IAM permission on the specified resource name:

  • transcoder.jobTemplates.get

Input

Input asset.

Fields
key

string

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

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 will be populated from Job.input_uri.

preprocessing_config

PreprocessingConfig

Preprocessing configurations.

Job

Transcoding job resource.

Fields
name

string

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

input_uri

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).

output_uri

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/.

state

ProcessingState

Output only. The current state of the job.

create_time

Timestamp

Output only. The time the job was created.

start_time

Timestamp

Output only. The time the transcoding started.

end_time

Timestamp

Output only. The time the transcoding finished.

ttl_after_completion_days

int32

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.

error

Status

Output only. An error object that describes the reason for the failure. This property is always present when state is FAILED.

Union field job_config. Specify the job_config for the transcoding job. If you don't specify the job_config, the API selects templateId; this template ID is set to preset/web-hd by default. When you use a template_id to create a job, the Job.config is populated by the JobTemplate.config.
job_config can be only one of the following:
template_id

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}
config

JobConfig

The configuration for this job.

ProcessingState

The current state of the job.

Enums
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

JobConfig

Job configuration

Fields
inputs[]

Input

List of input assets stored in Cloud Storage.

edit_list[]

EditAtom

List of Edit atoms. Defines the ultimate timeline of the resulting file or manifest.

elementary_streams[]

ElementaryStream

List of elementary streams.

mux_streams[]

MuxStream

List of multiplexing settings for output streams.

manifests[]

Manifest

List of output manifests.

output

Output

Output configuration.

ad_breaks[]

AdBreak

List of ad breaks. Specifies where to insert ad break tags in the output manifests.

pubsub_destination

PubsubDestination

Destination on Pub/Sub.

sprite_sheets[]

SpriteSheet

List of output sprite sheets.

overlays[]

Overlay

List of overlays on the output video, in descending Z-order.

JobTemplate

Transcoding job template resource.

Fields
name

string

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

config

JobConfig

The configuration for this template.

ListJobTemplatesRequest

Request message for TranscoderService.ListJobTemplates.

Fields
parent

string

Required. The parent location from which to retrieve the collection of job templates. Format: projects/{project}/locations/{location}

Authorization requires the following IAM permission on the specified resource parent:

  • transcoder.jobTemplates.list
page_size

int32

The maximum number of items to return.

page_token

string

The next_page_token value returned from a previous List request, if any.

filter

string

The filter expression, following the syntax outlined in https://google.aip.dev/160.

order_by

string

One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

ListJobTemplatesResponse

Response message for TranscoderService.ListJobTemplates.

Fields
job_templates[]

JobTemplate

List of job templates in the specified region.

next_page_token

string

The pagination token.

unreachable[]

string

List of regions that could not be reached.

ListJobsRequest

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

Fields
parent

string

Required. Format: projects/{project}/locations/{location}

Authorization requires the following IAM permission on the specified resource parent:

  • transcoder.jobs.list
page_size

int32

The maximum number of items to return.

page_token

string

The next_page_token value returned from a previous List request, if any.

filter

string

The filter expression, following the syntax outlined in https://google.aip.dev/160.

order_by

string

One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

ListJobsResponse

Response message for TranscoderService.ListJobs.

Fields
jobs[]

Job

List of jobs in the specified region.

next_page_token

string

The pagination token.

unreachable[]

string

List of regions that could not be reached.

Manifest

Manifest configuration.

Fields
file_name

string

The name of the generated file. The default is manifest with the extension suffix corresponding to the Manifest.type.

type

ManifestType

Required. Type of the manifest, can be HLS or DASH.

mux_streams[]

string

Required. List of user given MuxStream.keys 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.

ManifestType

The manifest type can be either HLS or DASH.

Enums
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
key

string

A unique key for this multiplexed stream. HLS media manifests will be named MuxStream.key with the .m3u8 extension suffix.

file_name

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.

container

string

The container format. The default is mp4

Supported container formats:

  • ts
  • fmp4- the corresponding file extension is .m4s
  • mp4
  • vtt
elementary_streams[]

string

List of ElementaryStream.keys multiplexed in this stream.

segment_settings

SegmentSettings

Segment settings for ts, fmp4 and vtt.

Output

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

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.

Overlay

Overlay configuration.

Fields
image

Image

Image overlay.

animations[]

Animation

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

Animation

Animation types.

Fields
Union field animation_type. Animations can be static or fade, or they can end the previous animation. animation_type can be only one of the following:
animation_static

AnimationStatic

Display static overlay object.

animation_fade

AnimationFade

Display overlay object with fade animation.

animation_end

AnimationEnd

End previous animation.

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
start_time_offset

Duration

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

AnimationFade

Display overlay object with fade animation.

Fields
fade_type

FadeType

Required. Type of fade animation: FADE_IN or FADE_OUT.

xy

NormalizedCoordinate

Normalized coordinates based on output video resolution. Valid values: 0.01.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.

start_time_offset

Duration

The time to start the fade animation, in seconds. Default: 0

end_time_offset

Duration

The time to end the fade animation, in seconds. Default: start_time_offset + 1s

AnimationStatic

Display static overlay object.

Fields
xy

NormalizedCoordinate

Normalized coordinates based on output video resolution. Valid values: 0.01.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.

start_time_offset

Duration

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

FadeType

Fade type for the overlay: FADE_IN or FADE_OUT.

Enums
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.

Image

Overlaid jpeg image.

Fields
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.

resolution

NormalizedCoordinate

Normalized image resolution, based on output video resolution. Valid values: 0.01.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.

alpha

double

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.

NormalizedCoordinate

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

Fields
x

double

Normalized x coordinate.

y

double

Normalized y coordinate.

PreprocessingConfig

Preprocessing configurations.

Fields
color

Color

Color preprocessing configuration.

denoise

Denoise

Denoise preprocessing configuration.

deblock

Deblock

Deblock preprocessing configuration.

audio

Audio

Audio preprocessing configuration.

crop

Crop

Specify the video cropping configuration.

pad

Pad

Specify the video pad filter configuration.

Audio

Audio preprocessing configuration.

Fields
lufs

double

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
high_boost

bool

Enable boosting high frequency components. The default is false.

low_boost

bool

Enable boosting low frequency components. The default is false.

Color

Color preprocessing configuration.

Fields
saturation

double

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.

contrast

double

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.

brightness

double

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.

Crop

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

Fields
top_pixels

int32

The number of pixels to crop from the top. The default is 0.

bottom_pixels

int32

The number of pixels to crop from the bottom. The default is 0.

left_pixels

int32

The number of pixels to crop from the left. The default is 0.

right_pixels

int32

The number of pixels to crop from the right. The default is 0.

Deblock

Deblock preprocessing configuration.

Fields
strength

double

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

bool

Enable deblocker. The default is false.

Denoise

Denoise preprocessing configuration.

Fields
strength

double

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

Pad

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

Fields
top_pixels

int32

The number of pixels to add to the top. The default is 0.

bottom_pixels

int32

The number of pixels to add to the bottom. The default is 0.

left_pixels

int32

The number of pixels to add to the left. The default is 0.

right_pixels

int32

The number of pixels to add to the right. The default is 0.

PubsubDestination

A Pub/Sub destination.

Fields
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
segment_duration

Duration

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.

individual_segments

bool

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

SpriteSheet

Sprite sheet configuration.

Fields
format

string

Format type. The default is jpeg.

Supported formats:

  • jpeg
file_prefix

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.

sprite_width_pixels

int32

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).

sprite_height_pixels

int32

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).

column_count

int32

The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.

row_count

int32

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.

start_time_offset

Duration

Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

end_time_offset

Duration

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.

quality

int32

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.

Union field extraction_strategy. Specify either total number of sprites or interval to create sprites. extraction_strategy can be only one of the following:
total_count

int32

Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.

interval

Duration

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

TextStream

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

Fields
codec

string

The codec for this text stream. The default is webvtt.

Supported text codecs:

  • srt
  • ttml
  • cea608
  • cea708
  • webvtt
mapping[]

TextMapping

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

TextMapping

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

Fields
atom_key

string

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

input_key

string

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

input_track

int32

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

VideoStream

Video stream resource.

Fields
Union field codec_settings. Codec settings can be h264, h265, or vp9. codec_settings can be only one of the following:
h264

H264CodecSettings

H264 codec settings.

h265

H265CodecSettings

H265 codec settings.

vp9

Vp9CodecSettings

VP9 codec settings.

H264CodecSettings

H264 codec settings.

Fields
width_pixels

int32

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.

height_pixels

int32

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.

frame_rate

double

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.

bitrate_bps

int32

Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.

pixel_format

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
rate_control_mode

string

Specify the rate_control_mode. The default is vbr.

Supported rate control modes:

  • vbr - variable bitrate
  • crf - constant rate factor
crf_level

int32

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.

allow_open_gop

bool

Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is false.

enable_two_pass

bool

Use two-pass encoding strategy to achieve better video quality. VideoStream.rate_control_mode must be vbr. The default is false.

vbv_size_bits

int32

Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to VideoStream.bitrate_bps.

vbv_fullness_bits

int32

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.

entropy_coder

string

The entropy coder to use. The default is cabac.

Supported entropy coders:

  • cavlc
  • cabac
b_pyramid

bool

Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is false.

b_frame_count

int32

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.

aq_strength

double

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.

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.

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.

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.

Union field gop_mode. GOP mode can be either by frame count or duration. gop_mode can be only one of the following:
gop_frame_count

int32

Select the GOP size based on the specified frame count. Must be greater than zero.

gop_duration

Duration

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.

H265CodecSettings

H265 codec settings.

Fields
width_pixels

int32

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.

height_pixels

int32

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.

frame_rate

double

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.

bitrate_bps

int32

Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.

pixel_format

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
rate_control_mode

string

Specify the rate_control_mode. The default is vbr.

Supported rate control modes:

  • vbr - variable bitrate
  • crf - constant rate factor
crf_level

int32

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.

allow_open_gop

bool

Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is false.

enable_two_pass

bool

Use two-pass encoding strategy to achieve better video quality. VideoStream.rate_control_mode must be vbr. The default is false.

vbv_size_bits

int32

Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to VideoStream.bitrate_bps.

vbv_fullness_bits

int32

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.

b_pyramid

bool

Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is false.

b_frame_count

int32

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.

aq_strength

double

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.

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.

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.

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.

Union field gop_mode. GOP mode can be either by frame count or duration. gop_mode can be only one of the following:
gop_frame_count

int32

Select the GOP size based on the specified frame count. Must be greater than zero.

gop_duration

Duration

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.

Vp9CodecSettings

VP9 codec settings.

Fields
width_pixels

int32

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.

height_pixels

int32

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.

frame_rate

double

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.

bitrate_bps

int32

Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.

pixel_format

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
rate_control_mode

string

Specify the rate_control_mode. The default is vbr.

Supported rate control modes:

  • vbr - variable bitrate
  • crf - constant rate factor
crf_level

int32

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.

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.

Union field gop_mode. GOP mode can be either by frame count or duration. gop_mode can be only one of the following:
gop_frame_count

int32

Select the GOP size based on the specified frame count. Must be greater than zero.

gop_duration

Duration

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.