Constructor
new Companion(propertiesopt)
Constructs a new Companion.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.video.stitcher.v1.ICompanion |
<optional> |
Properties to set |
- Implements:
-
- ICompanion
Members
adResource
Companion adResource.
adSlotId
Companion adSlotId.
apiFramework
Companion apiFramework.
assetHeightPx
Companion assetHeightPx.
assetWidthPx
Companion assetWidthPx.
events
Companion events.
expandedHeightPx
Companion expandedHeightPx.
expandedWidthPx
Companion expandedWidthPx.
heightPx
Companion heightPx.
htmlAdResource
Companion htmlAdResource.
iframeAdResource
Companion iframeAdResource.
staticAdResource
Companion staticAdResource.
widthPx
Companion widthPx.
Methods
toJSON() → {Object.<string, *>}
Converts this Companion to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.video.stitcher.v1.Companion}
Creates a new Companion instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.video.stitcher.v1.ICompanion |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.video.stitcher.v1.Companion |
Companion instance |
(static) decode(reader, lengthopt) → {google.cloud.video.stitcher.v1.Companion}
Decodes a Companion 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.Companion |
Companion |
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.Companion}
Decodes a Companion 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.Companion |
Companion |
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 Companion message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.video.stitcher.v1.ICompanion |
Companion 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 Companion message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.video.stitcher.v1.ICompanion |
Companion 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.Companion}
Creates a Companion 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.Companion |
Companion |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Companion
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 a Companion message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.video.stitcher.v1.Companion |
Companion |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Companion message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|