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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The resource name of the channel, in the form of: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The creation time. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The update time. |
↳ labels |
array|Google\Protobuf\Internal\MapField
User-defined key/value metadata. |
↳ 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 |
array<Google\Cloud\Video\LiveStream\V1\ElementaryStream>
List of elementary streams. |
↳ mux_streams |
array<Google\Cloud\Video\LiveStream\V1\MuxStream>
List of multiplexing settings for output streams. |
↳ manifests |
array<Google\Cloud\Video\LiveStream\V1\Manifest>
List of output manifests. |
↳ sprite_sheets |
array<Google\Cloud\Video\LiveStream\V1\SpriteSheet>
List of output 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 |
Google\Cloud\Video\LiveStream\V1\LogConfig
Configuration of platform logs for this channel. |
↳ timecode_config |
Google\Cloud\Video\LiveStream\V1\TimecodeConfig
Configuration of timecode for this channel. |
↳ 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}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The resource name of the channel, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The creation time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The update time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The update time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
User-defined key/value metadata.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
User-defined key/value metadata.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Video\LiveStream\V1\InputAttachment>
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOutput
Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Video\LiveStream\V1\Channel\Output|null | |
hasOutput
clearOutput
setOutput
Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Video\LiveStream\V1\Channel\Output
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getElementaryStreams
List of elementary streams.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setElementaryStreams
List of elementary streams.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Video\LiveStream\V1\ElementaryStream>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMuxStreams
List of multiplexing settings for output streams.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setMuxStreams
List of multiplexing settings for output streams.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Video\LiveStream\V1\MuxStream>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getManifests
List of output manifests.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setManifests
List of output manifests.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Video\LiveStream\V1\Manifest>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpriteSheets
List of output sprite sheets.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSpriteSheets
List of output sprite sheets.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Video\LiveStream\V1\SpriteSheet>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStreamingState
Output only. State of the streaming operation.
| Returns | |
|---|---|
| Type | Description |
int | |
setStreamingState
Output only. State of the streaming operation.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStreamingError
Output only. A description of the reason for the streaming error. This property is always present when streaming_state is STREAMING_ERROR.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLogConfig
Configuration of platform logs for this channel.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Video\LiveStream\V1\LogConfig|null | |
hasLogConfig
clearLogConfig
setLogConfig
Configuration of platform logs for this channel.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Video\LiveStream\V1\LogConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTimecodeConfig
Configuration of timecode for this channel.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Video\LiveStream\V1\TimecodeConfig|null | |
hasTimecodeConfig
clearTimecodeConfig
setTimecodeConfig
Configuration of timecode for this channel.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Video\LiveStream\V1\TimecodeConfig
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Video\LiveStream\V1\Encryption>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInputConfig
The configuration for input sources defined in input_attachments.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Video\LiveStream\V1\InputConfig|null | |
hasInputConfig
clearInputConfig
setInputConfig
The configuration for input sources defined in input_attachments.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Video\LiveStream\V1\InputConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |