venue

Documentation

Overview

Package venue provides functionality for parsing and understanding the Venue Patchlist (Patchbay > Export patch list) or Info (Options > System > Info) HTML output.

Index

• Constants
• func Moniker(num int) string
• type Channel
  • func NewChannel(moniker, name string) *Channel
  • func (c *Channel) CleanName() string
  • func (c *Channel) Equal(c2 *Channel) bool
  • func (c *Channel) Moniker() string
  • func (c *Channel) Name() string
  • func (c *Channel) String() string
• type Channels
  • func (cs Channels) Sorted() ChannelsByMoniker
• type ChannelsByMoniker
  • func (d ChannelsByMoniker) Len() int
  • func (d ChannelsByMoniker) Less(i, j int) bool
  • func (d ChannelsByMoniker) Swap(i, j int)
• type Device
  • func NewDevice(hw hardware.Hardware, name string, inputs, outputs Channels) *Device
  • func (d *Device) Hardware() hardware.Hardware
  • func (d *Device) Input(moniker string) *Channel
  • func (d *Device) Inputs() Channels
  • func (d *Device) Name() string
  • func (d *Device) NumInputs() int
  • func (d *Device) NumOutputs() int
  • func (d *Device) Output(moniker string) *Channel
  • func (d *Device) Outputs() Channels
  • func (d *Device) String() string
• type Devices
  • func (ds Devices) Inputs() map[int]*Channel
• type Venue
  • func NewVenue() *Venue
  • func (v *Venue) Devices() Devices
  • func (v *Venue) Parse(data []byte) error
  • func (v *Venue) String() string
• type XPath

Constants

const (
	Console  = "Console"
	Engine   = "Engine"
	Local    = "Local"
	ProTools = "Pro Tools"
	Stage1   = "Stage 1"
	Stage2   = "Stage 2"
	Stage3   = "Stage 3"
	Stage4   = "Stage 4"
)

Functions

func Moniker

func Moniker(num int) string

Types

type Channel

type Channel struct {
	// contains filtered or unexported fields
}

Channel describes a device channel.

func NewChannel

func NewChannel(moniker, name string) *Channel

NewChannel returns an instantiated Channel.

func (*Channel) CleanName

func (c *Channel) CleanName() string

CleanName returns a clean track name.

func (*Channel) Equal

func (c *Channel) Equal(c2 *Channel) bool

Equal returns true if the channels are equal.

func (*Channel) Moniker

func (c *Channel) Moniker() string

Moniker returns the channel moniker.

func (*Channel) Name

func (c *Channel) Name() string

Name returns the channel name.

func (*Channel) String

func (c *Channel) String() string

String implements the fmt.Stringer interface.

type Channels

type Channels map[string]*Channel

Channels is a map of channels.

func (Channels) Sorted

func (cs Channels) Sorted() ChannelsByMoniker

type ChannelsByMoniker

type ChannelsByMoniker []*Channel

func (ChannelsByMoniker) Len

func (d ChannelsByMoniker) Len() int

TODO(kward) Make this a numeric sort, instead of alphanumeric.

func (ChannelsByMoniker) Less

func (d ChannelsByMoniker) Less(i, j int) bool

func (ChannelsByMoniker) Swap

func (d ChannelsByMoniker) Swap(i, j int)

type Device

type Device struct {
	// contains filtered or unexported fields
}

Device describes a Venue IO device.

func NewDevice

func NewDevice(hw hardware.Hardware, name string, inputs, outputs Channels) *Device

NewDevice returns a pointer to an instantiated Device struct.

func (*Device) Hardware

func (d *Device) Hardware() hardware.Hardware

Type returns the device hardware type.

func (*Device) Input

func (d *Device) Input(moniker string) *Channel

Input returns a copy of the named input channel.

func (*Device) Inputs

func (d *Device) Inputs() Channels

Inputs returns the device inputs.

func (*Device) Name

func (d *Device) Name() string

Name returns the device name.

func (*Device) NumInputs

func (d *Device) NumInputs() int

NumInputs returns the number of input channels.

func (*Device) NumOutputs

func (d *Device) NumOutputs() int

NumOutputs returns the number of output channels.

func (*Device) Output

func (d *Device) Output(moniker string) *Channel

Output returns a copy of the named output channel, or nil if not found.

func (*Device) Outputs

func (d *Device) Outputs() Channels

Outputs returns the device outputs.

func (*Device) String

func (d *Device) String() string

String implements the fmt.Stringer interface.

type Devices

type Devices map[string]*Device

Devices is a map of devices.

func (Devices) Inputs

func (ds Devices) Inputs() map[int]*Channel

deviceInputs returns all input channels from all stage box devices.

type Venue

type Venue struct {
	// contains filtered or unexported fields
}

Venue describes an Avid Venue device as found in an exported patch list.

func NewVenue

func NewVenue() *Venue

NewVenue returns a pointer to an instantiated Venue struct.

func (*Venue) Devices

func (v *Venue) Devices() Devices

Devices returns the known devices.

func (*Venue) Parse

func (v *Venue) Parse(data []byte) error

Parse a Venue patch file.

func (*Venue) String

func (v *Venue) String() string

String implements the fmt.Stringer interface.

type XPath

type XPath struct {
	// contains filtered or unexported fields
}

XPath describes an xpath, and holds a compiled version.