Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pulse

package module

Go to main page

Versions in this module

v0

v0.5.1

Aug 6, 2026

v0.5.0

Aug 6, 2026

Changes in this version

type PlaybackStream

+ func (p *PlaybackStream) DrainContext(ctx context.Context) error

+ func (p *PlaybackStream) StartContext(ctx context.Context) error

v0.4.0

Jul 29, 2026

v0.3.1

May 21, 2026

Changes in this version

+ const EndOfData

+ const ErrConnectionClosed

+ type Client struct

+ func NewClient(opts ...ClientOption) (*Client, error)

+ func (c *Client) Close()

+ func (c *Client) DefaultSink() (*Sink, error)

+ func (c *Client) DefaultSource() (*Source, error)

+ func (c *Client) GetServerInfo() (proto.GetServerInfoReply, error)

+ func (c *Client) ListModules() ([]*proto.GetModuleInfoReply, error)

+ func (c *Client) ListSinks() ([]*Sink, error)

+ func (c *Client) ListSources() ([]*Source, error)

+ func (c *Client) LoadModule(name string, args string) (uint32, error)

+ func (c *Client) NewPlayback(r Reader, opts ...PlaybackOption) (*PlaybackStream, error)

+ func (c *Client) NewRecord(w Writer, opts ...RecordOption) (*RecordStream, error)

+ func (c *Client) RawRequest(req proto.RequestArgs, rpl proto.Reply) error

+ func (c *Client) SetSinkMute(name string, mute bool) error

+ func (c *Client) SetSinkVolume(name string, volume proto.ChannelVolumes) error

+ func (c *Client) SinkByID(name string) (*Sink, error)

+ func (c *Client) SourceByID(name string) (*Source, error)

+ func (c *Client) UnloadModule(idx uint32) error

+ type ClientOption func(*Client)

+ func ClientApplicationIconName(name string) ClientOption

+ func ClientApplicationName(name string) ClientOption

+ func ClientServerString(s string) ClientOption

+ func ClientTimeout(d time.Duration) ClientOption

+ type Float32Reader func([]float32) (int, error)

+ func (c Float32Reader) Format() byte

+ func (c Float32Reader) Read(buf []byte) (int, error)

+ type Float32Writer func([]float32) (int, error)

+ func (c Float32Writer) Format() byte

+ func (c Float32Writer) Write(buf []byte) (int, error)

+ type Int16Reader func([]int16) (int, error)

+ func (c Int16Reader) Format() byte

+ func (c Int16Reader) Read(buf []byte) (int, error)

+ type Int16Writer func([]int16) (int, error)

+ func (c Int16Writer) Format() byte

+ func (c Int16Writer) Write(buf []byte) (int, error)

+ type Int32Reader func([]int32) (int, error)

+ func (c Int32Reader) Format() byte

+ func (c Int32Reader) Read(buf []byte) (int, error)

+ type Int32Writer func([]int32) (int, error)

+ func (c Int32Writer) Format() byte

+ func (c Int32Writer) Write(buf []byte) (int, error)

+ type PlaybackOption func(*PlaybackStream)

+ var PlaybackMono PlaybackOption = func(p *PlaybackStream) { ... }

+ var PlaybackStereo PlaybackOption = func(p *PlaybackStream) { ... }

+ func PlaybackBufferSize(samples int) PlaybackOption

+ func PlaybackChannels(m proto.ChannelMap) PlaybackOption

+ func PlaybackLatency(seconds float64) PlaybackOption

+ func PlaybackMediaIconName(name string) PlaybackOption

+ func PlaybackMediaName(name string) PlaybackOption

+ func PlaybackRawOption(o func(*proto.CreatePlaybackStream)) PlaybackOption

+ func PlaybackSampleRate(rate int) PlaybackOption

+ func PlaybackSink(sink *Sink) PlaybackOption

+ func PlaybackVolumeChanges(changes chan proto.ChannelVolumes) PlaybackOption

+ type PlaybackStream struct

+ func (p *PlaybackStream) BufferSize() int

+ func (p *PlaybackStream) BufferSizeBytes() int

+ func (p *PlaybackStream) Channels() int

+ func (p *PlaybackStream) Close()

+ func (p *PlaybackStream) Closed() bool

+ func (p *PlaybackStream) Drain()

+ func (p *PlaybackStream) Error() error

+ func (p *PlaybackStream) Pause()

+ func (p *PlaybackStream) Resume()

+ func (p *PlaybackStream) Running() bool

+ func (p *PlaybackStream) SampleRate() int

+ func (p *PlaybackStream) SetVolume(volumes proto.ChannelVolumes) error

+ func (p *PlaybackStream) Start()

+ func (p *PlaybackStream) Stop()

+ func (p *PlaybackStream) StreamIndex() uint32

+ func (p *PlaybackStream) StreamInputIndex() uint32

+ func (p *PlaybackStream) Underflow() bool

+ func (p *PlaybackStream) Volume() (proto.ChannelVolumes, error)

+ type Reader interface

+ Format func() byte

+ func NewReader(r io.Reader, format byte) Reader

+ type RecordOption func(*RecordStream)

+ var RecordMono RecordOption = func(r *RecordStream) { ... }

+ var RecordStereo RecordOption = func(r *RecordStream) { ... }

+ func RecordBufferFragmentSize(size uint32) RecordOption

+ func RecordChannels(m proto.ChannelMap) RecordOption

+ func RecordLatency(seconds float64) RecordOption

+ func RecordMediaIconName(name string) RecordOption

+ func RecordMediaName(name string) RecordOption

+ func RecordMonitor(sink *Sink) RecordOption

+ func RecordRawOption(o func(*proto.CreateRecordStream)) RecordOption

+ func RecordSampleRate(rate int) RecordOption

+ func RecordSource(source *Source) RecordOption

+ type RecordStream struct

+ func (r *RecordStream) Channels() int

+ func (r *RecordStream) Close()

+ func (r *RecordStream) Closed() bool

+ func (r *RecordStream) Error() error

+ func (r *RecordStream) Running() bool

+ func (r *RecordStream) SampleRate() int

+ func (r *RecordStream) Start()

+ func (r *RecordStream) Stop()

+ func (r *RecordStream) StreamIndex() uint32

+ type Sink struct

+ func (s *Sink) Channels() proto.ChannelMap

+ func (s *Sink) ID() string

+ func (s *Sink) IsMute() bool

+ func (s *Sink) Name() string

+ func (s *Sink) SampleRate() int

+ func (s *Sink) SinkIndex() uint32

+ func (s *Sink) Volume() ([]uint32, uint32)

+ type Source struct

+ func (s *Source) Channels() proto.ChannelMap

+ func (s *Source) ID() string

+ func (s *Source) Name() string

+ func (s *Source) SampleRate() int

+ func (s *Source) SourceIndex() uint32

+ type Uint8Reader func([]byte) (int, error)

+ func (c Uint8Reader) Format() byte

+ func (c Uint8Reader) Read(buf []byte) (int, error)

+ type Uint8Writer func([]byte) (int, error)

+ func (c Uint8Writer) Format() byte

+ func (c Uint8Writer) Write(buf []byte) (int, error)

+ type Writer interface

+ Format func() byte

+ func NewWriter(w io.Writer, format byte) Writer