Google Cloud Video Live Stream V1 Client - Class Channel (0.4.2)

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

Namespace

Google \ Cloud \ Video \ LiveStream \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 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
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. The creation time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. The update time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The update time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLabels

User-defined key/value metadata.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

User-defined key/value metadata.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Cloud\Video\LiveStream\V1\InputAttachment>
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getOutput

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Video\LiveStream\V1\Channel\Output
Returns
TypeDescription
$this

getElementaryStreams

List of elementary streams.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setElementaryStreams

List of elementary streams.

Parameter
NameDescription
var array<Google\Cloud\Video\LiveStream\V1\ElementaryStream>
Returns
TypeDescription
$this

getMuxStreams

List of multiplexing settings for output streams.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMuxStreams

List of multiplexing settings for output streams.

Parameter
NameDescription
var array<Google\Cloud\Video\LiveStream\V1\MuxStream>
Returns
TypeDescription
$this

getManifests

List of output manifests.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setManifests

List of output manifests.

Parameter
NameDescription
var array<Google\Cloud\Video\LiveStream\V1\Manifest>
Returns
TypeDescription
$this

getSpriteSheets

List of output sprite sheets.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSpriteSheets

List of output sprite sheets.

Parameter
NameDescription
var array<Google\Cloud\Video\LiveStream\V1\SpriteSheet>
Returns
TypeDescription
$this

getStreamingState

Output only. State of the streaming operation.

Returns
TypeDescription
int

setStreamingState

Output only. State of the streaming operation.

Parameter
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this

getLogConfig

Configuration of platform logs for this channel.

Returns
TypeDescription
Google\Cloud\Video\LiveStream\V1\LogConfig|null

hasLogConfig

clearLogConfig

setLogConfig

Configuration of platform logs for this channel.

Parameter
NameDescription
var Google\Cloud\Video\LiveStream\V1\LogConfig
Returns
TypeDescription
$this

getTimecodeConfig

Configuration of timecode for this channel.

Returns
TypeDescription
Google\Cloud\Video\LiveStream\V1\TimecodeConfig|null

hasTimecodeConfig

clearTimecodeConfig

setTimecodeConfig

Configuration of timecode for this channel.

Parameter
NameDescription
var Google\Cloud\Video\LiveStream\V1\TimecodeConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Cloud\Video\LiveStream\V1\Encryption>
Returns
TypeDescription
$this

getInputConfig

The configuration for input sources defined in input_attachments.

Returns
TypeDescription
Google\Cloud\Video\LiveStream\V1\InputConfig|null

hasInputConfig

clearInputConfig

setInputConfig

The configuration for input sources defined in input_attachments.

Parameter
NameDescription
var Google\Cloud\Video\LiveStream\V1\InputConfig
Returns
TypeDescription
$this