Package google.cloud.video.livestream.v1

string

The resource name of the asset, in the form of: projects/{project}/locations/{location}/assets/{assetId}.

Timestamp

Output only. The creation time.

Timestamp

Output only. The update time.

map<string, string>

User-defined key/value metadata.

string

Based64-encoded CRC32c checksum of the asset file. For more information, see the crc32c checksum of the Cloud Storage Objects resource. If crc32c is omitted or left empty when the asset is created, this field is filled by the crc32c checksum of the Cloud Storage object indicated by VideoAsset.uri or ImageAsset.uri. If crc32c is set, the asset can't be created if the crc32c value does not match with the crc32c checksum of the Cloud Storage object indicated by VideoAsset.uri or ImageAsset.uri.

State

Output only. The state of the asset resource.

Status

Output only. Only present when state is ERROR. The reason for the error state of the asset.

VideoAsset

VideoAsset represents a video.

ImageAsset

ImageAsset represents an image.

string

Cloud Storage URI of the image. The format is gs://my-bucket/my-object.

string

Cloud Storage URI of the video. The format is gs://my-bucket/my-object.

string

Audio codec used in this audio stream.

int32

The number of audio channels.

string

A list of channel names specifying the layout of the audio channels.

bool

Specifies whether pass through (transmuxing) is enabled or not. If set to true, the rest of the settings, other than mapping, will be ignored. The default is false.

string

The codec for this audio stream. The default is aac.

Supported audio codecs:

• aac

int32

Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.

int32

Number of audio channels. Must be between 1 and 6. The default is 2.

string

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

AudioMapping

The mapping for the input streams and audio channels.

int32

The audio sample rate in Hertz. The default is 48000 Hertz.

string

Required. The Channel InputAttachment.key that identifies the input that this audio mapping applies to. If an active input doesn't have an audio mapping, the primary audio track in the input stream will be selected.

int32

Required. The zero-based index of the track in the input stream. All mappings in the same AudioStream must have the same input track.

int32

Required. The zero-based index of the channel in the input stream.

int32

Required. The zero-based index of the channel in the output audio stream. Must be consistent with the input_channel.

double

Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.

int32

Index of this audio stream.

AudioFormat

Properties of the audio format.

string

The resource name of the channel, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

Timestamp

Output only. The creation time.

Timestamp

Output only. The update time.

map<string, string>

User-defined key/value metadata.

InputAttachment

A list of input attachments that this channel uses. One channel can have multiple inputs as the input sources. Only one input can be selected as the input source at one time.

string

Output only. The InputAttachment.key that serves as the current input source. The first input in the input_attachments is the initial input source.

Output

Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).

ElementaryStream

List of elementary streams.

MuxStream

List of multiplexing settings for output streams.

Manifest

List of output manifests.

SpriteSheet

List of output sprite sheets.

StreamingState

Output only. State of the streaming operation.

Status

Output only. A description of the reason for the streaming error. This property is always present when streaming_state is STREAMING_ERROR.

LogConfig

Configuration of platform logs for this channel.

TimecodeConfig

Configuration of timecode for this channel.

Encryption

Encryption configurations for this channel. Each configuration has an ID which is referred to by each MuxStream to indicate which configuration is used for that output.

InputConfig

The configuration for input sources defined in input_attachments.

string

URI for the output file(s). For example, gs://my-bucket/outputs/.

string

Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

Asset

Required. The asset resource to be created.

string

Required. The ID of the asset resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string

Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

Channel

Required. The channel resource to be created.

string

Required. The ID of the channel resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string

Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

Event

Required. The event resource to be created.

string

Required. The ID of the event resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string

Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

Input

Required. The input resource to be created.

string

Required. The ID of the input resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string

Required. The name of the asset resource, in the form of: projects/{project}/locations/{location}/assets/{assetId}.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

bool

If the force field is set to the default value of false, you must delete all of a channel's events before you can delete the channel itself. If the field is set to true, requests to delete a channel also delete associated channel events.

string

Required. The name of the event resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string

Required. The name of the input resource, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string

A unique key for this elementary stream. The key must be 1-63 characters in length. The key must begin and end with a letter (regardless of case) or a number, but can contain dashes or underscores in between.

VideoStream

Encoding of a video stream.

AudioStream

Encoding of an audio stream.

TextStream

Encoding of a text stream. For example, closed captions or subtitles.

string

Required. Identifier for this set of encryption options. The ID must be 1-63 characters in length. The ID must begin and end with a letter (regardless of case) or a number, but can contain dashes or underscores in between.

DrmSystems

Required. Configuration for DRM systems.

SecretManagerSource

For keys stored in Google Secret Manager.

Aes128Encryption

Configuration for HLS AES-128 encryption.

SampleAesEncryption

Configuration for HLS SAMPLE-AES encryption.

MpegCommonEncryption

Configuration for MPEG-Dash Common Encryption (MPEG-CENC).

Widevine

Widevine configuration.

Fairplay

Fairplay configuration.

Playready

Playready configuration.

Clearkey

Clearkey configuration.

string

Required. Specify the encryption scheme, supported schemes: - cenc - AES-CTR subsample - cbcs- AES-CBC subsample pattern

string

Required. The name of the Secret Version containing the encryption key. projects/{project}/secrets/{secret_id}/versions/{version_number}

string

The resource name of the event, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.

Timestamp

Output only. The creation time.

Timestamp

Output only. The update time.

map<string, string>

User-defined key/value metadata.

bool

When this field is set to true, the event will be executed at the earliest time that the server can schedule the event and execution_time will be populated with the time that the server actually schedules the event.

Timestamp

The time to execute the event. If you set execute_now to true, then do not set this field in the CreateEvent request. In this case, the server schedules the event and populates this field. If you set execute_now to false, then you must set this field to at least 10 seconds in the future or else the event can't be created.

State

Output only. The state of the event.

Status

Output only. An error object that describes the reason for the failure. This property is always present when state is FAILED.

InputSwitchTask

Switches to another input stream.

AdBreakTask

Inserts a new ad opportunity.

ReturnToProgramTask

Stops any running ad break.

SlateTask

Inserts a slate.

MuteTask

Mutes the stream.

UnmuteTask

Unmutes the stream.

Duration

Duration of an ad opportunity. Must be greater than 0.

string

The InputAttachment.key of the input to switch to.

Duration

Duration for which the stream should be muted. If omitted, the stream will be muted until an UnmuteTask event is sent.

Duration

Optional. Duration of the slate. Must be greater than 0 if specified. Omit this field for a long running slate.

string

Slate asset to use for the duration. If its duration is less than the duration of the SlateTask, then the slate loops. The slate must be represented in the form of: projects/{project}/locations/{location}/assets/{assetId}.

string

Required. Name of the resource, in the following form: projects/{project}/locations/{location}/assets/{asset}.

string

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

string

Required. The name of the event resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.

string

Required. The name of the input resource, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.

string

Required. The name of the pool resource, in the form of: projects/{project}/locations/{location}/pools/{poolId}.

string

The resource name of the input, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.

Timestamp

Output only. The creation time.

Timestamp

Output only. The update time.

map<string, string>

User-defined key/value metadata.

Type

Source type.

Tier

Tier defines the maximum input specification that is accepted by the video pipeline. The billing is charged based on the tier specified here. See Pricing for more detail. The default is HD.

string

Output only. URI to push the input stream to. Its format depends on the input type, for example:

• RTMP_PUSH: rtmp://1.2.3.4/live/{STREAM-ID}
• SRT_PUSH: srt://1.2.3.4:4201?streamid={STREAM-ID}

PreprocessingConfig

Preprocessing configurations.

SecurityRule

Security rule for access control.

InputStreamProperty

Output only. The information for the input stream. This field will be present only when this input receives the input stream.

string

At least one ip range must match unless none specified. The IP range is defined by CIDR block: for example, 192.0.1.0/24 for a range and 192.0.1.0/32 for a single IP address.

string

A unique key for this input attachment. The key must be 1-63 characters in length. The key must begin and end with a letter (regardless of case) or a number, but can contain dashes or underscores in between.

string

The resource name of an existing input, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.

AutomaticFailover

Automatic failover configurations.

string

The InputAttachment.keys of inputs to failover to when this input is disconnected. Currently, only up to one backup input is supported.

InputSwitchMode

Input switch mode. Default mode is FAILOVER_PREFER_PRIMARY.

Timestamp

The time that the current input stream is accepted and the connection is established.

VideoStreamProperty

Properties of the video streams.

AudioStreamProperty

Properties of the audio streams.

string

Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

int32

Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

string

A token identifying a page of results the server should return.

string

Filtering results

string

Hint for how to order the results

Asset

The list of Assets

string

The next_page_token value returned from a previous List request, if any.

string

Locations that could not be reached.

string

Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

int32

The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.

string

The next_page_token value returned from a previous List request, if any.

string

The filter to apply to list results.

string

Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Channel

A list of channels.

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

string

Locations that could not be reached.

string

Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

int32

The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.

string

The next_page_token value returned from a previous List request, if any.

string

The filter to apply to list results.

string

Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Event

A list of events.

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

string

Locations that could not be reached.

string

Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

int32

The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more items left to be queried.

string

The next_page_token value returned from a previous List request, if any.

string

The filter to apply to list results.

string

Specifies the ordering of results following syntax at Sorting Order.

Input

A list of inputs.

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

string

Locations that could not be reached.

LogSeverity

The severity level of platform logging for this resource.

string

The name of the generated file. The default is manifest with the extension suffix corresponding to the Manifest type. If multiple manifests are added to the channel, each must have a unique file name.

ManifestType

Required. Type of the manifest, can be HLS or DASH.

string

Required. List of MuxStream keys that should appear in this manifest.

• For HLS, either fmp4 or ts mux streams can be specified but not mixed.
• For DASH, only fmp4 mux streams can be specified.

int32

Maximum number of segments that this manifest holds. Once the manifest reaches this maximum number of segments, whenever a new segment is added to the manifest, the oldest segment will be removed from the manifest. The minimum value is 3 and the default value is 5.

Duration

How long to keep a segment on the output Google Cloud Storage bucket after it is removed from the manifest. This field should be large enough to cover the manifest propagation delay. Otherwise, a player could receive 404 errors while accessing segments which are listed in the manifest that the player has, but were already deleted from the output Google Cloud Storage bucket. Default value is 60s.

If both segment_keep_duration and RetentionConfig.retention_window_duration are set, RetentionConfig.retention_window_duration is used and segment_keep_duration is ignored.

bool

Whether to use the timecode, as specified in timecode config, when setting:

• availabilityStartTime attribute in DASH manifests.
• #EXT-X-PROGRAM-DATE-TIME tag in HLS manifests.

If false, ignore the input timecode and use the time from system clock when the manifest is first generated. This is the default behavior.

string

A unique key for this multiplexed stream. The key must be 1-63 characters in length. The key must begin and end with a letter (regardless of case) or a number, but can contain dashes or underscores in between.

string

The container format. The default is fmp4.

Supported container formats:

• fmp4 - the corresponding file extension is .m4s
• ts - the corresponding file extension is .ts

string

List of ElementaryStream keys multiplexed in this stream.

• For fmp4 container, must contain either one video or one audio stream.
• For ts container, must contain exactly one audio stream and up to one video stream.

SegmentSettings

Segment settings for fmp4 and ts.

string

Identifier of the encryption configuration to use. If omitted, output will be unencrypted.

Timestamp

Output only. The time the operation was created.

Timestamp

Output only. The time the operation finished running.

string

Output only. Server-defined resource path for the target of the operation.

string

Output only. Name of the verb executed by the operation.

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

string

Output only. API version used to start the operation.

string

The resource name of the pool, in the form of: projects/{project}/locations/{location}/pools/{poolId}.

Timestamp

Output only. The creation time.

Timestamp

Output only. The update time.

map<string, string>

User-defined key/value metadata.

NetworkConfig

Network configuration for the pool.

string

peered_network is the network resource URL of the network that is peered to the service provider network. Must be of the format projects/NETWORK_PROJECT_NUMBER/global/networks/NETWORK_NAME, where NETWORK_PROJECT_NUMBER is the project number of the Cloud project that holds your VPC network and NETWORK_NAME is the name of your VPC network. If peered_network is omitted or empty, the pool will use endpoints that are publicly available.

Audio

Audio preprocessing configuration.

Crop

Specify the video cropping configuration.

Pad

Specify the video pad filter configuration.

double

Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0 according to the following:

• -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
• 0 disables normalization. The default is 0.

int32

The number of pixels to crop from the top. The default is 0.

int32

The number of pixels to crop from the bottom. The default is 0.

int32

The number of pixels to crop from the left. The default is 0.

int32

The number of pixels to crop from the right. The default is 0.

int32

The number of pixels to add to the top. The default is 0.

int32

The number of pixels to add to the bottom. The default is 0.

int32

The number of pixels to add to the left. The default is 0.

int32

The number of pixels to add to the right. The default is 0.

Duration

Duration of the segments in seconds. The default is 6s. Note that segmentDuration must be greater than or equal to gop_duration, and segmentDuration must be divisible by gop_duration. Valid range is [2s, 20s].

All mux_streams in the same manifest must have the same segment duration.

string

Format type. The default is jpeg.

Supported formats:

• jpeg

string

Required. File name prefix for the generated sprite sheets. If multiple sprite sheets are added to the channel, each must have a unique file prefix. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as sprite_sheet0000000123.jpeg.

int32

Required. The width of the sprite in pixels. Must be an even integer.

int32

Required. The height of the sprite in pixels. Must be an even integer.

int32

The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1.

int32

The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. Valid range is [1, 10] and the default value is 1.

Duration

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

int32

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.

string

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string

Required. The codec for this text stream.

Supported text codecs:

• cea608
• cea708

TimecodeSource

The source of the timecode that will later be used in outputs/manifests. It determines the initial timecode/timestamp (first frame) of output streams.

Duration

UTC offset. Must be whole seconds, between -18 hours and +18 hours.

TimeZone

Time zone e.g. "America/Los_Angeles".

FieldMask

Field mask is used to specify the fields to be overwritten in the Channel resource by the update. You can only update the following fields:

• inputAttachments
• inputConfig
• output
• elementaryStreams
• muxStreams
• manifests
• spriteSheets
• logConfig
• timecodeConfig
• encryptions

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

If the mask is not present, then each field from the list above is updated if the field appears in the request payload. To unset a field, add the field to the update mask and remove it from the request payload.

Channel

Required. The channel resource to be updated.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

FieldMask

Field mask is used to specify the fields to be overwritten in the Input resource by the update. You can only update the following fields:

• preprocessingConfig
• securityRules

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

If the mask is not present, then each field from the list above is updated if the field appears in the request payload. To unset a field, add the field to the update mask and remove it from the request payload.

Input

Required. The input resource to be updated.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

FieldMask

Field mask is used to specify the fields to be overwritten in the Pool resource by the update. You can only update the following fields:

• networkConfig

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

Pool

Required. The pool resource to be updated.

string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string

Video codec used in this video stream.

int32

The width of the video stream in pixels.

int32

The height of the video stream in pixels.

double

The frame rate of the input video stream.

H264CodecSettings

H264 codec settings.

int32

Required. The width of the video in pixels. Must be an even integer. Valid range is [320, 1920].

int32

Required. The height of the video in pixels. Must be an even integer. Valid range is [180, 1080].

double

Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 60. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. See Calculating frame rate for more information.

int32

Required. The video bitrate in bits per second. Minimum value is 10,000.

• For SD resolution (< 720p), must be <= 3,000,000 (3 Mbps).
• For HD resolution (<= 1080p), must be <= 15,000,000 (15 Mbps).

bool

Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is false.

int32

Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to bitrate_bps.

int32

Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of vbv_size_bits.

string

The entropy coder to use. The default is cabac.

Supported entropy coders:

• cavlc
• cabac

bool

Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is false.

int32

The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than gop_frame_count if set. The default is 0.

double

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.

string

Enforces the specified codec profile. The following profiles are supported:

• baseline
• main (default)
• high

The available options are FFmpeg-compatible Profile Options. Note that certain values for this field may cause the transcoder to override other fields you set in the H264CodecSettings message.

string

Enforces the specified codec tune. The available options are FFmpeg-compatible Encode Options Note that certain values for this field may cause the transcoder to override other fields you set in the H264CodecSettings message.

int32

Select the GOP size based on the specified frame count. If GOP frame count is set instead of GOP duration, GOP duration will be calculated by gopFrameCount/frameRate. The calculated GOP duration must satisfy the limitations on gopDuration as well. Valid range is [60, 600].

Duration

Select the GOP size based on the specified duration. The default is 2s. Note that gopDuration must be less than or equal to segment_duration, and segment_duration must be divisible by gopDuration. Valid range is [2s, 20s].

All video streams in the same channel must have the same GOP size.

int32

Index of this video stream.

VideoFormat

Properties of the video format.