execdriver

package

v0.6.3 Latest Latest Go to latest Published: Jul 22, 2026 License: MIT Imports: 7 Imported by: 0

Details

Package execdriver provides a command-based audio driver.

This section is empty.

This section is empty.

This section is empty.

type Command struct {
	Path string
	Args []string
}

Command describes the command used to play an audio cue. Use {{path}} and {{volume}} placeholders inside args.

func DefaultCommand() (Command, bool)

DefaultCommand returns the first command candidate for this OS.

func DefaultCommandCandidates() []Command

DefaultCommandCandidates returns OS-specific command options.

func DetectCommand() (Command, bool)

DetectCommand returns the first available command in PATH.

type Config struct {
	Command Command
	Sources map[string]Source
}

Config configures a command driver.

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

Driver executes external commands to play audio.

func NewDriver(cfg Config) *Driver

NewDriver creates a command-based audio driver.

func (d *Driver) Play(cue audio.Cue) error

Play starts a command for the cue.

func (d *Driver) Register(id string, src Source)

Register adds or replaces a cue source.

func (d *Driver) Stop(kind audio.Kind) error

Stop stops music playback.

type Source struct {
	Path    string
	Command Command
}

Source maps a cue ID to a file path and optional command override.