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 \ V1Methods
__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. |
↳ state |
int
Output only. State of the distribution. |
↳ error |
Google\Rpc\Status
Output only. Only present when the |
↳ 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
keys that should
appear in this distribution output.
- For SRT protocol, only
tsdistribution streams can be specified. - For RTMP protocol, only
flvdistribution streams can be specified.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDistributionStream
Required. DistributionStream
keys that should
appear in this distribution output.
- For SRT protocol, only
tsdistribution streams can be specified. - For RTMP protocol, only
flvdistribution 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 |
Google\Rpc\Status|null |
|
hasError
clearError
setError
Output only. Only present when the state is ERROR. The reason for the
error state of the distribution.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSrtPush
Output endpoint using SRT_PUSH.
| Returns | |
|---|---|
| Type | Description |
SrtPushOutputEndpoint|null |
|
hasSrtPush
setSrtPush
Output endpoint using SRT_PUSH.
| Parameter | |
|---|---|
| Name | Description |
var |
SrtPushOutputEndpoint
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRtmpPush
Output endpoint using RTMP_PUSH.
| Returns | |
|---|---|
| Type | Description |
RtmpPushOutputEndpoint|null |
|
hasRtmpPush
setRtmpPush
Output endpoint using RTMP_PUSH.
| Parameter | |
|---|---|
| Name | Description |
var |
RtmpPushOutputEndpoint
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndpoint
| Returns | |
|---|---|
| Type | Description |
string |
|