volume

package

v0.0.0-...-cb77e8e Latest Latest Go to latest Published: Oct 7, 2019 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package volume provides an i3bar module that interfaces with alsa or pulse to display and control the system volume.

This section is empty.

This section is empty.

This section is empty.

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

Module represents a bar.Module that displays volume information.

func DefaultMixer() *Module

DefaultMixer constructs an instance of the volume module for the default mixer.

func DefaultSink() *Module

DefaultSink creates a PulseAudio volume module that follows the default sink.

func Mixer(card, mixer string) *Module

Mixer constructs an instance of the volume module for a specific card and mixer on that card.

func Sink(sinkName string) *Module

Sink creates a PulseAudio volume module for a named sink.

func (m *Module) Output(outputFunc func(Volume) bar.Output) *Module

Output configures a module to display the output of a user-defined function.

func (m *Module) Stream(s bar.Sink)

Stream starts the module.

type Volume struct {
	Min, Max, Vol int64
	Mute          bool
	// contains filtered or unexported fields
}

Volume represents the current audio volume and mute state.

func (v Volume) Frac() float64

Frac returns the current volume as a fraction of the total range.

func (v Volume) Pct() int

Pct returns the current volume in the range 0-100.

func (v Volume) SetMuted(muted bool)

SetMuted controls whether the system volume is muted.

func (v Volume) SetVolume(volume int64)

SetVolume sets the system volume. It does not change the mute status.