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

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

Methods

__construct

Constructor.

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

Required. Switches to another input stream.

↳ ad_break Google\Cloud\Video\LiveStream\V1\Event\AdBreakTask

Required. Inserts a new ad opportunity.

↳ return_to_program Google\Cloud\Video\LiveStream\V1\Event\ReturnToProgramTask

Required. Stops any running ad break.

↳ mute Google\Cloud\Video\LiveStream\V1\Event\MuteTask

Required. Mutes the stream.

↳ unmute Google\Cloud\Video\LiveStream\V1\Event\UnmuteTask

Required. 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
TypeDescription
string

setName

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

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

getInputSwitch

Required. Switches to another input stream.

Returns
TypeDescription
Google\Cloud\Video\LiveStream\V1\Event\InputSwitchTask|null

hasInputSwitch

setInputSwitch

Required. Switches to another input stream.

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

getAdBreak

Required. Inserts a new ad opportunity.

Returns
TypeDescription
Google\Cloud\Video\LiveStream\V1\Event\AdBreakTask|null

hasAdBreak

setAdBreak

Required. Inserts a new ad opportunity.

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

getReturnToProgram

Required. Stops any running ad break.

Returns
TypeDescription
Google\Cloud\Video\LiveStream\V1\Event\ReturnToProgramTask|null

hasReturnToProgram

setReturnToProgram

Required. Stops any running ad break.

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

getMute

Required. Mutes the stream.

Returns
TypeDescription
Google\Cloud\Video\LiveStream\V1\Event\MuteTask|null

hasMute

setMute

Required. Mutes the stream.

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

getUnmute

Required. Unmutes the stream.

Returns
TypeDescription
Google\Cloud\Video\LiveStream\V1\Event\UnmuteTask|null

hasUnmute

setUnmute

Required. Unmutes the stream.

Parameter
NameDescription
var Google\Cloud\Video\LiveStream\V1\Event\UnmuteTask
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getState

Output only. The state of the event.

Returns
TypeDescription
int

setState

Output only. The state of the event.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getError

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

This property is always present when state is FAILED.

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

getTask

Returns
TypeDescription
string