Reference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#active_input
def active_input() -> ::String
Returns
- (::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.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The creation time.
#elementary_streams
def elementary_streams() -> ::Array<::Google::Cloud::Video::LiveStream::V1::ElementaryStream>
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::ElementaryStream>) — List of elementary streams.
#elementary_streams=
def elementary_streams=(value) -> ::Array<::Google::Cloud::Video::LiveStream::V1::ElementaryStream>
Parameter
- value (::Array<::Google::Cloud::Video::LiveStream::V1::ElementaryStream>) — List of elementary streams.
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::ElementaryStream>) — List of elementary streams.
#encryptions
def encryptions() -> ::Array<::Google::Cloud::Video::LiveStream::V1::Encryption>
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::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.
#encryptions=
def encryptions=(value) -> ::Array<::Google::Cloud::Video::LiveStream::V1::Encryption>
Parameter
- value (::Array<::Google::Cloud::Video::LiveStream::V1::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.
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::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_attachments
def input_attachments() -> ::Array<::Google::Cloud::Video::LiveStream::V1::InputAttachment>
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::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.
#input_attachments=
def input_attachments=(value) -> ::Array<::Google::Cloud::Video::LiveStream::V1::InputAttachment>
Parameter
- value (::Array<::Google::Cloud::Video::LiveStream::V1::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.
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::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.
#input_config
def input_config() -> ::Google::Cloud::Video::LiveStream::V1::InputConfig
Returns
- (::Google::Cloud::Video::LiveStream::V1::InputConfig) — The configuration for input sources defined in input_attachments.
#input_config=
def input_config=(value) -> ::Google::Cloud::Video::LiveStream::V1::InputConfig
Parameter
- value (::Google::Cloud::Video::LiveStream::V1::InputConfig) — The configuration for input sources defined in input_attachments.
Returns
- (::Google::Cloud::Video::LiveStream::V1::InputConfig) — The configuration for input sources defined in input_attachments.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — User-defined key/value metadata.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — User-defined key/value metadata.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — User-defined key/value metadata.
#log_config
def log_config() -> ::Google::Cloud::Video::LiveStream::V1::LogConfig
Returns
- (::Google::Cloud::Video::LiveStream::V1::LogConfig) — Configuration of platform logs for this channel.
#log_config=
def log_config=(value) -> ::Google::Cloud::Video::LiveStream::V1::LogConfig
Parameter
- value (::Google::Cloud::Video::LiveStream::V1::LogConfig) — Configuration of platform logs for this channel.
Returns
- (::Google::Cloud::Video::LiveStream::V1::LogConfig) — Configuration of platform logs for this channel.
#manifests
def manifests() -> ::Array<::Google::Cloud::Video::LiveStream::V1::Manifest>
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::Manifest>) — List of output manifests.
#manifests=
def manifests=(value) -> ::Array<::Google::Cloud::Video::LiveStream::V1::Manifest>
Parameter
- value (::Array<::Google::Cloud::Video::LiveStream::V1::Manifest>) — List of output manifests.
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::Manifest>) — List of output manifests.
#mux_streams
def mux_streams() -> ::Array<::Google::Cloud::Video::LiveStream::V1::MuxStream>
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::MuxStream>) — List of multiplexing settings for output streams.
#mux_streams=
def mux_streams=(value) -> ::Array<::Google::Cloud::Video::LiveStream::V1::MuxStream>
Parameter
- value (::Array<::Google::Cloud::Video::LiveStream::V1::MuxStream>) — List of multiplexing settings for output streams.
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::MuxStream>) — List of multiplexing settings for output streams.
#name
def name() -> ::String
Returns
-
(::String) — The resource name of the channel, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — The resource name of the channel, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
Returns
-
(::String) — The resource name of the channel, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
#output
def output() -> ::Google::Cloud::Video::LiveStream::V1::Channel::Output
Returns
- (::Google::Cloud::Video::LiveStream::V1::Channel::Output) — Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).
#output=
def output=(value) -> ::Google::Cloud::Video::LiveStream::V1::Channel::Output
Parameter
- value (::Google::Cloud::Video::LiveStream::V1::Channel::Output) — Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).
Returns
- (::Google::Cloud::Video::LiveStream::V1::Channel::Output) — Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).
#retention_config
def retention_config() -> ::Google::Cloud::Video::LiveStream::V1::RetentionConfig
Returns
- (::Google::Cloud::Video::LiveStream::V1::RetentionConfig) — Optional. Configuration for retention of output files for this channel.
#retention_config=
def retention_config=(value) -> ::Google::Cloud::Video::LiveStream::V1::RetentionConfig
Parameter
- value (::Google::Cloud::Video::LiveStream::V1::RetentionConfig) — Optional. Configuration for retention of output files for this channel.
Returns
- (::Google::Cloud::Video::LiveStream::V1::RetentionConfig) — Optional. Configuration for retention of output files for this channel.
#sprite_sheets
def sprite_sheets() -> ::Array<::Google::Cloud::Video::LiveStream::V1::SpriteSheet>
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::SpriteSheet>) — List of output sprite sheets.
#sprite_sheets=
def sprite_sheets=(value) -> ::Array<::Google::Cloud::Video::LiveStream::V1::SpriteSheet>
Parameter
- value (::Array<::Google::Cloud::Video::LiveStream::V1::SpriteSheet>) — List of output sprite sheets.
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::SpriteSheet>) — List of output sprite sheets.
#static_overlays
def static_overlays() -> ::Array<::Google::Cloud::Video::LiveStream::V1::StaticOverlay>
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::StaticOverlay>) — Optional. List of static overlay images. Those images display over the output content for the whole duration of the live stream.
#static_overlays=
def static_overlays=(value) -> ::Array<::Google::Cloud::Video::LiveStream::V1::StaticOverlay>
Parameter
- value (::Array<::Google::Cloud::Video::LiveStream::V1::StaticOverlay>) — Optional. List of static overlay images. Those images display over the output content for the whole duration of the live stream.
Returns
- (::Array<::Google::Cloud::Video::LiveStream::V1::StaticOverlay>) — Optional. List of static overlay images. Those images display over the output content for the whole duration of the live stream.
#streaming_error
def streaming_error() -> ::Google::Rpc::Status
Returns
- (::Google::Rpc::Status) — Output only. A description of the reason for the streaming error. This property is always present when streaming_state is STREAMING_ERROR.
#streaming_state
def streaming_state() -> ::Google::Cloud::Video::LiveStream::V1::Channel::StreamingState
Returns
- (::Google::Cloud::Video::LiveStream::V1::Channel::StreamingState) — Output only. State of the streaming operation.
#timecode_config
def timecode_config() -> ::Google::Cloud::Video::LiveStream::V1::TimecodeConfig
Returns
- (::Google::Cloud::Video::LiveStream::V1::TimecodeConfig) — Configuration of timecode for this channel.
#timecode_config=
def timecode_config=(value) -> ::Google::Cloud::Video::LiveStream::V1::TimecodeConfig
Parameter
- value (::Google::Cloud::Video::LiveStream::V1::TimecodeConfig) — Configuration of timecode for this channel.
Returns
- (::Google::Cloud::Video::LiveStream::V1::TimecodeConfig) — Configuration of timecode for this channel.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The update time.