public sealed class Event : IMessage<Event>, IEquatable<Event>, IDeepCloneable<Event>, IBufferMessage, IMessageReference documentation and code samples for the Live Stream v1 API 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.
Namespace
Google.Cloud.Video.LiveStream.V1Assembly
Google.Cloud.Video.LiveStream.V1.dll
Constructors
Event()
public Event()Event(Event)
public Event(Event other)| Parameter | |
|---|---|
| Name | Description |
other |
Event |
Properties
AdBreak
public Event.Types.AdBreakTask AdBreak { get; set; }Inserts a new ad opportunity.
| Property Value | |
|---|---|
| Type | Description |
EventTypesAdBreakTask |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. The creation time.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Error
public Status Error { get; set; }Output only. An error object that describes the reason for the failure.
This property is always present when state is FAILED.
| Property Value | |
|---|---|
| Type | Description |
Status |
|
EventName
public EventName EventName { get; set; }| Property Value | |
|---|---|
| Type | Description |
EventName |
|
ExecuteNow
public bool ExecuteNow { get; set; }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][google.cloud.video.livestream.v1.Event.execution_time] will be populated with the time that the server actually schedules the event.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
ExecutionTime
public Timestamp ExecutionTime { get; set; }The time to execute the event. If you set
[execute_now][google.cloud.video.livestream.v1.Event.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][google.cloud.video.livestream.v1.Event.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.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
InputSwitch
public Event.Types.InputSwitchTask InputSwitch { get; set; }Switches to another input stream.
| Property Value | |
|---|---|
| Type | Description |
EventTypesInputSwitchTask |
|
Labels
public MapField<string, string> Labels { get; }User-defined key/value metadata.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Mute
public Event.Types.MuteTask Mute { get; set; }Mutes the stream.
| Property Value | |
|---|---|
| Type | Description |
EventTypesMuteTask |
|
Name
public string Name { get; set; }The resource name of the event, in the form of:
projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ReturnToProgram
public Event.Types.ReturnToProgramTask ReturnToProgram { get; set; }Stops any running ad break.
| Property Value | |
|---|---|
| Type | Description |
EventTypesReturnToProgramTask |
|
Slate
public Event.Types.SlateTask Slate { get; set; }Inserts a slate.
| Property Value | |
|---|---|
| Type | Description |
EventTypesSlateTask |
|
State
public Event.Types.State State { get; set; }Output only. The state of the event.
| Property Value | |
|---|---|
| Type | Description |
EventTypesState |
|
TaskCase
public Event.TaskOneofCase TaskCase { get; }| Property Value | |
|---|---|
| Type | Description |
EventTaskOneofCase |
|
Unmute
public Event.Types.UnmuteTask Unmute { get; set; }Unmutes the stream.
| Property Value | |
|---|---|
| Type | Description |
EventTypesUnmuteTask |
|
UpdateEncryptions
public Event.Types.UpdateEncryptionsTask UpdateEncryptions { get; set; }Updates encryption settings.
| Property Value | |
|---|---|
| Type | Description |
EventTypesUpdateEncryptionsTask |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. The update time.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|