volume

README

volume-go

Volume control in Go

This is a Go language package for controlling audio volume.

CLI tool usage

install

 $ go get -u github.com/itchyny/volume-go/cmd/volume

get

Gets current volume.

 $ volume get 
20

set

Set volume to specified amount.

 $ volume set 40
 $ volume status
volume: 40
muted: false

up/down

Increase/decrease volume by specified amount, default 6.

 $ volume get
40
 $ volume up
 $ volume get
46

 $ volume up 4
 $ volume get
50

 $ volume down
 $ volume get
44
 $ volume down 4
 $ volume get
40

status

Get current volume and is muted.

 $ volume status
volume: 20
muted: false

mute/unmute

 $ volume mute
 $ volume status
volume: 20
muted: true

 $ volume unmute
 $ volume status
volume: 20
muted: false

Package usage

package main

import (
	"fmt"
	"log"

	"github.com/itchyny/volume-go"
)

func main() {
	vol, err := volume.GetVolume()
	if err != nil {
		log.Fatalf("get volume failed: %+v", err)
	}
	fmt.Printf("current volume: %d\n", vol)

	err = volume.SetVolume(10)
	if err != nil {
		log.Fatalf("set volume failed: %+v", err)
	}
	fmt.Printf("set volume success\n")

	err = volume.Mute()
	if err != nil {
		log.Fatalf("mute failed: %+v", err)
	}

	err = volume.Unmute()
	if err != nil {
		log.Fatalf("unmute failed: %+v", err)
	}
}

Bug Tracker

Report bug at Issues・itchyny/volume-go - GitHub.

Author

itchyny (https://github.com/itchyny)

License

This software is released under the MIT License, see LICENSE.

Documentation

Index

• func GetMuted() (bool, error)
• func GetVolume() (int, error)
• func IncreaseVolume(diff int) error
• func Mute() error
• func SetVolume(volume int) error
• func Unmute() error

Functions

func GetMuted

func GetMuted() (bool, error)

GetMuted returns the current muted status.

func GetVolume

func GetVolume() (int, error)

GetVolume returns the current volume (0 to 100).

func IncreaseVolume

func IncreaseVolume(diff int) error

IncreaseVolume increases (or decreases) the audio volume by the specified value.

func Mute

func Mute() error

Mute mutes the audio.

func SetVolume

func SetVolume(volume int) error

SetVolume sets the sound volume to the specified value.

func Unmute

func Unmute() error

Unmute unmutes the audio.