Represents a Companion.
Package
@google-cloud/video-stitcherConstructors
(constructor)(properties)
constructor(properties?: google.cloud.video.stitcher.v1.ICompanion);Constructs a new Companion.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICompanion
Properties to set |
Properties
adResource
public adResource?: ("iframeAdResource"|"staticAdResource"|"htmlAdResource");Companion adResource.
adSlotId
public adSlotId: string;Companion adSlotId.
apiFramework
public apiFramework: string;Companion apiFramework.
assetHeightPx
public assetHeightPx: number;Companion assetHeightPx.
assetWidthPx
public assetWidthPx: number;Companion assetWidthPx.
events
public events: google.cloud.video.stitcher.v1.IEvent[];Companion events.
expandedHeightPx
public expandedHeightPx: number;Companion expandedHeightPx.
expandedWidthPx
public expandedWidthPx: number;Companion expandedWidthPx.
heightPx
public heightPx: number;Companion heightPx.
htmlAdResource
public htmlAdResource?: (google.cloud.video.stitcher.v1.IHtmlAdResource|null);Companion htmlAdResource.
iframeAdResource
public iframeAdResource?: (google.cloud.video.stitcher.v1.IIframeAdResource|null);Companion iframeAdResource.
staticAdResource
public staticAdResource?: (google.cloud.video.stitcher.v1.IStaticAdResource|null);Companion staticAdResource.
widthPx
public widthPx: number;Companion widthPx.
Methods
create(properties)
public static create(properties?: google.cloud.video.stitcher.v1.ICompanion): google.cloud.video.stitcher.v1.Companion;Creates a new Companion instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ICompanion
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Companion | Companion instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.video.stitcher.v1.Companion;Decodes a Companion message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Companion | Companion |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.video.stitcher.v1.Companion;Decodes a Companion message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Companion | Companion |
encode(message, writer)
public static encode(message: google.cloud.video.stitcher.v1.ICompanion, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Companion message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICompanion
Companion message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.video.stitcher.v1.ICompanion, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Companion message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ICompanion
Companion message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.video.stitcher.v1.Companion;Creates a Companion message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Companion | Companion |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Companion
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Companion to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.video.stitcher.v1.Companion, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Companion message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Companion
Companion |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Companion message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|