beeep

README

beeep

beeep provides a cross-platform library for sending desktop notifications, alerts and beeps.

Installation

go get -u github.com/gen2brain/beeep

Build tags

• nodbus - disable godbus/dbus and use only notify-send

Examples

err := beeep.Beep(beeep.DefaultFreq, beeep.DefaultDuration)
if err != nil {
    panic(err)
}

//go:embed testdata/info.png
var icon []byte

err := beeep.Notify("Title", "Message body", icon)
if err != nil {
panic(err)
}

beeep.AppName = "My App Name"

err := beeep.Alert("Title", "Message body", "testdata/warning.png")
if err != nil {
    panic(err)
}

Documentation

Overview

Package beeep provides a cross-platform library for sending desktop notifications and beeps.

Index

• Variables
• func Alert(title, message string, icon any) error
• func Beep(freq float64, duration int) (err error)
• func Notify(title, message string, icon any) (err error)

Examples

• Alert
• Beep
• Notify

Variables

var (
	// DefaultFreq - frequency, in Hz, middle A
	DefaultFreq = 0.0
	// DefaultDuration - duration in milliseconds
	DefaultDuration = 0
)

var AppName = "DefaultAppName"

AppName is the name of app. This should be the application's formal name, rather than some sort of ID.

var (
	// ErrUnsupported is returned when an operating system is not supported.
	ErrUnsupported = fmt.Errorf("beeep: unsupported operating system: %s", runtime.GOOS)
)

Functions

func Alert

func Alert(title, message string, icon any) error

Alert displays a desktop notification and plays a beep.

Example

package main

import (
	_ "embed"
	"github.com/gen2brain/beeep"
)

func main() {
	beeep.AppName = "My App Name" // change the default app name

	_ = beeep.Alert("Title", "MessageBody", "testdata/warning.png")
}

func Beep

func Beep(freq float64, duration int) (err error)

Beep beeps the PC speaker (https://en.wikipedia.org/wiki/PC_speaker).

Example

package main

import (
	_ "embed"
	"github.com/gen2brain/beeep"
)

func main() {
	_ = beeep.Beep(beeep.DefaultFreq, beeep.DefaultDuration)
}

func Notify

func Notify(title, message string, icon any) (err error)

Notify sends desktop notification.

On the Web, in Firefox it just works, in Chrome you must call it from some "user gesture" like `onclick`, and you must use TLS certificate, it doesn't work with plain http.

Example

package main

import (
	_ "embed"
	"github.com/gen2brain/beeep"
)

//go:embed testdata/info.png
var icon []byte

func main() {
	_ = beeep.Notify("Title", "MessageBody", icon) // icon is embedded file
}