Volume

godoc

import "barista.run/modules/volume"

Show volume for a device: volume.New(someProvider).

Volume supports displaying the current audio volume settings using a variety of pluggable providers, with the ability to add custom providers fairly easily. Provider is just

type Provider interface {
	Worker(s *value.ErrorValue)
}

where Worker is a long-running function that pushes new Volume values when changes occur. The MakeVolume function can be used to construct Volume values and provide a controller for changing the volume state.

A few providers are included out of the box:

• ALSA
• PulseAudio: Uses D-Bus. Pull requests to use the C API are welcome.

Configuration

• Output(func(Info) bar.Output): Sets the output format.

  If a segment does not have a click handler, the module will set a default click handler, which:

  • Toggles mute on left click
  • Increases/decreases the volume on scroll up/down

Example

V:065

V:MUT

Show the volume percentage (or “MUT”):

volume.DefaultMixer().Output(func(v volume.Volume) bar.Output {
	if v.Mute {
		return outputs.Text("V:MUT")
	}
	return outputs.Textf("V:%03d", v.Pct())
})

Data: type Volume struct

Fields

• Min, Max int64: Minimum/Maximum valid values for volume.
• Vol int64: Current volume.
• Mute bool: Whether the volume is currently muted. Vol may be non-zero even if this is set.

Methods

• Frac() float64: Volume as a fraction of its range (0.0 = min, 1.0 = max).
• Pct() int: Volume as an integral percentage of its range (0 = min, 100 = max).

Controller Methods

In addition to the data methods listed above, volume also provides controller methods to set the volume state:

• SetMuted(bool): Sets the mute state.
• SetVolume(int64): Sets the volume, clamped to Min/Max.