Google Cloud Video Live Stream V1 Client - Class Distribution (1.3.0)

Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class Distribution.

Distribution configuration.

Generated from protobuf message google.cloud.video.livestream.v1.Distribution

Namespace

Google \ Cloud \ Video \ LiveStream \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ key
string

Required. A unique key for this distribution. The key must be 1-63 characters in length. The key must begin and end with a letter (regardless of case) or a number, but can contain dashes or underscores in between.

↳ distribution_stream
string

Required. DistributionStream key s that should appear in this distribution output. - For SRT protocol, only ts distribution streams can be specified. - For RTMP protocol, only flv distribution streams can be specified.

↳ state
int

Output only. State of the distribution.

↳ error
Google\Rpc\Status

Output only. Only present when the state is ERROR . The reason for the error state of the distribution.

↳ srt_push
SrtPushOutputEndpoint

Output endpoint using SRT_PUSH.

↳ rtmp_push
RtmpPushOutputEndpoint

Output endpoint using RTMP_PUSH.

getKey

Required. A unique key for this distribution. The key must be 1-63 characters in length. The key must begin and end with a letter (regardless of case) or a number, but can contain dashes or underscores in between.

Returns
Type
Description
string

setKey

Required. A unique key for this distribution. The key must be 1-63 characters in length. The key must begin and end with a letter (regardless of case) or a number, but can contain dashes or underscores in between.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDistributionStream

Required. DistributionStream key s that should appear in this distribution output.

  • For SRT protocol, only ts distribution streams can be specified.
  • For RTMP protocol, only flv distribution streams can be specified.
Returns
Type
Description
string

setDistributionStream

Required. DistributionStream key s that should appear in this distribution output.

  • For SRT protocol, only ts distribution streams can be specified.
  • For RTMP protocol, only flv distribution streams can be specified.
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getState

Output only. State of the distribution.

Returns
Type
Description
int
Enum of type State .

setState

Output only. State of the distribution.

Parameter
Name
Description
var
int

Enum of type State .

Returns
Type
Description
$this

getError

Output only. Only present when the state is ERROR . The reason for the error state of the distribution.

Returns
Type
Description

hasError

clearError

setError

Output only. Only present when the state is ERROR . The reason for the error state of the distribution.

Parameter
Name
Description
Returns
Type
Description
$this

getSrtPush

Output endpoint using SRT_PUSH.

Returns
Type
Description

hasSrtPush

setSrtPush

Output endpoint using SRT_PUSH.

Parameter
Name
Description
Returns
Type
Description
$this

getRtmpPush

Output endpoint using RTMP_PUSH.

Returns
Type
Description

hasRtmpPush

setRtmpPush

Output endpoint using RTMP_PUSH.

Parameter
Name
Description
Returns
Type
Description
$this

getEndpoint

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: