andesitejs / Exports / api/types / PlayerState

Interface: PlayerState

api/types.PlayerState

Hierarchy

• PlayerState

Table of contents

Properties

• filters
• mixer
• mixerEnabled
• paused
• position
• time
• volume

Properties

filters

• filters: FilterMap

Map of filter name -> filter settings for each filter present.

Defined in: api/types.ts:615

---

mixer

• mixer: MixerPlayer

Map of mixer player id -> mixer player

Defined in: api/types.ts:620

---

mixerEnabled

• mixerEnabled: boolean

Whether or not the mixer is the current source of audio.

Defined in: api/types.ts:625

---

paused

• paused: boolean

Whether or not the player is paused

Defined in: api/types.ts:605

---

position

• position: null | number

Position of the current playing track, or null if nothing is playing

Defined in: api/types.ts:600

---

time

• time: string

Current unix timestamp on the node.

Defined in: api/types.ts:595

---

volume

• volume: boolean

The volume of the player.

Defined in: api/types.ts:610