AES/EBU Digital audio transmitter control
[Mixer and Controls]

The AESEBU transmitter transmits audio via a standard digital audio interface (AESEBU or SPDIF). More...

Functions

HPI_ERR HPI_AESEBU_Transmitter_SetSampleRate (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW32 dwSampleRate)
 Set the AES/EBU transmitters sample rate.
HPI_ERR HPI_AESEBU_Transmitter_SetUserData (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wIndex, HW16 wData)
 Set one of 4 userdata bytes in the AES/EBU stream.
HPI_ERR HPI_AESEBU_Transmitter_SetChannelStatus (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wIndex, HW16 wData)
 Set one of 24 channel status bytes in the AES/EBU stream.
HPI_ERR HPI_AESEBU_Transmitter_GetChannelStatus (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wIndex, HW16 *pwData)
 Get a byte of channel status in the AES/EBU stream.
HPI_ERR HPI_AESEBU_Transmitter_QueryFormat (const HPI_HSUBSYS *phSubSys, const HPI_HCONTROL hAesTx, const HW32 dwIndex, HW16 *pwFormat)
 Query the formats supported by this AESEBU transmitter Iterate dwIndex until an error is returned to get allowed values for aesebu format in *pwFormat.
HPI_ERR HPI_AESEBU_Transmitter_SetFormat (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 wOutputFormat)
 Set the output electrical format for the AESEBU transmitter.
HPI_ERR HPI_AESEBU_Transmitter_GetFormat (HPI_HSUBSYS *phSubSys, HPI_HCONTROL hControl, HW16 *pwOutputFormat)
 Get the current output electrical format for the AESEBU transmitter.

Detailed Description

The AESEBU transmitter transmits audio via a standard digital audio interface (AESEBU or SPDIF).

aesebu_transmitter.png

Function Documentation

HPI_ERR HPI_AESEBU_Transmitter_SetSampleRate (  HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW32  dwSampleRate
) 
 

Set the AES/EBU transmitters sample rate.

This is only valid if the source is the analog mixer if the source is an outstream, then the samplerate will be that of the outstream.

Returns:
0 on success, or one of the HPI Error codes.
Note:
Not all audio adapters will have both kinds of inputs.
Parameters:
phSubSys  Pointer to HPI subsystem handle.
hControl  Handle to control of type HPI_CONTROL_AESEBU_TRANSMITTER.
dwSampleRate  32000, 44100 or 48000.

HPI_ERR HPI_AESEBU_Transmitter_SetUserData (  HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16  wIndex,
HW16  wData
) 
 

Set one of 4 userdata bytes in 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_TRANSMITTER
wIndex  byte index ranges from 0..3
wData  user data to set (? only byte values 0..255 allowed?)

HPI_ERR HPI_AESEBU_Transmitter_SetChannelStatus (  HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16  wIndex,
HW16  wData
) 
 

Set one of 24 channel status bytes in 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_TRANSMITTER.
wIndex  byte index ranges from 0..23.
wData  channel status data to write (? only byte values 0..255 allowed?).

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

Get a byte of channel status in the AES/EBU stream.

Warning:
Currently disabled pending debug of DSP code.
Returns:
0 on success, or one of the HPI Error codes.
Return values:
Always HPI_ERROR_INVALID_OPERATION.
Parameters:
phSubSys  Pointer to HPI subsystem handle.
hControl  Handle to control of type HPI_CONTROL_AESEBU_TRANSMITTER.
wIndex  byte index ranges from 0..23.
pwData  read channel status data.

HPI_ERR HPI_AESEBU_Transmitter_QueryFormat (  const HPI_HSUBSYS *  phSubSys,
const HPI_HCONTROL  hAesTx,
const HW32  dwIndex,
HW16 *  pwFormat
) 
 

Query the formats supported by this AESEBU transmitter Iterate dwIndex until an error is returned to get allowed values for aesebu format in *pwFormat.

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

HPI_ERR HPI_AESEBU_Transmitter_SetFormat (  HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16  wOutputFormat
) 
 

Set the output electrical format for the AESEBU transmitter.

Some adapters only support one of the two formats (usually AESEBU).

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_TRANSMITTER.
wOutputFormat  formats either HPI_AESEBU_FORMAT_SPDIF or HPI_AESEBU_FORMAT_AESEBU.

HPI_ERR HPI_AESEBU_Transmitter_GetFormat (  HPI_HSUBSYS *  phSubSys,
HPI_HCONTROL  hControl,
HW16 *  pwOutputFormat
) 
 

Get the current output electrical format for the AESEBU transmitter.

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_TRANSMITTER.
pwOutputFormat  Current format either HPI_AESEBU_FORMAT_AESEBU or HPI_AESEBU_FORMAT_SPDIF.

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