Types for Google Cloud Video Transcoder v1 API¶
- class google.cloud.video.transcoder_v1.types.AdBreak(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAd break.
- start_time_offset¶
Start time in seconds for the ad break, relative to the output file timeline. The default is
0s.
- class google.cloud.video.transcoder_v1.types.AudioStream(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAudio stream resource.
- codec¶
The codec for this audio stream. The default is
aac.Supported audio codecs:
aacaac-heaac-he-v2mp3ac3eac3
- Type
- channel_layout¶
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 channelfr- Front right channelsl- Side left channelsr- Side right channelfc- Front center channellfe- Low frequency
- Type
MutableSequence[str]
- mapping_¶
The mapping for the
Job.edit_listatoms with audioEditAtom.inputs.- Type
MutableSequence[google.cloud.video.transcoder_v1.types.AudioStream.AudioMapping]
- language_code¶
The BCP-47 language code, such as
en-USorsr-Latn. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not supported in MP4 files.- Type
- display_name¶
The name for this particular audio stream that will be added to the HLS/DASH manifest. Not supported in MP4 files.
- Type
- class AudioMapping(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe mapping for the
Job.edit_listatoms with audioEditAtom.inputs.- atom_key¶
Required. The
EditAtom.keythat references the atom with audio inputs in theJob.edit_list.- Type
- class google.cloud.video.transcoder_v1.types.CreateJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
TranscoderService.CreateJob.- parent¶
Required. The parent location to create and process this job. Format:
projects/{project}/locations/{location}- Type
- job¶
Required. Parameters for creating transcoding job.
- class google.cloud.video.transcoder_v1.types.CreateJobTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
TranscoderService.CreateJobTemplate.- parent¶
Required. The parent location to create this job template. Format:
projects/{project}/locations/{location}- Type
- job_template¶
Required. Parameters for creating job template.
- class google.cloud.video.transcoder_v1.types.DeleteJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
TranscoderService.DeleteJob.- name¶
Required. The name of the job to delete. Format:
projects/{project}/locations/{location}/jobs/{job}- Type
- class google.cloud.video.transcoder_v1.types.DeleteJobTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
TranscoderService.DeleteJobTemplate.- name¶
Required. The name of the job template to delete.
projects/{project}/locations/{location}/jobTemplates/{job_template}- Type
- class google.cloud.video.transcoder_v1.types.EditAtom(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEdit atom.
- inputs¶
List of
Input.keys identifying files that should be used in this atom. The listedinputsmust have the same timeline.- Type
MutableSequence[str]
- end_time_offset¶
End time in seconds for the atom, relative to the input file timeline. When
end_time_offsetis not specified, theinputsare used until the end of the atom.
- start_time_offset¶
Start time in seconds for the atom, relative to the input file timeline. The default is
0s.
- class google.cloud.video.transcoder_v1.types.ElementaryStream(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEncoding 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.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class google.cloud.video.transcoder_v1.types.Encryption(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEncryption settings.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- sample_aes¶
Configuration for SAMPLE-AES encryption.
This field is a member of oneof
encryption_mode.
- mpeg_cenc¶
Configuration for MPEG Common Encryption (MPEG-CENC).
This field is a member of oneof
encryption_mode.
- secret_manager_key_source¶
Keys are stored in Google Secret Manager.
This field is a member of oneof
secret_source.
- drm_systems¶
Required. DRM system(s) to use; at least one must be specified. If a DRM system is omitted, it is considered disabled.
- class Aes128Encryption(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for AES-128 encryption.
- class Clearkey(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageClearkey configuration.
- class DrmSystems(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefines configuration for DRM systems in use.
- widevine¶
Widevine configuration.
- fairplay¶
Fairplay configuration.
- playready¶
Playready configuration.
- clearkey¶
Clearkey configuration.
- class Fairplay(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFairplay configuration.
- class MpegCommonEncryption(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for MPEG Common Encryption (MPEG-CENC).
- class Playready(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePlayready configuration.
- class SampleAesEncryption(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for SAMPLE-AES encryption.
- class SecretManagerSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration for secrets stored in Google Secret Manager.
- class Widevine(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageWidevine configuration.
- class google.cloud.video.transcoder_v1.types.GetJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
TranscoderService.GetJob.
- class google.cloud.video.transcoder_v1.types.GetJobTemplateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
TranscoderService.GetJobTemplate.
- class google.cloud.video.transcoder_v1.types.Input(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageInput asset.
- key¶
A unique key for this input. Must be specified when using advanced mapping and edit lists.
- Type
- uri¶
URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example,
gs://bucket/inputs/file.mp4). If empty, the value is populated fromJob.input_uri. See Supported input and output formats.- Type
- preprocessing_config¶
Preprocessing configurations.
- class google.cloud.video.transcoder_v1.types.Job(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTranscoding job resource.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- name¶
The resource name of the job. Format:
projects/{project_number}/locations/{location}/jobs/{job}- Type
- input_uri¶
Input only. Specify the
input_urito populate emptyurifields in each element ofJob.config.inputsorJobTemplate.config.inputswhen using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example,gs://bucket/inputs/file.mp4). See Supported input and output formats.- Type
- output_uri¶
Input only. Specify the
output_urito populate an emptyJob.config.output.uriorJobTemplate.config.output.uriwhen using template. URI for the output file(s). For example,gs://my-bucket/outputs/. See Supported input and output formats.- Type
- template_id¶
Input only. Specify the
template_idto use for populatingJob.config. The default ispreset/web-hd, which is the only supported preset.User defined JobTemplate:
{job_template_id}This field is a member of oneof
job_config.- Type
- state¶
Output only. The current state of the job.
- create_time¶
Output only. The time the job was created.
- start_time¶
Output only. The time the transcoding started.
- end_time¶
Output only. The time the transcoding finished.
- ttl_after_completion_days¶
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.
- Type
- labels¶
The labels associated with this job. You can use these to organize and group your jobs.
- error¶
Output only. An error object that describes the reason for the failure. This property is always present when
stateisFAILED.- Type
google.rpc.status_pb2.Status
- mode¶
The processing mode of the job. The default is
PROCESSING_MODE_INTERACTIVE.
- batch_mode_priority¶
The processing priority of a batch job. This field can only be set for batch mode jobs. The default value is 0. This value cannot be negative. Higher values correspond to higher priorities for the job.
- Type
- optimization¶
Optional. The optimization strategy of the job. The default is
AUTODETECT.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class OptimizationStrategy(value)[source]¶
Bases:
proto.enums.EnumThe optimization strategy of the job. The default is
AUTODETECT.- Values:
- OPTIMIZATION_STRATEGY_UNSPECIFIED (0):
The optimization strategy is not specified.
- AUTODETECT (1):
Prioritize job processing speed.
- DISABLED (2):
Disable all optimizations.
- class ProcessingMode(value)[source]¶
Bases:
proto.enums.EnumThe processing mode of the job.
- Values:
- PROCESSING_MODE_UNSPECIFIED (0):
The job processing mode is not specified.
- PROCESSING_MODE_INTERACTIVE (1):
The job processing mode is interactive mode. Interactive job will either be ran or rejected if quota does not allow for it.
- PROCESSING_MODE_BATCH (2):
The job processing mode is batch mode. Batch mode allows queuing of jobs.
- class ProcessingState(value)[source]¶
Bases:
proto.enums.EnumThe current state of the job.
- Values:
- PROCESSING_STATE_UNSPECIFIED (0):
The processing state is not specified.
- PENDING (1):
The job is enqueued and will be picked up for processing soon.
- RUNNING (2):
The job is being processed.
- SUCCEEDED (3):
The job has been completed successfully.
- FAILED (4):
The job has failed. For additional information, see
failure_reasonandfailure_details
- class google.cloud.video.transcoder_v1.types.JobConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageJob configuration
- inputs¶
List of input assets stored in Cloud Storage.
- Type
MutableSequence[google.cloud.video.transcoder_v1.types.Input]
- edit_list¶
List of
Edit atoms. Defines the ultimate timeline of the resulting file or manifest.- Type
MutableSequence[google.cloud.video.transcoder_v1.types.EditAtom]
- elementary_streams¶
List of elementary streams.
- Type
MutableSequence[google.cloud.video.transcoder_v1.types.ElementaryStream]
- mux_streams¶
List of multiplexing settings for output streams.
- Type
MutableSequence[google.cloud.video.transcoder_v1.types.MuxStream]
- manifests¶
List of output manifests.
- Type
MutableSequence[google.cloud.video.transcoder_v1.types.Manifest]
- output¶
Output configuration.
- ad_breaks¶
List of ad breaks. Specifies where to insert ad break tags in the output manifests.
- Type
MutableSequence[google.cloud.video.transcoder_v1.types.AdBreak]
- pubsub_destination¶
Destination on Pub/Sub.
- sprite_sheets¶
List of output sprite sheets. Spritesheets require at least one VideoStream in the Jobconfig.
- Type
MutableSequence[google.cloud.video.transcoder_v1.types.SpriteSheet]
- overlays¶
List of overlays on the output video, in descending Z-order.
- Type
MutableSequence[google.cloud.video.transcoder_v1.types.Overlay]
- encryptions¶
List of encryption configurations for the content. Each configuration has an ID. Specify this ID in the [MuxStream.encryption_id][google.cloud.video.transcoder.v1.MuxStream.encryption_id] field to indicate the configuration to use for that
MuxStreamoutput.- Type
MutableSequence[google.cloud.video.transcoder_v1.types.Encryption]
- class google.cloud.video.transcoder_v1.types.JobTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTranscoding job template resource.
- name¶
The resource name of the job template. Format:
projects/{project_number}/locations/{location}/jobTemplates/{job_template}- Type
- config¶
The configuration for this template.
- labels¶
The labels associated with this job template. You can use these to organize and group your job templates.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.video.transcoder_v1.types.ListJobTemplatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
TranscoderService.ListJobTemplates.- parent¶
Required. The parent location from which to retrieve the collection of job templates. Format:
projects/{project}/locations/{location}- Type
- filter¶
The filter expression, following the syntax outlined in https://google.aip.dev/160.
- Type
- order_by¶
One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
- Type
- class google.cloud.video.transcoder_v1.types.ListJobTemplatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for
TranscoderService.ListJobTemplates.- job_templates¶
List of job templates in the specified region.
- Type
MutableSequence[google.cloud.video.transcoder_v1.types.JobTemplate]
- class google.cloud.video.transcoder_v1.types.ListJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
TranscoderService.ListJobs. The parent location from which to retrieve the collection of jobs.- filter¶
The filter expression, following the syntax outlined in https://google.aip.dev/160.
- Type
- order_by¶
One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
- Type
- class google.cloud.video.transcoder_v1.types.ListJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for
TranscoderService.ListJobs.- jobs¶
List of jobs in the specified region.
- Type
MutableSequence[google.cloud.video.transcoder_v1.types.Job]
- class google.cloud.video.transcoder_v1.types.Manifest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageManifest configuration.
- file_name¶
The name of the generated file. The default is
manifestwith the extension suffix corresponding to theManifest.type.- Type
- type_¶
Required. Type of the manifest.
- mux_streams¶
Required. List of user given
MuxStream.keys that should appear in this manifest.When
Manifest.typeisHLS, a media manifest with nameMuxStream.keyand.m3u8extension is generated for each element of theManifest.mux_streams.- Type
MutableSequence[str]
- class DashConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDASHmanifest configuration.- segment_reference_scheme¶
The segment reference scheme for a
DASHmanifest. The default isSEGMENT_LIST.
- class SegmentReferenceScheme(value)[source]¶
Bases:
proto.enums.EnumThe segment reference scheme for a
DASHmanifest.- Values:
- SEGMENT_REFERENCE_SCHEME_UNSPECIFIED (0):
The segment reference scheme is not specified.
- SEGMENT_LIST (1):
Lists the URLs of media files for each segment.
- SEGMENT_TEMPLATE_NUMBER (2):
Lists each segment from a template with $Number$ variable.
- class ManifestType(value)[source]¶
Bases:
proto.enums.EnumThe manifest type, which corresponds to the adaptive streaming format used.
- Values:
- MANIFEST_TYPE_UNSPECIFIED (0):
The manifest type is not specified.
- HLS (1):
Create an HLS manifest. The corresponding file extension is
.m3u8.- DASH (2):
Create an MPEG-DASH manifest. The corresponding file extension is
.mpd.
- class google.cloud.video.transcoder_v1.types.MuxStream(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMultiplexing settings for output stream.
- key¶
A unique key for this multiplexed stream. HLS media manifests will be named
MuxStream.keywith the.m3u8extension suffix.- Type
- file_name¶
The name of the generated file. The default is
MuxStream.keywith the extension suffix corresponding to theMuxStream.container.Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as
mux_stream0000000123.ts.- Type
- container¶
The container format. The default is
mp4Supported container formats:
tsfmp4- the corresponding file extension is.m4smp4vtt
See also: Supported input and output formats
- Type
- elementary_streams¶
List of
ElementaryStream.keys multiplexed in this stream.- Type
MutableSequence[str]
- segment_settings¶
Segment settings for
ts,fmp4andvtt.
- class google.cloud.video.transcoder_v1.types.Output(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageLocation of output file(s) in a Cloud Storage bucket.
- uri¶
URI for the output file(s). For example,
gs://my-bucket/outputs/. If empty, the value is populated fromJob.output_uri. See Supported input and output formats.- Type
- class google.cloud.video.transcoder_v1.types.Overlay(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOverlay configuration.
- image¶
Image overlay.
- animations¶
List of Animations. The list should be chronological, without any time overlap.
- Type
MutableSequence[google.cloud.video.transcoder_v1.types.Overlay.Animation]
- class Animation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAnimation types.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- animation_fade¶
Display overlay object with fade animation.
This field is a member of oneof
animation_type.
- class AnimationEnd(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEnd previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video.
- start_time_offset¶
The time to end overlay object, in seconds. Default: 0
- class AnimationFade(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDisplay overlay object with fade animation.
- fade_type¶
Required. Type of fade animation:
FADE_INorFADE_OUT.
- xy¶
Normalized coordinates based on output video resolution. Valid values:
0.0–1.0.xyis 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¶
The time to start the fade animation, in seconds. Default: 0
- end_time_offset¶
The time to end the fade animation, in seconds. Default:
start_time_offset+ 1s
- class AnimationStatic(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDisplay static overlay object.
- xy¶
Normalized coordinates based on output video resolution. Valid values:
0.0–1.0.xyis 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¶
The time to start displaying the overlay object, in seconds. Default: 0
- class FadeType(value)[source]¶
Bases:
proto.enums.EnumFade type for the overlay:
FADE_INorFADE_OUT.- Values:
- FADE_TYPE_UNSPECIFIED (0):
The fade type is not specified.
- FADE_IN (1):
Fade the overlay object into view.
- FADE_OUT (2):
Fade the overlay object out of view.
- class Image(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOverlaid image.
- uri¶
Required. URI of the image in Cloud Storage. For example,
gs://bucket/inputs/image.png. Only PNG and JPEG images are supported.- Type
- resolution¶
Normalized image resolution, based on output video resolution. Valid values:
0.0–1.0. To respect the original image aspect ratio, set eitherxoryto0.0. To use the original image resolution, set bothxandyto0.0.
- class google.cloud.video.transcoder_v1.types.PreprocessingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePreprocessing configurations.
- 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.
- class Audio(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAudio preprocessing configuration.
- lufs¶
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
- Type
- high_boost¶
Enable boosting high frequency components. The default is
false.Note: This field is not supported.
- Type
- class Color(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageColor preprocessing configuration.
Note: This configuration is not supported.
- 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.
- Type
- 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.
- Type
- class Crop(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVideo cropping configuration for the input video. The cropped input video is scaled to match the output resolution.
- class Deblock(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDeblock preprocessing configuration.
Note: This configuration is not supported.
- 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.
- Type
- class Deinterlace(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDeinterlace configuration for input video.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- yadif¶
Specifies the Yet Another Deinterlacing Filter Configuration.
This field is a member of oneof
deinterlacing_filter.
- bwdif¶
Specifies the Bob Weaver Deinterlacing Filter Configuration.
This field is a member of oneof
deinterlacing_filter.
- class BwdifConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageBob Weaver Deinterlacing Filter Configuration.
- mode¶
Specifies the deinterlacing mode to adopt. The default is
send_frame. Supported values:send_frame: Output one frame for each framesend_field: Output one frame for each field
- Type
- parity¶
The picture field parity assumed for the input interlaced video. The default is
auto. Supported values:tff: Assume the top field is firstbff: Assume the bottom field is firstauto: Enable automatic detection of field parity
- Type
- class YadifConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageYet Another Deinterlacing Filter Configuration.
- mode¶
Specifies the deinterlacing mode to adopt. The default is
send_frame. Supported values:send_frame: Output one frame for each framesend_field: Output one frame for each field
- Type
- parity¶
The picture field parity assumed for the input interlaced video. The default is
auto. Supported values:tff: Assume the top field is firstbff: Assume the bottom field is firstauto: Enable automatic detection of field parity
- Type
- class Denoise(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDenoise preprocessing configuration.
Note: This configuration is not supported.
- 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.
- Type
- class Pad(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution.
- class google.cloud.video.transcoder_v1.types.PubsubDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA Pub/Sub destination.
- class google.cloud.video.transcoder_v1.types.SegmentSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSegment settings for
ts,fmp4andvtt.- segment_duration¶
Duration of the segments in seconds. The default is
6.0s. Note thatsegmentDurationmust be greater than or equal to`gopDuration<#videostream>`__, andsegmentDurationmust be divisible by`gopDuration<#videostream>`__.
- class google.cloud.video.transcoder_v1.types.SpriteSheet(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSprite sheet configuration.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- file_prefix¶
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.- Type
- sprite_width_pixels¶
Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the [SpriteSheet.sprite_width_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_width_pixels] field or the [SpriteSheet.sprite_height_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_height_pixels] field, but not both (the API will automatically calculate the missing field).
For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.
- Type
- sprite_height_pixels¶
Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the [SpriteSheet.sprite_height_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_height_pixels] field or the [SpriteSheet.sprite_width_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_width_pixels] field, but not both (the API will automatically calculate the missing field).
For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.
- Type
- column_count¶
The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
- Type
- row_count¶
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.
- Type
- start_time_offset¶
Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is
0s.
- end_time_offset¶
End time in seconds, relative to the output file timeline. When
end_time_offsetis not specified, the sprites are generated until the end of the output file.
- total_count¶
Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
This field is a member of oneof
extraction_strategy.- Type
- class google.cloud.video.transcoder_v1.types.TextStream(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageEncoding of a text stream. For example, closed captions or subtitles.
- codec¶
The codec for this text stream. The default is
webvtt.Supported text codecs:
srtttmlcea608cea708webvtt
- Type
- language_code¶
The BCP-47 language code, such as
en-USorsr-Latn. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not supported in MP4 files.- Type
- mapping_¶
The mapping for the
Job.edit_listatoms with textEditAtom.inputs.- Type
MutableSequence[google.cloud.video.transcoder_v1.types.TextStream.TextMapping]
- display_name¶
The name for this particular text stream that will be added to the HLS/DASH manifest. Not supported in MP4 files.
- Type
- class TextMapping(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe mapping for the
Job.edit_listatoms with textEditAtom.inputs.- atom_key¶
Required. The
EditAtom.keythat references atom with text inputs in theJob.edit_list.- Type
- class google.cloud.video.transcoder_v1.types.VideoStream(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVideo stream resource.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class H264CodecSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageH264 codec settings.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- width_pixels¶
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.
- Type
- height_pixels¶
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.
- Type
- frame_rate¶
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.
- Type
- bitrate_bps¶
Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
- Type
- pixel_format¶
Pixel format to use. The default is
yuv420p.Supported pixel formats:
yuv420ppixel formatyuv422ppixel formatyuv444ppixel formatyuv420p1010-bit HDR pixel formatyuv422p1010-bit HDR pixel formatyuv444p1010-bit HDR pixel formatyuv420p1212-bit HDR pixel formatyuv422p1212-bit HDR pixel formatyuv444p1212-bit HDR pixel format
- Type
- rate_control_mode¶
Specify the
rate_control_mode. The default isvbr.Supported rate control modes:
vbr- variable bitratecrf- constant rate factor
- Type
- crf_level¶
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.
- Type
- allow_open_gop¶
Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is
false.- Type
- gop_frame_count¶
Select the GOP size based on the specified frame count. Must be greater than zero.
This field is a member of oneof
gop_mode.- Type
- gop_duration¶
Select the GOP size based on the specified duration. The default is
3s. Note thatgopDurationmust be less than or equal to`segmentDuration<#SegmentSettings>`__, and`segmentDuration<#SegmentSettings>`__ must be divisible bygopDuration.This field is a member of oneof
gop_mode.
- enable_two_pass¶
Use two-pass encoding strategy to achieve better video quality.
VideoStream.rate_control_modemust bevbr. The default isfalse.- Type
- vbv_size_bits¶
Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to
VideoStream.bitrate_bps.- Type
- vbv_fullness_bits¶
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.- Type
- entropy_coder¶
The entropy coder to use. The default is
cabac.Supported entropy coders:
cavlccabac
- Type
- b_pyramid¶
Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is
false.- Type
- b_frame_count¶
The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than
VideoStream.gop_frame_countif set. The default is 0.- Type
- aq_strength¶
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.
- Type
- profile¶
Enforces the specified codec profile. The following profiles are supported:
baselinemainhigh(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
H264CodecSettingsmessage.- Type
- 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
H264CodecSettingsmessage.- Type
- preset¶
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 theH264CodecSettingsmessage.- Type
- class H265CodecSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageH265 codec settings.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- width_pixels¶
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.
- Type
- height_pixels¶
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.
- Type
- frame_rate¶
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.
- Type
- bitrate_bps¶
Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
- Type
- pixel_format¶
Pixel format to use. The default is
yuv420p.Supported pixel formats:
yuv420ppixel formatyuv422ppixel formatyuv444ppixel formatyuv420p1010-bit HDR pixel formatyuv422p1010-bit HDR pixel formatyuv444p1010-bit HDR pixel formatyuv420p1212-bit HDR pixel formatyuv422p1212-bit HDR pixel formatyuv444p1212-bit HDR pixel format
- Type
- rate_control_mode¶
Specify the
rate_control_mode. The default isvbr.Supported rate control modes:
vbr- variable bitratecrf- constant rate factor
- Type
- crf_level¶
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.
- Type
- allow_open_gop¶
Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is
false.- Type
- gop_frame_count¶
Select the GOP size based on the specified frame count. Must be greater than zero.
This field is a member of oneof
gop_mode.- Type
- gop_duration¶
Select the GOP size based on the specified duration. The default is
3s. Note thatgopDurationmust be less than or equal to`segmentDuration<#SegmentSettings>`__, and`segmentDuration<#SegmentSettings>`__ must be divisible bygopDuration.This field is a member of oneof
gop_mode.
- enable_two_pass¶
Use two-pass encoding strategy to achieve better video quality.
VideoStream.rate_control_modemust bevbr. The default isfalse.- Type
- vbv_size_bits¶
Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to
VideoStream.bitrate_bps.- Type
- vbv_fullness_bits¶
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.- Type
- b_pyramid¶
Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is
false.- Type
- b_frame_count¶
The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than
VideoStream.gop_frame_countif set. The default is 0.- Type
- aq_strength¶
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.
- Type
- profile¶
Enforces the specified codec profile. The following profiles are supported:
8-bit profiles
main(default)main-intramainstillpicture
10-bit profiles
main10(default)main10-intramain422-10main422-10-intramain444-10main444-10-intra
12-bit profiles
main12(default)main12-intramain422-12main422-12-intramain444-12main444-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
H265CodecSettingsmessage.- Type
- 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
H265CodecSettingsmessage.- Type
- preset¶
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 theH265CodecSettingsmessage.- Type
- class Vp9CodecSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVP9 codec settings.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- width_pixels¶
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.
- Type
- height_pixels¶
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.
- Type
- frame_rate¶
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.
- Type
- bitrate_bps¶
Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.
- Type
- pixel_format¶
Pixel format to use. The default is
yuv420p.Supported pixel formats:
yuv420ppixel formatyuv422ppixel formatyuv444ppixel formatyuv420p1010-bit HDR pixel formatyuv422p1010-bit HDR pixel formatyuv444p1010-bit HDR pixel formatyuv420p1212-bit HDR pixel formatyuv422p1212-bit HDR pixel formatyuv444p1212-bit HDR pixel format
- Type
- rate_control_mode¶
Specify the
rate_control_mode. The default isvbr.Supported rate control modes:
vbr- variable bitrate
- Type
- crf_level¶
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.
- Type
- gop_frame_count¶
Select the GOP size based on the specified frame count. Must be greater than zero.
This field is a member of oneof
gop_mode.- Type
- gop_duration¶
Select the GOP size based on the specified duration. The default is
3s. Note thatgopDurationmust be less than or equal to`segmentDuration<#SegmentSettings>`__, and`segmentDuration<#SegmentSettings>`__ must be divisible bygopDuration.This field is a member of oneof
gop_mode.
- profile¶
Enforces the specified codec profile. The following profiles are supported:
profile0(default)profile1profile2profile3
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
Vp9CodecSettingsmessage.- Type
