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

Represents a SpriteSheet.

Package

@google-cloud/video-transcoder!

Constructors

(constructor)(properties)

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

Constructs a new SpriteSheet.

Parameter
Name Description
properties ISpriteSheet

Properties to set

Properties

columnCount

public columnCount: number;

SpriteSheet columnCount.

Property Value
Type Description
number

endTimeOffset

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

SpriteSheet endTimeOffset.

Property Value
Type Description
(google.protobuf.IDuration|null)

extractionStrategy

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

SpriteSheet extractionStrategy.

Property Value
Type Description
("totalCount"|"interval")

filePrefix

public filePrefix: string;

SpriteSheet filePrefix.

Property Value
Type Description
string

format

public format: string;

SpriteSheet format.

Property Value
Type Description
string

interval

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

SpriteSheet interval.

Property Value
Type Description
(google.protobuf.IDuration|null)

quality

public quality: number;

SpriteSheet quality.

Property Value
Type Description
number

rowCount

public rowCount: number;

SpriteSheet rowCount.

Property Value
Type Description
number

spriteHeightPixels

public spriteHeightPixels: number;

SpriteSheet spriteHeightPixels.

Property Value
Type Description
number

spriteWidthPixels

public spriteWidthPixels: number;

SpriteSheet spriteWidthPixels.

Property Value
Type Description
number

startTimeOffset

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

SpriteSheet startTimeOffset.

Property Value
Type Description
(google.protobuf.IDuration|null)

totalCount

public totalCount?: (number|null);

SpriteSheet totalCount.

Property Value
Type Description
(number|null)

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
Name Description
properties ISpriteSheet

Properties to set
Returns
Type Description
google.cloud.video.transcoder.v1.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
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.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
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.video.transcoder.v1.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
Name Description
message ISpriteSheet

SpriteSheet 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.ISpriteSheet, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISpriteSheet

SpriteSheet 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.SpriteSheet;

Creates a SpriteSheet 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.SpriteSheet

SpriteSheet

toJSON()

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

Converts this SpriteSheet to JSON.

Returns
Type Description
{ [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
Name Description
message google.cloud.video.transcoder.v1.SpriteSheet

SpriteSheet
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 SpriteSheet 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