SpriteSheet

google.cloud.video.transcoder.v1. SpriteSheet

Represents a SpriteSheet.

Constructor

new SpriteSheet(propertiesopt)

Constructs a new SpriteSheet.

Parameters:
Name Type Attributes Description
properties google.cloud.video.transcoder.v1.ISpriteSheet <optional>

Properties to set

Implements:
  • ISpriteSheet

Members

columnCount

SpriteSheet columnCount.

endTimeOffset

SpriteSheet endTimeOffset.

extractionStrategy

SpriteSheet extractionStrategy.

filePrefix

SpriteSheet filePrefix.

format

SpriteSheet format.

interval

SpriteSheet interval.

quality

SpriteSheet quality.

rowCount

SpriteSheet rowCount.

spriteHeightPixels

SpriteSheet spriteHeightPixels.

spriteWidthPixels

SpriteSheet spriteWidthPixels.

startTimeOffset

SpriteSheet startTimeOffset.

totalCount

SpriteSheet totalCount.

Methods

(static) create(propertiesopt) → {google.cloud.video.transcoder.v1.SpriteSheet}

Creates a new SpriteSheet instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.video.transcoder.v1.ISpriteSheet <optional>

Properties to set

Returns:
Type Description
google.cloud.video.transcoder.v1.SpriteSheet

SpriteSheet instance

(static) decode(reader, lengthopt) → {google.cloud.video.transcoder.v1.SpriteSheet}

Decodes a SpriteSheet 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.transcoder.v1.SpriteSheet

SpriteSheet

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.transcoder.v1.SpriteSheet}

Decodes a SpriteSheet 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.transcoder.v1.SpriteSheet

SpriteSheet

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 SpriteSheet message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.video.transcoder.v1.ISpriteSheet

SpriteSheet 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 SpriteSheet message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.video.transcoder.v1.ISpriteSheet

SpriteSheet 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.transcoder.v1.SpriteSheet}

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

SpriteSheet

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.video.transcoder.v1.SpriteSheet

SpriteSheet

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a SpriteSheet message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this SpriteSheet to JSON.

Returns:
Type Description
Object.<string, *>

JSON object