Google Cloud Video Live Stream V1 Client - Class Input (0.2.6)

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

Input resource represents the endpoint from which the channel ingests the input stream.

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` The resource name of the input, in the form of: `projects/{project}/locations/{location}/inputs/{inputId}`.
`↳ 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.
`↳ type`	`int` Source type.
`↳ tier`	`int` Tier defines the maximum input specification that is accepted by the video pipeline. The billing is charged based on the tier specified here. See Pricing for more detail. The default is `HD`.
`↳ uri`	`string` Output only. URI to push the input stream to. Its format depends on the input type, for example: * `RTMP_PUSH`: `rtmp://1.2.3.4/live/{STREAM-ID}` * `SRT_PUSH`: `srt://1.2.3.4:4201?streamid={STREAM-ID}`
`↳ preprocessing_config`	`Google\Cloud\Video\LiveStream\V1\PreprocessingConfig` Preprocessing configurations.
`↳ security_rules`	`Google\Cloud\Video\LiveStream\V1\Input\SecurityRule` Security rule for access control.
`↳ input_stream_property`	`Google\Cloud\Video\LiveStream\V1\InputStreamProperty` Output only. The information for the input stream. This field will be present only when this input receives the input stream.

getName

The resource name of the input, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.

Returns
Type	Description
`string`

setName

The resource name of the input, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.

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`

getType

Source type.

Returns
Type	Description
`int`

setType

Source type.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getTier

Tier defines the maximum input specification that is accepted by the video pipeline. The billing is charged based on the tier specified here.

See Pricing for more detail. The default is HD.

Returns
Type	Description
`int`

setTier

Tier defines the maximum input specification that is accepted by the video pipeline. The billing is charged based on the tier specified here.

See Pricing for more detail. The default is HD.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getUri

Output only. URI to push the input stream to.

Its format depends on the input type, for example:

RTMP_PUSH: rtmp://1.2.3.4/live/{STREAM-ID}
SRT_PUSH: srt://1.2.3.4:4201?streamid={STREAM-ID}

Returns
Type	Description
`string`

setUri

Output only. URI to push the input stream to.

Its format depends on the input type, for example:

RTMP_PUSH: rtmp://1.2.3.4/live/{STREAM-ID}
SRT_PUSH: srt://1.2.3.4:4201?streamid={STREAM-ID}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPreprocessingConfig

Preprocessing configurations.

Returns
Type	Description
`Google\Cloud\Video\LiveStream\V1\PreprocessingConfig\|null`

hasPreprocessingConfig

clearPreprocessingConfig

setPreprocessingConfig

Preprocessing configurations.

Parameter
Name	Description
`var`	`Google\Cloud\Video\LiveStream\V1\PreprocessingConfig`

Returns
Type	Description
`$this`

getSecurityRules

Security rule for access control.

Returns
Type	Description
`Google\Cloud\Video\LiveStream\V1\Input\SecurityRule\|null`

hasSecurityRules

clearSecurityRules

setSecurityRules

Security rule for access control.

Parameter
Name	Description
`var`	`Google\Cloud\Video\LiveStream\V1\Input\SecurityRule`

Returns
Type	Description
`$this`

getInputStreamProperty

Output only. The information for the input stream. This field will be present only when this input receives the input stream.

Returns
Type	Description
`Google\Cloud\Video\LiveStream\V1\InputStreamProperty\|null`

hasInputStreamProperty

clearInputStreamProperty

setInputStreamProperty

Output only. The information for the input stream. This field will be present only when this input receives the input stream.

Parameter
Name	Description
`var`	`Google\Cloud\Video\LiveStream\V1\InputStreamProperty`

Returns
Type	Description
`$this`