- JSON representation
- Input
- PreprocessingConfig
- Color
- Denoise
- Deblock
- Audio
- Crop
- Pad
- EditAtom
- ElementaryStream
- VideoStream
- AudioStream
- AudioAtom
- AudioChannel
- AudioChannelInput
- TextStream
- TextAtom
- TextInput
- MuxStream
- SegmentSettings
- Encryption
- Aes128Encryption
- SampleAesEncryption
- MpegCommonEncryption
- Manifest
- ManifestType
- Output
- AdBreak
- PubsubDestination
- SpriteSheet
- Overlay
- Image
- NormalizedCoordinate
- Animation
- AnimationStatic
- AnimationFade
- FadeType
- AnimationEnd
Job configuration
JSON representation | |
---|---|
{ "inputs": [ { object ( |
Fields | |
---|---|
inputs[] |
List of input assets stored in Cloud Storage. |
editList[] |
List of |
elementaryStreams[] |
List of elementary streams. |
muxStreams[] |
List of multiplexing settings for output streams. |
manifests[] |
List of output manifests. |
output |
Output configuration. |
adBreaks[] |
List of ad breaks. Specifies where to insert ad break tags in the output manifests. |
pubsubDestination |
Destination on Pub/Sub. |
spriteSheets[] |
List of output sprite sheets. |
overlays[] |
List of overlays on the output video, in descending Z-order. |
Input
Input asset.
JSON representation | |
---|---|
{
"key": string,
"uri": string,
"preprocessingConfig": {
object ( |
Fields | |
---|---|
key |
A unique key for this input. Must be specified when using advanced mapping and edit lists. |
uri |
URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, |
preprocessingConfig |
Preprocessing configurations. |
PreprocessingConfig
Preprocessing configurations.
JSON representation | |
---|---|
{ "color": { object ( |
Fields | |
---|---|
color |
Color preprocessing configuration. |
denoise |
Denoise preprocessing configuration. |
deblock |
Deblock preprocessing configuration. |
audio |
Audio preprocessing configuration. |
crop |
Specify the video cropping configuration. |
pad |
Specify the video pad filter configuration. |
Color
Color preprocessing configuration.
JSON representation | |
---|---|
{ "saturation": number, "contrast": number, "brightness": number } |
Fields | |
---|---|
saturation |
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 |
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 |
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. |
Denoise
Denoise preprocessing configuration.
JSON representation | |
---|---|
{ "strength": number, "tune": string } |
Fields | |
---|---|
strength |
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 |
Set the denoiser mode. The default is Supported denoiser modes: - 'standard' - 'grain' |
Deblock
Deblock preprocessing configuration.
JSON representation | |
---|---|
{ "strength": number, "enabled": boolean } |
Fields | |
---|---|
strength |
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 |
Enable deblocker. The default is |
Audio
Audio preprocessing configuration.
JSON representation | |
---|---|
{ "lufs": number, "highBoost": boolean, "lowBoost": boolean } |
Fields | |
---|---|
lufs |
Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 (the default), where:
|
highBoost |
Enable boosting high frequency components. The default is |
lowBoost |
Enable boosting low frequency components. The default is |
Crop
Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution.
JSON representation | |
---|---|
{ "topPixels": integer, "bottomPixels": integer, "leftPixels": integer, "rightPixels": integer } |
Fields | |
---|---|
topPixels |
The number of pixels to crop from the top. The default is 0. |
bottomPixels |
The number of pixels to crop from the bottom. The default is 0. |
leftPixels |
The number of pixels to crop from the left. The default is 0. |
rightPixels |
The number of pixels to crop from the right. The default is 0. |
Pad
Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution.
JSON representation | |
---|---|
{ "topPixels": integer, "bottomPixels": integer, "leftPixels": integer, "rightPixels": integer } |
Fields | |
---|---|
topPixels |
The number of pixels to add to the top. The default is 0. |
bottomPixels |
The number of pixels to add to the bottom. The default is 0. |
leftPixels |
The number of pixels to add to the left. The default is 0. |
rightPixels |
The number of pixels to add to the right. The default is 0. |
EditAtom
Edit atom.
JSON representation | |
---|---|
{ "key": string, "inputs": [ string ], "endTimeOffset": string, "startTimeOffset": string } |
Fields | |
---|---|
key |
A unique key for this atom. Must be specified when using advanced mapping. |
inputs[] |
List of |
endTimeOffset |
End time in seconds for the atom, relative to the input file timeline. When A duration in seconds with up to nine fractional digits, terminated by ' |
startTimeOffset |
Start time in seconds for the atom, relative to the input file timeline. The default is A duration in seconds with up to nine fractional digits, terminated by ' |
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.
JSON representation | |
---|---|
{ "key": string, // Union field |
Fields | ||
---|---|---|
key |
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: |
||
videoStream |
Encoding of a video stream. |
|
audioStream |
Encoding of an audio stream. |
|
textStream |
Encoding of a text stream. For example, closed captions or subtitles. |
VideoStream
Video stream resource.
JSON representation | |
---|---|
{ "codec": string, "profile": string, "tune": string, "preset": string, "heightPixels": integer, "widthPixels": integer, "pixelFormat": string, "bitrateBps": integer, "rateControlMode": string, "enableTwoPass": boolean, "crfLevel": integer, "vbvSizeBits": integer, "vbvFullnessBits": integer, "allowOpenGop": boolean, "entropyCoder": string, "bPyramid": boolean, "bFrameCount": integer, "frameRate": number, "aqStrength": number, // Union field |
Fields | ||
---|---|---|
codec |
Codec type. The following codecs are supported:
|
|
profile |
Enforces the specified codec profile. The following profiles are supported:
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 |
|
tune |
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 |
|
preset |
Enforces the specified codec preset. The default is |
|
heightPixels |
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. |
|
widthPixels |
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. |
|
pixelFormat |
Pixel format to use. The default is 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. |
|
bitrateBps |
Required. The video bitrate in bits per second. Must be between 1 and 1,000,000,000. |
|
rateControlMode |
Specify the Supported rate control modes: - 'vbr' - variable bitrate - 'crf' - constant rate factor |
|
enableTwoPass |
Use two-pass encoding strategy to achieve better video quality. |
|
crfLevel |
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. |
|
vbvSizeBits |
Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to |
|
vbvFullnessBits |
Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of |
|
allowOpenGop |
Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is |
|
entropyCoder |
The entropy coder to use. The default is Supported entropy coders: - 'cavlc' - 'cabac' |
|
bPyramid |
Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is |
|
bFrameCount |
The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than |
|
frameRate |
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 Calculate frame rate for more information. |
|
aqStrength |
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. |
|
Union field gop_mode . GOP mode can be either by frame count or duration. gop_mode can be only one of the following: |
||
gopFrameCount |
Select the GOP size based on the specified frame count. Must be greater than zero. |
|
gopDuration |
Select the GOP size based on the specified duration. The default is A duration in seconds with up to nine fractional digits, terminated by ' |
AudioStream
Audio stream resource.
JSON representation | |
---|---|
{
"codec": string,
"bitrateBps": integer,
"channelCount": integer,
"channelLayout": [
string
],
"mapping": [
{
object ( |
Fields | |
---|---|
codec |
The codec for this audio stream. The default is Supported audio codecs: - 'aac' - 'aac-he' - 'aac-he-v2' - 'mp3' - 'ac3' - 'eac3' |
bitrateBps |
Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000. |
channelCount |
Number of audio channels. Must be between 1 and 6. The default is 2. |
channelLayout[] |
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 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[] |
The mapping for the |
sampleRateHertz |
The audio sample rate in Hertz. The default is 48000 Hertz. |
AudioAtom
The mapping for the Job.edit_list
atoms with audio EditAtom.inputs
.
JSON representation | |
---|---|
{
"key": string,
"channels": [
{
object ( |
Fields | |
---|---|
key |
Required. The |
channels[] |
List of |
AudioChannel
The audio channel.
JSON representation | |
---|---|
{
"inputs": [
{
object ( |
Fields | |
---|---|
inputs[] |
List of |
AudioChannelInput
Identifies which input file, track, and channel should be used.
JSON representation | |
---|---|
{ "key": string, "track": integer, "channel": integer, "gainDb": number } |
Fields | |
---|---|
key |
Required. The |
track |
Required. The zero-based index of the track in the input file. |
channel |
Required. The zero-based index of the channel in the input file. |
gainDb |
Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0. |
TextStream
Encoding of a text stream. For example, closed captions or subtitles.
JSON representation | |
---|---|
{
"codec": string,
"languageCode": string,
"mapping": [
{
object ( |
Fields | |
---|---|
codec |
The codec for this text stream. The default is Supported text codecs: - 'srt' - 'ttml' - 'cea608' - 'cea708' - 'webvtt' |
languageCode |
Required. The BCP-47 language code, such as |
mapping[] |
The mapping for the |
TextAtom
The mapping for the Job.edit_list
atoms with text EditAtom.inputs
.
JSON representation | |
---|---|
{
"key": string,
"inputs": [
{
object ( |
Fields | |
---|---|
key |
Required. The |
inputs[] |
List of |
TextInput
Identifies which input file and track should be used.
JSON representation | |
---|---|
{ "key": string, "track": integer } |
Fields | |
---|---|
key |
Required. The |
track |
Required. The zero-based index of the track in the input file. |
MuxStream
Multiplexing settings for output stream.
JSON representation | |
---|---|
{ "key": string, "fileName": string, "container": string, "elementaryStreams": [ string ], "segmentSettings": { object ( |
Fields | |
---|---|
key |
A unique key for this multiplexed stream. HLS media manifests will be named |
fileName |
The name of the generated file. The default is Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as |
container |
The container format. The default is Supported container formats: - 'ts' - 'fmp4'- the corresponding file extension is |
elementaryStreams[] |
List of |
segmentSettings |
Segment settings for |
encryption |
Encryption settings. |
SegmentSettings
Segment settings for "ts"
, "fmp4"
and "vtt"
.
JSON representation | |
---|---|
{ "segmentDuration": string, "individualSegments": boolean } |
Fields | |
---|---|
segmentDuration |
Duration of the segments in seconds. The default is A duration in seconds with up to nine fractional digits, terminated by ' |
individualSegments |
Required. Create an individual segment file. The default is |
Encryption
Encryption settings.
JSON representation | |
---|---|
{ "key": string, "iv": string, // Union field |
Fields | ||
---|---|---|
key |
Required. 128 bit encryption key represented as lowercase hexadecimal digits. |
|
iv |
Required. 128 bit Initialization Vector (IV) represented as lowercase hexadecimal digits. |
|
Union field encryption_mode . Encryption mode can be either aes or cenc . encryption_mode can be only one of the following: |
||
aes128 |
Configuration for AES-128 encryption. |
|
sampleAes |
Configuration for SAMPLE-AES encryption. |
|
mpegCenc |
Configuration for MPEG Common Encryption (MPEG-CENC). |
Aes128Encryption
Configuration for AES-128 encryption.
JSON representation | |
---|---|
{ "keyUri": string } |
Fields | |
---|---|
keyUri |
Required. URI of the key delivery service. This URI is inserted into the M3U8 header. |
SampleAesEncryption
Configuration for SAMPLE-AES encryption.
JSON representation | |
---|---|
{ "keyUri": string } |
Fields | |
---|---|
keyUri |
Required. URI of the key delivery service. This URI is inserted into the M3U8 header. |
MpegCommonEncryption
Configuration for MPEG Common Encryption (MPEG-CENC).
JSON representation | |
---|---|
{ "keyId": string, "scheme": string } |
Fields | |
---|---|
keyId |
Required. 128 bit Key ID represented as lowercase hexadecimal digits for use with common encryption. |
scheme |
Required. Specify the encryption scheme. Supported encryption schemes: - 'cenc' - 'cbcs' |
Manifest
Manifest configuration.
JSON representation | |
---|---|
{
"fileName": string,
"type": enum ( |
Fields | |
---|---|
fileName |
The name of the generated file. The default is |
type |
Required. Type of the manifest, can be "HLS" or "DASH". |
muxStreams[] |
Required. List of user given When |
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" . |
Output
Location of output file(s) in a Cloud Storage bucket.
JSON representation | |
---|---|
{ "uri": string } |
Fields | |
---|---|
uri |
URI for the output file(s). For example, |
AdBreak
Ad break.
JSON representation | |
---|---|
{ "startTimeOffset": string } |
Fields | |
---|---|
startTimeOffset |
Start time in seconds for the ad break, relative to the output file timeline. The default is A duration in seconds with up to nine fractional digits, terminated by ' |
PubsubDestination
A Pub/Sub destination.
JSON representation | |
---|---|
{ "topic": string } |
Fields | |
---|---|
topic |
The name of the Pub/Sub topic to publish job completion notification to. For example: |
SpriteSheet
Sprite sheet configuration.
JSON representation | |
---|---|
{ "format": string, "filePrefix": string, "spriteWidthPixels": integer, "spriteHeightPixels": integer, "columnCount": integer, "rowCount": integer, "startTimeOffset": string, "endTimeOffset": string, "quality": integer, // Union field |
Fields | ||
---|---|---|
format |
Format type. The default is Supported formats: - 'jpeg' |
|
filePrefix |
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 |
|
spriteWidthPixels |
Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the |
|
spriteHeightPixels |
Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the |
|
columnCount |
The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit. |
|
rowCount |
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. |
|
startTimeOffset |
Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is A duration in seconds with up to nine fractional digits, terminated by ' |
|
endTimeOffset |
End time in seconds, relative to the output file timeline. When A duration in seconds with up to nine fractional digits, terminated by ' |
|
quality |
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: |
||
totalCount |
Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100. |
|
interval |
Starting from A duration in seconds with up to nine fractional digits, terminated by ' |
Overlay
Overlay configuration.
JSON representation | |
---|---|
{ "image": { object ( |
Fields | |
---|---|
image |
Image overlay. |
animations[] |
List of Animations. The list should be chronological, without any time overlap. |
Image
Overlaid jpeg image.
JSON representation | |
---|---|
{
"uri": string,
"resolution": {
object ( |
Fields | |
---|---|
uri |
Required. URI of the JPEG image in Cloud Storage. For example, |
resolution |
Normalized image resolution, based on output video resolution. Valid values: |
alpha |
Target image opacity. Valid values: |
NormalizedCoordinate
2D normalized coordinates. Default: {0.0, 0.0}
JSON representation | |
---|---|
{ "x": number, "y": number } |
Fields | |
---|---|
x |
Normalized x coordinate. |
y |
Normalized y coordinate. |
Animation
Animation types.
JSON representation | |
---|---|
{ // Union field |
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: |
||
animationStatic |
Display static overlay object. |
|
animationFade |
Display overlay object with fade animation. |
|
animationEnd |
End previous animation. |
AnimationStatic
Display static overlay object.
JSON representation | |
---|---|
{
"xy": {
object ( |
Fields | |
---|---|
xy |
Normalized coordinates based on output video resolution. Valid values: |
startTimeOffset |
The time to start displaying the overlay object, in seconds. Default: 0 A duration in seconds with up to nine fractional digits, terminated by ' |
AnimationFade
Display overlay object with fade animation.
JSON representation | |
---|---|
{ "fadeType": enum ( |
Fields | |
---|---|
fadeType |
Required. Type of fade animation: |
xy |
Normalized coordinates based on output video resolution. Valid values: |
startTimeOffset |
The time to start the fade animation, in seconds. Default: 0 A duration in seconds with up to nine fractional digits, terminated by ' |
endTimeOffset |
The time to end the fade animation, in seconds. Default: A duration in seconds with up to nine fractional digits, terminated by ' |
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. |
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.
JSON representation | |
---|---|
{ "startTimeOffset": string } |
Fields | |
---|---|
startTimeOffset |
The time to end overlay object, in seconds. Default: 0 A duration in seconds with up to nine fractional digits, terminated by ' |