lavaqueue

package module
v0.0.0-...-924e484 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 10, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

README

lavaqueue-plugin

Documentation

Index

Constants

View Source
const (
	EventTypeQueueEnd lavalink.EventType = "QueueEndEvent"
)

Variables

This section is empty.

Functions

func AddQueueTracks

func AddQueueTracks(ctx context.Context, node disgolink.Node, guildID snowflake.ID, tracks []QueueTrack) (*lavalink.Track, error)

func ClearHistory

func ClearHistory(ctx context.Context, node disgolink.Node, guildID snowflake.ID) error

func ClearQueue

func ClearQueue(ctx context.Context, node disgolink.Node, guildID snowflake.ID) error

func GetHistory

func GetHistory(ctx context.Context, node disgolink.Node, guildID snowflake.ID) ([]lavalink.Track, error)

func QueueNextTrack

func QueueNextTrack(ctx context.Context, node disgolink.Node, guildID snowflake.ID) (*lavalink.Track, error)

func QueuePreviousTrack

func QueuePreviousTrack(ctx context.Context, node disgolink.Node, guildID snowflake.ID) (*lavalink.Track, error)

func RemoveQueueTrack

func RemoveQueueTrack(ctx context.Context, node disgolink.Node, guildID snowflake.ID, trackID int) error

func ShuffleQueue

func ShuffleQueue(ctx context.Context, node disgolink.Node, guildID snowflake.ID) error

func UpdateQueue

func UpdateQueue(ctx context.Context, node disgolink.Node, guildID snowflake.ID, queue QueueUpdate) (*lavalink.Track, error)

Types

type LavaQueueEventListener

type LavaQueueEventListener interface {
	OnQueueEnd(player disgolink.Player, event QueueEndEvent)
}

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

func New

func New() *Plugin

func NewWithLogger

func NewWithLogger(logger *slog.Logger) *Plugin

func (*Plugin) EventPlugins

func (p *Plugin) EventPlugins() []disgolink.EventPlugin

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) Version

func (p *Plugin) Version() string

type Queue

type Queue struct {
	Type   QueueType        `json:"type"`
	Tracks []lavalink.Track `json:"tracks"`
}

func GetQueue

func GetQueue(ctx context.Context, node disgolink.Node, guildID snowflake.ID) (*Queue, error)

type QueueEndEvent

type QueueEndEvent struct {
	GuildID_ snowflake.ID `json:"guild_id"`
}

func (QueueEndEvent) GuildID

func (e QueueEndEvent) GuildID() snowflake.ID

func (QueueEndEvent) Op

func (QueueEndEvent) Op() lavalink.Op

func (QueueEndEvent) Type

type QueueTrack

type QueueTrack struct {
	Encoded  string           `json:"encoded"`
	UserData lavalink.RawData `json:"userData,omitempty"`
}

type QueueType

type QueueType string
const (
	QueueTypeNormal      QueueType = "normal"
	QueueTypeRepeatTrack QueueType = "repeat_track"
	QueueTypeRepeatQueue QueueType = "repeat_queue"
)

type QueueUpdate

type QueueUpdate struct {
	Type   *QueueType    `json:"type,omitempty"`
	Tracks *[]QueueTrack `json:"tracks,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL