Live Stream v1 API - Class Channel (1.8.0)

public sealed class Channel : IMessage<Channel>, IEquatable<Channel>, IDeepCloneable<Channel>, IBufferMessage, IMessage

Reference documentation and code samples for the Live Stream v1 API class 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.

Inheritance

object > Channel

Namespace

Google.Cloud.Video.LiveStream.V1

Assembly

Google.Cloud.Video.LiveStream.V1.dll

Constructors

Channel()

public Channel()

Channel(Channel)

public Channel(Channel other)
Parameter
Name Description
other Channel

Properties

ActiveInput

public string ActiveInput { get; set; }

Output only. The [InputAttachment.key][google.cloud.video.livestream.v1.InputAttachment.key] that serves as the current input source. The first input in the [input_attachments][google.cloud.video.livestream.v1.Channel.input_attachments] is the initial input source.

Property Value
Type Description
string

ChannelName

public ChannelName ChannelName { get; set; }

ChannelName-typed view over the Name resource name property.

Property Value
Type Description
ChannelName

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The creation time.

Property Value
Type Description
Timestamp

ElementaryStreams

public RepeatedField<ElementaryStream> ElementaryStreams { get; }

List of elementary streams.

Property Value
Type Description
RepeatedFieldElementaryStream

Encryptions

public RepeatedField<Encryption> Encryptions { get; }

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.

Property Value
Type Description
RepeatedFieldEncryption

InputAttachments

public RepeatedField<InputAttachment> InputAttachments { get; }

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.

Property Value
Type Description
RepeatedFieldInputAttachment

InputConfig

public InputConfig InputConfig { get; set; }

The configuration for input sources defined in [input_attachments][google.cloud.video.livestream.v1.Channel.input_attachments].

Property Value
Type Description
InputConfig

Labels

public MapField<string, string> Labels { get; }

User-defined key/value metadata.

Property Value
Type Description
MapFieldstringstring

LogConfig

public LogConfig LogConfig { get; set; }

Configuration of platform logs for this channel.

Property Value
Type Description
LogConfig

Manifests

public RepeatedField<Manifest> Manifests { get; }

List of output manifests.

Property Value
Type Description
RepeatedFieldManifest

MuxStreams

public RepeatedField<MuxStream> MuxStreams { get; }

List of multiplexing settings for output streams.

Property Value
Type Description
RepeatedFieldMuxStream

Name

public string Name { get; set; }

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

Property Value
Type Description
string

Output

public Channel.Types.Output Output { get; set; }

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

Property Value
Type Description
ChannelTypesOutput

RetentionConfig

public RetentionConfig RetentionConfig { get; set; }

Optional. Configuration for retention of output files for this channel.

Property Value
Type Description
RetentionConfig

SpriteSheets

public RepeatedField<SpriteSheet> SpriteSheets { get; }

List of output sprite sheets.

Property Value
Type Description
RepeatedFieldSpriteSheet

StaticOverlays

public RepeatedField<StaticOverlay> StaticOverlays { get; }

Optional. List of static overlay images. Those images display over the output content for the whole duration of the live stream.

Property Value
Type Description
RepeatedFieldStaticOverlay

StreamingError

public Status StreamingError { get; set; }

Output only. A description of the reason for the streaming error. This property is always present when [streaming_state][google.cloud.video.livestream.v1.Channel.streaming_state] is [STREAMING_ERROR][google.cloud.video.livestream.v1.Channel.StreamingState.STREAMING_ERROR].

Property Value
Type Description
Status

StreamingState

public Channel.Types.StreamingState StreamingState { get; set; }

Output only. State of the streaming operation.

Property Value
Type Description
ChannelTypesStreamingState

TimecodeConfig

public TimecodeConfig TimecodeConfig { get; set; }

Configuration of timecode for this channel.

Property Value
Type Description
TimecodeConfig

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The update time.

Property Value
Type Description
Timestamp