Constructor
new Event(propertiesopt)
Constructs a new Event.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
google.cloud.video.livestream.v1.IEvent |
<optional> |
Properties to set |
- Implements:
-
- IEvent
Classes
Members
adBreak
Event adBreak.
createTime
Event createTime.
error
Event error.
executeNow
Event executeNow.
executionTime
Event executionTime.
inputSwitch
Event inputSwitch.
labels
Event labels.
mute
Event mute.
name
Event name.
returnToProgram
Event returnToProgram.
slate
Event slate.
state
Event state.
task
Event task.
unmute
Event unmute.
updateTime
Event updateTime.
State
State enum.
Properties:
Name | Type | Description |
---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
SCHEDULED |
number |
SCHEDULED value |
RUNNING |
number |
RUNNING value |
SUCCEEDED |
number |
SUCCEEDED value |
FAILED |
number |
FAILED value |
PENDING |
number |
PENDING value |
STOPPED |
number |
STOPPED value |
Methods
toJSON() → {Object.<string, *>}
Converts this Event to JSON.
Returns:
Type | Description |
---|---|
Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.video.livestream.v1.Event}
Creates a new Event instance using the specified properties.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
properties |
google.cloud.video.livestream.v1.IEvent |
<optional> |
Properties to set |
Returns:
Type | Description |
---|---|
google.cloud.video.livestream.v1.Event |
Event instance |
(static) decode(reader, lengthopt) → {google.cloud.video.livestream.v1.Event}
Decodes an Event message from the specified reader or buffer.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
Type | Description |
---|---|
google.cloud.video.livestream.v1.Event |
Event |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.video.livestream.v1.Event}
Decodes an Event message from the specified reader or buffer, length delimited.
Parameters:
Name | Type | Description |
---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
Type | Description |
---|---|
google.cloud.video.livestream.v1.Event |
Event |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Event message. Does not implicitly verify messages.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
google.cloud.video.livestream.v1.IEvent |
Event message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
Type | Description |
---|---|
$protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Event message, length delimited. Does not implicitly verify messages.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
google.cloud.video.livestream.v1.IEvent |
Event message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
Type | Description |
---|---|
$protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.video.livestream.v1.Event}
Creates an Event message from a plain object. Also converts values to their respective internal types.
Parameters:
Name | Type | Description |
---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
Type | Description |
---|---|
google.cloud.video.livestream.v1.Event |
Event |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Event
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
Type | Description |
---|---|
string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from an Event message. Also converts values to other types if specified.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
message |
google.cloud.video.livestream.v1.Event |
Event |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
Type | Description |
---|---|
Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies an Event message.
Parameters:
Name | Type | Description |
---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
Type | Description |
---|---|
string | null |
|