Package Classes (1.10.0)

Summary of entries of Classes for livestream.

Classes

LivestreamServiceAsyncClient

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).

LivestreamServiceClient

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).

ListAssetsAsyncPager

A pager for iterating through list_assets requests.

This class thinly wraps an initial ListAssetsResponse object, and provides an __aiter__ method to iterate through its assets field.

If there are more pages, the __aiter__ method will make additional ListAssets requests and continue to iterate through the assets field on the corresponding responses.

All the usual ListAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAssetsPager

A pager for iterating through list_assets requests.

This class thinly wraps an initial ListAssetsResponse object, and provides an __iter__ method to iterate through its assets field.

If there are more pages, the __iter__ method will make additional ListAssets requests and continue to iterate through the assets field on the corresponding responses.

All the usual ListAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListChannelsAsyncPager

A pager for iterating through list_channels requests.

This class thinly wraps an initial ListChannelsResponse object, and provides an __aiter__ method to iterate through its channels field.

If there are more pages, the __aiter__ method will make additional ListChannels requests and continue to iterate through the channels field on the corresponding responses.

All the usual ListChannelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListChannelsPager

A pager for iterating through list_channels requests.

This class thinly wraps an initial ListChannelsResponse object, and provides an __iter__ method to iterate through its channels field.

If there are more pages, the __iter__ method will make additional ListChannels requests and continue to iterate through the channels field on the corresponding responses.

All the usual ListChannelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListClipsAsyncPager

A pager for iterating through list_clips requests.

This class thinly wraps an initial ListClipsResponse object, and provides an __aiter__ method to iterate through its clips field.

If there are more pages, the __aiter__ method will make additional ListClips requests and continue to iterate through the clips field on the corresponding responses.

All the usual ListClipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListClipsPager

A pager for iterating through list_clips requests.

This class thinly wraps an initial ListClipsResponse object, and provides an __iter__ method to iterate through its clips field.

If there are more pages, the __iter__ method will make additional ListClips requests and continue to iterate through the clips field on the corresponding responses.

All the usual ListClipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEventsAsyncPager

A pager for iterating through list_events requests.

This class thinly wraps an initial ListEventsResponse object, and provides an __aiter__ method to iterate through its events field.

If there are more pages, the __aiter__ method will make additional ListEvents requests and continue to iterate through the events field on the corresponding responses.

All the usual ListEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEventsPager

A pager for iterating through list_events requests.

This class thinly wraps an initial ListEventsResponse object, and provides an __iter__ method to iterate through its events field.

If there are more pages, the __iter__ method will make additional ListEvents requests and continue to iterate through the events field on the corresponding responses.

All the usual ListEventsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListInputsAsyncPager

A pager for iterating through list_inputs requests.

This class thinly wraps an initial ListInputsResponse object, and provides an __aiter__ method to iterate through its inputs field.

If there are more pages, the __aiter__ method will make additional ListInputs requests and continue to iterate through the inputs field on the corresponding responses.

All the usual ListInputsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListInputsPager

A pager for iterating through list_inputs requests.

This class thinly wraps an initial ListInputsResponse object, and provides an __iter__ method to iterate through its inputs field.

If there are more pages, the __iter__ method will make additional ListInputs requests and continue to iterate through the inputs field on the corresponding responses.

All the usual ListInputsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Asset

An asset represents a video or an image.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImageAsset

Image represents an image. The supported formats are JPEG, PNG.

LabelsEntry

The abstract base class for a message.

State

State of the asset resource.

VideoAsset

VideoAsset represents a video. The supported formats are MP4, MPEG-TS, and FLV. The supported video codec is H264. The supported audio codecs are AAC, AC3, MP2, and MP3.

AudioFormat

Properties of the audio format.

AudioStream

Audio stream resource.

AudioMapping

The mapping for the input streams and audio channels.

AudioStreamProperty

Properties of the audio stream.

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.

LabelsEntry

The abstract base class for a message.

Output

Location of output file(s) in a Google Cloud Storage bucket.

StreamingState

State of streaming operation that the channel is running.

ChannelOperationResponse

Response message for Start/Stop Channel long-running operations.

Clip

Clip is a sub-resource under channel. Each clip represents a clipping operation that generates a VOD playlist from its channel given a set of timestamp ranges.

ClipManifest

ClipManifest identifies a source manifest for the generated clip manifest.

LabelsEntry

The abstract base class for a message.

Slice

Slice represents a slice of the requested clip.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

State of clipping operation.

TimeSlice

TimeSlice represents a tuple of Unix epoch timestamps that specifies a time range.

CreateAssetRequest

Request message for "LivestreamService.CreateAsset".

CreateChannelRequest

Request message for "LivestreamService.CreateChannel".

CreateClipRequest

Request message for "LivestreamService.CreateClip".

CreateEventRequest

Request message for "LivestreamService.CreateEvent".

CreateInputRequest

Request message for "LivestreamService.CreateInput".

DeleteAssetRequest

Request message for "LivestreamService.DeleteAsset".

DeleteChannelRequest

Request message for "LivestreamService.DeleteChannel".

DeleteClipRequest

Request message for "LivestreamService.DeleteClip".

DeleteEventRequest

Request message for "LivestreamService.DeleteEvent".

DeleteInputRequest

Request message for "LivestreamService.DeleteInput".

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Encryption

Encryption settings.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Aes128Encryption

Configuration for HLS AES-128 encryption.

Clearkey

Clearkey configuration.

DrmSystems

Defines configuration for DRM systems in use. If a field is omitted, that DRM system will be considered to be disabled.

Fairplay

Fairplay configuration.

MpegCommonEncryption

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

Playready

Playready configuration.

SampleAesEncryption

Configuration for HLS SAMPLE-AES encryption.

SecretManagerSource

Configuration for secrets stored in Google Secret Manager.

Widevine

Widevine configuration.

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AdBreakTask

Inserts a new ad opportunity.

InputSwitchTask

Switches to another input stream. Automatic failover is then disabled.

LabelsEntry

The abstract base class for a message.

MuteTask

Mutes the stream.

ReturnToProgramTask

Stops any events which are currently running. This only applies to events with a duration.

SlateTask

Inserts a slate.

State

State of the event

UnmuteTask

Unmutes the stream. The task fails if the stream is not currently muted.

GetAssetRequest

Request message for "LivestreamService.GetAsset".

GetChannelRequest

Request message for "LivestreamService.GetChannel".

GetClipRequest

Request message for "LivestreamService.GetClip".

GetEventRequest

Request message for "LivestreamService.GetEvent".

GetInputRequest

Request message for "LivestreamService.GetInput".

GetPoolRequest

Request message for "LivestreamService.GetPool".

Input

Input resource represents the endpoint from which the channel ingests the input stream.

LabelsEntry

The abstract base class for a message.

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.

Tier

Tier of the input specification.

Type

The type of the input.

InputAttachment

A group of information for attaching an input resource to this channel.

AutomaticFailover

Configurations to follow when automatic failover happens.

InputConfig

Configuration for the input sources of a channel.

InputSwitchMode

Input switch mode.

InputStreamProperty

Properties of the input stream.

ListAssetsRequest

Request message for "LivestreamService.ListAssets".

ListAssetsResponse

Response message for "LivestreamService.ListAssets".

ListChannelsRequest

Request message for "LivestreamService.ListChannels".

ListChannelsResponse

Response message for "LivestreamService.ListChannels".

ListClipsRequest

Request message for "LivestreamService.ListClips".

ListClipsResponse

Response message for "LivestreamService.ListClips".

ListEventsRequest

Request message for "LivestreamService.ListEvents".

ListEventsResponse

Response message for "LivestreamService.ListEvents".

ListInputsRequest

Request message for "LivestreamService.ListInputs".

ListInputsResponse

Response message for "LivestreamService.ListInputs".

LogConfig

Configuration of platform logs. See Using and managing platform logs <https://cloud.google.com/logging/docs/api/platform-logs#managing-logs>__ for more information about how to view platform logs through Cloud Logging.

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 <https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity>__ for more information.

Manifest

Manifest configuration.

ManifestType

The manifest type can be either HLS or DASH.

MuxStream

Multiplexing settings for output stream.

NormalizedCoordinate

2D normalized coordinates.

NormalizedResolution

Normalized resolution.

OperationMetadata

Represents the metadata of the long-running operation.

Pool

Pool resource defines the configuration of Live Stream pools for a specific location. Currently we support only one pool resource per project per location. After the creation of the first input, a default pool is created automatically at "projects/{project}/locations/{location}/pools/default".

LabelsEntry

The abstract base class for a message.

NetworkConfig

Defines the network configuration for the pool.

PreprocessingConfig

Preprocessing configurations.

Audio

Audio preprocessing configuration.

Crop

Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution.

Pad

Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution.

RetentionConfig

Configuration for retention of output files.

SegmentSettings

Segment settings for fmp4 and ts.

SpriteSheet

Sprite sheet configuration.

StartChannelRequest

Request message for "LivestreamService.StartChannel".

StaticOverlay

Configuration for the static overlay.

StopChannelRequest

Request message for "LivestreamService.StopChannel".

TextStream

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

TimecodeConfig

Timecode configuration.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TimecodeSource

The source of timecode.

UpdateChannelRequest

Request message for "LivestreamService.UpdateChannel".

UpdateInputRequest

Request message for "LivestreamService.UpdateInput".

UpdatePoolRequest

Request message for "LivestreamService.UpdatePool".

VideoFormat

Properties of the video format.

VideoStream

Video stream resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

H264CodecSettings

H264 codec settings.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

VideoStreamProperty

Properties of the video stream.

Modules

pagers

API documentation for video.live_stream_v1.services.livestream_service.pagers module.