Class: EmbeddedMusic

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

Represents an EmbeddedMusic.

Implements

• IEmbeddedMusic

Constructors

new EmbeddedMusic()

new EmbeddedMusic(properties?): EmbeddedMusic

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

Constructs a new EmbeddedMusic.

Parameters

properties?

IEmbeddedMusic

Properties to set

Returns

EmbeddedMusic

Properties

artistAttribution?

optional artistAttribution: null | string

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

EmbeddedMusic artistAttribution.

Implementation of

IEmbeddedMusic.artistAttribution

---

artworkDirectPath?

optional artworkDirectPath: null | string

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

EmbeddedMusic artworkDirectPath.

Implementation of

IEmbeddedMusic.artworkDirectPath

---

artworkEncSha256?

optional artworkEncSha256: null | Uint8Array<ArrayBufferLike>

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

EmbeddedMusic artworkEncSha256.

Implementation of

IEmbeddedMusic.artworkEncSha256

---

artworkMediaKey?

optional artworkMediaKey: null | Uint8Array<ArrayBufferLike>

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

EmbeddedMusic artworkMediaKey.

Implementation of

IEmbeddedMusic.artworkMediaKey

---

artworkSha256?

optional artworkSha256: null | Uint8Array<ArrayBufferLike>

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

EmbeddedMusic artworkSha256.

Implementation of

IEmbeddedMusic.artworkSha256

---

author?

optional author: null | string

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

EmbeddedMusic author.

Implementation of

IEmbeddedMusic.author

---

countryBlocklist?

optional countryBlocklist: null | Uint8Array<ArrayBufferLike>

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

EmbeddedMusic countryBlocklist.

Implementation of

IEmbeddedMusic.countryBlocklist

---

isExplicit?

optional isExplicit: null | boolean

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

EmbeddedMusic isExplicit.

Implementation of

IEmbeddedMusic.isExplicit

---

musicContentMediaId?

optional musicContentMediaId: null | string

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

EmbeddedMusic musicContentMediaId.

Implementation of

IEmbeddedMusic.musicContentMediaId

---

songId?

optional songId: null | string

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

EmbeddedMusic songId.

Implementation of

IEmbeddedMusic.songId

---

title?

optional title: null | string

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

EmbeddedMusic title.

Implementation of

IEmbeddedMusic.title

Methods

toJSON()

toJSON(): object

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

Converts this EmbeddedMusic to JSON.

Returns

object

JSON object

---

create()

static create(properties?): EmbeddedMusic

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

Creates a new EmbeddedMusic instance using the specified properties.

Parameters

properties?

IEmbeddedMusic

Properties to set

Returns

EmbeddedMusic

EmbeddedMusic instance

---

decode()

static decode(reader, length?): EmbeddedMusic

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

Decodes an EmbeddedMusic 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

EmbeddedMusic

EmbeddedMusic

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): EmbeddedMusic

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

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

EmbeddedMusic

EmbeddedMusic

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:12645

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

Parameters

message

IEmbeddedMusic

EmbeddedMusic 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:12653

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

Parameters

message

IEmbeddedMusic

EmbeddedMusic message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): EmbeddedMusic

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

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

Parameters

object

Plain object

Returns

EmbeddedMusic

EmbeddedMusic

---

getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

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

Gets the default type url for EmbeddedMusic

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:12694

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

Parameters

message

EmbeddedMusic

EmbeddedMusic

options?

IConversionOptions

Conversion options

Returns

object

Plain object

---

verify()

static verify(message): null | string

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

Verifies an EmbeddedMusic message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not