StarMusic

Por cada conexión de audio exite un MusicSubscription con la cola de reprodución y ajustes de la misma.

Hierarchy

MusicSubscription

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MusicSubscription(voiceConnection: VoiceConnection, __namedParameters: functionsData): MusicSubscription

- Defined in Suscription.ts:47
Parameters
- voiceConnection: VoiceConnection
- __namedParameters: functionsData
Returns MusicSubscription

Properties

Readonly audioPlayer

audioPlayer: AudioPlayer

Optional loop

loop: "single" | "all"

onAddQueue

onAddQueue: (song: Song) => void

Type declaration

- (song: Song): void
- Parameters
  - song: Song
  Returns void

Readonly onDestroy

onDestroy: () => void

Type declaration

- (): void
- Returns void

Readonly onError

onError: (error: unknown) => void

Type declaration

- (error: unknown): void
- Parameters
  - error: unknown
  Returns void

onFinish

onFinish: (subscription: MusicSubscription) => void

Type declaration

- (subscription: MusicSubscription): void
- Parameters
  - subscription: MusicSubscription
  Returns void

onStart

onStart: (song: Song) => void

Type declaration

- (song: Song): void
- Parameters
  - song: Song
  Returns void

queue

queue: Song[]

queueLock

queueLock: boolean = false

readyLock

readyLock: boolean = false

Readonly voiceConnection

voiceConnection: VoiceConnection

Methods

addedToQueue

addedToQueue(song: Song): void

- Defined in Suscription.ts:116
Agrega una nueva canción a la cola.

Parameters
- song: Song
Returns void

Private processQueue

processQueue(song?: Song): Promise<void>

- Defined in Suscription.ts:155
Reproduce una canción de la cola si es posible

Parameters
- Optional song: Song
  
  Una canción que es pasada desde addedToQueue.
Returns Promise<void>

No retorna nada.

removeQueue

removeQueue(song?: number): void

- Defined in Suscription.ts:135
Vacía la cola de reproducción o remueve una canción de ella.

Parameters
- song: number = -1
  
  Número de la posición de la canción a remover.
Returns void

setLoop

setLoop(loop?: "single" | "all"): void

- Defined in Suscription.ts:126
Establece el modo de reproducción de la cola actual.

Parameters
- Optional loop: "single" | "all"
  
  El valor a establecer
Returns void

stop

stop(): void

- Defined in Suscription.ts:143
Detiene la reproducción de audio y vacía la cola

Returns void

Generado usando TypeDoc