Constructor
new Event(propertiesopt)
Constructs a new Event.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.video.stitcher.v1.IEvent |
<optional> |
Properties to set |
- Implements:
-
- IEvent
Members
id
Event id.
offset
Event offset.
type
Event type.
uri
Event uri.
EventType
EventType enum.
Properties:
| Name | Type | Description |
|---|---|---|
EVENT_TYPE_UNSPECIFIED |
number |
EVENT_TYPE_UNSPECIFIED value |
CREATIVE_VIEW |
number |
CREATIVE_VIEW value |
START |
number |
START value |
BREAK_START |
number |
BREAK_START value |
BREAK_END |
number |
BREAK_END value |
IMPRESSION |
number |
IMPRESSION value |
FIRST_QUARTILE |
number |
FIRST_QUARTILE value |
MIDPOINT |
number |
MIDPOINT value |
THIRD_QUARTILE |
number |
THIRD_QUARTILE value |
COMPLETE |
number |
COMPLETE value |
PROGRESS |
number |
PROGRESS value |
MUTE |
number |
MUTE value |
UNMUTE |
number |
UNMUTE value |
PAUSE |
number |
PAUSE value |
CLICK |
number |
CLICK value |
CLICK_THROUGH |
number |
CLICK_THROUGH value |
REWIND |
number |
REWIND value |
RESUME |
number |
RESUME value |
ERROR |
number |
ERROR value |
EXPAND |
number |
EXPAND value |
COLLAPSE |
number |
COLLAPSE value |
CLOSE |
number |
CLOSE value |
CLOSE_LINEAR |
number |
CLOSE_LINEAR value |
SKIP |
number |
SKIP value |
ACCEPT_INVITATION |
number |
ACCEPT_INVITATION value |
Methods
toJSON() → {Object.<string, *>}
Converts this Event to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.video.stitcher.v1.Event}
Creates a new Event instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.video.stitcher.v1.IEvent |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.video.stitcher.v1.Event |
Event instance |
(static) decode(reader, lengthopt) → {google.cloud.video.stitcher.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.stitcher.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.stitcher.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.stitcher.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.stitcher.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.stitcher.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.stitcher.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.stitcher.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.stitcher.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 |
|