StarMusic
Opciones
Todo
  • Público
  • Público/Protegido
  • Todo
Menú

Clase base de módulo, dividiendo las funciones internas de las públicas

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Music(options: MusicOpts): Music

  • Crea una instancia de StarMusic.

    memberof

    Music

    Parameters

    • options: MusicOpts

    Returns Music

Properties

Protected _admin_roles

_admin_roles: string[]

IDs de roles que se consideran como admins en el servidor.

Protected _any_pause

_any_pause: boolean

Si cualquiera puede pausar el bot en el servidor.

Protected _any_skip

_any_skip: boolean

Si cualquiera puede saltar una canción del bot en el servidor.

Protected _any_take_out

_any_take_out: boolean

Si cualquiera puede sacarl al bot de un canal.

Protected _bitrate

_bitrate: number | "auto"

Tasa de bits a manejar.

Protected _dj_roles

_dj_roles: string[]

IDs de roles que se consideran como DJ en el servidor.

Protected _embed_color

_embed_color: number

Color principal de los embeds.

Protected _emoji

_emoji: string

Emoji que se usará en el embed de reproducción.

Protected _just_dj

_just_dj: boolean

Si solamente podrán poner música los que tengan el/los roles de DJ.

Protected _max_tail

_max_tail: number

Cola máxima que manejará el bot.

Protected _new_song_message

_new_song_message: boolean

Si se mandará un mensaje cada vez que comience una nueva canción.

Protected _radio_station

_radio_station: string

Link de la estación por defecto para la radio.

Protected _show_name

_show_name: boolean

Si se mostrará el nombre del que use los comandos.

Protected _subscriptions

_subscriptions: Map<string, MusicSubscription> = ...

Colección de subscriciones de cada servidor, asignados por su ID.

Protected _youtube

_youtube: YouTube

Instancia de popyt para hacer búsquedas en YouTube.

Protected _youtubeKey

_youtubeKey: string

Clave de la API de Youtube Para obtener detalles sobre cómo obtener una clave de API y crear un proyecto, visite este enlace

Accessors

subscriptions

  • Obtén la colección de subscriciones de cada servidor, asignados por su ID.

    Returns Map<string, MusicSubscription>

Methods

Abstract clear

  • clear(message: Message | CommandInteraction): void

  • Limpia la cola actual de reproducción.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    Returns void

Protected connectBot

  • Conecta al bot en un canal de voz.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord

    Returns Promise<MusicSubscription>

Protected createSong

  • createSong(message: Message | CommandInteraction, url: string): Promise<Song>

  • Crea una canción con su información para añadirla a la cola.

    Parameters

    • message: Message | CommandInteraction
    • url: string

    Returns Promise<Song>

Protected getSong

  • getSong(message: Message | CommandInteraction): Song

  • Parameters

    • message: Message | CommandInteraction

    Returns Song

Protected isAdmin

  • isAdmin(member: GuildMember): Promise<boolean>

  • Validar si el usuario es administrador.

    Parameters

    • member: GuildMember

      Un usuario de un servidor de Discord

    Returns Promise<boolean>

Protected isDj

  • isDj(member: GuildMember): Promise<boolean>

  • Validar si el usuario tiene rol de Dj.

    Parameters

    • member: GuildMember

      Un usuario de un servidor de Discord.

    Returns Promise<boolean>

Protected isStreamValid

  • isStreamValid(url: string): boolean

  • Evalúa un string si es válido como url de transmición de audio.

    Parameters

    • url: string

      URL a evaluar.

    Returns boolean

    Si es válido el url.

Abstract leave

  • leave(message: Message | CommandInteraction): void

  • Saca al bot del canal de voz actual.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    Returns void

Protected musicArraySort

  • musicArraySort(array: Song[], n: number): Song[][]

  • Parameters

    • array: Song[]
    • n: number

      Cantidad de datos a retornar.

    Returns Song[][]

Protected notaMsg

  • notaMsg(type: "wrap" | "note" | "search" | "fail" | "font" | "error", text: string): string

  • Mandar mensaje estilizado.

    Parameters

    • type: "wrap" | "note" | "search" | "fail" | "font" | "error"

      El tipo de mensaje que se mandará.

    • text: string

      Mensaje a mandar.

    Returns string

Abstract np

  • np(message: Message | CommandInteraction): void

  • Ve lo que se está reproduciendo actualmente

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    Returns void

Abstract pause

  • pause(message: Message | CommandInteraction): void

  • Coloca pausa a la reproducción actual del bot.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    Returns void

Abstract play

  • play(message: Message | CommandInteraction, search: string): void

  • Reproduce una canción su nombre o la URL.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    • search: string

      Canción a reproducir.

    Returns void

Protected playSong

  • playSong(message: Message | CommandInteraction, song: Song): void

  • Función principal que reproduce la canción.

    Parameters

    • message: Message | CommandInteraction
    • song: Song

    Returns void

Protected progressBar

  • progressBar(message: Message | CommandInteraction, res: Song): Promise<void>

  • Manda el mensaje de barra de progreso de la canción en reproducción.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    • res: Song

      Canción en reproducción.

    Returns Promise<void>

Abstract queue

  • queue(message: Message | CommandInteraction, song?: number): void

  • Ve la cola de reproducción actual.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    • Optional song: number

      Número de la canción en cola.

    Returns void

Abstract radio

  • radio(message: Message | CommandInteraction, stream?: string): void

  • Inicia la radio.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    • Optional stream: string

      URL de la estación de radio a escuchar.

    Returns void

Abstract remove

  • remove(message: Message | CommandInteraction, song: number): void

  • Quita una canción de la cola de producción.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    • song: number

      Número de la posisión de la canción a quitar

    Returns void

Abstract repeat

  • repeat(message: Message | CommandInteraction, song?: 0 | 1 | 2 | 3): Promise<void>

  • Establece el modo de repetición de la lista de canciones o canción actual.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    • Optional song: 0 | 1 | 2 | 3

      Modo. Si no pasa esta propiedad el modo se establecerá al siguiente de la lista. Modos:

      • 1: Modo repetir una canción.
      • 2: Repetir todas las canciones.
      • 0 | 3: Desactivar modo repetir.

    Returns Promise<void>

Abstract resume

  • resume(message: Message | CommandInteraction): void

  • Reanuda la reproducción previamente pausada.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    Returns void

Abstract search

  • search(message: Message | CommandInteraction, search: string): void

  • Busca una lista de canciones para reproducir una de ellas.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    • search: string

      Nombre de canciones a buscar.

    Returns void

Protected sendMessage

  • sendMessage(message: Message | CommandInteraction, video: Song): Promise<void>

  • Manda el mensaje de reproducción con la información del vídeo.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    • video: Song

      Vídeo a mostrar.

    Returns Promise<void>

Protected sendMessageAddQueue

  • sendMessageAddQueue(message: Message | CommandInteraction, video: Song): Promise<void>

  • Parameters

    • message: Message | CommandInteraction
    • video: Song

    Returns Promise<void>

Protected sendReply

  • sendReply(message: Message | CommandInteraction, options: string | (MessageOptions & { ephemeral?: boolean; split?: false })): Promise<Message>

  • Procesa el envío de un mensaje para un comando normal o para una interacción.

    Parameters

    • message: Message | CommandInteraction

      Una instancia de mensaje o CommandInteraction

    • options: string | (MessageOptions & { ephemeral?: boolean; split?: false })

      Mensaje a enviar

    Returns Promise<Message>

    EL objeto message enviado.

Abstract skip

  • skip(message: Message | CommandInteraction): void

  • Salta la canción en reproducción por la que sigue en la lista.

    Parameters

    • message: Message | CommandInteraction

      Un mensaje de Discord.

    Returns void

Leyenda

  • Constructor
  • Property
  • Method
  • Protected property
  • Protected method
  • Property
  • Inherited constructor
  • Private method

Generado usando TypeDoc