blob: 8400b6dfde51c36144098fd5acc6b0c6d3566329 [file] [log] [blame]
{
"mtlsRootUrl": "https://transcoder.mtls.googleapis.com/",
"name": "transcoder",
"basePath": "",
"title": "Transcoder API",
"protocol": "rest",
"canonicalName": "Transcoder",
"version_module": true,
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"schemas": {
"Job": {
"id": "Job",
"description": "Transcoding job resource.",
"properties": {
"priority": {
"type": "integer",
"description": "Specify the priority of the job. Enter a value between 0 and 100, where 0 is the lowest priority and 100 is the highest priority. The default is 0.",
"format": "int32"
},
"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. It must be stored in Cloud Storage. For example, `gs://bucket/inputs/file.mp4`."
},
"progress": {
"description": "Output only. Estimated fractional progress, from `0` to `1` for each step. *Note*: This feature is not yet available.",
"$ref": "Progress",
"readOnly": true
},
"config": {
"description": "The configuration for this job.",
"$ref": "JobConfig"
},
"state": {
"type": "string",
"readOnly": true,
"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 `failure_reason` and `failure_details`"
],
"enum": [
"PROCESSING_STATE_UNSPECIFIED",
"PENDING",
"RUNNING",
"SUCCEEDED",
"FAILED"
],
"description": "Output only. The current state of the job."
},
"createTime": {
"format": "google-datetime",
"readOnly": true,
"description": "Output only. The time the job was created.",
"type": "string"
},
"originUri": {
"readOnly": true,
"description": "Output only. The origin URI. *Note*: This feature is not yet available.",
"$ref": "OriginUri"
},
"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/`.",
"type": "string"
},
"failureReason": {
"readOnly": true,
"type": "string",
"description": "Output only. A description of the reason for the failure. This property is always present when `state` is `FAILED`."
},
"failureDetails": {
"readOnly": true,
"description": "Output only. List of failure details. This property may contain additional information about the failure when `failure_reason` is present. *Note*: This feature is not yet available.",
"items": {
"$ref": "FailureDetail"
},
"type": "array"
},
"startTime": {
"format": "google-datetime",
"type": "string",
"readOnly": true,
"description": "Output only. The time the transcoding started."
},
"name": {
"description": "The resource name of the job. Format: `projects/{project}/locations/{location}/jobs/{job}`",
"type": "string"
},
"templateId": {
"description": "Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`",
"type": "string"
},
"endTime": {
"type": "string",
"format": "google-datetime",
"readOnly": true,
"description": "Output only. The time the transcoding finished."
}
},
"type": "object"
},
"SegmentSettings": {
"type": "object",
"id": "SegmentSettings",
"properties": {
"individualSegments": {
"type": "boolean",
"description": "Required. Create an individual segment file. The default is `false`."
},
"segmentDuration": {
"description": "Duration of the segments in seconds. The default is `\"6.0s\"`.",
"type": "string",
"format": "google-duration"
}
},
"description": "Segment settings for `\"ts\"`, `\"fmp4\"` and `\"vtt\"`."
},
"Color": {
"id": "Color",
"type": "object",
"description": "Color preprocessing configuration.",
"properties": {
"brightness": {
"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.",
"type": "number",
"format": "double"
},
"saturation": {
"format": "double",
"type": "number",
"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."
},
"contrast": {
"type": "number",
"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"
}
}
},
"Crop": {
"id": "Crop",
"description": "Video cropping configuration.",
"type": "object",
"properties": {
"leftPixels": {
"type": "integer",
"format": "int32",
"description": "The number of pixels to crop from the left. The default is 0."
},
"topPixels": {
"format": "int32",
"type": "integer",
"description": "The number of pixels to crop from the top. The default is 0."
},
"rightPixels": {
"description": "The number of pixels to crop from the right. The default is 0.",
"type": "integer",
"format": "int32"
},
"bottomPixels": {
"description": "The number of pixels to crop from the bottom. The default is 0.",
"format": "int32",
"type": "integer"
}
}
},
"AdBreak": {
"type": "object",
"properties": {
"startTimeOffset": {
"format": "google-duration",
"description": "Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.",
"type": "string"
}
},
"description": "Ad break.",
"id": "AdBreak"
},
"JobTemplate": {
"id": "JobTemplate",
"description": "Transcoding job template resource.",
"properties": {
"config": {
"$ref": "JobConfig",
"description": "The configuration for this template."
},
"name": {
"description": "The resource name of the job template. Format: `projects/{project}/locations/{location}/jobTemplates/{job_template}`",
"type": "string"
}
},
"type": "object"
},
"TextAtom": {
"type": "object",
"properties": {
"key": {
"description": "Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.",
"type": "string"
},
"inputs": {
"description": "List of `Job.inputs` that should be embedded in this atom. Only one input is supported.",
"type": "array",
"items": {
"$ref": "TextInput"
}
}
},
"id": "TextAtom",
"description": "The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`."
},
"Progress": {
"id": "Progress",
"type": "object",
"description": "Estimated fractional progress for each step, from `0` to `1`.",
"properties": {
"notified": {
"type": "number",
"format": "double",
"description": "Estimated fractional progress for `notifying` step."
},
"analyzed": {
"type": "number",
"description": "Estimated fractional progress for `analyzing` step.",
"format": "double"
},
"encoded": {
"type": "number",
"format": "double",
"description": "Estimated fractional progress for `encoding` step."
},
"uploaded": {
"format": "double",
"description": "Estimated fractional progress for `uploading` step.",
"type": "number"
}
}
},
"NormalizedCoordinate": {
"id": "NormalizedCoordinate",
"properties": {
"y": {
"description": "Normalized y coordinate.",
"format": "double",
"type": "number"
},
"x": {
"format": "double",
"type": "number",
"description": "Normalized x coordinate."
}
},
"type": "object",
"description": "2D normalized coordinates. Default: `{0.0, 0.0}`"
},
"PreprocessingConfig": {
"id": "PreprocessingConfig",
"description": "Preprocessing configurations.",
"type": "object",
"properties": {
"denoise": {
"description": "Denoise preprocessing configuration.",
"$ref": "Denoise"
},
"audio": {
"$ref": "Audio",
"description": "Audio preprocessing configuration."
},
"color": {
"$ref": "Color",
"description": "Color preprocessing configuration."
},
"deblock": {
"description": "Deblock preprocessing configuration.",
"$ref": "Deblock"
},
"crop": {
"description": "Specify the video cropping configuration.",
"$ref": "Crop"
}
}
},
"Denoise": {
"properties": {
"strength": {
"format": "double",
"type": "number",
"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."
},
"tune": {
"type": "string",
"description": "Set the denoiser mode. The default is `\"standard\"`. Supported denoiser modes: - 'standard' - 'grain'"
}
},
"id": "Denoise",
"type": "object",
"description": "Denoise preprocessing configuration."
},
"TextInput": {
"id": "TextInput",
"properties": {
"track": {
"format": "int32",
"type": "integer",
"description": "Required. The zero-based index of the track in the input file."
},
"key": {
"description": "Required. The `Input.key` that identifies the input file.",
"type": "string"
}
},
"type": "object",
"description": "Identifies which input file and track should be used."
},
"MuxStream": {
"properties": {
"elementaryStreams": {
"description": "List of `ElementaryStream.key`s multiplexed in this stream.",
"type": "array",
"items": {
"type": "string"
}
},
"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"
},
"container": {
"description": "The container format. The default is `\"mp4\"` Supported container formats: - 'ts' - 'fmp4'- the corresponding file extension is `\".m4s\"` - 'mp4' - 'vtt'",
"type": "string"
},
"encryption": {
"$ref": "Encryption",
"description": "Encryption settings."
},
"segmentSettings": {
"description": "Segment settings for `\"ts\"`, `\"fmp4\"` and `\"vtt\"`.",
"$ref": "SegmentSettings"
},
"key": {
"description": "A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `\".m3u8\"` extension suffix.",
"type": "string"
}
},
"id": "MuxStream",
"description": "Multiplexing settings for output stream.",
"type": "object"
},
"Deblock": {
"type": "object",
"id": "Deblock",
"description": "Deblock preprocessing configuration.",
"properties": {
"enabled": {
"description": "Enable deblocker. The default is `false`.",
"type": "boolean"
},
"strength": {
"format": "double",
"type": "number",
"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."
}
}
},
"JobConfig": {
"properties": {
"inputs": {
"type": "array",
"description": "List of input assets stored in Cloud Storage.",
"items": {
"$ref": "Input"
}
},
"spriteSheets": {
"type": "array",
"description": "List of output sprite sheets.",
"items": {
"$ref": "SpriteSheet"
}
},
"elementaryStreams": {
"description": "List of elementary streams.",
"type": "array",
"items": {
"$ref": "ElementaryStream"
}
},
"adBreaks": {
"type": "array",
"items": {
"$ref": "AdBreak"
},
"description": "List of ad breaks. Specifies where to insert ad break tags in the output manifests."
},
"output": {
"$ref": "Output",
"description": "Output configuration."
},
"pubsubDestination": {
"description": "Destination on Pub/Sub.",
"$ref": "PubsubDestination"
},
"muxStreams": {
"description": "List of multiplexing settings for output streams.",
"items": {
"$ref": "MuxStream"
},
"type": "array"
},
"overlays": {
"description": "List of overlays on the output video, in descending Z-order.",
"type": "array",
"items": {
"$ref": "Overlay"
}
},
"editList": {
"type": "array",
"items": {
"$ref": "EditAtom"
},
"description": "List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest."
},
"manifests": {
"description": "List of output manifests.",
"items": {
"$ref": "Manifest"
},
"type": "array"
}
},
"type": "object",
"description": "Job configuration",
"id": "JobConfig"
},
"MpegCommonEncryption": {
"description": "Configuration for MPEG Common Encryption (MPEG-CENC).",
"id": "MpegCommonEncryption",
"properties": {
"scheme": {
"description": "Required. Specify the encryption scheme. Supported encryption schemes: - 'cenc' - 'cbcs'",
"type": "string"
},
"keyId": {
"type": "string",
"description": "Required. 128 bit Key ID represented as lowercase hexadecimal digits for use with common encryption."
}
},
"type": "object"
},
"ListJobTemplatesResponse": {
"description": "Response message for `TranscoderService.ListJobTemplates`.",
"id": "ListJobTemplatesResponse",
"type": "object",
"properties": {
"nextPageToken": {
"description": "The pagination token.",
"type": "string"
},
"jobTemplates": {
"type": "array",
"items": {
"$ref": "JobTemplate"
},
"description": "List of job templates in the specified region."
}
}
},
"AnimationFade": {
"properties": {
"fadeType": {
"type": "string",
"description": "Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.",
"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."
]
},
"endTimeOffset": {
"description": "The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s",
"type": "string",
"format": "google-duration"
},
"startTimeOffset": {
"description": "The time to start the fade animation, in seconds. Default: 0",
"type": "string",
"format": "google-duration"
},
"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."
}
},
"id": "AnimationFade",
"type": "object",
"description": "Display overlay object with fade animation."
},
"AnimationStatic": {
"id": "AnimationStatic",
"type": "object",
"description": "Display static overlay object.",
"properties": {
"startTimeOffset": {
"type": "string",
"description": "The time to start displaying the overlay object, in seconds. Default: 0",
"format": "google-duration"
},
"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."
}
}
},
"AnimationEnd": {
"type": "object",
"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.",
"id": "AnimationEnd",
"properties": {
"startTimeOffset": {
"format": "google-duration",
"type": "string",
"description": "The time to end overlay object, in seconds. Default: 0"
}
}
},
"FailureDetail": {
"properties": {
"description": {
"type": "string",
"description": "A description of the failure."
}
},
"description": "Additional information about the reasons for the failure.",
"id": "FailureDetail",
"type": "object"
},
"TextStream": {
"type": "object",
"properties": {
"mapping": {
"type": "array",
"description": "The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.",
"items": {
"$ref": "TextAtom"
}
},
"languageCode": {
"type": "string",
"description": "Required. 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."
},
"codec": {
"type": "string",
"description": "The codec for this text stream. The default is `\"webvtt\"`. Supported text codecs: - 'srt' - 'ttml' - 'cea608' - 'cea708' - 'webvtt'"
}
},
"description": "Encoding of a text stream. For example, closed captions or subtitles.",
"id": "TextStream"
},
"Manifest": {
"properties": {
"type": {
"description": "Required. Type of the manifest, can be \"HLS\" or \"DASH\".",
"enum": [
"MANIFEST_TYPE_UNSPECIFIED",
"HLS",
"DASH"
],
"type": "string",
"enumDescriptions": [
"The manifest type is not specified.",
"Create `\"HLS\"` manifest. The corresponding file extension is `\".m3u8\"`.",
"Create `\"DASH\"` manifest. The corresponding file extension is `\".mpd\"`."
]
},
"muxStreams": {
"type": "array",
"description": "Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.",
"items": {
"type": "string"
}
},
"fileName": {
"type": "string",
"description": "The name of the generated file. The default is `\"manifest\"` with the extension suffix corresponding to the `Manifest.type`."
}
},
"type": "object",
"description": "Manifest configuration.",
"id": "Manifest"
},
"AudioChannel": {
"description": "The audio channel.",
"type": "object",
"id": "AudioChannel",
"properties": {
"inputs": {
"type": "array",
"items": {
"$ref": "AudioChannelInput"
},
"description": "List of `Job.inputs` for this audio channel."
}
}
},
"Image": {
"description": "Overlaid jpeg image.",
"id": "Image",
"properties": {
"alpha": {
"type": "number",
"description": "Target image opacity. Valid values: `1` (solid, default), `0` (transparent).",
"format": "double"
},
"uri": {
"description": "Required. URI of the image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`.",
"type": "string"
},
"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`."
}
},
"type": "object"
},
"ListJobsResponse": {
"type": "object",
"properties": {
"jobs": {
"type": "array",
"description": "List of jobs in the specified region.",
"items": {
"$ref": "Job"
}
},
"nextPageToken": {
"type": "string",
"description": "The pagination token."
}
},
"description": "Response message for `TranscoderService.ListJobs`.",
"id": "ListJobsResponse"
},
"VideoStream": {
"type": "object",
"id": "VideoStream",
"properties": {
"preset": {
"description": "Enforces the specified codec preset. The default is `veryfast`. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.",
"type": "string"
},
"bitrateBps": {
"description": "Required. The video bitrate in bits per second. Must be between 1 and 1,000,000,000.",
"format": "int32",
"type": "integer"
},
"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."
},
"gopFrameCount": {
"format": "int32",
"type": "integer",
"description": "Select the GOP size based on the specified frame count. Must be greater than zero."
},
"profile": {
"type": "string",
"description": "Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message."
},
"frameRate": {
"format": "double",
"type": "number",
"description": "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. The following table shows the computed video FPS given the target FPS (in parenthesis) and input FPS (in the first column): | | (30) | (60) | (25) | (50) | |--------|--------|--------|------|------| | 240 | Fail | Fail | Fail | Fail | | 120 | 30 | 60 | 20 | 30 | | 100 | 25 | 50 | 20 | 30 | | 50 | 25 | 50 | 20 | 30 | | 60 | 30 | 60 | 20 | 30 | | 59.94 | 29.97 | 59.94 | 20 | 30 | | 48 | 24 | 48 | 20 | 30 | | 30 | 30 | 30 | 20 | 30 | | 25 | 25 | 25 | 20 | 30 | | 24 | 24 | 24 | 20 | 30 | | 23.976 | 23.976 | 23.976 | 20 | 30 | | 15 | 15 | 15 | 20 | 30 | | 12 | 12 | 12 | 20 | 30 | | 10 | 10 | 10 | 20 | 30 |"
},
"vbvSizeBits": {
"type": "integer",
"format": "int32",
"description": "Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`."
},
"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.",
"format": "int32",
"type": "integer"
},
"tune": {
"description": "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 `VideoStream` message.",
"type": "string"
},
"codec": {
"description": "Codec type. The following codecs are supported: * `h264` (default) * `h265` * `vp9`",
"type": "string"
},
"allowOpenGop": {
"type": "boolean",
"description": "Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`."
},
"bFrameCount": {
"format": "int32",
"description": "The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.",
"type": "integer"
},
"rateControlMode": {
"type": "string",
"description": "Specify the `rate_control_mode`. The default is `\"vbr\"`. Supported rate control modes: - 'vbr' - variable bitrate - 'crf' - constant rate factor"
},
"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.",
"format": "int32"
},
"enableTwoPass": {
"type": "boolean",
"description": "Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `\"vbr\"`. The default is `false`."
},
"entropyCoder": {
"type": "string",
"description": "The entropy coder to use. The default is `\"cabac\"`. Supported entropy coders: - 'cavlc' - 'cabac'"
},
"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"
},
"bPyramid": {
"type": "boolean",
"description": "Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`."
},
"vbvFullnessBits": {
"format": "int32",
"type": "integer",
"description": "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`."
},
"gopDuration": {
"format": "google-duration",
"type": "string",
"description": "Select the GOP size based on the specified duration. The default is `\"3s\"`."
},
"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.",
"type": "integer"
}
},
"description": "Video stream resource."
},
"Audio": {
"type": "object",
"properties": {
"lowBoost": {
"description": "Enable boosting low frequency components. The default is `false`.",
"type": "boolean"
},
"lufs": {
"description": "Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0, where -24 is the Advanced Television Systems Committee (ATSC A/85), -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, and 0 disables normalization. The default is 0.",
"format": "double",
"type": "number"
},
"highBoost": {
"description": "Enable boosting high frequency components. The default is `false`.",
"type": "boolean"
}
},
"description": "Audio preprocessing configuration.",
"id": "Audio"
},
"AudioStream": {
"description": "Audio stream resource.",
"id": "AudioStream",
"type": "object",
"properties": {
"channelCount": {
"description": "Number of audio channels. Must be between 1 and 6. The default is 2.",
"type": "integer",
"format": "int32"
},
"bitrateBps": {
"type": "integer",
"format": "int32",
"description": "Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000."
},
"mapping": {
"type": "array",
"items": {
"$ref": "AudioAtom"
},
"description": "The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`."
},
"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"
}
},
"sampleRateHertz": {
"format": "int32",
"description": "The audio sample rate in Hertz. The default is 48000 Hertz.",
"type": "integer"
},
"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'"
}
}
},
"AudioChannelInput": {
"id": "AudioChannelInput",
"type": "object",
"description": "Identifies which input file, track, and channel should be used.",
"properties": {
"channel": {
"description": "Required. The zero-based index of the channel in the input file.",
"format": "int32",
"type": "integer"
},
"gainDb": {
"description": "Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.",
"format": "double",
"type": "number"
},
"track": {
"format": "int32",
"description": "Required. The zero-based index of the track in the input file.",
"type": "integer"
},
"key": {
"type": "string",
"description": "Required. The `Input.key` that identifies the input file."
}
}
},
"ElementaryStream": {
"id": "ElementaryStream",
"type": "object",
"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.",
"properties": {
"textStream": {
"description": "Encoding of a text stream. For example, closed captions or subtitles.",
"$ref": "TextStream"
},
"audioStream": {
"$ref": "AudioStream",
"description": "Encoding of an audio stream."
},
"key": {
"description": "A unique key for this elementary stream.",
"type": "string"
},
"videoStream": {
"description": "Encoding of a video stream.",
"$ref": "VideoStream"
}
}
},
"Encryption": {
"id": "Encryption",
"type": "object",
"properties": {
"aes128": {
"$ref": "Aes128Encryption",
"description": "Configuration for AES-128 encryption."
},
"iv": {
"type": "string",
"description": "Required. 128 bit Initialization Vector (IV) represented as lowercase hexadecimal digits."
},
"sampleAes": {
"description": "Configuration for SAMPLE-AES encryption.",
"$ref": "SampleAesEncryption"
},
"key": {
"type": "string",
"description": "Required. 128 bit encryption key represented as lowercase hexadecimal digits."
},
"mpegCenc": {
"$ref": "MpegCommonEncryption",
"description": "Configuration for MPEG Common Encryption (MPEG-CENC)."
}
},
"description": "Encryption settings."
},
"EditAtom": {
"properties": {
"inputs": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline."
},
"key": {
"description": "A unique key for this atom. Must be specified when using advanced mapping.",
"type": "string"
},
"startTimeOffset": {
"format": "google-duration",
"description": "Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.",
"type": "string"
},
"endTimeOffset": {
"type": "string",
"format": "google-duration",
"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."
}
},
"description": "Edit atom.",
"id": "EditAtom",
"type": "object"
},
"SampleAesEncryption": {
"type": "object",
"properties": {
"keyUri": {
"description": "Required. URI of the key delivery service. This URI is inserted into the M3U8 header.",
"type": "string"
}
},
"description": "Configuration for SAMPLE-AES encryption.",
"id": "SampleAesEncryption"
},
"Aes128Encryption": {
"type": "object",
"properties": {
"keyUri": {
"type": "string",
"description": "Required. URI of the key delivery service. This URI is inserted into the M3U8 header."
}
},
"description": "Configuration for AES-128 encryption.",
"id": "Aes128Encryption"
},
"Input": {
"description": "Input asset.",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "A unique key for this input. Must be specified when using advanced mapping and edit lists."
},
"uri": {
"description": "URI of the media. It must be stored in Cloud Storage. Example `gs://bucket/inputs/file.mp4`. If empty the value will be populated from `Job.input_uri`.",
"type": "string"
},
"preprocessingConfig": {
"description": "Preprocessing configurations.",
"$ref": "PreprocessingConfig"
}
},
"id": "Input"
},
"SpriteSheet": {
"type": "object",
"id": "SpriteSheet",
"description": "Sprite sheet configuration.",
"properties": {
"format": {
"description": "Format type. The default is `\"jpeg\"`. Supported formats: - 'jpeg'",
"type": "string"
},
"columnCount": {
"type": "integer",
"format": "int32",
"description": "The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit."
},
"totalCount": {
"format": "int32",
"description": "Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.",
"type": "integer"
},
"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"
},
"interval": {
"description": "Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.",
"type": "string",
"format": "google-duration"
},
"spriteHeightPixels": {
"format": "int32",
"type": "integer",
"description": "Required. The height of sprite in pixels. Must be an even integer."
},
"startTimeOffset": {
"description": "Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.",
"format": "google-duration",
"type": "string"
},
"spriteWidthPixels": {
"type": "integer",
"format": "int32",
"description": "Required. The width of sprite in pixels. Must be an even integer."
},
"filePrefix": {
"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\"`.",
"type": "string"
},
"endTimeOffset": {
"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.",
"type": "string"
}
}
},
"AudioAtom": {
"type": "object",
"properties": {
"channels": {
"items": {
"$ref": "AudioChannel"
},
"description": "List of `Channel`s for this audio stream. for in-depth explanation.",
"type": "array"
},
"key": {
"type": "string",
"description": "Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`."
}
},
"description": "The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.",
"id": "AudioAtom"
},
"Output": {
"type": "object",
"description": "Location of output file(s) in a Cloud Storage bucket.",
"id": "Output",
"properties": {
"uri": {
"type": "string",
"description": "URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`."
}
}
},
"Overlay": {
"id": "Overlay",
"properties": {
"image": {
"description": "Image overlay.",
"$ref": "Image"
},
"animations": {
"items": {
"$ref": "Animation"
},
"type": "array",
"description": "List of Animations. The list should be chronological, without any time overlap."
}
},
"description": "Overlay configuration.",
"type": "object"
},
"PubsubDestination": {
"type": "object",
"description": "A Pub/Sub destination.",
"id": "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"
}
}
},
"OriginUri": {
"id": "OriginUri",
"properties": {
"dash": {
"type": "string",
"description": "Dash manifest URI. If multiple Dash manifests are created, only the first one is listed."
},
"hls": {
"description": "HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4. If multiple HLS manifests are created, only the first one is listed.",
"type": "string"
}
},
"type": "object",
"description": "The origin URI."
},
"Empty": {
"id": "Empty",
"properties": {},
"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); } The JSON representation for `Empty` is empty JSON object `{}`."
},
"Animation": {
"description": "Animation types.",
"properties": {
"animationEnd": {
"$ref": "AnimationEnd",
"description": "End previous animation."
},
"animationFade": {
"$ref": "AnimationFade",
"description": "Display overlay object with fade animation."
},
"animationStatic": {
"description": "Display static overlay object.",
"$ref": "AnimationStatic"
}
},
"type": "object",
"id": "Animation"
}
},
"revision": "20201111",
"parameters": {
"$.xgafv": {
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
]
},
"alt": {
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
]
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"callback": {
"location": "query",
"type": "string",
"description": "JSONP"
},
"quotaUser": {
"type": "string",
"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.",
"location": "query"
},
"upload_protocol": {
"type": "string",
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"location": "query",
"default": "true",
"type": "boolean"
}
},
"description": "This API converts video files into formats suitable for consumer distribution. ",
"rootUrl": "https://transcoder.googleapis.com/",
"version": "v1beta1",
"id": "transcoder:v1beta1",
"fullyEncodeReservedExpansion": true,
"ownerName": "Google",
"servicePath": "",
"baseUrl": "https://transcoder.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"documentationLink": "https://cloud.google.com/transcoder/docs/",
"discoveryVersion": "v1",
"ownerDomain": "google.com",
"batchPath": "batch",
"kind": "discovery#restDescription",
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"jobTemplates": {
"methods": {
"delete": {
"path": "v1beta1/{+name}",
"response": {
"$ref": "Empty"
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobTemplates/{jobTemplatesId}",
"description": "Deletes a job template.",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/jobTemplates/[^/]+$",
"required": true,
"type": "string",
"description": "Required. The name of the job template to delete. `projects/{project}/locations/{location}/jobTemplates/{job_template}`",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "transcoder.projects.locations.jobTemplates.delete",
"parameterOrder": [
"name"
],
"httpMethod": "DELETE"
},
"list": {
"id": "transcoder.projects.locations.jobTemplates.list",
"httpMethod": "GET",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobTemplates",
"path": "v1beta1/{+parent}/jobTemplates",
"parameterOrder": [
"parent"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "ListJobTemplatesResponse"
},
"parameters": {
"parent": {
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$",
"type": "string",
"location": "path",
"description": "Required. The parent location from which to retrieve the collection of job templates. Format: `projects/{project}/locations/{location}`"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "The `next_page_token` value returned from a previous List request, if any."
},
"pageSize": {
"type": "integer",
"description": "The maximum number of items to return.",
"format": "int32",
"location": "query"
}
},
"description": "Lists job templates in the specified region."
},
"create": {
"httpMethod": "POST",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobTemplates",
"path": "v1beta1/{+parent}/jobTemplates",
"parameterOrder": [
"parent"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "transcoder.projects.locations.jobTemplates.create",
"description": "Creates a job template in the specified region.",
"parameters": {
"parent": {
"location": "path",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$",
"type": "string",
"description": "Required. The parent location to create this job template. Format: `projects/{project}/locations/{location}`"
},
"jobTemplateId": {
"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*`.",
"location": "query",
"type": "string"
}
},
"response": {
"$ref": "JobTemplate"
},
"request": {
"$ref": "JobTemplate"
}
},
"get": {
"id": "transcoder.projects.locations.jobTemplates.get",
"path": "v1beta1/{+name}",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/jobTemplates/[^/]+$",
"description": "Required. The name of the job template to retrieve. Format: `projects/{project}/locations/{location}/jobTemplates/{job_template}`",
"type": "string",
"location": "path",
"required": true
}
},
"parameterOrder": [
"name"
],
"description": "Returns the job template data.",
"httpMethod": "GET",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobTemplates/{jobTemplatesId}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "JobTemplate"
}
}
}
},
"jobs": {
"methods": {
"list": {
"httpMethod": "GET",
"path": "v1beta1/{+parent}/jobs",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobs",
"parameterOrder": [
"parent"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "transcoder.projects.locations.jobs.list",
"response": {
"$ref": "ListJobsResponse"
},
"description": "Lists jobs in the specified region.",
"parameters": {
"parent": {
"description": "Required. Format: `projects/{project}/locations/{location}`",
"type": "string",
"location": "path",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$"
},
"pageToken": {
"location": "query",
"description": "The `next_page_token` value returned from a previous List request, if any.",
"type": "string"
},
"pageSize": {
"location": "query",
"type": "integer",
"format": "int32",
"description": "The maximum number of items to return."
}
}
},
"get": {
"path": "v1beta1/{+name}",
"description": "Returns the job data.",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"description": "Required. The name of the job to retrieve. Format: `projects/{project}/locations/{location}/jobs/{job}`",
"type": "string",
"required": true,
"location": "path"
}
},
"id": "transcoder.projects.locations.jobs.get",
"response": {
"$ref": "Job"
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameterOrder": [
"name"
],
"httpMethod": "GET"
},
"delete": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"description": "Required. The name of the job to delete. Format: `projects/{project}/locations/{location}/jobs/{job}`",
"location": "path",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"description": "Deletes a job.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}",
"httpMethod": "DELETE",
"id": "transcoder.projects.locations.jobs.delete",
"parameterOrder": [
"name"
]
},
"create": {
"parameters": {
"parent": {
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"description": "Required. The parent location to create and process this job. Format: `projects/{project}/locations/{location}`",
"location": "path",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"path": "v1beta1/{+parent}/jobs",
"request": {
"$ref": "Job"
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/jobs",
"description": "Creates a job in the specified region.",
"httpMethod": "POST",
"id": "transcoder.projects.locations.jobs.create",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "Job"
}
}
}
}
}
}
}
}
}
}