Google Cloud Video Live Stream V1 Client - Class Event (1.0.0)

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

Event is a sub-resource of a channel, which can be scheduled by the user to execute operations on a channel resource without having to stop the channel.

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

Namespace

Google \ Cloud \ Video \ LiveStream \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

The resource name of the event, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.
↳ 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_switch Google\Cloud\Video\LiveStream\V1\Event\InputSwitchTask

Switches to another input stream.
↳ ad_break Google\Cloud\Video\LiveStream\V1\Event\AdBreakTask

Inserts a new ad opportunity.
↳ return_to_program Google\Cloud\Video\LiveStream\V1\Event\ReturnToProgramTask

Stops any running ad break.
↳ slate Google\Cloud\Video\LiveStream\V1\Event\SlateTask

Inserts a slate.
↳ mute Google\Cloud\Video\LiveStream\V1\Event\MuteTask

Mutes the stream.
↳ unmute Google\Cloud\Video\LiveStream\V1\Event\UnmuteTask

Unmutes the stream.
↳ execute_now bool

When this field is set to true, the event will be executed at the earliest time that the server can schedule the event and execution_time will be populated with the time that the server actually schedules the event.
↳ execution_time Google\Protobuf\Timestamp

The time to execute the event. If you set execute_now to true, then do not set this field in the CreateEvent request. In this case, the server schedules the event and populates this field. If you set execute_now to false, then you must set this field to at least 10 seconds in the future or else the event can't be created.
↳ state int

Output only. The state of the event.
↳ error Google\Rpc\Status

Output only. An error object that describes the reason for the failure. This property is always present when state is FAILED.

getName

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

Returns
Type Description
string

setName

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

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

getInputSwitch

Switches to another input stream.

Returns
Type Description
Google\Cloud\Video\LiveStream\V1\Event\InputSwitchTask|null

hasInputSwitch

setInputSwitch

Switches to another input stream.

Parameter
Name Description
var Google\Cloud\Video\LiveStream\V1\Event\InputSwitchTask
Returns
Type Description
$this

getAdBreak

Inserts a new ad opportunity.

Returns
Type Description
Google\Cloud\Video\LiveStream\V1\Event\AdBreakTask|null

hasAdBreak

setAdBreak

Inserts a new ad opportunity.

Parameter
Name Description
var Google\Cloud\Video\LiveStream\V1\Event\AdBreakTask
Returns
Type Description
$this

getReturnToProgram

Stops any running ad break.

Returns
Type Description
Google\Cloud\Video\LiveStream\V1\Event\ReturnToProgramTask|null

hasReturnToProgram

setReturnToProgram

Stops any running ad break.

Parameter
Name Description
var Google\Cloud\Video\LiveStream\V1\Event\ReturnToProgramTask
Returns
Type Description
$this

getSlate

Inserts a slate.

Returns
Type Description
Google\Cloud\Video\LiveStream\V1\Event\SlateTask|null

hasSlate

setSlate

Inserts a slate.

Parameter
Name Description
var Google\Cloud\Video\LiveStream\V1\Event\SlateTask
Returns
Type Description
$this

getMute

Mutes the stream.

Returns
Type Description
Google\Cloud\Video\LiveStream\V1\Event\MuteTask|null

hasMute

setMute

Mutes the stream.

Parameter
Name Description
var Google\Cloud\Video\LiveStream\V1\Event\MuteTask
Returns
Type Description
$this

getUnmute

Unmutes the stream.

Returns
Type Description
Google\Cloud\Video\LiveStream\V1\Event\UnmuteTask|null

hasUnmute

setUnmute

Unmutes the stream.

Parameter
Name Description
var Google\Cloud\Video\LiveStream\V1\Event\UnmuteTask
Returns
Type Description
$this

getExecuteNow

When this field is set to true, the event will be executed at the earliest time that the server can schedule the event and execution_time will be populated with the time that the server actually schedules the event.

Returns
Type Description
bool

setExecuteNow

When this field is set to true, the event will be executed at the earliest time that the server can schedule the event and execution_time will be populated with the time that the server actually schedules the event.

Parameter
Name Description
var bool
Returns
Type Description
$this

getExecutionTime

The time to execute the event. If you set execute_now to true, then do not set this field in the CreateEvent request. In this case, the server schedules the event and populates this field. If you set execute_now to false, then you must set this field to at least 10 seconds in the future or else the event can't be created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasExecutionTime

clearExecutionTime

setExecutionTime

The time to execute the event. If you set execute_now to true, then do not set this field in the CreateEvent request. In this case, the server schedules the event and populates this field. If you set execute_now to false, then you must set this field to at least 10 seconds in the future or else the event can't be created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getState

Output only. The state of the event.

Returns
Type Description
int

setState

Output only. The state of the event.

Parameter
Name Description
var int
Returns
Type Description
$this

getError

Output only. An error object that describes the reason for the failure.

This property is always present when state is FAILED.

Returns
Type Description
Google\Rpc\Status|null

hasError

clearError

setError

Output only. An error object that describes the reason for the failure.

This property is always present when state is FAILED.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this

getTask

Returns
Type Description
string