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.
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
↳ update_time
↳ labels
↳ input_switch
↳ ad_break
↳ return_to_program
↳ mute
↳ unmute
↳ 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}
.
string
setName
The resource name of the event, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}
.
var
string
$this
getCreateTime
Output only. The creation time.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation time.
$this
getUpdateTime
Output only. The update time.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The update time.
$this
getLabels
User-defined key/value metadata.
setLabels
User-defined key/value metadata.
$this
getInputSwitch
Required. Switches to another input stream.
hasInputSwitch
setInputSwitch
Required. Switches to another input stream.
$this
getAdBreak
Required. Inserts a new ad opportunity.
hasAdBreak
setAdBreak
Required. Inserts a new ad opportunity.
$this
getReturnToProgram
Required. Stops any running ad break.
hasReturnToProgram
setReturnToProgram
Required. Stops any running ad break.
$this
getMute
Required. Mutes the stream.
hasMute
setMute
Required. Mutes the stream.
$this
getUnmute
Required. Unmutes the stream.
hasUnmute
setUnmute
Required. Unmutes the stream.
$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.
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.
var
bool
$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.
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.
$this
getState
Output only. The state of the event.
int
setState
Output only. The state of the event.
var
int
$this
getError
Output only. An error object that describes the reason for the failure.
This property is always present when state
is FAILED
.
hasError
clearError
setError
Output only. An error object that describes the reason for the failure.
This property is always present when state
is FAILED
.
$this
getTask
string
