Adapter properties
[HPI constant definitions]

These are used in HPI_AdapterSetProperty() and HPI_AdapterGetProperty(). More...

Defines

#define HPI_ADAPTER_PROPERTY_GROUPING   2
 Adapter grouping property Indicates whether the adapter supports the grouping API (for ASIO and SSX2).
#define HPI_ADAPTER_PROPERTY_ENABLE_SSX2   3
 Adapter SSX2 property Indicates whether the adapter supports SSX2 multichannel streams in hardware.
#define HPI_ADAPTER_PROPERTY_READONLYBASE   256
 Base number for readonly properties.
#define HPI_ADAPTER_PROPERTY_LATENCY   (HPI_ADAPTER_PROPERTY_READONLYBASE+0)
 Readonly adapter latency property.
#define HPI_ADAPTER_PROPERTY_GRANULARITY   (HPI_ADAPTER_PROPERTY_READONLYBASE+1)
 Readonly adapter granularity property.
#define HPI_ADAPTER_PROPERTY_CURCHANNELS   (HPI_ADAPTER_PROPERTY_READONLYBASE+2)
 Readonly adapter number of current channels property.
#define HPI_ADAPTER_PROPERTY_SOFTWARE_VERSION   (HPI_ADAPTER_PROPERTY_READONLYBASE+3)
 Readonly adapter software version.
#define HPI_ADAPTER_PROPERTY_MAC_ADDRESS_MSB   (HPI_ADAPTER_PROPERTY_READONLYBASE+4)
 Readonly adapter MAC address MSBs.
#define HPI_ADAPTER_PROPERTY_MAC_ADDRESS_LSB   (HPI_ADAPTER_PROPERTY_READONLYBASE+5)
 Readonly adapter MAC address LSBs The MAC_ADDRESS_LSB property returns the least significant 16 bits of the MAC address.
#define HPI_ADAPTER_PROPERTY_EXTENDED_ADAPTER_TYPE   (HPI_ADAPTER_PROPERTY_READONLYBASE+6)
 Readonly extended adapter type number The EXTENDED_ADAPTER_TYPE property returns the 4 digits of an extended adapter type, i.e ASI8920-0022, 0022 is the extended type.
#define HPI_ADAPTER_PROPERTY_LOGTABLEN   (HPI_ADAPTER_PROPERTY_READONLYBASE+7)
 Readonly debug log buffer information.
#define HPI_ADAPTER_PROPERTY_IP_ADDRESS   (HPI_ADAPTER_PROPERTY_READONLYBASE+9)
 Readonly adapter IP address For 192.168.1.101 Property 1 returns the 1st two (left most) digits, i.e 192*256 + 168 in the example above, the upper byte being the left most digit.
#define HPI_ADAPTER_PROPERTY_BUFFER_UPDATE_COUNT   (HPI_ADAPTER_PROPERTY_READONLYBASE+10)
 Readonly adapter buffer processed count.

Detailed Description

These are used in HPI_AdapterSetProperty() and HPI_AdapterGetProperty().


Define Documentation

#define HPI_ADAPTER_PROPERTY_GROUPING   2
 

Adapter grouping property Indicates whether the adapter supports the grouping API (for ASIO and SSX2).

#define HPI_ADAPTER_PROPERTY_ENABLE_SSX2   3
 

Adapter SSX2 property Indicates whether the adapter supports SSX2 multichannel streams in hardware.

This feature is not yet used by the hardware. Consider this property more of a "reserved for future use" property.

#define HPI_ADAPTER_PROPERTY_READONLYBASE   256
 

Base number for readonly properties.

#define HPI_ADAPTER_PROPERTY_LATENCY   (HPI_ADAPTER_PROPERTY_READONLYBASE+0)
 

Readonly adapter latency property.

This property returns in the input and output latency in samples. Property 1 is the estimated input latency in samples, while Property 2 is that output latency in samples.

#define HPI_ADAPTER_PROPERTY_GRANULARITY   (HPI_ADAPTER_PROPERTY_READONLYBASE+1)
 

Readonly adapter granularity property.

The granulariy is the smallest size chunk of stereo samples that is processed by the adapter. This property returns the record granularity in samples in Property 1. Property 2 returns the play granularity.

#define HPI_ADAPTER_PROPERTY_CURCHANNELS   (HPI_ADAPTER_PROPERTY_READONLYBASE+2)
 

Readonly adapter number of current channels property.

Property 1 is the number of record channels per record device. Property 2 is the number of play channels per playback device.

#define HPI_ADAPTER_PROPERTY_SOFTWARE_VERSION   (HPI_ADAPTER_PROPERTY_READONLYBASE+3)
 

Readonly adapter software version.

The SOFTWARE_VERSION property returns the version of the software running on the adapter as Major.Minor.Release. Property 1 contains Major in bits 15..8 and Minor in bits 7..0. Property 2 contains Release in bits 7..0.

#define HPI_ADAPTER_PROPERTY_MAC_ADDRESS_MSB   (HPI_ADAPTER_PROPERTY_READONLYBASE+4)
 

Readonly adapter MAC address MSBs.

The MAC_ADDRESS_MSB property returns the most significant 32 bits of the MAC address. Property 1 contains bits 47..32 of the MAC address. Property 2 contains bits 31..16 of the MAC address.

#define HPI_ADAPTER_PROPERTY_MAC_ADDRESS_LSB   (HPI_ADAPTER_PROPERTY_READONLYBASE+5)
 

Readonly adapter MAC address LSBs The MAC_ADDRESS_LSB property returns the least significant 16 bits of the MAC address.

Property 1 contains bits 15..0 of the MAC address.

#define HPI_ADAPTER_PROPERTY_EXTENDED_ADAPTER_TYPE   (HPI_ADAPTER_PROPERTY_READONLYBASE+6)
 

Readonly extended adapter type number The EXTENDED_ADAPTER_TYPE property returns the 4 digits of an extended adapter type, i.e ASI8920-0022, 0022 is the extended type.

The digits are returned as ASCII characters rather than the hex digits that are returned for the main type Property 1 returns the 1st two (left most) digits, i.e "00" in the example above, the upper byte being the left most digit. Property 2 returns the 2nd two digits, i.e "22" in the example above

#define HPI_ADAPTER_PROPERTY_LOGTABLEN   (HPI_ADAPTER_PROPERTY_READONLYBASE+7)
 

Readonly debug log buffer information.

#define HPI_ADAPTER_PROPERTY_IP_ADDRESS   (HPI_ADAPTER_PROPERTY_READONLYBASE+9)
 

Readonly adapter IP address For 192.168.1.101 Property 1 returns the 1st two (left most) digits, i.e 192*256 + 168 in the example above, the upper byte being the left most digit.

Property 2 returns the 2nd two digits, i.e 1*256 + 101 in the example above,

#define HPI_ADAPTER_PROPERTY_BUFFER_UPDATE_COUNT   (HPI_ADAPTER_PROPERTY_READONLYBASE+10)
 

Readonly adapter buffer processed count.

Returns a buffer processed count that is incremented every time all buffers for all streams are updated. This is useful for checking completion of all stream operations across the adapter when using grouped streams.


Generated on Tue Jun 15 10:08:53 2010 for AudioScience HPI by  doxygen 1.4.6-NO