Class SmartPreviewParams

Parameters describing the "smart" (auto-selected) preview of a track.

Hierarchy (View Summary)

YandexMusicModel
- SmartPreviewParams

Index

Constructors

Properties

client? durationMs? fade?

Methods

deJson requireClient

Constructors

constructor

new SmartPreviewParams(client?: Client): SmartPreviewParams
Parameters
- Optionalclient: Client
  The owning client, stored for later convenience calls.
Returns SmartPreviewParams
Inherited from YandexMusicModel.constructor
- Defined in src/base.ts:177

Properties

`Optional`client

client?: Client

The client that created this model, used by convenience methods.

`Optional`durationMs

durationMs?: number

Preview duration in milliseconds.

`Optional`fade

fade?: Fade

Fade timing for the preview.

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): SmartPreviewParams | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns SmartPreviewParams | null
See
SmartPreviewParams
- Defined in src/models/track/nested.ts:119

`Protected`requireClient

requireClient(): Client
Assert that this model carries a client, returning it narrowed to non-null.

Convenience methods that need to call the API use this to fail fast with a clear message instead of a generic "cannot read property of undefined".

Returns Client
The owning Client.

Throws
When the model was created without a client.
Inherited from YandexMusicModel.requireClient
- Defined in src/base.ts:190