sound

package

v1.32.0 Latest Latest Go to latest Published: Mar 12, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/docker/docker-agent

Links

Open Source Insights

Documentation ¶

Overview ¶

Package sound provides cross-platform sound notification support. It plays system sounds asynchronously to notify users of task completion or failure.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Play ¶

func Play(event Event)

Play plays a notification sound for the given event in the background. It is non-blocking and safe to call from any goroutine. If the sound cannot be played, the error is logged and silently ignored.

Types ¶

type Event ¶

type Event int

Event represents the type of sound to play.

const (
	// Success is played when a task completes successfully.
	Success Event = iota
	// Failure is played when a task fails.
	Failure
)

Source Files ¶

View all Source files

sound.go

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