Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client 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.
Generated from protobuf message google.cloud.video.livestream.v1.Channel
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The resource name of the channel, in the form of: projects/{project}/locations/{location}/channels/{channelId}
.
↳ create_time
↳ update_time
↳ labels
↳ input_attachments
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.
↳ active_input
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.
↳ output
Google\Cloud\Video\LiveStream\V1\Channel\Output
Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).
↳ elementary_streams
↳ mux_streams
array< Google\Cloud\Video\LiveStream\V1\MuxStream
>
List of multiplexing settings for output streams.
↳ manifests
↳ sprite_sheets
↳ streaming_state
int
Output only. State of the streaming operation.
↳ streaming_error
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 .
↳ log_config
↳ timecode_config
↳ encryptions
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_config
Google\Cloud\Video\LiveStream\V1\InputConfig
The configuration for input sources defined in input_attachments .
getName
The resource name of the channel, in the form of: projects/{project}/locations/{location}/channels/{channelId}
.
string
setName
The resource name of the channel, in the form of: projects/{project}/locations/{location}/channels/{channelId}
.
var
string
$this
getCreateTime
Output only. The creation time.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation time.
$this
getUpdateTime
Output only. The update time.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The update time.
$this
getLabels
User-defined key/value metadata.
setLabels
User-defined key/value metadata.
$this
getInputAttachments
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.
setInputAttachments
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.
$this
getActiveInput
Output only. The InputAttachment.key that serves as the current input source. The first input in the input_attachments is the initial input source.
string
setActiveInput
Output only. The InputAttachment.key that serves as the current input source. The first input in the input_attachments is the initial input source.
var
string
$this
getOutput
Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).
hasOutput
clearOutput
setOutput
Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).
$this
getElementaryStreams
List of elementary streams.
setElementaryStreams
List of elementary streams.
$this
getMuxStreams
List of multiplexing settings for output streams.
setMuxStreams
List of multiplexing settings for output streams.
$this
getManifests
List of output manifests.
setManifests
List of output manifests.
$this
getSpriteSheets
List of output sprite sheets.
setSpriteSheets
List of output sprite sheets.
$this
getStreamingState
Output only. State of the streaming operation.
int
setStreamingState
Output only. State of the streaming operation.
var
int
$this
getStreamingError
Output only. A description of the reason for the streaming error. This property is always present when streaming_state is STREAMING_ERROR .
hasStreamingError
clearStreamingError
setStreamingError
Output only. A description of the reason for the streaming error. This property is always present when streaming_state is STREAMING_ERROR .
$this
getLogConfig
Configuration of platform logs for this channel.
hasLogConfig
clearLogConfig
setLogConfig
Configuration of platform logs for this channel.
$this
getTimecodeConfig
Configuration of timecode for this channel.
hasTimecodeConfig
clearTimecodeConfig
setTimecodeConfig
Configuration of timecode for this channel.
$this
getEncryptions
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.
setEncryptions
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.
$this
getInputConfig
The configuration for input sources defined in input_attachments .
hasInputConfig
clearInputConfig
setInputConfig
The configuration for input sources defined in input_attachments .
$this
