Class Channel (1.8.0)

Channel(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Attributes

Name Description
name str
The resource name of the channel, in the form of: projects/{project}/locations/{location}/channels/{channelId}.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The creation time.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The update time.
labels MutableMapping[str, str]
User-defined key/value metadata.
input_attachments MutableSequence[google.cloud.video.live_stream_v1.types.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.
active_input str
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 google.cloud.video.live_stream_v1.types.Channel.Output
Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).
elementary_streams MutableSequence[google.cloud.video.live_stream_v1.types.ElementaryStream]
List of elementary streams.
mux_streams MutableSequence[google.cloud.video.live_stream_v1.types.MuxStream]
List of multiplexing settings for output streams.
manifests MutableSequence[google.cloud.video.live_stream_v1.types.Manifest]
List of output manifests.
sprite_sheets MutableSequence[google.cloud.video.live_stream_v1.types.SpriteSheet]
List of output sprite sheets.
streaming_state google.cloud.video.live_stream_v1.types.Channel.StreamingState
Output only. State of the streaming operation.
streaming_error google.rpc.status_pb2.Status
Output only. A description of the reason for the streaming error. This property is always present when streaming_state is STREAMING_ERROR.
log_config google.cloud.video.live_stream_v1.types.LogConfig
Configuration of platform logs for this channel.
timecode_config google.cloud.video.live_stream_v1.types.TimecodeConfig
Configuration of timecode for this channel.
encryptions MutableSequence[google.cloud.video.live_stream_v1.types.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.
input_config google.cloud.video.live_stream_v1.types.InputConfig
The configuration for input sources defined in input_attachments.
retention_config google.cloud.video.live_stream_v1.types.RetentionConfig
Optional. Configuration for retention of output files for this channel.
static_overlays MutableSequence[google.cloud.video.live_stream_v1.types.StaticOverlay]
Optional. List of static overlay images. Those images display over the output content for the whole duration of the live stream.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Output

Output(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

StreamingState

StreamingState(value)

State of streaming operation that the channel is running.