beeper

README

beeper

beeper - play sound via PC speaker

Installation

go get github.com/biter777/beeper

Usage

func main() {
	b, _ := beeper.NewBeeper()
	b.Beep(5000, 100*time.Millisecond)   // beep sound via PC speaker, 5000 hz, 100 ms
	b.BeepItems(beeper.StarWars(), 1)    // play StarWars melody via PC speaker with melody speed = 1 :)
	b.Close()
}

Contributing

Welcome pull requests, bug fixes and issue reports.
Before proposing a change, please discuss it first by raising an issue.
Star us. Give us a star, please, if it's not against your religion :)

Documentation

Overview

Package beeper - play sound via PC speaker

Index

• func SimpleBeep() error
• type BeepItem
  • func StarWars() []BeepItem
  • func StarWarsShortest() []BeepItem
• type Beeper
  • func NewBeeper() (Beeper, error)

Functions

func SimpleBeep

func SimpleBeep() error

SimpleBeep - just a simple beep via stdout

Types

type BeepItem

type BeepItem struct {
	Freq     int
	Duration time.Duration
	Pause    time.Duration // Pause after sound off, used in BeepItems()
}

BeepItem - Beep Item (freq and duration)

func StarWars

func StarWars() []BeepItem

StarWars - StarWars

func StarWarsShortest

func StarWarsShortest() []BeepItem

StarWarsShortest - StarWarsShortest

type Beeper

type Beeper interface {
	Beep(freq int, duration time.Duration) error
	BeepItem(item *BeepItem) error
	BeepItems(items []BeepItem, speed float64) error
	Close() error
}

Beeper - PC-speaker beeper

func NewBeeper

func NewBeeper() (Beeper, error)

NewBeeper - NewBeeper