HPI constant definitions

Modules
	Adapter types/product ids
	Audio format types
	Stream States
	Source node types
	Destination node types
	Mixer control types
	Adapter properties
	These are used in HPI_AdapterSetProperty() and HPI_AdapterGetProperty().
	Adapter Modes
	These are used by HPI_AdapterSetModeEx().
	MPEG modes
	MPEG modes - can be used optionally for HPI_FormatCreate() parameter dwAttributes.
	AES/EBU error status bits
	Tuners
	Channel Modes
	Used for HPI_ChannelModeSet/Get().
	SampleClock source values
	Async Event sources
	HPI Error codes
	Almost all HPI functions return an error code A return value of zero means there was no error.
Defines
#define	HPI_ADAPTER_MODE_SET   (0)
	Used in wQueryOrSet field of HPI_AdapterSetModeEx().
#define	HPI_ADAPTER_MODE_QUERY   (1)
	Used in wQueryOrSet field of HPI_AdapterSetModeEx().
#define	HPI_SWITCH_OFF   0
	Turn the mixer plugin on.
#define	HPI_SWITCH_ON   1
	Turn the mixer plugin off.
#define	HPI_UNITS_PER_dB   100
	volumes units are 100ths of a dB
#define	HPI_GAIN_OFF   (-100 * HPI_UNITS_PER_dB)
	turns volume control OFF or MUTE
#define	HPI_METER_MINIMUM   (-150 * HPI_UNITS_PER_dB)
	value returned for no signal
#define	HPI_VOLUME_AUTOFADE_LOG   2
	log fade - dB attenuation changes linearly over time
#define	HPI_VOLUME_AUTOFADE_LINEAR   3
	linear fade - amplitude changes linearly
#define	HPI_AESEBU_FORMAT_AESEBU   1
	AES/EBU physical format - AES/EBU balanced "professional".
#define	HPI_AESEBU_FORMAT_SPDIF   2
	AES/EBU physical format - S/PDIF unbalanced "consumer".
#define	HPI_MAX_ADAPTERS   20
	Maximum number of adapters per HPI sub-system WARNING: modifying this value changes the response structure size.
#define	HPI_MAX_STREAMS   16
	Maximum number of in or out streams per adapter.
#define	HPI_MAX_ANC_BYTES_PER_FRAME   (64)
	maximum number of ancillary bytes per MPEG frame
#define	HPI_OSTREAM_VELOCITY_UNITS   4096
	Velocity units.
#define	HPI_OSTREAM_TIMESCALE_UNITS   10000
	OutStream timescale units.
#define	HPI_OSTREAM_TIMESCALE_PASSTHROUGH   99999
	OutStream timescale passthrough - turns timescaling on in passthough mode.
Enumerations
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_FILTER_TYPE {   HPI_FILTER_TYPE_BYPASS = 0, HPI_FILTER_TYPE_LOWSHELF = 1, HPI_FILTER_TYPE_HIGHSHELF = 2, HPI_FILTER_TYPE_EQ_BAND = 3,   HPI_FILTER_TYPE_LOWPASS = 4, HPI_FILTER_TYPE_HIGHPASS = 5, HPI_FILTER_TYPE_BANDPASS = 6, HPI_FILTER_TYPE_BANDSTOP = 7 }
	Equalizer filter types. More...

---

Define Documentation

#define HPI_ADAPTER_MODE_SET   (0)

Used in wQueryOrSet field of HPI_AdapterSetModeEx().

#define HPI_ADAPTER_MODE_QUERY   (1)

Used in wQueryOrSet field of HPI_AdapterSetModeEx().

#define HPI_SWITCH_OFF   0

Turn the mixer plugin on.

#define HPI_SWITCH_ON   1

Turn the mixer plugin off.

#define HPI_UNITS_PER_dB   100

volumes units are 100ths of a dB

#define HPI_GAIN_OFF   (-100 * HPI_UNITS_PER_dB)

turns volume control OFF or MUTE

#define HPI_METER_MINIMUM   (-150 * HPI_UNITS_PER_dB)

value returned for no signal

#define HPI_VOLUME_AUTOFADE_LOG   2

log fade - dB attenuation changes linearly over time

#define HPI_VOLUME_AUTOFADE_LINEAR   3

linear fade - amplitude changes linearly

#define HPI_AESEBU_FORMAT_AESEBU   1

AES/EBU physical format - AES/EBU balanced "professional".

#define HPI_AESEBU_FORMAT_SPDIF   2

AES/EBU physical format - S/PDIF unbalanced "consumer".

#define HPI_MAX_ADAPTERS   20

Maximum number of adapters per HPI sub-system WARNING: modifying this value changes the response structure size.

#define HPI_MAX_STREAMS   16

Maximum number of in or out streams per adapter.

#define HPI_MAX_ANC_BYTES_PER_FRAME   (64)

maximum number of ancillary bytes per MPEG frame

#define HPI_OSTREAM_VELOCITY_UNITS   4096

Velocity units.

#define HPI_OSTREAM_TIMESCALE_UNITS   10000

OutStream timescale units.

#define HPI_OSTREAM_TIMESCALE_PASSTHROUGH   99999

OutStream timescale passthrough - turns timescaling on in passthough mode.

---

Enumeration Type Documentation

enum HPI_MIXER_STORE_COMMAND

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  Save the attributes of a single control.

enum HPI_FILTER_TYPE

Equalizer filter types. Used by HPI_ParametricEQ_SetBand() Enumerator: HPI_FILTER_TYPE_BYPASS  Filter is turned off. HPI_FILTER_TYPE_LOWSHELF  EQ low shelf. HPI_FILTER_TYPE_HIGHSHELF  EQ high shelf. HPI_FILTER_TYPE_EQ_BAND  EQ gain. HPI_FILTER_TYPE_LOWPASS  Standard low pass. HPI_FILTER_TYPE_HIGHPASS  Standard high pass. HPI_FILTER_TYPE_BANDPASS  Standard band pass. HPI_FILTER_TYPE_BANDSTOP  Standard band stop/notch.

---