{ "protocol": "rest", "revision": "20260909", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "id": "transcoder:v1", "ownerDomain": "google.com", "version": "v1", "resources": { "projects": { "resources": { "locations": { "resources": { "jobTemplates": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/jobTemplates", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobTemplates", "id": "transcoder.projects.locations.jobTemplates.create", "response": { "$ref": "JobTemplate" }, "description": "Creates a job template in the specified region.", "httpMethod": "POST", "request": { "$ref": "JobTemplate" }, "parameters": { "jobTemplateId": { "location": "query", "description": "Required. The ID to use for the job template, which will become the final component of the job template's resource name. This value should be 4-63 characters, and valid characters must match the regular expression `a-zA-Z*`.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The parent location to create this job template. Format: `projects/{project}/locations/{location}`", "type": "string", "location": "path" } } }, "delete": { "description": "Deletes a job template.", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/jobTemplates/[^/]+$", "type": "string", "description": "Required. The name of the job template to delete. `projects/{project}/locations/{location}/jobTemplates/{job_template}`", "location": "path" }, "allowMissing": { "description": "If set to true, and the job template is not found, the request will succeed but no action will be taken on the server.", "location": "query", "type": "boolean" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "transcoder.projects.locations.jobTemplates.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobTemplates/{jobTemplatesId}" }, "get": { "httpMethod": "GET", "description": "Returns the job template data.", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobTemplates/[^/]+$", "description": "Required. The name of the job template to retrieve. Format: `projects/{project}/locations/{location}/jobTemplates/{job_template}`", "required": true, "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobTemplates/{jobTemplatesId}", "response": { "$ref": "JobTemplate" }, "id": "transcoder.projects.locations.jobTemplates.get", "path": "v1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "filter": { "type": "string", "description": "The filter expression, following the syntax outlined in https://google.aip.dev/160.", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The maximum number of items to return." }, "orderBy": { "description": "One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.", "type": "string", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "The `next_page_token` value returned from a previous List request, if any." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent location from which to retrieve the collection of job templates. Format: `projects/{project}/locations/{location}`", "type": "string", "required": true } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "transcoder.projects.locations.jobTemplates.list", "response": { "$ref": "ListJobTemplatesResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobTemplates", "description": "Lists job templates in the specified region.", "path": "v1/{+parent}/jobTemplates", "parameterOrder": [ "parent" ] } } }, "jobs": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Returns the job data.", "id": "transcoder.projects.locations.jobs.get", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}", "httpMethod": "GET", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", "type": "string", "description": "Required. The name of the job to retrieve. Format: `projects/{project}/locations/{location}/jobs/{job}`", "required": true } }, "response": { "$ref": "Job" }, "path": "v1/{+name}" }, "list": { "id": "transcoder.projects.locations.jobs.list", "description": "Lists jobs in the specified region.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs", "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. Format: `projects/{project}/locations/{location}`" }, "pageSize": { "type": "integer", "format": "int32", "description": "The maximum number of items to return.", "location": "query" }, "orderBy": { "location": "query", "description": "One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.", "type": "string" }, "filter": { "description": "The filter expression, following the syntax outlined in https://google.aip.dev/160.", "location": "query", "type": "string" }, "pageToken": { "description": "The `next_page_token` value returned from a previous List request, if any.", "location": "query", "type": "string" } }, "response": { "$ref": "ListJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/jobs", "parameterOrder": [ "parent" ] }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "description": "Required. The parent location to create and process this job. Format: `projects/{project}/locations/{location}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } }, "httpMethod": "POST", "id": "transcoder.projects.locations.jobs.create", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/jobs", "description": "Creates a job in the specified region.", "request": { "$ref": "Job" }, "response": { "$ref": "Job" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the job to delete. Format: `projects/{project}/locations/{location}/jobs/{job}`", "required": true }, "allowMissing": { "type": "boolean", "location": "query", "description": "If set to true, and the job is not found, the request will succeed but no action will be taken on the server." } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}", "description": "Deletes a job.", "path": "v1/{+name}", "id": "transcoder.projects.locations.jobs.delete" } } } } } } } }, "basePath": "", "documentationLink": "https://cloud.google.com/transcoder/docs/", "parameters": { "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "$.xgafv": { "description": "V1 error format.", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ], "location": "query" }, "alt": { "type": "string", "location": "query", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "default": "json" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string", "location": "query" }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string", "location": "query" } }, "discoveryVersion": "v1", "servicePath": "", "kind": "discovery#restDescription", "name": "transcoder", "fullyEncodeReservedExpansion": true, "mtlsRootUrl": "https://transcoder.mtls.googleapis.com/", "description": "This API converts video files into formats suitable for consumer distribution. For more information, see the Transcoder API overview. ", "batchPath": "batch", "canonicalName": "Transcoder", "ownerName": "Google", "title": "Transcoder API", "schemas": { "JobConfig": { "properties": { "muxStreams": { "description": "List of multiplexing settings for output streams.", "items": { "$ref": "MuxStream" }, "type": "array" }, "encryptions": { "description": "List of encryption configurations for the content. Each configuration has an ID. Specify this ID in the MuxStream.encryption_id field to indicate the configuration to use for that `MuxStream` output.", "items": { "$ref": "Encryption" }, "type": "array" }, "manifests": { "items": { "$ref": "Manifest" }, "type": "array", "description": "List of output manifests." }, "overlays": { "description": "List of overlays on the output video, in descending Z-order.", "items": { "$ref": "Overlay" }, "type": "array" }, "output": { "description": "Output configuration.", "$ref": "Output" }, "editList": { "type": "array", "items": { "$ref": "EditAtom" }, "description": "List of edit atoms. Defines the ultimate timeline of the resulting file or manifest." }, "adBreaks": { "items": { "$ref": "AdBreak" }, "description": "List of ad breaks. Specifies where to insert ad break tags in the output manifests.", "type": "array" }, "inputs": { "type": "array", "items": { "$ref": "Input" }, "description": "List of input assets stored in Cloud Storage." }, "pubsubDestination": { "description": "Destination on Pub/Sub.", "$ref": "PubsubDestination" }, "spriteSheets": { "type": "array", "description": "List of output sprite sheets. Spritesheets require at least one VideoStream in the Jobconfig.", "items": { "$ref": "SpriteSheet" } }, "elementaryStreams": { "description": "List of elementary streams.", "items": { "$ref": "ElementaryStream" }, "type": "array" } }, "id": "JobConfig", "type": "object", "description": "Job configuration" }, "TextMapping": { "properties": { "inputTrack": { "format": "int32", "type": "integer", "description": "Required. The zero-based index of the track in the input file." }, "inputKey": { "description": "Required. The Input.key that identifies the input file.", "type": "string" }, "atomKey": { "description": "Required. The EditAtom.key that references atom with text inputs in the JobConfig.edit_list.", "type": "string" } }, "type": "object", "description": "The mapping for the JobConfig.edit_list atoms with text EditAtom.inputs.", "id": "TextMapping" }, "Animation": { "id": "Animation", "type": "object", "description": "Animation types.", "properties": { "animationEnd": { "description": "End previous animation.", "$ref": "AnimationEnd" }, "animationFade": { "$ref": "AnimationFade", "description": "Display overlay object with fade animation." }, "animationStatic": { "$ref": "AnimationStatic", "description": "Display static overlay object." } } }, "SecretManagerSource": { "type": "object", "description": "Configuration for secrets stored in Google Secret Manager.", "id": "SecretManagerSource", "properties": { "secretVersion": { "type": "string", "description": "Required. The name of the Secret Version containing the encryption key in the following format: `projects/{project}/secrets/{secret_id}/versions/{version_number}` Note that only numbered versions are supported. Aliases like \"latest\" are not supported." } } }, "VideoStream": { "properties": { "vp9": { "$ref": "Vp9CodecSettings", "description": "VP9 codec settings." }, "h265": { "$ref": "H265CodecSettings", "description": "H265 codec settings." }, "h264": { "description": "H264 codec settings.", "$ref": "H264CodecSettings" } }, "id": "VideoStream", "description": "Video stream resource.", "type": "object" }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "type": "object", "properties": { "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array" }, "code": { "type": "integer", "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code." } } }, "Clearkey": { "properties": {}, "id": "Clearkey", "type": "object", "description": "Clearkey configuration." }, "MpegCommonEncryption": { "properties": { "scheme": { "description": "Required. Specify the encryption scheme. Supported encryption schemes: - `cenc` - `cbcs`", "type": "string" } }, "id": "MpegCommonEncryption", "description": "Configuration for MPEG Common Encryption (MPEG-CENC).", "type": "object" }, "InputAttributes": { "id": "InputAttributes", "properties": { "trackDefinitions": { "description": "Optional. A list of track definitions for the input asset.", "type": "array", "items": { "$ref": "TrackDefinition" } } }, "description": "Input attributes that provide additional information about the input asset.", "type": "object" }, "BwdifConfig": { "description": "Bob Weaver Deinterlacing Filter Configuration.", "id": "BwdifConfig", "properties": { "parity": { "description": "The picture field parity assumed for the input interlaced video. The default is `auto`. Supported values: - `tff`: Assume the top field is first - `bff`: Assume the bottom field is first - `auto`: Enable automatic detection of field parity", "type": "string" }, "mode": { "description": "Specifies the deinterlacing mode to adopt. The default is `send_frame`. Supported values: - `send_frame`: Output one frame for each frame - `send_field`: Output one frame for each field", "type": "string" }, "deinterlaceAllFrames": { "description": "Deinterlace all frames rather than just the frames identified as interlaced. The default is `false`.", "type": "boolean" } }, "type": "object" }, "Pad": { "properties": { "rightPixels": { "description": "The number of pixels to add to the right. The default is 0.", "format": "int32", "type": "integer" }, "leftPixels": { "type": "integer", "format": "int32", "description": "The number of pixels to add to the left. The default is 0." }, "bottomPixels": { "format": "int32", "description": "The number of pixels to add to the bottom. The default is 0.", "type": "integer" }, "topPixels": { "description": "The number of pixels to add to the top. The default is 0.", "format": "int32", "type": "integer" } }, "id": "Pad", "description": "Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution.", "type": "object" }, "H264CodecSettings": { "description": "H264 codec settings.", "type": "object", "id": "H264CodecSettings", "properties": { "hlg": { "$ref": "H264ColorFormatHLG", "description": "Optional. HLG color format setting for H264." }, "enableTwoPass": { "type": "boolean", "description": "Use two-pass encoding strategy to achieve better video quality. H264CodecSettings.rate_control_mode must be `vbr`. The default is `false`." }, "heightPixels": { "format": "int32", "description": "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": "integer" }, "entropyCoder": { "type": "string", "description": "The entropy coder to use. The default is `cabac`. Supported entropy coders: - `cavlc` - `cabac`" }, "allowOpenGop": { "description": "Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.", "type": "boolean" }, "preset": { "type": "string", "description": "Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message." }, "vbvFullnessBits": { "format": "int32", "description": "Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of H264CodecSettings.vbv_size_bits.", "type": "integer" }, "aqStrength": { "description": "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.", "format": "double", "type": "number" }, "sdr": { "$ref": "H264ColorFormatSDR", "description": "Optional. SDR color format setting for H264." }, "pixelFormat": { "type": "string", "description": "Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format" }, "bitrateBps": { "format": "int32", "type": "integer", "description": "Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000." }, "gopDuration": { "format": "google-duration", "description": "Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.", "type": "string" }, "bFrameCount": { "format": "int32", "type": "integer", "description": "The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than H264CodecSettings.gop_frame_count if set. The default is 0." }, "profile": { "type": "string", "description": "Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message." }, "vbvSizeBits": { "format": "int32", "type": "integer", "description": "Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to H264CodecSettings.bitrate_bps." }, "crfLevel": { "format": "int32", "type": "integer", "description": "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." }, "frameRate": { "format": "double", "description": "Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120.", "type": "number" }, "widthPixels": { "type": "integer", "description": "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.", "format": "int32" }, "frameRateConversionStrategy": { "enumDescriptions": [ "Unspecified frame rate conversion strategy.", "Selectively retain frames to reduce the output frame rate. Every _n_ th frame is kept, where `n = ceil(input frame rate / target frame rate)`. When _n_ = 1 (that is, the target frame rate is greater than the input frame rate), the output frame rate matches the input frame rate. When _n_ \u003e 1, frames are dropped and the output frame rate is equal to `(input frame rate / n)`. For more information, see [Calculate frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate).", "Drop or duplicate frames to match the specified frame rate." ], "enum": [ "FRAME_RATE_CONVERSION_STRATEGY_UNSPECIFIED", "DOWNSAMPLE", "DROP_DUPLICATE" ], "description": "Optional. Frame rate conversion strategy for desired frame rate. The default is `DOWNSAMPLE`.", "type": "string" }, "bPyramid": { "description": "Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.", "type": "boolean" }, "rateControlMode": { "description": "Specify the mode. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor", "type": "string" }, "gopFrameCount": { "description": "Select the GOP size based on the specified frame count. Must be greater than zero.", "type": "integer", "format": "int32" }, "tune": { "description": "Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune). Note that certain values for this field may cause the transcoder to override other fields you set in the `H264CodecSettings` message.", "type": "string" } } }, "H264ColorFormatHLG": { "properties": {}, "id": "H264ColorFormatHLG", "description": "Convert the input video to a Hybrid Log Gamma (HLG) video.", "type": "object" }, "MuxStream": { "properties": { "fmp4": { "description": "Optional. `fmp4` container configuration.", "$ref": "Fmp4Config" }, "elementaryStreams": { "type": "array", "description": "List of ElementaryStream.key values multiplexed in this stream.", "items": { "type": "string" } }, "container": { "description": "The container format. The default is `mp4` Supported streaming formats: - `ts` - `fmp4`- the corresponding file extension is `.m4s` Supported standalone file formats: - `mp4` - `mp3` - `ogg` - `vtt` See also: [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats)", "type": "string" }, "key": { "description": "A unique key for this multiplexed stream.", "type": "string" }, "segmentSettings": { "description": "Segment settings for `ts`, `fmp4` and `vtt`.", "$ref": "SegmentSettings" }, "encryptionId": { "type": "string", "description": "Identifier of the encryption configuration to use. If omitted, output will be unencrypted." }, "fileName": { "description": "The name of the generated file. The default is MuxStream.key with the extension suffix corresponding to the MuxStream.container. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `mux_stream0000000123.ts`.", "type": "string" } }, "id": "MuxStream", "type": "object", "description": "Multiplexing settings for output stream." }, "EditAtom": { "properties": { "inputs": { "type": "array", "description": "List of Input.key values identifying files that should be used in this atom. The listed `inputs` must have the same timeline.", "items": { "type": "string" } }, "key": { "type": "string", "description": "A unique key for this atom. Must be specified when using advanced mapping." }, "endTimeOffset": { "type": "string", "description": "End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.", "format": "google-duration" }, "startTimeOffset": { "type": "string", "description": "Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.", "format": "google-duration" } }, "type": "object", "description": "Edit atom.", "id": "EditAtom" }, "Output": { "id": "Output", "type": "object", "description": "Location of output file(s) in a Cloud Storage bucket.", "properties": { "uri": { "description": "URI for the output file(s). For example, `gs://my-bucket/outputs/`. Must be a directory and not a top-level bucket. If empty, the value is populated from Job.output_uri. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).", "type": "string" } } }, "Vp9ColorFormatSDR": { "type": "object", "properties": {}, "description": "Convert the input video to a Standard Dynamic Range (SDR) video.", "id": "Vp9ColorFormatSDR" }, "Job": { "properties": { "fillContentGaps": { "description": "Optional. Insert silence and duplicate frames when timestamp gaps are detected in a given stream.", "type": "boolean" }, "templateId": { "description": "Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`, which is the only supported preset. User defined JobTemplate: `{job_template_id}`", "type": "string" }, "batchModePriority": { "description": "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": "integer", "format": "int32" }, "error": { "description": "Output only. An error object that describes the reason for the failure. This property is always present when ProcessingState is `FAILED`.", "readOnly": true, "$ref": "Status" }, "mode": { "description": "The processing mode of the job. The default is `PROCESSING_MODE_INTERACTIVE`.", "enumDescriptions": [ "The job processing mode is not specified.", "The job processing mode is interactive mode. Interactive job will either be ran or rejected if quota does not allow for it.", "The job processing mode is batch mode. Batch mode allows queuing of jobs." ], "type": "string", "enum": [ "PROCESSING_MODE_UNSPECIFIED", "PROCESSING_MODE_INTERACTIVE", "PROCESSING_MODE_BATCH" ] }, "config": { "$ref": "JobConfig", "description": "The configuration for this job." }, "state": { "enumDescriptions": [ "The processing state is not specified.", "The job is enqueued and will be picked up for processing soon.", "The job is being processed.", "The job has been completed successfully.", "The job has failed. For additional information, see [Troubleshooting](https://cloud.google.com/transcoder/docs/troubleshooting)." ], "description": "Output only. The current state of the job.", "enum": [ "PROCESSING_STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED" ], "type": "string", "readOnly": true }, "outputUri": { "description": "Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "The labels associated with this job. You can use these to organize and group your jobs." }, "inputUri": { "type": "string", "description": "Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats)." }, "startTime": { "description": "Output only. The time the transcoding started.", "readOnly": true, "type": "string", "format": "google-datetime" }, "createTime": { "type": "string", "description": "Output only. The time the job was created.", "readOnly": true, "format": "google-datetime" }, "ttlAfterCompletionDays": { "format": "int32", "type": "integer", "description": "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." }, "endTime": { "type": "string", "readOnly": true, "description": "Output only. The time the transcoding finished.", "format": "google-datetime" }, "optimization": { "description": "Optional. The optimization strategy of the job. The default is `AUTODETECT`.", "type": "string", "enumDescriptions": [ "The optimization strategy is not specified.", "Prioritize job processing speed.", "Disable all optimizations." ], "enum": [ "OPTIMIZATION_STRATEGY_UNSPECIFIED", "AUTODETECT", "DISABLED" ] }, "name": { "description": "The resource name of the job. Format: `projects/{project_number}/locations/{location}/jobs/{job}`", "type": "string" } }, "description": "Transcoding job resource.", "type": "object", "id": "Job" }, "AnimationEnd": { "id": "AnimationEnd", "description": "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.", "type": "object", "properties": { "startTimeOffset": { "format": "google-duration", "type": "string", "description": "The time to end overlay object, in seconds. Default: 0" } } }, "ElementaryStream": { "properties": { "videoStream": { "description": "Encoding of a video stream.", "$ref": "VideoStream" }, "textStream": { "$ref": "TextStream", "description": "Encoding of a text stream. For example, closed captions or subtitles." }, "key": { "description": "A unique key for this elementary stream.", "type": "string" }, "audioStream": { "$ref": "AudioStream", "description": "Encoding of an audio stream." } }, "id": "ElementaryStream", "description": "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.", "type": "object" }, "DrmSystems": { "id": "DrmSystems", "type": "object", "properties": { "widevine": { "$ref": "Widevine", "description": "Widevine configuration." }, "fairplay": { "$ref": "Fairplay", "description": "Fairplay configuration." }, "clearkey": { "description": "Clearkey configuration.", "$ref": "Clearkey" }, "playready": { "description": "Playready configuration.", "$ref": "Playready" } }, "description": "Defines configuration for DRM systems in use." }, "NormalizedCoordinate": { "type": "object", "properties": { "x": { "format": "double", "description": "Normalized x coordinate.", "type": "number" }, "y": { "format": "double", "type": "number", "description": "Normalized y coordinate." } }, "id": "NormalizedCoordinate", "description": "2D normalized coordinates. Default: `{0.0, 0.0}`" }, "PreprocessingConfig": { "type": "object", "id": "PreprocessingConfig", "description": "Preprocessing configurations.", "properties": { "color": { "description": "Color preprocessing configuration.", "$ref": "Color" }, "denoise": { "description": "Denoise preprocessing configuration.", "$ref": "Denoise" }, "pad": { "description": "Specify the video pad filter configuration.", "$ref": "Pad" }, "audio": { "$ref": "Audio", "description": "Audio preprocessing configuration." }, "crop": { "description": "Specify the video cropping configuration.", "$ref": "Crop" }, "deblock": { "description": "Deblock preprocessing configuration.", "$ref": "Deblock" }, "deinterlace": { "$ref": "Deinterlace", "description": "Specify the video deinterlace configuration." } } }, "Color": { "type": "object", "properties": { "brightness": { "type": "number", "description": "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.", "format": "double" }, "contrast": { "description": "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.", "format": "double", "type": "number" }, "saturation": { "type": "number", "format": "double", "description": "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." } }, "description": "Color preprocessing configuration. **Note:** This configuration is not supported.", "id": "Color" }, "YadifConfig": { "properties": { "parity": { "description": "The picture field parity assumed for the input interlaced video. The default is `auto`. Supported values: - `tff`: Assume the top field is first - `bff`: Assume the bottom field is first - `auto`: Enable automatic detection of field parity", "type": "string" }, "mode": { "description": "Specifies the deinterlacing mode to adopt. The default is `send_frame`. Supported values: - `send_frame`: Output one frame for each frame - `send_field`: Output one frame for each field", "type": "string" }, "disableSpatialInterlacing": { "type": "boolean", "description": "Disable spacial interlacing. The default is `false`." }, "deinterlaceAllFrames": { "description": "Deinterlace all frames rather than just the frames identified as interlaced. The default is `false`.", "type": "boolean" } }, "id": "YadifConfig", "description": "Yet Another Deinterlacing Filter Configuration.", "type": "object" }, "AudioMapping": { "description": "The mapping for the JobConfig.edit_list atoms with audio EditAtom.inputs.", "id": "AudioMapping", "properties": { "inputKey": { "type": "string", "description": "Required. The Input.key that identifies the input file." }, "outputChannel": { "description": "Required. The zero-based index of the channel in the output audio stream.", "type": "integer", "format": "int32" }, "atomKey": { "description": "Required. The EditAtom.key that references the atom with audio inputs in the JobConfig.edit_list.", "type": "string" }, "inputTrack": { "type": "integer", "format": "int32", "description": "Required. The zero-based index of the track in the input file." }, "inputChannel": { "type": "integer", "description": "Required. The zero-based index of the channel in the input audio stream.", "format": "int32" }, "gainDb": { "description": "Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.", "type": "number", "format": "double" } }, "type": "object" }, "H265ColorFormatHLG": { "properties": {}, "description": "Convert the input video to a Hybrid Log Gamma (HLG) video.", "id": "H265ColorFormatHLG", "type": "object" }, "H264ColorFormatSDR": { "id": "H264ColorFormatSDR", "properties": {}, "type": "object", "description": "Convert the input video to a Standard Dynamic Range (SDR) video." }, "TrackDefinition": { "type": "object", "id": "TrackDefinition", "properties": { "languages": { "description": "Optional. A list of languages spoken in the input asset, represented by a BCP 47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "items": { "type": "string" }, "type": "array" }, "inputTrack": { "description": "The input track.", "type": "integer", "format": "int32" }, "detectedLanguages": { "readOnly": true, "description": "Output only. A list of languages detected in the input asset, represented by a BCP 47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. This field is only populated if the detect_languages field is set to true.", "type": "array", "items": { "type": "string" } }, "detectLanguages": { "description": "Optional. Whether to automatically detect the languages present in the track. If true, the system will attempt to identify all the languages present in the track and populate the languages field.", "type": "boolean" } }, "description": "Track definition for the input asset." }, "Deinterlace": { "description": "Deinterlace configuration for input video.", "type": "object", "properties": { "yadif": { "$ref": "YadifConfig", "description": "Specifies the Yet Another Deinterlacing Filter Configuration." }, "bwdif": { "$ref": "BwdifConfig", "description": "Specifies the Bob Weaver Deinterlacing Filter Configuration." } }, "id": "Deinterlace" }, "TextStream": { "type": "object", "properties": { "displayName": { "description": "The name for this particular text stream that will be added to the HLS/DASH manifest. Not supported in MP4 files.", "type": "string" }, "codec": { "description": "The codec for this text stream. The default is `webvtt`. Supported text codecs: - `srt` - `ttml` - `cea608` - `cea708` - `webvtt`", "type": "string" }, "languageCode": { "type": "string", "description": "The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not supported in MP4 files." }, "mapping": { "description": "The mapping for the JobConfig.edit_list atoms with text EditAtom.inputs.", "items": { "$ref": "TextMapping" }, "type": "array" } }, "id": "TextStream", "description": "Encoding of a text stream. For example, closed captions or subtitles." }, "SampleAesEncryption": { "properties": {}, "type": "object", "id": "SampleAesEncryption", "description": "Configuration for SAMPLE-AES encryption." }, "Empty": { "type": "object", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "properties": {}, "id": "Empty" }, "Input": { "properties": { "key": { "type": "string", "description": "A unique key for this input. Must be specified when using advanced mapping and edit lists." }, "uri": { "type": "string", "description": "URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value is populated from Job.input_uri. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats)." }, "preprocessingConfig": { "$ref": "PreprocessingConfig", "description": "Preprocessing configurations." }, "attributes": { "$ref": "InputAttributes", "description": "Optional. Input Attributes." } }, "description": "Input asset.", "id": "Input", "type": "object" }, "H265CodecSettings": { "type": "object", "properties": { "preset": { "description": "Enforces the specified codec preset. The default is `veryfast`. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message.", "type": "string" }, "allowOpenGop": { "type": "boolean", "description": "Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`." }, "enableTwoPass": { "type": "boolean", "description": "Use two-pass encoding strategy to achieve better video quality. H265CodecSettings.rate_control_mode must be `vbr`. The default is `false`." }, "gopDuration": { "format": "google-duration", "description": "Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.", "type": "string" }, "bFrameCount": { "description": "The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than H265CodecSettings.gop_frame_count if set. The default is 0.", "type": "integer", "format": "int32" }, "hdr10": { "description": "Optional. HDR10 color format setting for H265.", "$ref": "H265ColorFormatHDR10" }, "pixelFormat": { "type": "string", "description": "Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format" }, "heightPixels": { "description": "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": "integer", "format": "int32" }, "frameRate": { "description": "Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120.", "type": "number", "format": "double" }, "rateControlMode": { "description": "Specify the mode. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate - `crf` - constant rate factor", "type": "string" }, "hlg": { "description": "Optional. HLG color format setting for H265.", "$ref": "H265ColorFormatHLG" }, "aqStrength": { "format": "double", "description": "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": "number" }, "profile": { "type": "string", "description": "Enforces the specified codec profile. The following profiles are supported: * 8-bit profiles * `main` (default) * `main-intra` * `mainstillpicture` * 10-bit profiles * `main10` (default) * `main10-intra` * `main422-10` * `main422-10-intra` * `main444-10` * `main444-10-intra` * 12-bit profiles * `main12` (default) * `main12-intra` * `main422-12` * `main422-12-intra` * `main444-12` * `main444-12-intra` The available options are [FFmpeg-compatible](https://x265.readthedocs.io/). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message." }, "vbvFullnessBits": { "description": "Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of H265CodecSettings.vbv_size_bits.", "type": "integer", "format": "int32" }, "sdr": { "description": "Optional. SDR color format setting for H265.", "$ref": "H265ColorFormatSDR" }, "crfLevel": { "description": "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": "integer", "format": "int32" }, "frameRateConversionStrategy": { "enumDescriptions": [ "Unspecified frame rate conversion strategy.", "Selectively retain frames to reduce the output frame rate. Every _n_ th frame is kept, where `n = ceil(input frame rate / target frame rate)`. When _n_ = 1 (that is, the target frame rate is greater than the input frame rate), the output frame rate matches the input frame rate. When _n_ \u003e 1, frames are dropped and the output frame rate is equal to `(input frame rate / n)`. For more information, see [Calculate frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate).", "Drop or duplicate frames to match the specified frame rate." ], "description": "Optional. Frame rate conversion strategy for desired frame rate. The default is `DOWNSAMPLE`.", "enum": [ "FRAME_RATE_CONVERSION_STRATEGY_UNSPECIFIED", "DOWNSAMPLE", "DROP_DUPLICATE" ], "type": "string" }, "widthPixels": { "format": "int32", "type": "integer", "description": "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." }, "bitrateBps": { "type": "integer", "format": "int32", "description": "Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000." }, "vbvSizeBits": { "description": "Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.", "type": "integer", "format": "int32" }, "tune": { "type": "string", "description": "Enforces the specified codec tune. The available options are [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.265). Note that certain values for this field may cause the transcoder to override other fields you set in the `H265CodecSettings` message." }, "bPyramid": { "type": "boolean", "description": "Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`." }, "gopFrameCount": { "description": "Select the GOP size based on the specified frame count. Must be greater than zero.", "format": "int32", "type": "integer" } }, "id": "H265CodecSettings", "description": "H265 codec settings." }, "Crop": { "description": "Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution.", "id": "Crop", "type": "object", "properties": { "bottomPixels": { "format": "int32", "description": "The number of pixels to crop from the bottom. The default is 0.", "type": "integer" }, "rightPixels": { "type": "integer", "description": "The number of pixels to crop from the right. The default is 0.", "format": "int32" }, "topPixels": { "format": "int32", "description": "The number of pixels to crop from the top. The default is 0.", "type": "integer" }, "leftPixels": { "description": "The number of pixels to crop from the left. The default is 0.", "type": "integer", "format": "int32" } } }, "ListJobsResponse": { "properties": { "nextPageToken": { "description": "The pagination token.", "type": "string" }, "jobs": { "description": "List of jobs in the specified region.", "items": { "$ref": "Job" }, "type": "array" }, "unreachable": { "items": { "type": "string" }, "type": "array", "description": "List of regions that could not be reached." } }, "description": "Response message for `TranscoderService.ListJobs`.", "type": "object", "id": "ListJobsResponse" }, "Audio": { "id": "Audio", "type": "object", "description": "Audio preprocessing configuration.", "properties": { "lowBoost": { "type": "boolean", "description": "Enable boosting low frequency components. The default is `false`. **Note:** This field is not supported." }, "lufs": { "description": "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", "format": "double", "type": "number" }, "highBoost": { "type": "boolean", "description": "Enable boosting high frequency components. The default is `false`. **Note:** This field is not supported." } } }, "AudioStream": { "type": "object", "id": "AudioStream", "description": "Audio stream resource.", "properties": { "sampleRateHertz": { "type": "integer", "description": "The audio sample rate in Hertz. The default is 48000 Hertz.", "format": "int32" }, "languageCode": { "description": "The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. Not supported in MP4 files.", "type": "string" }, "mapping": { "description": "The mapping for the JobConfig.edit_list atoms with audio EditAtom.inputs.", "type": "array", "items": { "$ref": "AudioMapping" } }, "displayName": { "type": "string", "description": "The name for this particular audio stream that will be added to the HLS/DASH manifest. Not supported in MP4 files." }, "channelLayout": { "type": "array", "description": "A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `[\"fl\", \"fr\"]`. Supported channel names: - `fl` - Front left channel - `fr` - Front right channel - `sl` - Side left channel - `sr` - Side right channel - `fc` - Front center channel - `lfe` - Low frequency", "items": { "type": "string" } }, "bitrateBps": { "description": "Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.", "format": "int32", "type": "integer" }, "channelCount": { "description": "Number of audio channels. Must be between 1 and 6. The default is 2.", "type": "integer", "format": "int32" }, "codec": { "type": "string", "description": "The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` - `vorbis`" } } }, "SegmentSettings": { "properties": { "segmentDuration": { "description": "Duration of the segments in seconds. The default is `6.0s`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).", "type": "string", "format": "google-duration" }, "individualSegments": { "type": "boolean", "description": "Required. Create an individual segment file. The default is `false`." } }, "id": "SegmentSettings", "type": "object", "description": "Segment settings for `ts`, `fmp4` and `vtt`." }, "Vp9CodecSettings": { "type": "object", "id": "Vp9CodecSettings", "description": "VP9 codec settings.", "properties": { "hlg": { "$ref": "Vp9ColorFormatHLG", "description": "Optional. HLG color format setting for VP9." }, "rateControlMode": { "type": "string", "description": "Specify the mode. The default is `vbr`. Supported rate control modes: - `vbr` - variable bitrate" }, "heightPixels": { "description": "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": "integer", "format": "int32" }, "sdr": { "description": "Optional. SDR color format setting for VP9.", "$ref": "Vp9ColorFormatSDR" }, "frameRate": { "type": "number", "format": "double", "description": "Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120." }, "profile": { "description": "Enforces the specified codec profile. The following profiles are supported: * `profile0` (default) * `profile1` * `profile2` * `profile3` The available options are [WebM-compatible](https://www.webmproject.org/vp9/profiles/). Note that certain values for this field may cause the transcoder to override other fields you set in the `Vp9CodecSettings` message.", "type": "string" }, "gopDuration": { "type": "string", "description": "Select the GOP size based on the specified duration. The default is `3s`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.", "format": "google-duration" }, "pixelFormat": { "type": "string", "description": "Pixel format to use. The default is `yuv420p`. Supported pixel formats: - `yuv420p` pixel format - `yuv422p` pixel format - `yuv444p` pixel format - `yuv420p10` 10-bit HDR pixel format - `yuv422p10` 10-bit HDR pixel format - `yuv444p10` 10-bit HDR pixel format - `yuv420p12` 12-bit HDR pixel format - `yuv422p12` 12-bit HDR pixel format - `yuv444p12` 12-bit HDR pixel format" }, "crfLevel": { "format": "int32", "description": "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": "integer" }, "bitrateBps": { "type": "integer", "description": "Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.", "format": "int32" }, "widthPixels": { "type": "integer", "format": "int32", "description": "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." }, "frameRateConversionStrategy": { "enum": [ "FRAME_RATE_CONVERSION_STRATEGY_UNSPECIFIED", "DOWNSAMPLE", "DROP_DUPLICATE" ], "enumDescriptions": [ "Unspecified frame rate conversion strategy.", "Selectively retain frames to reduce the output frame rate. Every _n_ th frame is kept, where `n = ceil(input frame rate / target frame rate)`. When _n_ = 1 (that is, the target frame rate is greater than the input frame rate), the output frame rate matches the input frame rate. When _n_ \u003e 1, frames are dropped and the output frame rate is equal to `(input frame rate / n)`. For more information, see [Calculate frame rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate).", "Drop or duplicate frames to match the specified frame rate." ], "description": "Optional. Frame rate conversion strategy for desired frame rate. The default is `DOWNSAMPLE`.", "type": "string" }, "gopFrameCount": { "type": "integer", "format": "int32", "description": "Select the GOP size based on the specified frame count. Must be greater than zero." } } }, "Aes128Encryption": { "description": "Configuration for AES-128 encryption.", "properties": {}, "id": "Aes128Encryption", "type": "object" }, "Encryption": { "type": "object", "id": "Encryption", "properties": { "secretManagerKeySource": { "$ref": "SecretManagerSource", "description": "Keys are stored in Google Secret Manager." }, "aes128": { "description": "Configuration for AES-128 encryption.", "$ref": "Aes128Encryption" }, "sampleAes": { "$ref": "SampleAesEncryption", "description": "Configuration for SAMPLE-AES encryption." }, "drmSystems": { "$ref": "DrmSystems", "description": "Required. DRM system(s) to use; at least one must be specified. If a DRM system is omitted, it is considered disabled." }, "id": { "description": "Required. Identifier for this set of encryption options.", "type": "string" }, "mpegCenc": { "$ref": "MpegCommonEncryption", "description": "Configuration for MPEG Common Encryption (MPEG-CENC)." } }, "description": "Encryption settings." }, "JobTemplate": { "id": "JobTemplate", "properties": { "config": { "description": "The configuration for this template.", "$ref": "JobConfig" }, "name": { "type": "string", "description": "The resource name of the job template. Format: `projects/{project_number}/locations/{location}/jobTemplates/{job_template}`" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The labels associated with this job template. You can use these to organize and group your job templates." } }, "description": "Transcoding job template resource.", "type": "object" }, "ListJobTemplatesResponse": { "properties": { "unreachable": { "items": { "type": "string" }, "type": "array", "description": "List of regions that could not be reached." }, "jobTemplates": { "description": "List of job templates in the specified region.", "type": "array", "items": { "$ref": "JobTemplate" } }, "nextPageToken": { "type": "string", "description": "The pagination token." } }, "description": "Response message for `TranscoderService.ListJobTemplates`.", "type": "object", "id": "ListJobTemplatesResponse" }, "Overlay": { "description": "Overlay configuration.", "properties": { "animations": { "items": { "$ref": "Animation" }, "description": "List of animations. The list should be chronological, without any time overlap.", "type": "array" }, "image": { "description": "Image overlay.", "$ref": "Image" } }, "id": "Overlay", "type": "object" }, "Vp9ColorFormatHLG": { "id": "Vp9ColorFormatHLG", "type": "object", "properties": {}, "description": "Convert the input video to a Hybrid Log Gamma (HLG) video." }, "Image": { "type": "object", "properties": { "resolution": { "$ref": "NormalizedCoordinate", "description": "Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`." }, "uri": { "description": "Required. URI of the image in Cloud Storage. For example, `gs://bucket/inputs/image.png`. Only PNG and JPEG images are supported.", "type": "string" }, "alpha": { "format": "double", "type": "number", "description": "Target image opacity. Valid values are from `1.0` (solid, default) to `0.0` (transparent), exclusive. Set this to a value greater than `0.0`." } }, "id": "Image", "description": "Overlaid image." }, "Fairplay": { "properties": {}, "type": "object", "description": "Fairplay configuration.", "id": "Fairplay" }, "PubsubDestination": { "properties": { "topic": { "description": "The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.", "type": "string" } }, "type": "object", "id": "PubsubDestination", "description": "A Pub/Sub destination." }, "Fmp4Config": { "type": "object", "description": "`fmp4` container configuration.", "id": "Fmp4Config", "properties": { "codecTag": { "type": "string", "description": "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: - `hvc1` (default) - `hev1`" } } }, "Manifest": { "type": "object", "description": "Manifest configuration.", "id": "Manifest", "properties": { "muxStreams": { "items": { "type": "string" }, "type": "array", "description": "Required. List of user supplied MuxStream.key values that should appear in this manifest. When Manifest.type is `HLS`, a media manifest with name MuxStream.key and `.m3u8` extension is generated for each element in this list." }, "type": { "description": "Required. Type of the manifest.", "enum": [ "MANIFEST_TYPE_UNSPECIFIED", "HLS", "DASH" ], "enumDescriptions": [ "The manifest type is not specified.", "Create an HLS manifest. The corresponding file extension is `.m3u8`.", "Create an MPEG-DASH manifest. The corresponding file extension is `.mpd`." ], "type": "string" }, "dash": { "description": "`DASH` manifest configuration.", "$ref": "DashConfig" }, "fileName": { "type": "string", "description": "The name of the generated file. The default is `manifest` with the extension suffix corresponding to the Manifest.type." } } }, "Widevine": { "type": "object", "id": "Widevine", "description": "Widevine configuration.", "properties": {} }, "Denoise": { "id": "Denoise", "properties": { "strength": { "description": "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": "number", "format": "double" }, "tune": { "description": "Set the denoiser mode. The default is `standard`. Supported denoiser modes: - `standard` - `grain`", "type": "string" } }, "type": "object", "description": "Denoise preprocessing configuration. **Note:** This configuration is not supported." }, "H265ColorFormatSDR": { "description": "Convert the input video to a Standard Dynamic Range (SDR) video.", "id": "H265ColorFormatSDR", "type": "object", "properties": {} }, "H265ColorFormatHDR10": { "type": "object", "properties": {}, "description": "Convert the input video to a High Dynamic Range 10 (HDR10) video.", "id": "H265ColorFormatHDR10" }, "Deblock": { "properties": { "strength": { "type": "number", "format": "double", "description": "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": { "description": "Enable deblocker. The default is `false`.", "type": "boolean" } }, "type": "object", "description": "Deblock preprocessing configuration. **Note:** This configuration is not supported.", "id": "Deblock" }, "DashConfig": { "id": "DashConfig", "properties": { "segmentReferenceScheme": { "description": "The segment reference scheme for a `DASH` manifest. The default is `SEGMENT_LIST`.", "type": "string", "enum": [ "SEGMENT_REFERENCE_SCHEME_UNSPECIFIED", "SEGMENT_LIST", "SEGMENT_TEMPLATE_NUMBER" ], "enumDescriptions": [ "The segment reference scheme is not specified.", "Explicitly lists the URLs of media files for each segment. For example, if SegmentSettings.individual_segments is `true`, then the manifest contains fields similar to the following: ```xml ... ```", "SegmentSettings.individual_segments must be set to `true` to use this segment reference scheme. Uses the DASH specification `` tag to determine the URLs of media files for each segment. For example: ```xml ... ```" ] } }, "type": "object", "description": "`DASH` manifest configuration." }, "Playready": { "properties": {}, "description": "Playready configuration.", "id": "Playready", "type": "object" }, "SpriteSheet": { "id": "SpriteSheet", "description": "Sprite sheet configuration.", "type": "object", "properties": { "filePrefix": { "type": "string", "description": "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`." }, "endTimeOffset": { "type": "string", "format": "google-duration", "description": "End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file." }, "quality": { "description": "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.", "type": "integer", "format": "int32" }, "spriteWidthPixels": { "type": "integer", "description": "Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field). For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.", "format": "int32" }, "spriteHeightPixels": { "type": "integer", "format": "int32", "description": "Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field). For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output." }, "rowCount": { "type": "integer", "description": "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.", "format": "int32" }, "startTimeOffset": { "format": "google-duration", "description": "Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.", "type": "string" }, "interval": { "format": "google-duration", "description": "Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.", "type": "string" }, "format": { "type": "string", "description": "Format type. The default is `jpeg`. Supported formats: - `jpeg`" }, "columnCount": { "format": "int32", "description": "The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.", "type": "integer" }, "totalCount": { "format": "int32", "type": "integer", "description": "Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100." } } }, "AnimationStatic": { "id": "AnimationStatic", "properties": { "startTimeOffset": { "format": "google-duration", "type": "string", "description": "The time to start displaying the overlay object, in seconds. Default: 0" }, "xy": { "description": "Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video.", "$ref": "NormalizedCoordinate" } }, "description": "Display static overlay object.", "type": "object" }, "AdBreak": { "type": "object", "id": "AdBreak", "description": "Ad break.", "properties": { "startTimeOffset": { "format": "google-duration", "type": "string", "description": "Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`." } } }, "AnimationFade": { "properties": { "fadeType": { "enum": [ "FADE_TYPE_UNSPECIFIED", "FADE_IN", "FADE_OUT" ], "enumDescriptions": [ "The fade type is not specified.", "Fade the overlay object into view.", "Fade the overlay object out of view." ], "description": "Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.", "type": "string" }, "endTimeOffset": { "description": "The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s", "format": "google-duration", "type": "string" }, "xy": { "$ref": "NormalizedCoordinate", "description": "Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video." }, "startTimeOffset": { "format": "google-duration", "type": "string", "description": "The time to start the fade animation, in seconds. Default: 0" } }, "type": "object", "description": "Display overlay object with fade animation.", "id": "AnimationFade" } }, "rootUrl": "https://transcoder.googleapis.com/", "baseUrl": "https://transcoder.googleapis.com/", "version_module": true }