- JSON representation
- Input
- PreprocessingConfig
- Color
- Denoise
- Deblock
- Audio
- Crop
- Pad
- Deinterlace
- YadifConfig
- BwdifConfig
- EditAtom
- ElementaryStream
- VideoStream
- H264CodecSettings
- FrameRateConversionStrategy
- H264ColorFormatSDR
- H264ColorFormatHLG
- H265CodecSettings
- H265ColorFormatSDR
- H265ColorFormatHLG
- H265ColorFormatHDR10
- Vp9CodecSettings
- Vp9ColorFormatSDR
- Vp9ColorFormatHLG
- AudioStream
- AudioMapping
- TextStream
- TextMapping
- MuxStream
- SegmentSettings
- Fmp4Config
- Manifest
- ManifestType
- DashConfig
- SegmentReferenceScheme
- Output
- AdBreak
- PubsubDestination
- SpriteSheet
- Overlay
- Image
- NormalizedCoordinate
- Animation
- AnimationStatic
- AnimationFade
- FadeType
- AnimationEnd
- Encryption
- Aes128Encryption
- SampleAesEncryption
- MpegCommonEncryption
- SecretManagerSource
- DrmSystems
- Widevine
- Fairplay
- Playready
- Clearkey
Job configuration
JSON representation |
---|
{ "inputs": [ { object ( |
Fields | |
---|---|
inputs[] |
List of input assets stored in Cloud Storage. |
editList[] |
List of edit atoms. Defines the ultimate timeline of the resulting file or manifest. |
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. Spritesheets require at least one VideoStream in the Jobconfig. |
overlays[] |
List of overlays on the output video, in descending Z-order. |
encryptions[] |
List of encryption configurations for the content. Each configuration has an ID. Specify this ID in the |
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. |
deinterlace |
Specify the video deinterlace configuration. |
Color
Color preprocessing configuration.
Note: This configuration is not supported.
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.
Note: This configuration is not supported.
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:
|
Deblock
Deblock preprocessing configuration.
Note: This configuration is not supported.
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 Note: This field is not supported. |
lowBoost |
Enable boosting low frequency components. The default is Note: This field is not supported. |
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. |
Deinterlace
Deinterlace configuration for input video.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field deinterlacing_filter . Specify the video deinterlacing filter. The default is yadif . deinterlacing_filter can be only one of the following: |
|
yadif |
Specifies the Yet Another Deinterlacing Filter Configuration. |
bwdif |
Specifies the Bob Weaver Deinterlacing Filter Configuration. |
YadifConfig
Yet Another Deinterlacing Filter Configuration.
JSON representation |
---|
{ "mode": string, "disableSpatialInterlacing": boolean, "parity": string, "deinterlaceAllFrames": boolean } |
Fields | |
---|---|
mode |
Specifies the deinterlacing mode to adopt. The default is
|
disableSpatialInterlacing |
Disable spacial interlacing. The default is |
parity |
The picture field parity assumed for the input interlaced video. The default is
|
deinterlaceAllFrames |
Deinterlace all frames rather than just the frames identified as interlaced. The default is |
BwdifConfig
Bob Weaver Deinterlacing Filter Configuration.
JSON representation |
---|
{ "mode": string, "parity": string, "deinterlaceAllFrames": boolean } |
Fields | |
---|---|
mode |
Specifies the deinterlacing mode to adopt. The default is
|
parity |
The picture field parity assumed for the input interlaced video. The default is
|
deinterlaceAllFrames |
Deinterlace all frames rather than just the frames identified as interlaced. The default is |
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, ending with ' |
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, ending with ' |
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 |
---|
{ // Union field |
Fields | |
---|---|
Union field codec_settings . Codec settings can be h264, h265, or vp9. codec_settings can be only one of the following: |
|
h264 |
H264 codec settings. |
h265 |
H265 codec settings. |
vp9 |
VP9 codec settings. |
H264CodecSettings
H264 codec settings.
JSON representation |
---|
{ "widthPixels": integer, "heightPixels": integer, "frameRate": number, "frameRateConversionStrategy": enum ( |
Fields | |
---|---|
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. 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. |
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. 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. |
frameRate |
Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. |
frameRateConversionStrategy |
Optional. Frame rate conversion strategy for desired frame rate. The default is |
bitrateBps |
Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000. |
pixelFormat |
Pixel format to use. The default is Supported pixel formats:
|
rateControlMode |
Specify the mode. The default is Supported rate control modes:
|
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. |
allowOpenGop |
Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is |
enableTwoPass |
Use two-pass encoding strategy to achieve better video quality. |
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 |
entropyCoder |
The entropy coder to use. The default is Supported entropy coders:
|
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 |
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. |
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 |
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, ending with ' |
Union field color_format . Color format can be sdr or hlg. color_format can be only one of the following: |
|
sdr |
Optional. SDR color format setting for H264. |
hlg |
Optional. HLG color format setting for H264. |
FrameRateConversionStrategy
The conversion strategy for desired frame rate.
Enums | |
---|---|
FRAME_RATE_CONVERSION_STRATEGY_UNSPECIFIED |
Unspecified frame rate conversion strategy. |
DOWNSAMPLE |
Selectively retain frames to reduce the output frame rate. Every n th frame is kept, where |
DROP_DUPLICATE |
Drop or duplicate frames to match the specified frame rate. |
H264ColorFormatSDR
This type has no fields.
Convert the input video to a Standard Dynamic Range (SDR) video.
H264ColorFormatHLG
This type has no fields.
Convert the input video to a Hybrid Log Gamma (HLG) video.
H265CodecSettings
H265 codec settings.
JSON representation |
---|
{ "widthPixels": integer, "heightPixels": integer, "frameRate": number, "frameRateConversionStrategy": enum ( |
Fields | |
---|---|
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. 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. |
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. 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. |
frameRate |
Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. |
frameRateConversionStrategy |
Optional. Frame rate conversion strategy for desired frame rate. The default is |
bitrateBps |
Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000. |
pixelFormat |
Pixel format to use. The default is Supported pixel formats:
|
rateControlMode |
Specify the mode. The default is Supported rate control modes:
|
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. |
allowOpenGop |
Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is |
enableTwoPass |
Use two-pass encoding strategy to achieve better video quality. |
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 |
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 |
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. |
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 |
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, ending with ' |
Union field color_format . Color format can be sdr, hlg, hdr10. color_format can be only one of the following: |
|
sdr |
Optional. SDR color format setting for H265. |
hlg |
Optional. HLG color format setting for H265. |
hdr10 |
Optional. HDR10 color format setting for H265. |
H265ColorFormatSDR
This type has no fields.
Convert the input video to a Standard Dynamic Range (SDR) video.
H265ColorFormatHLG
This type has no fields.
Convert the input video to a Hybrid Log Gamma (HLG) video.
H265ColorFormatHDR10
This type has no fields.
Convert the input video to a High Dynamic Range 10 (HDR10) video.
Vp9CodecSettings
VP9 codec settings.
JSON representation |
---|
{ "widthPixels": integer, "heightPixels": integer, "frameRate": number, "frameRateConversionStrategy": enum ( |
Fields | |
---|---|
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. 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. |
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. 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. |
frameRate |
Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. |
frameRateConversionStrategy |
Optional. Frame rate conversion strategy for desired frame rate. The default is |
bitrateBps |
Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000. |
pixelFormat |
Pixel format to use. The default is Supported pixel formats:
|
rateControlMode |
Specify the mode. The default is Supported rate control modes:
|
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. Note: This field is not supported. |
profile |
Enforces the specified codec profile. The following profiles are supported:
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 |
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, ending with ' |
Union field color_format . Color format can be sdr or hlg. color_format can be only one of the following: |
|
sdr |
Optional. SDR color format setting for VP9. |
hlg |
Optional. HLG color format setting for VP9. |
Vp9ColorFormatSDR
This type has no fields.
Convert the input video to a Standard Dynamic Range (SDR) video.
Vp9ColorFormatHLG
This type has no fields.
Convert the input video to a Hybrid Log Gamma (HLG) video.
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:
|
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:
|
mapping[] |
The mapping for the |
sampleRateHertz |
The audio sample rate in Hertz. The default is 48000 Hertz. |
languageCode |
The BCP-47 language code, such as |
displayName |
The name for this particular audio stream that will be added to the HLS/DASH manifest. Not supported in MP4 files. |
AudioMapping
The mapping for the JobConfig.edit_list
atoms with audio EditAtom.inputs
.
JSON representation |
---|
{ "atomKey": string, "inputKey": string, "inputTrack": integer, "inputChannel": integer, "outputChannel": integer, "gainDb": number } |
Fields | |
---|---|
atomKey |
Required. The |
inputKey |
Required. The |
inputTrack |
Required. The zero-based index of the track in the input file. |
inputChannel |
Required. The zero-based index of the channel in the input audio stream. |
outputChannel |
Required. The zero-based index of the channel in the output audio stream. |
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:
|
languageCode |
The BCP-47 language code, such as |
mapping[] |
The mapping for the |
displayName |
The name for this particular text stream that will be added to the HLS/DASH manifest. Not supported in MP4 files. |
TextMapping
The mapping for the JobConfig.edit_list
atoms with text EditAtom.inputs
.
JSON representation |
---|
{ "atomKey": string, "inputKey": string, "inputTrack": integer } |
Fields | |
---|---|
atomKey |
Required. The |
inputKey |
Required. The |
inputTrack |
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. |
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:
See also: Supported input and output formats |
elementaryStreams[] |
List of |
segmentSettings |
Segment settings for |
encryptionId |
Identifier of the encryption configuration to use. If omitted, output will be unencrypted. |
Union field container_config . Specifies the container configuration. container_config can be only one of the following: |
|
fmp4 |
Optional. |
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, ending with ' |
individualSegments |
Required. Create an individual segment file. The default is |
Fmp4Config
fmp4
container configuration.
JSON representation |
---|
{ "codecTag": string } |
Fields | |
---|---|
codecTag |
Optional. Specify the codec tag string that will be used in the media bitstream. When not specified, the codec appropriate value is used. Supported H265 codec tags:
|
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. |
muxStreams[] |
Required. List of user supplied When |
Union field manifest_config . Specifies the manifest configuration. manifest_config can be only one of the following: |
|
dash |
|
ManifestType
The manifest type, which corresponds to the adaptive streaming format used.
Enums | |
---|---|
MANIFEST_TYPE_UNSPECIFIED |
The manifest type is not specified. |
HLS |
Create an HLS manifest. The corresponding file extension is .m3u8 . |
DASH |
Create an MPEG-DASH manifest. The corresponding file extension is .mpd . |
DashConfig
DASH
manifest configuration.
JSON representation |
---|
{
"segmentReferenceScheme": enum ( |
Fields | |
---|---|
segmentReferenceScheme |
The segment reference scheme for a |
SegmentReferenceScheme
The segment reference scheme for a DASH
manifest.
Enums | |
---|---|
SEGMENT_REFERENCE_SCHEME_UNSPECIFIED |
The segment reference scheme is not specified. |
SEGMENT_LIST |
Explicitly lists the URLs of media files for each segment. For example, if
|
SEGMENT_TEMPLATE_NUMBER |
|
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, ending with ' |
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:
|
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 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. |
spriteHeightPixels |
Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the 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. |
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, ending with ' |
endTimeOffset |
End time in seconds, relative to the output file timeline. When A duration in seconds with up to nine fractional digits, ending with ' |
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, ending with ' |
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 image.
JSON representation |
---|
{
"uri": string,
"resolution": {
object ( |
Fields | |
---|---|
uri |
Required. URI of the image in Cloud Storage. For example, |
resolution |
Normalized image resolution, based on output video resolution. Valid values: |
alpha |
Target image opacity. Valid values are from |
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, ending with ' |
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, ending with ' |
endTimeOffset |
The time to end the fade animation, in seconds. Default: A duration in seconds with up to nine fractional digits, ending with ' |
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, ending with ' |
Encryption
Encryption settings.
JSON representation |
---|
{ "id": string, "drmSystems": { object ( |
Fields | |
---|---|
id |
Required. Identifier for this set of encryption options. |
drmSystems |
Required. DRM system(s) to use; at least one must be specified. If a DRM system is omitted, it is considered disabled. |
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). |
Union field secret_source . Defines where content keys are stored. secret_source can be only one of the following: |
|
secretManagerKeySource |
Keys are stored in Google Secret Manager. |
Aes128Encryption
This type has no fields.
Configuration for AES-128 encryption.
SampleAesEncryption
This type has no fields.
Configuration for SAMPLE-AES encryption.
MpegCommonEncryption
Configuration for MPEG Common Encryption (MPEG-CENC).
JSON representation |
---|
{ "scheme": string } |
Fields | |
---|---|
scheme |
Required. Specify the encryption scheme. Supported encryption schemes:
|
SecretManagerSource
Configuration for secrets stored in Google Secret Manager.
JSON representation |
---|
{ "secretVersion": string } |
Fields | |
---|---|
secretVersion |
Required. The name of the Secret Version containing the encryption key in the following format: Note that only numbered versions are supported. Aliases like "latest" are not supported. |
DrmSystems
Defines configuration for DRM systems in use.
JSON representation |
---|
{ "widevine": { object ( |
Fields | |
---|---|
widevine |
Widevine configuration. |
fairplay |
Fairplay configuration. |
playready |
Playready configuration. |
clearkey |
Clearkey configuration. |
Widevine
This type has no fields.
Widevine configuration.
Fairplay
This type has no fields.
Fairplay configuration.
Playready
This type has no fields.
Playready configuration.
Clearkey
This type has no fields.
Clearkey configuration.