andesitejs / Exports / api/types

Module: api/types

Table of contents

Interfaces

• Band
• ConnectOptions
• CreatePlayerOptions
• DiscordVoiceServer
• DiscordVoiceState
• Equalizer
• EventBase
• Exception
• FilterMap
• Karaoke
• LoadTracksResponse
• MixerPlayer
• NodeMetadata
• NodeOptions
• NodeStats
• PlayOptions
• PlayerManagerOptions
• PlayerState
• PlaylistInfo
• ReconnectionOptions
• StackFrame
• Timescale
• TrackEndEvent
• TrackExceptionEvent
• TrackInfo
• TrackMetadata
• TrackStartEvent
• TrackStuckEvent
• Tremolo
• UpdatePlayer
• Vibrato
• VoiceServerUpdate
• Volume
• WebSocketClosedEvent

Type aliases

• Dictionary
• Event
• EventType
• LoadTypes
• PlayerTransport
• SendMethod
• TrackEndReason

Type aliases

Dictionary

Ƭ Dictionary<T>: Record<string, T>

Type parameters:

Name	Default
T	any

Defined in: api/types.ts:766

---

Event

Ƭ Event: TrackStartEvent | TrackEndEvent | TrackExceptionEvent | TrackStuckEvent | WebSocketClosedEvent

Defined in: api/types.ts:770

---

EventType

Ƭ EventType: TrackStartEvent | TrackEndEvent | TrackExceptionEvent | TrackStuckEvent | WebSocketClosedEvent

Defined in: api/types.ts:774

---

LoadTypes

Ƭ LoadTypes: TRACK_LOADED | SEARCH_RESULT | PLAYLIST_LOADED | NO_MATCHES | LOAD_FAILED

• TRACK_LOADED - tracks will only have one track, playlistInfo, cause and severity will be null.
• SEARCH_RESULT - cause and severity will be null.
• PLAYLIST_LOADED - cause and severity will be null.
• NO_MATCHES - all other fields will be null.
• LOAD_FAILED - tracks and playlistInfo will be null.

Defined in: api/types.ts:789

---

PlayerTransport

Ƭ PlayerTransport: websocket | rest

"websocket" - controls the player via websocket "rest" - controls the player through the rest api.

Defined in: api/types.ts:764

---

SendMethod

Ƭ SendMethod: (id: string, payload: any) => any

Defined in: api/types.ts:768

---

TrackEndReason

Ƭ TrackEndReason: FINISHED | LOAD_FAILED | STOPPED | REPLACED | CLEANUP

Defined in: api/types.ts:772