syncosc

README

syncosc

Tiny package that contains constants for oscsync

Documentation

Overview

Package syncosc exists to define constants used in the oscsync protocol. See http://github.com/scgolang/oscsync/README.md

Index

• Constants
• func GetPulseDuration(tempo float32) time.Duration
• func Ticker(ctx context.Context, slave Slave, host string) error
• type ConnectorFunc
• type Pulse
  • func PulseFromMessage(m osc.Message) (Pulse, error)
• type Slave

Constants

const (
	AddressPulse       = "/sync/pulse"
	AddressSlaveAdd    = "/sync/slave/add"
	AddressSlaveList   = "/sync/slave/list"
	AddressSlaveRemove = "/sync/slave/remove"
	AddressTempo       = "/sync/tempo"
)

OSC addresses.

const MasterPort = 5776

MasterPort is the listening port for the oscsync master.

const PulsesPerBar = 96

PulsesPerBar is the number of pulses in a bar (measure).

Functions

func GetPulseDuration

func GetPulseDuration(tempo float32) time.Duration

GetPulseDuration converts the tempo in bpm to a time.Duration callers are responsible for making concurrent access safe.

func Ticker

func Ticker(ctx context.Context, slave Slave, host string) error

Ticker runs a ticker that triggers the slave. This func blocks forever.

Types

type ConnectorFunc

type ConnectorFunc func(ctx context.Context, slave Slave, host string) error

ConnectorFunc connects a slave to an oscsync server.

type Pulse

type Pulse struct {
	Tempo float32
	Count int32
}

Pulse represents the arguments in a /sync/pulse message.

func PulseFromMessage

func PulseFromMessage(m osc.Message) (Pulse, error)

PulseFromMessage gets a Pulse from an OSC message.

type Slave

type Slave interface {
	Pulse(Pulse) error
}

Slave is any type that can sync to an oscsync master. The slave's Pulse method will be invoked every time a new pulse is received from the oscsync master.