soundboard

README

Soundboard

Soundboard plugin for YAGPDB

Folder structure:

Sounds waiting:

soundboard/queue/guildid/soundhash.extension

Transcoded sounds

soundboard/ready/guildid/soundhash.dca

Documentation

Index

• Constants
• Variables
• func CanPlaySound(s *models.SoundboardSound, roles []int64) bool
• func DownloadNewSoundFile(r io.Reader, w io.Writer, limit int) (tooBig bool, err error)
• func GetSoundboardSounds(guildID int64, ctx context.Context) ([]*models.SoundboardSound, error)
• func HandleDelete(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)
• func HandleGetCP(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)
• func HandleNew(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)
• func HandleUpdate(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)
• func KeySoundLock(id int) string
• func ListSounds(sounds []*models.SoundboardSound, ms *dstate.MemberState) string
• func MaxSoundsForContext(ctx context.Context) int
• func RegisterPlugin()
• func RequestPlaySound(guildID int64, channelID, channelRanFrom int64, soundID int) (queued bool)
• func SoundFilePath(id int, status TranscodingStatus) string
• type PlayRequest
• type Plugin
  • func (p *Plugin) AddCommands()
  • func (p *Plugin) InitWeb()
  • func (p *Plugin) LoadServerHomeWidget(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)
  • func (p *Plugin) PluginInfo() *common.PluginInfo
  • func (p *Plugin) RunBackgroundWorker()
  • func (p *Plugin) StopBackgroundWorker(wg *sync.WaitGroup)
• type PostForm
  • func (pf *PostForm) ToDBModel() *models.SoundboardSound
• type TranscodingStatus
  • func (s TranscodingStatus) String() string

Constants

const (
	MaxGuildSounds        = 50
	MaxGuildSoundsPremium = 250
)

const DBSchema = `` /* 1714-byte string literal not displayed */

Variables

var (
	ErrVoiceSendTimeout = errors.New("Voice send timeout")
)

var (
	Silence = []byte{0xF8, 0xFF, 0xFE}
)

Functions

func CanPlaySound

func CanPlaySound(s *models.SoundboardSound, roles []int64) bool

func DownloadNewSoundFile

func DownloadNewSoundFile(r io.Reader, w io.Writer, limit int) (tooBig bool, err error)

func GetSoundboardSounds

func GetSoundboardSounds(guildID int64, ctx context.Context) ([]*models.SoundboardSound, error)

func HandleDelete

func HandleDelete(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)

func HandleGetCP

func HandleGetCP(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)

func HandleNew

func HandleNew(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)

func HandleUpdate

func HandleUpdate(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)

func KeySoundLock

func KeySoundLock(id int) string

func ListSounds

func ListSounds(sounds []*models.SoundboardSound, ms *dstate.MemberState) string

func MaxSoundsForContext

func MaxSoundsForContext(ctx context.Context) int

func RegisterPlugin

func RegisterPlugin()

func RequestPlaySound

func RequestPlaySound(guildID int64, channelID, channelRanFrom int64, soundID int) (queued bool)

RequestPlaySound either queues up a sound to be played in an existing player or creates a new one

func SoundFilePath

func SoundFilePath(id int, status TranscodingStatus) string

Types

type PlayRequest

type PlayRequest struct {
	ChannelID      int64
	GuildID        int64
	CommandRanFrom int64
	Sound          int
}

type Plugin

type Plugin struct{}

func (*Plugin) AddCommands

func (p *Plugin) AddCommands()

func (*Plugin) InitWeb

func (p *Plugin) InitWeb()

func (*Plugin) LoadServerHomeWidget

func (p *Plugin) LoadServerHomeWidget(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)

func (*Plugin) PluginInfo

func (p *Plugin) PluginInfo() *common.PluginInfo

func (*Plugin) RunBackgroundWorker

func (p *Plugin) RunBackgroundWorker()

func (*Plugin) StopBackgroundWorker

func (p *Plugin) StopBackgroundWorker(wg *sync.WaitGroup)

type PostForm

type PostForm struct {
	ID   int
	Name string `valid:",100"`

	RequiredRoles    []int64 `valid:"role"`
	BlacklistedRoles []int64 `valid:"role"`
}

func (*PostForm) ToDBModel

func (pf *PostForm) ToDBModel() *models.SoundboardSound

type TranscodingStatus

type TranscodingStatus int

const (
	// In the transcoding queue
	TranscodingStatusQueued TranscodingStatus = iota
	// Done transcoding and ready to be played
	TranscodingStatusReady
	// Currently transcoding
	TranscodingStatusTranscoding
	// Failed transcoding, too long
	TranscodingStatusFailedLong
	// Failed transcofing, contact support
	TranscodingStatusFailedOther
)

func (TranscodingStatus) String

func (s TranscodingStatus) String() string