Class protos.google.cloud.video.transcoder.v1.Overlay (1.6.1)

Represents an Overlay.

Package

@google-cloud/video-transcoder!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.video.transcoder.v1.IOverlay);

Constructs a new Overlay.

Parameter
Name Description
properties IOverlay

Properties to set

Properties

animations

public animations: google.cloud.video.transcoder.v1.Overlay.IAnimation[];

Overlay animations.

Property Value
Type Description
google.cloud.video.transcoder.v1.Overlay.IAnimation[]

image

public image?: (google.cloud.video.transcoder.v1.Overlay.IImage|null);

Overlay image.

Property Value
Type Description
(google.cloud.video.transcoder.v1.Overlay.IImage|null)

Methods

create(properties)

public static create(properties?: google.cloud.video.transcoder.v1.IOverlay): google.cloud.video.transcoder.v1.Overlay;

Creates a new Overlay instance using the specified properties.

Parameter
Name Description
properties IOverlay

Properties to set
Returns
Type Description
google.cloud.video.transcoder.v1.Overlay

Overlay instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.video.transcoder.v1.Overlay;

Decodes an Overlay message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.video.transcoder.v1.Overlay

Overlay

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.video.transcoder.v1.Overlay;

Decodes an Overlay message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.video.transcoder.v1.Overlay

Overlay

encode(message, writer)

public static encode(message: google.cloud.video.transcoder.v1.IOverlay, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Overlay message. Does not implicitly messages.

Parameters
Name Description
message IOverlay

Overlay 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.transcoder.v1.IOverlay, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Overlay message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IOverlay

Overlay 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.transcoder.v1.Overlay;

Creates an Overlay 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
google.cloud.video.transcoder.v1.Overlay

Overlay

toJSON()

public toJSON(): { [k: string]: any };

Converts this Overlay to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.video.transcoder.v1.Overlay, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an Overlay message. Also converts values to other types if specified.

Parameters
Name Description
message google.cloud.video.transcoder.v1.Overlay

Overlay
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 an Overlay message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not