AudioScience HPI Version_4.10.
Enumerations | Functions

AES/EBU Digital audio transmitter control

Controls

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

Enumerations

enum  HPI_AESEBU_FORMATS { HPI_AESEBU_FORMAT_AESEBU = 1, HPI_AESEBU_FORMAT_SPDIF = 2 }
 

The physical encoding format of the AESEBU I/O.

More...

Functions

hpi_err_t HPI_AESEBU_Transmitter_SetSampleRate (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint32_t dwSampleRate)
 Set the AES/EBU transmitters sample rate.
hpi_err_t HPI_AESEBU_Transmitter_SetUserData (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wIndex, uint16_t wData)
 Set one of 4 userdata bytes in the AES/EBU stream.
hpi_err_t HPI_AESEBU_Transmitter_SetChannelStatus (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wIndex, uint16_t wData)
 Set one of 24 channel status bytes in the AES/EBU stream.
hpi_err_t HPI_AESEBU_Transmitter_GetChannelStatus (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wIndex, uint16_t *pwData)
 Get a byte of channel status in the AES/EBU stream.
hpi_err_t HPI_AESEBU_Transmitter_QueryFormat (const hpi_hsubsys_t *phSubSys, const hpi_handle_t hAesTx, const uint32_t dwIndex, uint16_t *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_t HPI_AESEBU_Transmitter_SetFormat (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t wOutputFormat)
 Set the output electrical format for the AESEBU transmitter.
hpi_err_t HPI_AESEBU_Transmitter_GetFormat (const hpi_hsubsys_t *phSubSys, hpi_handle_t hControl, uint16_t *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

Enumeration Type Documentation

The physical encoding format of the AESEBU I/O.

Used in HPI_AESEBU_Transmitter_SetFormat(), HPI_AESEBU_Receiver_SetFormat() along with related Get and Query functions

Enumerator:
HPI_AESEBU_FORMAT_AESEBU 

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

HPI_AESEBU_FORMAT_SPDIF 

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


Function Documentation

hpi_err_t HPI_AESEBU_Transmitter_SetSampleRate ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
uint32_t  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:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlHandle to control of type HPI_CONTROL_AESEBU_TRANSMITTER.
dwSampleRate32000, 44100 or 48000.
hpi_err_t HPI_AESEBU_Transmitter_SetUserData ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
uint16_t  wIndex,
uint16_t  wData 
)

Set one of 4 userdata bytes in the AES/EBU stream.

Returns:
0 on success, or one of the HPI_ERROR_CODES.
Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlHandle to control of type HPI_CONTROL_AESEBU_TRANSMITTER
wIndexbyte index ranges from 0..3
wDatauser data to set (? only byte values 0..255 allowed?)
hpi_err_t HPI_AESEBU_Transmitter_SetChannelStatus ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
uint16_t  wIndex,
uint16_t  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:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlHandle to control of type HPI_CONTROL_AESEBU_TRANSMITTER.
wIndexbyte index ranges from 0..23.
wDatachannel status data to write (? only byte values 0..255 allowed?).
hpi_err_t HPI_AESEBU_Transmitter_GetChannelStatus ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
uint16_t  wIndex,
uint16_t *  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:
AlwaysHPI_ERROR_INVALID_OPERATION.
Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlHandle to control of type HPI_CONTROL_AESEBU_TRANSMITTER.
wIndexbyte index ranges from 0..23.
pwDataread channel status data.

References HPI_ERROR_INVALID_OPERATION.

hpi_err_t HPI_AESEBU_Transmitter_QueryFormat ( const hpi_hsubsys_t *  phSubSys,
const hpi_handle_t  hAesTx,
const uint32_t  dwIndex,
uint16_t *  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:
phSubSysVestigial subsys handle (unused), may be set to NULL
hAesTxControl to query
dwIndexIndex for possible attribute values
pwFormataesebu format one of the HPI_AESEBU_FORMATS

References HPI_ControlQuery().

hpi_err_t HPI_AESEBU_Transmitter_SetFormat ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
uint16_t  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:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlHandle to control of type HPI_CONTROL_AESEBU_TRANSMITTER.
wOutputFormatone of the HPI_AESEBU_FORMATS
hpi_err_t HPI_AESEBU_Transmitter_GetFormat ( const hpi_hsubsys_t *  phSubSys,
hpi_handle_t  hControl,
uint16_t *  pwOutputFormat 
)

Get the current output electrical format for the AESEBU transmitter.

Returns:
0 on success, or one of the HPI_ERROR_CODES.
Parameters:
phSubSysVestigial subsys handle (unused), may be set to NULL
hControlHandle to control of type HPI_CONTROL_AESEBU_TRANSMITTER.
pwOutputFormatCurrent format, one of the HPI_AESEBU_FORMATS.