Index
LivestreamService
(interface)AudioFormat
(message)AudioStream
(message)AudioStream.AudioMapping
(message)AudioStreamProperty
(message)Channel
(message)Channel.Output
(message)Channel.StreamingState
(enum)ChannelOperationResponse
(message)CreateChannelRequest
(message)CreateEventRequest
(message)CreateInputRequest
(message)DeleteChannelRequest
(message)DeleteEventRequest
(message)DeleteInputRequest
(message)ElementaryStream
(message)Event
(message)Event.AdBreakTask
(message)Event.State
(enum)GetChannelRequest
(message)GetEventRequest
(message)GetInputRequest
(message)Input
(message)Input.SecurityRule
(message)Input.Tier
(enum)Input.Type
(enum)InputAttachment
(message)InputAttachment.AutomaticFailover
(message)InputStreamProperty
(message)ListChannelsRequest
(message)ListChannelsResponse
(message)ListEventsRequest
(message)ListEventsResponse
(message)ListInputsRequest
(message)ListInputsResponse
(message)LogConfig
(message)LogConfig.LogSeverity
(enum)Manifest
(message)Manifest.ManifestType
(enum)MuxStream
(message)OperationMetadata
(message)PreprocessingConfig
(message)PreprocessingConfig.Crop
(message)PreprocessingConfig.Pad
(message)SegmentSettings
(message)SpriteSheet
(message)StartChannelRequest
(message)StopChannelRequest
(message)TextStream
(message)UpdateChannelRequest
(message)UpdateInputRequest
(message)VideoFormat
(message)VideoStream
(message)VideoStream.H264CodecSettings
(message)VideoStreamProperty
(message)
LivestreamService
Using Live Stream API, you can generate live streams in the various renditions and streaming formats. The streaming format include HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can send a source stream in the various ways, including Real-Time Messaging Protocol (RTMP) and Secure Reliable Transport (SRT).
CreateChannel |
---|
Creates a channel with the provided unique ID in the specified region.
|
CreateEvent |
---|
Creates an event with the provided unique ID in the specified channel.
|
CreateInput |
---|
Creates an input with the provided unique ID in the specified region.
|
DeleteChannel |
---|
Deletes the specified channel.
|
DeleteEvent |
---|
Deletes the specified event.
|
DeleteInput |
---|
Deletes the specified input.
|
GetChannel |
---|
Returns the specified channel.
|
GetEvent |
---|
Returns the specified event.
|
GetInput |
---|
Returns the specified input.
|
ListChannels |
---|
Returns a list of all channels in the specified region.
|
ListEvents |
---|
Returns a list of all events in the specified channel.
|
ListInputs |
---|
Returns a list of all inputs in the specified region.
|
StartChannel |
---|
Starts the specified channel. Part of the video pipeline will be created only when the StartChannel request is received by the server.
|
StopChannel |
---|
Stops the specified channel. Part of the video pipeline will be released when the StopChannel request is received by the server.
|
UpdateChannel |
---|
Updates the specified channel.
|
UpdateInput |
---|
Updates the specified input.
|
AudioFormat
Properties of the audio format.
Fields | |
---|---|
codec |
Audio codec used in this audio stream. |
channel_count |
The number of audio channels. |
channel_layout[] |
A list of channel names specifying the layout of the audio channels. |
AudioStream
Audio stream resource.
Fields | |
---|---|
transmux |
Specifies whether pass through (transmuxing) is enabled or not. If set to |
codec |
The codec for this audio stream. The default is Supported audio codecs:
|
bitrate_bps |
Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000. |
channel_count |
Number of audio channels. Must be between 1 and 6. The default is 2. |
channel_layout[] |
A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is Supported channel names:
|
mapping[] |
The mapping for the input streams and audio channels. |
sample_rate_hertz |
The audio sample rate in Hertz. The default is 48000 Hertz. |
AudioMapping
The mapping for the input streams and audio channels.
Fields | |
---|---|
input_key |
Required. The |
input_track |
Required. The zero-based index of the track in the input stream. All |
input_channel |
Required. The zero-based index of the channel in the input stream. |
output_channel |
Required. The zero-based index of the channel in the output audio stream. Must be consistent with the |
AudioStreamProperty
Properties of the audio stream.
Fields | |
---|---|
index |
Index of this audio stream. |
audio_format |
Properties of the audio format. |
Channel
Channel resource represents the processor that does a user-defined "streaming" operation, which includes getting an input stream through an input, transcoding it to multiple renditions, and publishing output live streams in certain formats (for example, HLS or DASH) to the specified location.
Fields | |
---|---|
name |
The resource name of the channel, in the form of: |
create_time |
Output only. The creation time. |
update_time |
Output only. The update time. |
labels |
User-defined key/value metadata. |
input_attachments[] |
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. |
active_input |
Output only. The |
output |
Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream). |
elementary_streams[] |
List of elementary streams. |
mux_streams[] |
List of multiplexing settings for output streams. |
manifests[] |
List of output manifests. |
sprite_sheets[] |
List of output sprite sheets. |
streaming_state |
Output only. State of the streaming operation. |
streaming_error |
Output only. A description of the reason for the streaming error. This property is always present when |
log_config |
Configuration of platform logs for this channel. |
Output
Location of output file(s) in a Google Cloud Storage bucket.
Fields | |
---|---|
uri |
URI for the output file(s). For example, |
StreamingState
State of streaming operation that the channel is running.
Enums | |
---|---|
STREAMING_STATE_UNSPECIFIED |
Streaming state is not specified. |
STREAMING |
Channel is getting the input stream, generating the live streams to the specified output location. |
AWAITING_INPUT |
Channel is waiting for the input stream through the input. |
STREAMING_ERROR |
Channel is running, but has trouble publishing the live streams onto the specified output location (for example, the specified Cloud Storage bucket is not writable). |
STREAMING_NO_INPUT |
Channel is generating live streams with no input stream. Live streams are filled out with black screen, while input stream is missing. Not supported yet. |
STOPPED |
Channel is stopped, finishing live streams. |
STARTING |
Channel is starting. |
STOPPING |
Channel is stopping. |
ChannelOperationResponse
Response message for Start/Stop Channel long-running operations.
CreateChannelRequest
Request message for "LivestreamService.CreateChannel".
Fields | |
---|---|
parent |
Required. The parent location for the resource, in the form of: |
channel |
Required. The channel resource to be created. |
channel_id |
Required. The ID of the channel resource to be created. This value must be 1-63 characters, begin and end with |
request_id |
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 |
CreateEventRequest
Request message for "LivestreamService.CreateEvent".
Fields | |
---|---|
parent |
Required. The parent channel for the resource, in the form of: |
event |
Required. The event resource to be created. |
event_id |
Required. The ID of the event resource to be created. This value must be 1-63 characters, begin and end with |
request_id |
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 |
CreateInputRequest
Request message for "LivestreamService.CreateInput".
Fields | |
---|---|
parent |
Required. The parent location for the resource, in the form of: |
input |
Required. The input resource to be created. |
input_id |
Required. The ID of the input resource to be created. This value must be 1-63 characters, begin and end with |
request_id |
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 |
DeleteChannelRequest
Request message for "LivestreamService.DeleteChannel".
Fields | |
---|---|
name |
Required. The name of the channel resource, in the form of: |
request_id |
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 |
force |
If the |
DeleteEventRequest
Request message for "LivestreamService.DeleteEvent".
Fields | |
---|---|
name |
Required. The name of the event resource, in the form of: |
request_id |
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 |
DeleteInputRequest
Request message for "LivestreamService.DeleteInput".
Fields | |
---|---|
name |
Required. The name of the input resource, in the form of: |
request_id |
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 |
ElementaryStream
Encoding of an input element such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.
Fields | |
---|---|
key |
A unique key for this elementary stream. |
Union field elementary_stream . Required. Encoding of an audio, video, or text track. elementary_stream can be only one of the following: |
|
video_stream |
Encoding of a video stream. |
audio_stream |
Encoding of an audio stream. |
text_stream |
Encoding of a text stream. For example, closed captions or subtitles. |
Event
Event is a sub-resource of a channel, which can be scheduled by the user to execute operations on a channel resource without having to stop the channel.
Fields | |
---|---|
name |
The resource name of the event, in the form of: |
create_time |
Output only. The creation time. |
update_time |
Output only. The update time. |
labels |
User-defined key/value metadata. |
execute_now |
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 |
The time when the event should be executed. When |
state |
Output only. The state of the event. |
error |
Output only. An error object that describes the reason for the failure. This property is always present when |
ad_break |
Required. Inserts a new ad opportunity. |
AdBreakTask
Inserts a new ad opportunity.
Fields | |
---|---|
duration |
Duration of an ad opportunity. Must be greater than 0. |
State
State of the event
Enums | |
---|---|
STATE_UNSPECIFIED |
Event state is not specified. |
SCHEDULED |
Event is scheduled but not executed yet. |
RUNNING |
Event is being executed. |
SUCCEEDED |
Event has been successfully executed. |
FAILED |
Event fails to be executed. |
PENDING |
Event has been created but not scheduled yet. |
STOPPED |
Event was stopped before running for its full duration. |
GetChannelRequest
Request message for "LivestreamService.GetChannel".
Fields | |
---|---|
name |
Required. The name of the channel resource, in the form of: |
GetEventRequest
Request message for "LivestreamService.GetEvent".
Fields | |
---|---|
name |
Required. The name of the event resource, in the form of: |
GetInputRequest
Request message for "LivestreamService.GetInput".
Fields | |
---|---|
name |
Required. The name of the input resource, in the form of: |
Input
Input resource represents the endpoint from which the channel ingests the input stream.
Fields | |
---|---|
name |
The resource name of the input, in the form of: |
create_time |
Output only. The creation time. |
update_time |
Output only. The update time. |
labels |
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 |
uri |
Output only. URI to push the input stream to. Its format depends on the input
|
preprocessing_config |
Preprocessing configurations. |
security_rules |
Security rule for access control. |
input_stream_property |
Output only. The information for the input stream. This field will be present only when this input receives the input stream. |
SecurityRule
Security rules for access control. Each field represents one security rule. Only when the source of the input stream satisfies all the fields, this input stream can be accepted.
Fields | |
---|---|
ip_ranges[] |
At least one ip range must match unless none specified. The IP range is defined by CIDR block: for example, |
Tier
Tier of the input specification.
Enums | |
---|---|
TIER_UNSPECIFIED |
Tier is not specified. |
SD |
Resolution < 1280x720. Bitrate <= 6 Mbps. FPS <= 60. |
HD |
Resolution <= 1920x1080. Bitrate <= 25 Mbps. FPS <= 60. |
UHD |
Resolution <= 4096x2160. Not supported yet. |
Type
The type of the input.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Input type is not specified. |
RTMP_PUSH |
Input will take an rtmp input stream. |
SRT_PUSH |
Input will take an srt (Secure Reliable Transport) input stream. |
InputAttachment
A group of information for attaching an input resource to this channel.
Fields | |
---|---|
key |
A unique key for this input attachment. |
input |
The resource name of an existing input, in the form of: |
automatic_failover |
Automatic failover configurations. |
AutomaticFailover
Configurations to follow when automatic failover happens.
Fields | |
---|---|
input_keys[] |
The |
InputStreamProperty
Properties of the input stream.
Fields | |
---|---|
last_establish_time |
The time that the current input stream is accepted and the connection is established. |
video_streams[] |
Properties of the video streams. |
audio_streams[] |
Properties of the audio streams. |
ListChannelsRequest
Request message for "LivestreamService.ListChannels".
Fields | |
---|---|
parent |
Required. The parent location for the resource, in the form of: |
page_size |
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 |
page_token |
The next_page_token value returned from a previous List request, if any. |
filter |
The filter to apply to list results. |
order_by |
Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order. |
ListChannelsResponse
Response message for "LivestreamService.ListChannels".
Fields | |
---|---|
channels[] |
A list of channels. |
next_page_token |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
unreachable[] |
Locations that could not be reached. |
ListEventsRequest
Request message for "LivestreamService.ListEvents".
Fields | |
---|---|
parent |
Required. The parent channel for the resource, in the form of: |
page_size |
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 |
page_token |
The next_page_token value returned from a previous List request, if any. |
filter |
The filter to apply to list results. |
order_by |
Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order. |
ListEventsResponse
Response message for "LivestreamService.ListEvents".
Fields | |
---|---|
events[] |
A list of events. |
next_page_token |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
unreachable[] |
Locations that could not be reached. |
ListInputsRequest
Request message for "LivestreamService.ListInputs".
Fields | |
---|---|
parent |
Required. The parent location for the resource, in the form of: |
page_size |
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 |
page_token |
The next_page_token value returned from a previous List request, if any. |
filter |
The filter to apply to list results. |
order_by |
Specifies the ordering of results following syntax at Sorting Order. |
ListInputsResponse
Response message for "LivestreamService.ListInputs".
Fields | |
---|---|
inputs[] |
A list of inputs. |
next_page_token |
Token to retrieve the next page of results, or empty if there are no more results in the list. |
unreachable[] |
Locations that could not be reached. |
LogConfig
Configuration of platform logs. See Using and managing platform logs for more information about how to view platform logs through Cloud Logging.
Fields | |
---|---|
log_severity |
The severity level of platform logging for this resource. |
LogSeverity
The severity level of platform logging for this channel. Logs with a severity level higher than or equal to the chosen severity level will be logged and can be viewed through Cloud Logging. The severity level of a log is ranked as followed from low to high: DEBUG < INFO < NOTICE < WARNING < ERROR < CRITICAL < ALERT < EMERGENCY. See LogSeverity for more information.
Enums | |
---|---|
LOG_SEVERITY_UNSPECIFIED |
Log severity is not specified. This is the same as log severity is OFF. |
OFF |
Log is turned off. |
DEBUG |
Log with severity higher than or equal to DEBUG are logged. |
INFO |
Logs with severity higher than or equal to INFO are logged. |
WARNING |
Logs with severity higher than or equal to WARNING are logged. |
ERROR |
Logs with severity higher than or equal to ERROR are logged. |
Manifest
Manifest configuration.
Fields | |
---|---|
file_name |
The name of the generated file. The default is |
type |
Required. Type of the manifest, can be |
mux_streams[] |
Required. List of
|
max_segment_count |
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. |
segment_keep_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 |
ManifestType
The manifest type can be either HLS
or DASH
.
Enums | |
---|---|
MANIFEST_TYPE_UNSPECIFIED |
The manifest type is not specified. |
HLS |
Create an HLS manifest. The corresponding file extension is .m3u8 . |
DASH |
Create a DASH manifest. The corresponding file extension is .mpd . |
MuxStream
Multiplexing settings for output stream.
Fields | |
---|---|
key |
A unique key for this multiplexed stream. |
container |
The container format. The default is Supported container formats:
|
elementary_streams[] |
List of
|
segment_settings |
Segment settings for |
OperationMetadata
Represents the metadata of the long-running operation.
Fields | |
---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
target |
Output only. Server-defined resource path for the target of the operation. |
verb |
Output only. Name of the verb executed by the operation. |
requested_cancellation |
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a |
api_version |
Output only. API version used to start the operation. |
PreprocessingConfig
Preprocessing configurations.
Fields | |
---|---|
crop |
Specify the video cropping configuration. |
pad |
Specify the video pad filter configuration. |
Crop
Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution.
Fields | |
---|---|
top_pixels |
The number of pixels to crop from the top. The default is 0. |
bottom_pixels |
The number of pixels to crop from the bottom. The default is 0. |
left_pixels |
The number of pixels to crop from the left. The default is 0. |
right_pixels |
The number of pixels to crop from the right. The default is 0. |
Pad
Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution.
Fields | |
---|---|
top_pixels |
The number of pixels to add to the top. The default is 0. |
bottom_pixels |
The number of pixels to add to the bottom. The default is 0. |
left_pixels |
The number of pixels to add to the left. The default is 0. |
right_pixels |
The number of pixels to add to the right. The default is 0. |
SegmentSettings
Segment settings for fmp4
and ts
.
Fields | |
---|---|
segment_duration |
Duration of the segments in seconds. The default is All |
SpriteSheet
Sprite sheet configuration.
Fields | |
---|---|
format |
Format type. The default is Supported formats:
|
file_prefix |
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_width_pixels |
Required. The width of the sprite in pixels. Must be an even integer. |
sprite_height_pixels |
Required. The height of the sprite in pixels. Must be an even integer. |
column_count |
The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1. |
row_count |
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. |
interval |
Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is |
quality |
The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio. |
StartChannelRequest
Request message for "LivestreamService.StartChannel".
Fields | |
---|---|
name |
Required. The name of the channel resource, in the form of: |
request_id |
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 |
StopChannelRequest
Request message for "LivestreamService.StopChannel".
Fields | |
---|---|
name |
Required. The name of the channel resource, in the form of: |
request_id |
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 |
TextStream
Encoding of a text stream. For example, closed captions or subtitles.
Fields | |
---|---|
codec |
Required. The codec for this text stream. Supported text codecs:
|
UpdateChannelRequest
Request message for "LivestreamService.UpdateChannel".
Fields | |
---|---|
update_mask |
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: 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. |
channel |
Required. The channel resource to be updated. |
request_id |
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 |
UpdateInputRequest
Request message for "LivestreamService.UpdateInput".
Fields | |
---|---|
update_mask |
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: 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. |
input |
Required. The input resource to be updated. |
request_id |
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 |
VideoFormat
Properties of the video format.
Fields | |
---|---|
codec |
Video codec used in this video stream. |
width_pixels |
The width of the video stream in pixels. |
height_pixels |
The height of the video stream in pixels. |
frame_rate |
The frame rate of the input video stream. |
VideoStream
Video stream resource.
Fields | |
---|---|
h264 |
H264 codec settings. |
H264CodecSettings
H264 codec settings.
Fields | |
---|---|
width_pixels |
Required. The width of the video in pixels. Must be an even integer. Valid range is [320, 1920]. |
height_pixels |
Required. The height of the video in pixels. Must be an even integer. Valid range is [180, 1080]. |
frame_rate |
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. |
bitrate_bps |
Required. The video bitrate in bits per second. Minimum value is 10,000.
|
allow_open_gop |
Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is |
vbv_size_bits |
Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to |
vbv_fullness_bits |
Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of |
entropy_coder |
The entropy coder to use. The default is Supported entropy coders:
|
b_pyramid |
Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is |
b_frame_count |
The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than |
aq_strength |
Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0. |
profile |
Enforces the specified codec profile. The following profiles are supported:
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 |
tune |
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 |
Union field gop_mode . GOP mode can be either by frame count or duration. gop_mode can be only one of the following: |
|
gop_frame_count |
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 |
gop_duration |
Select the GOP size based on the specified duration. The default is All video streams in the same channel must have the same GOP size. |
VideoStreamProperty
Properties of the video stream.
Fields | |
---|---|
index |
Index of this video stream. |
video_format |
Properties of the video format. |