Skip to main content

Class: MediaData

Defined in: WAProto/index.d.ts:16430

Represents a MediaData.

Implements​

Constructors​

new MediaData()​

new MediaData(properties?): MediaData

Defined in: WAProto/index.d.ts:16436

Constructs a new MediaData.

Parameters​

properties?​

IMediaData

Properties to set

Returns​

MediaData

Properties​

localPath?​

optional localPath: null | string

Defined in: WAProto/index.d.ts:16439

MediaData localPath.

Implementation of​

IMediaData.localPath

Methods​

toJSON()​

toJSON(): object

Defined in: WAProto/index.d.ts:16509

Converts this MediaData to JSON.

Returns​

object

JSON object

create()​

static create(properties?): MediaData

Defined in: WAProto/index.d.ts:16446

Creates a new MediaData instance using the specified properties.

Parameters​

properties?​

IMediaData

Properties to set

Returns​

MediaData

MediaData instance

decode()​

static decode(reader, length?): MediaData

Defined in: WAProto/index.d.ts:16472

Decodes a MediaData message from the specified reader or buffer.

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

length?​

number

Message length if known beforehand

Returns​

MediaData

MediaData

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): MediaData

Defined in: WAProto/index.d.ts:16481

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

Parameters​

reader​

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns​

MediaData

MediaData

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:16454

Encodes the specified MediaData message. Does not implicitly verify messages.

Parameters​

message​

IMediaData

MediaData message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:16462

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

Parameters​

message​

IMediaData

MediaData message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): MediaData

Defined in: WAProto/index.d.ts:16495

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

Parameters​

object​

Plain object

Returns​

MediaData

MediaData

getTypeUrl()​

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:16516

Gets the default type url for MediaData

Parameters​

typeUrlPrefix?​

string

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

Returns​

string

The default type url

toObject()​

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:16503

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

Parameters​

message​

MediaData

MediaData

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object

verify()​

static verify(message): null | string

Defined in: WAProto/index.d.ts:16488

Verifies a MediaData message.

Parameters​

message​

Plain object to verify

Returns​

null | string

null if valid, otherwise the reason why it is not