Class protos.google.cloud.video.transcoder.v1.SpriteSheet (3.0.3)

Represents a SpriteSheet.

Package

@google-cloud/video-transcoder

Constructors

(constructor)(properties)

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

Constructs a new SpriteSheet.

Parameter
NameDescription
properties ISpriteSheet

Properties to set

Properties

columnCount

public columnCount: number;

SpriteSheet columnCount.

endTimeOffset

public endTimeOffset?: (google.protobuf.IDuration|null);

SpriteSheet endTimeOffset.

extractionStrategy

public extractionStrategy?: ("totalCount"|"interval");

SpriteSheet extractionStrategy.

filePrefix

public filePrefix: string;

SpriteSheet filePrefix.

format

public format: string;

SpriteSheet format.

interval

public interval?: (google.protobuf.IDuration|null);

SpriteSheet interval.

quality

public quality: number;

SpriteSheet quality.

rowCount

public rowCount: number;

SpriteSheet rowCount.

spriteHeightPixels

public spriteHeightPixels: number;

SpriteSheet spriteHeightPixels.

spriteWidthPixels

public spriteWidthPixels: number;

SpriteSheet spriteWidthPixels.

startTimeOffset

public startTimeOffset?: (google.protobuf.IDuration|null);

SpriteSheet startTimeOffset.

totalCount

public totalCount?: (number|null);

SpriteSheet totalCount.

Methods

create(properties)

public static create(properties?: google.cloud.video.transcoder.v1.ISpriteSheet): google.cloud.video.transcoder.v1.SpriteSheet;

Creates a new SpriteSheet instance using the specified properties.

Parameter
NameDescription
properties ISpriteSheet

Properties to set

Returns
TypeDescription
SpriteSheet

SpriteSheet instance

decode(reader, length)

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

Decodes a SpriteSheet message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
SpriteSheet

SpriteSheet

decodeDelimited(reader)

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

Decodes a SpriteSheet message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
SpriteSheet

SpriteSheet

encode(message, writer)

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

Encodes the specified SpriteSheet message. Does not implicitly messages.

Parameters
NameDescription
message ISpriteSheet

SpriteSheet message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message ISpriteSheet

SpriteSheet message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.video.transcoder.v1.SpriteSheet;

Creates a SpriteSheet message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
SpriteSheet

SpriteSheet

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for SpriteSheet

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this SpriteSheet to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message SpriteSheet

SpriteSheet

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a SpriteSheet message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not