AudioScience HPI Version_4.10.
Functions | Enumerations

Mixer

Functions

 Mixer Functions
 Controls
 Blocks

Enumerations

enum  HPI_SOURCENODES {
  HPI_SOURCENODE_NONE = 100, HPI_SOURCENODE_OSTREAM = 101, HPI_SOURCENODE_LINEIN = 102, HPI_SOURCENODE_AESEBU_IN = 103,
  HPI_SOURCENODE_TUNER = 104, HPI_SOURCENODE_RF = 105, HPI_SOURCENODE_CLOCK_SOURCE = 106, HPI_SOURCENODE_RAW_BITSTREAM = 107,
  HPI_SOURCENODE_MICROPHONE = 108, HPI_SOURCENODE_COBRANET = 109, HPI_SOURCENODE_ANALOG = 110, HPI_SOURCENODE_ADAPTER = 111,
  HPI_SOURCENODE_RTP_DESTINATION = 112, HPI_SOURCENODE_INTERNAL = 113, HPI_SOURCENODE_LAST_INDEX = 113
}
 

Source node types.

More...
enum  HPI_DESTNODES {
  HPI_DESTNODE_NONE = 200, HPI_DESTNODE_ISTREAM = 201, HPI_DESTNODE_LINEOUT = 202, HPI_DESTNODE_AESEBU_OUT = 203,
  HPI_DESTNODE_RF = 204, HPI_DESTNODE_SPEAKER = 205, HPI_DESTNODE_COBRANET = 206, HPI_DESTNODE_ANALOG = 207,
  HPI_DESTNODE_RTP_SOURCE = 208, HPI_DESTNODE_LAST_INDEX = 208
}
 

Destination node types.

More...
enum  HPI_CONTROLS {
  HPI_CONTROL_GENERIC = 0, HPI_CONTROL_CONNECTION = 1, HPI_CONTROL_VOLUME = 2, HPI_CONTROL_METER = 3 ,
  HPI_CONTROL_MULTIPLEXER = 5, HPI_CONTROL_AESEBU_TRANSMITTER = 6 , HPI_CONTROL_AESEBU_RECEIVER = 7 , HPI_CONTROL_LEVEL = 8,
  HPI_CONTROL_TUNER = 9, HPI_CONTROL_VOX = 11, HPI_CONTROL_CHANNEL_MODE = 15, HPI_CONTROL_BITSTREAM = 16,
  HPI_CONTROL_SAMPLECLOCK = 17, HPI_CONTROL_MICROPHONE = 18, HPI_CONTROL_PARAMETRIC_EQ = 19 , HPI_CONTROL_COMPANDER = 20,
  HPI_CONTROL_COBRANET = 21, HPI_CONTROL_TONEDETECTOR = 22, HPI_CONTROL_SILENCEDETECTOR = 23, HPI_CONTROL_PAD = 24,
  HPI_CONTROL_SRC = 25, HPI_CONTROL_UNIVERSAL = 26, HPI_CONTROL_LAST_INDEX = 26
}
 

Mixer control types.

More...
enum  HPI_MIXER_STORE_COMMAND {
  HPI_MIXER_STORE_SAVE = 1, HPI_MIXER_STORE_RESTORE = 2, HPI_MIXER_STORE_DELETE = 3, HPI_MIXER_STORE_ENABLE = 4,
  HPI_MIXER_STORE_DISABLE = 5, HPI_MIXER_STORE_SAVE_SINGLE = 6
}
 

Commands used by HPI_MixerStore()

More...
enum  HPI_SWITCH_STATES { HPI_SWITCH_OFF = 0, HPI_SWITCH_ON = 1 }
 

Used by mixer plugin enable functions.

More...

Enumeration Type Documentation

Source node types.

Enumerator:
HPI_SOURCENODE_NONE 

This define can be used instead of 0 to indicate that there is no valid source node.

A control that exists on a destination node can be searched for using a source node value of either 0, or HPI_SOURCENODE_NONE

HPI_SOURCENODE_OSTREAM 

Out Stream (Play) node.

HPI_SOURCENODE_LINEIN 

Line in node - could be analog, AES/EBU or network.

HPI_SOURCENODE_AESEBU_IN 

AES/EBU input node.

HPI_SOURCENODE_TUNER 

Tuner node.

HPI_SOURCENODE_RF 

RF input node.

HPI_SOURCENODE_CLOCK_SOURCE 

Clock source node.

HPI_SOURCENODE_RAW_BITSTREAM 

Raw bitstream node.

HPI_SOURCENODE_MICROPHONE 

Microphone node.

HPI_SOURCENODE_COBRANET 

Cobranet input node - Audio samples come from the Cobranet network and into the device.

HPI_SOURCENODE_ANALOG 

Analog input node.

HPI_SOURCENODE_ADAPTER 

Adapter node.

HPI_SOURCENODE_RTP_DESTINATION 

RTP stream input node - This node is a destination for packets of RTP audio samples from other devices.

HPI_SOURCENODE_INTERNAL 

Node internal to the device.

HPI_SOURCENODE_LAST_INDEX 

largest ID

Destination node types.

Enumerator:
HPI_DESTNODE_NONE 

This define can be used instead of 0 to indicate that there is no valid destination node.

A control that exists on a source node can be searched for using a destination node value of either 0, or HPI_DESTNODE_NONE

HPI_DESTNODE_ISTREAM 

In Stream (Record) node.

HPI_DESTNODE_LINEOUT 

Line Out node.

HPI_DESTNODE_AESEBU_OUT 

AES/EBU output node.

HPI_DESTNODE_RF 

RF output node.

HPI_DESTNODE_SPEAKER 

Speaker output node.

HPI_DESTNODE_COBRANET 

Cobranet output node - Audio samples from the device are sent out on the Cobranet network.

HPI_DESTNODE_ANALOG 

Analog output node.

HPI_DESTNODE_RTP_SOURCE 

RTP stream output node - This node is a source for packets of RTP audio samples that are sent to other devices.

HPI_DESTNODE_LAST_INDEX 

largest ID

Mixer control types.

Enumerator:
HPI_CONTROL_GENERIC 

Generic control.

HPI_CONTROL_CONNECTION 

A connection between nodes.

HPI_CONTROL_VOLUME 

Volume control - works in dBFs.

HPI_CONTROL_METER 

Peak meter control.

HPI_CONTROL_MULTIPLEXER 

Multiplexer control.

HPI_CONTROL_AESEBU_TRANSMITTER 

AES/EBU transmitter control.

HPI_CONTROL_AESEBU_RECEIVER 

AES/EBU receiver control.

HPI_CONTROL_LEVEL 

Level/trim control - works in dBu.

HPI_CONTROL_TUNER 

Tuner control.

HPI_CONTROL_VOX 

Vox control.

HPI_CONTROL_CHANNEL_MODE 

Channel mode control.

HPI_CONTROL_BITSTREAM 

Bitstream control.

HPI_CONTROL_SAMPLECLOCK 

Sample clock control.

HPI_CONTROL_MICROPHONE 

Microphone control.

HPI_CONTROL_PARAMETRIC_EQ 

Parametric EQ control.

HPI_CONTROL_COMPANDER 

Compander control.

HPI_CONTROL_COBRANET 

Cobranet control.

HPI_CONTROL_TONEDETECTOR 

Tone detector control.

HPI_CONTROL_SILENCEDETECTOR 

Silence detector control.

HPI_CONTROL_PAD 

Tuner PAD control.

HPI_CONTROL_SRC 

Samplerate converter control.

HPI_CONTROL_UNIVERSAL 

Universal control.

HPI_CONTROL_LAST_INDEX 

Highest control type ID.

Commands used by HPI_MixerStore()

Enumerator:
HPI_MIXER_STORE_SAVE 

Save all mixer control settings.

HPI_MIXER_STORE_RESTORE 

Restore all controls from saved.

HPI_MIXER_STORE_DELETE 

Delete saved control settings.

HPI_MIXER_STORE_ENABLE 

Enable auto storage of some control settings.

HPI_MIXER_STORE_DISABLE 

Disable auto storage of some control settings.

HPI_MIXER_STORE_SAVE_SINGLE 

Unimplemented - save the attributes of a single control.

Used by mixer plugin enable functions.

E.g. HPI_ParametricEQ_SetState()

Enumerator:
HPI_SWITCH_OFF 

Turn the mixer plugin on.

HPI_SWITCH_ON 

Turn the mixer plugin off.