simpleradio

Documentation

Overview

package simpleradio contains a bespoke SimpleRadio-Standalone client.

Index

• type Client
  • func NewClient(config types.ClientConfiguration) (Client, error)

Types

type Client

type Client interface {
	// Name returns the name of the client as it appears in the SRS client list and in in-game transmissions.
	Name() string
	// Frequency returns the radio frequency the client is configured to receive and transmit on in Hz.
	Frequency() float64
	// FrequencyMHz returns Client.Frequency in MHz.
	FrequencyMHz() float64
	// Run starts the SimpleRadio-Standalone client. It should be called exactly once.
	Run(context.Context, *sync.WaitGroup) error
	// Receive returns a channel that receives transmissions over the radio. Each transmission is F32LE PCM audio data.
	Receive() <-chan audio.Audio
	// Transmit queues a transmission to send over the radio. The audio data should be in F32LE PCM format.
	Transmit(audio.Audio)
	// IsOnFrequency checks if the named unit is on the client's frequency.
	IsOnFrequency(string) bool
	// ClientsOnFrequency returns the number of peers on this client's frequency.
	ClientsOnFrequency() int
}

Client is a SimpleRadio-Standalone client.

func NewClient

func NewClient(config types.ClientConfiguration) (Client, error)