AES/EBU Digital audio receiver controls
[Mixer and Controls]

The AESEBU receiver receives audio from a standard digital audio interface (AESEBU or SPDIF). More...

Functions

HPI_ERR HPI_AESEBU_Receiver_QueryFormat (const HPI_HSUBSYS *phSubSys, const HPI_HCONTROL hAesRx, const HW32 dwIndex, HW16 *pwFormat)
 query formats supported by this aesebu receiver Iterate dwIndex until an error is returned to get allowed values for aesebu format in *pwFormat
HPI_ERR HPI_AESEBU_Receiver_SetFormat (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wFormat)
 Sets the physical format of the digital audio input to either the balanced, professional AES/EBU input or the unbalanced, consumer S/PDIF input.
HPI_ERR HPI_AESEBU_Receiver_GetFormat (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 *pwFormat)
 Gets the physical format of the digital audio input : either the balanced, professional AES/EBU input or the unbalanced, consumer S/PDIF input.
HPI_ERR HPI_AESEBU_Receiver_GetSampleRate (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 *pdwSampleRate)
 Returns the sample rate of the incoming AES/EBU digital audio stream in *pdwSampleRate.
HPI_ERR HPI_AESEBU_Receiver_GetUserData (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wIndex, HW16 *pwData)
 Get one of 4 userdata bytes from the AES/EBU stream.
HPI_ERR HPI_AESEBU_Receiver_GetChannelStatus (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wIndex, HW16 *pwData)
 Get one of 24 channel status bytes from the AES/EBU stream.
HPI_ERR HPI_AESEBU_Receiver_GetErrorStatus (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 *pwErrorData)
 Get error status from the AES/EBU stream.

Detailed Description

The AESEBU receiver receives audio from a standard digital audio interface (AESEBU or SPDIF).

As well as receiving the audio, status and user bits are extracted from the digital bitstream.

aesebu_receiver.png

Function Documentation

HPI_ERR HPI_AESEBU_Receiver_QueryFormat (  const HPI_HSUBSYS *  phSubSys,
const HPI_HCONTROL  hAesRx,
const HW32  dwIndex,
HW16 *  pwFormat
) 
 

query formats supported by this aesebu receiver Iterate dwIndex until an error is returned to get allowed values for aesebu format in *pwFormat

Parameters:
phSubSys  Pointer to HPI subsystem handle
hAesRx  Control to query
dwIndex  Index for possible attribute values
pwFormat  aesebu format

HPI_ERR HPI_AESEBU_Receiver_SetFormat (  HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16  wFormat
) 
 

Sets the physical format of the digital audio input to either the balanced, professional AES/EBU input or the unbalanced, consumer S/PDIF input.

Note that not all audio adpaters will have both kinds of inputs.

Returns:
0 on success, or one of the HPI Error codes.
Parameters:
phSubSys  Pointer to HPI subsystem handle
hControl  Handle to control of type HPI_CONTROL_AESEBU_RECEIVER
wFormat  HPI_AESEBU_FORMAT_AESEBU or HPI_AESEBU_FORMAT_SPDIF

HPI_ERR HPI_AESEBU_Receiver_GetFormat (  HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16 *  pwFormat
) 
 

Gets the physical format of the digital audio input : either the balanced, professional AES/EBU input or the unbalanced, consumer S/PDIF input.

Note:
Not all audio adapters will have both kinds of inputs.
Returns:
0 on success, or one of the HPI Error codes.
Parameters:
phSubSys  Pointer to HPI subsystem handle.
hControl  Handle to control of type HPI_CONTROL_AESEBU_RECEIVER.
pwFormat  current format, either HPI_AESEBU_FORMAT_SPDIF orHPI_AESEBU_FORMAT_AESEBU.

HPI_ERR HPI_AESEBU_Receiver_GetSampleRate (  HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW32 *  pdwSampleRate
) 
 

Returns the sample rate of the incoming AES/EBU digital audio stream in *pdwSampleRate.

This information is obtained from the channel status bits in the digital audio bitstream.

Returns:
0 on success, or one of the HPI Error codes.
Return values:
HPI_ERROR_INVALID_OPERATION if PLL unlocked.
Parameters:
phSubSys  Pointer to HPI subsystem handle
hControl  Handle to control of type HPI_CONTROL_AESEBU_RECEIVER
pdwSampleRate  samplerate 0, 32000,44100 or 48000 (or x2, x4) returned

HPI_ERR HPI_AESEBU_Receiver_GetUserData (  HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16  wIndex,
HW16 *  pwData
) 
 

Get one of 4 userdata bytes from the AES/EBU stream.

Returns:
0 on success, or one of the HPI Error codes.
Parameters:
phSubSys  Pointer to HPI subsystem handle.
hControl  Handle to control of type HPI_CONTROL_AESEBU_RECEIVER.
wIndex  byte index ranges from 0..3.
pwData  returned user data.

HPI_ERR HPI_AESEBU_Receiver_GetChannelStatus (  HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16  wIndex,
HW16 *  pwData
) 
 

Get one of 24 channel status bytes from the AES/EBU stream.

Returns:
0 on success, or one of the HPI Error codes.
Parameters:
phSubSys  Pointer to HPI subsystem handle.
hControl  Handle to control of type HPI_CONTROL_AESEBU_RECEIVER.
wIndex  byte index ranges from 0..23.
pwData  returned channel status data.

HPI_ERR HPI_AESEBU_Receiver_GetErrorStatus (  HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16 *  pwErrorData
) 
 

Get error status from the AES/EBU stream.

Returns:
0 on success, or one of the HPI Error codes.
Parameters:
phSubSys  Pointer to HPI subsystem handle.
hControl  Handle to control of type HPI_CONTROL_AESEBU_RECEIVER.
pwErrorData  returned error status bitfields defined by AES/EBU error status bits.

Generated on Tue Nov 18 12:59:30 2008 for AudioScience HPI by  doxygen 1.4.6-NO