audio

Documentation

Index

• Variables
• func LoopOff(place int64) error
• func LoopOn(place int64) error
• func Pause(place int64) error
• func Resume(place int64) error
• func Skip(place int64) error
• type Item
  • func GetInfo(url string) (Item, error)
  • func Play(args []string, sp core.AudioSpeaker, place int64) (Item, error, error)
  • func Queue(place int64) ([]Item, error)
• type Playing

Variables

var (
	ErrNotPaused        = errors.New("Not paused.")
	ErrNotPlaying       = errors.New("Not playing anything.")
	ErrNotLooping       = errors.New("Not looping.")
	ErrSiteNotSupported = errors.New("This website is not supported.")
)

var Advanced = advanced{}

var AdvancedLoop = advancedLoop{}

var AdvancedLoopOff = advancedLoopOff{}

var AdvancedLoopOn = advancedLoopOn{}

var AdvancedPause = advancedPause{}

var AdvancedPlay = advancedPlay{}

var AdvancedQueue = advancedQueue{}

var AdvancedResume = advancedResume{}

var AdvancedSkip = advancedSkip{}

Functions

func LoopOff

func LoopOff(place int64) error

LoopOff will turn looping off by setting the state to Play for the specified place. Returns ErrNotPlaying if the queue is empty. Returns ErrNotLooping if the current state is not Loop.

func LoopOn

func LoopOn(place int64) error

LoopOn will turn on looping by setting the state to Loop for the specified place. Returns an ErrNotPlaying if the queue is empty.

func Pause

func Pause(place int64) error

Pause will pause by setting the state to Pause in the specified place. Returns ErrNotPlaying if the queue is empty or if the state is not set to Play.

func Resume

func Resume(place int64) error

Resume will resume playback by setting the state to Play in the specified place. Returns an ErrNotPlaying if the queue is empty. Returns ErrNotPaused if the state is not set to Pause.

func Skip

func Skip(place int64) error

Skip will skip the currenly playing item by setting the state to Stop in the specified place, which will exit the currenly playing item allowing for the next one to be played. Returns ErrNotPlaying if the queue is empty.

Types

type Item

type Item struct {
	URL   string `json:"webpage_url"`
	Title string `json:"title"`
}

func GetInfo

func GetInfo(url string) (Item, error)

func Play

func Play(args []string, sp core.AudioSpeaker, place int64) (Item, error, error)

Play will:

• Check if the first argument is a url, if yes, then will try to stream it. If not then assumes that it is a search and will query youtube to find the corresponding video.
• Join the voice channel if necessary.
• Adds the item in the queue, if no queue exists creates one and begins item playback.

Returns ErrSiteNotSupported if the provided URL is a website that is not supported. Also passes any potential user errors that were generated by youtube.SearchVideo if a video search was performed.

func Queue

func Queue(place int64) ([]Item, error)

Queue returns the list of items that are currenly in the queue. The first item is the one that is currenly active. Returns ErrNotPlaying if the queue is empty.

type Playing

type Playing struct {
	State *core.AudioState
	Queue *gosafe.Slice[Item]
}