simpleradio

Documentation

Overview

package simpleradio contains a bespoke SimpleRadio-Standalone client.

Index

• type Client
  • func NewClient(config types.ClientConfiguration) (Client, error)
• type RadioFrequency
  • func ParseRadioFrequency(s string) (*RadioFrequency, error)
  • func (f RadioFrequency) IsSameFrequency(other RadioFrequency) bool
  • func (f RadioFrequency) String() string

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
	// 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 any of the client's frequencies.
	IsOnFrequency(string) bool
	// ClientsOnFrequency returns the number of peers on the client's frequencies.
	ClientsOnFrequency() int
}

Client is a SimpleRadio-Standalone client.

func NewClient

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

type RadioFrequency

type RadioFrequency struct {
	Frequency  unit.Frequency
	Modulation types.Modulation
}

RadioFrequency selects a frequency and either AM or FM modulation.

func ParseRadioFrequency

func ParseRadioFrequency(s string) (*RadioFrequency, error)

ParseRadioFrequency parses a string into a RadioFrequency. The string should be a postive decimal number optionally followed by either "AM" or "FM". If the modulation is not recognized, it defaults to AM.

func (RadioFrequency) IsSameFrequency

func (f RadioFrequency) IsSameFrequency(other RadioFrequency) bool

func (RadioFrequency) String

func (f RadioFrequency) String() string

String representation of the RadioFrequency.