ASX Version4.13.09
Functions

Cobranet receiver control functions

These functions implement Cobranet receiver configuration. More...

Functions

ASX32_API ASX_ERROR ASX_CobranetRx_GetStatus (ASX_HANDLE hCobranetRx, unsigned int *pnStatus, unsigned int *pnDropouts, unsigned int *pnDelay, unsigned int nFormat[8])
 Gets a Cobranet receiver's status.
ASX32_API ASX_ERROR ASX_CobranetRx_GetBundle (ASX_HANDLE hCobranetRx, unsigned int *pnBundle)
 Gets a Cobranet receiver's bundle.
ASX32_API ASX_ERROR ASX_CobranetRx_SetBundle (ASX_HANDLE hCobranetRx, const unsigned int nBundle)
 Sets a Cobranet receiver's bundle.
ASX32_API ASX_ERROR ASX_CobranetRx_GetSourceMAC (ASX_HANDLE hCobranetRx, unsigned int *pdwMAC_MSBs, unsigned short *pwMAC_LSBs)
 Gets a Cobranet receiver's source MAC address for private bundles.
ASX32_API ASX_ERROR ASX_CobranetRx_SetSourceMAC (ASX_HANDLE hCobranetRx, const unsigned int dwMAC_MSBs, const unsigned short wMAC_LSBs)
 Sets a Cobranet receiver's source MAC address for private bundles.
ASX32_API ASX_ERROR ASX_CobranetRx_GetChannelMap (ASX_HANDLE hCobranetRx, unsigned int nMap[8])
 Gets a Cobranet receiver's channel mapping.
ASX32_API ASX_ERROR ASX_CobranetRx_SetChannelMap (ASX_HANDLE hCobranetRx, const unsigned int nMap[8])
 Sets a Cobranet receiver's channel mapping.
ASX32_API ASX_ERROR ASX_CobranetRx_GetMinimumDelay (ASX_HANDLE hCobranetRx, unsigned int *pnMinDelay)
 Gets a Cobranet receiver's minimum delay.
ASX32_API ASX_ERROR ASX_CobranetRx_SetMinimumDelay (ASX_HANDLE hCobranetRx, const unsigned int nMinDelay)
 Sets a Cobranet receiver's channel mapping.

Detailed Description

These functions implement Cobranet receiver configuration.


Function Documentation

ASX32_API ASX_ERROR ASX_CobranetRx_GetBundle ( ASX_HANDLE  hCobranetRx,
unsigned int *  pnBundle 
)

Gets a Cobranet receiver's bundle.

Parameters:
hCobranetRxA handle to an ASX cobranet receiver control.
pnBundleBundle number being received. 0 indicates no bundle is being received.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
cobranet/main.c.
ASX32_API ASX_ERROR ASX_CobranetRx_GetChannelMap ( ASX_HANDLE  hCobranetRx,
unsigned int  nMap[8] 
)

Gets a Cobranet receiver's channel mapping.

Parameters:
hCobranetRxA handle to an ASX cobranet receiver control.
nMapAudio channel mapping.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
Examples:
cobranet/main.c.
ASX32_API ASX_ERROR ASX_CobranetRx_GetMinimumDelay ( ASX_HANDLE  hCobranetRx,
unsigned int *  pnMinDelay 
)

Gets a Cobranet receiver's minimum delay.

Parameters:
hCobranetRxA handle to an ASX cobranet receiver control.
pnMinDelayMinimum received audio delay.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_CobranetRx_GetSourceMAC ( ASX_HANDLE  hCobranetRx,
unsigned int *  pdwMAC_MSBs,
unsigned short *  pwMAC_LSBs 
)

Gets a Cobranet receiver's source MAC address for private bundles.

Parameters:
hCobranetRxA handle to an ASX cobranet receiver control.
pdwMAC_MSBsGets the four most significant bytes of the source MAC address.
pwMAC_LSBsGets the two least significant bytes of the source MAC address.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_CobranetRx_GetStatus ( ASX_HANDLE  hCobranetRx,
unsigned int *  pnStatus,
unsigned int *  pnDropouts,
unsigned int *  pnDelay,
unsigned int  nFormat[8] 
)

Gets a Cobranet receiver's status.

This function reads SNMP variables rxStatus, rxDropouts, rxDelay and rxSubFormat.

Parameters:
hCobranetRxA handle to an ASX cobranet receiver control.
pnStatus1 indicates a bundle is being received. 0 indicates no bundle is being received.
pnDropoutsCounts the number of times bundle reception has been interrupted.
pnDelayA non-zero value indicates the number of additional delays imposed on the received audio due to network forwarding delays. Delay is expressed in units of the system latency. ie 1-1/3ms for 5-1/3ms latency.
nFormatThe format information for the received audio channels. Subformat codes are shown in the following table. The least significant bit of the subformat entries is set when the received format is supported for reception by the CobraNet interface. A test of this least significant bit can be used to determine correct reception on a per audio channel basis.

txSubFormat value

Resolution

Sample Rate

Latency

0invalidinvalidinvalid
0x04400016-bit48 kHz5-1/3 ms
0x05400020-bit48 kHz5-1/3 ms
0x06400024-bit48 kHz5-1/3 ms
0x14800016-bit96 kHz5-1/3 ms
0x15800020-bit96 kHz5-1/3 ms
0x16800024-bit96 kHz5-1/3 ms
0x04200016-bit48 kHz2-2/3 ms
0x05200020-bit48 kHz2-2/3 ms
0x06200024-bit48 kHz2-2/3 ms
0x14400016-bit96 kHz2-2/3 ms
0x15400020-bit96 kHz2-2/3 ms
0x16400024-bit96 kHz2-2/3 ms
0x04100016-bit48 kHz1-1/3 ms
0x05100020-bit48 kHz1-1/3 ms
0x06100024-bit48 kHz1-1/3 ms
0x14200016-bit96 kHz1-1/3 ms
0x15200020-bit96 kHz1-1/3 ms
0x16200024-bit96 kHz1-1/3 ms
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_CobranetRx_SetBundle ( ASX_HANDLE  hCobranetRx,
const unsigned int  nBundle 
)

Sets a Cobranet receiver's bundle.

Parameters:
hCobranetRxA handle to an ASX cobranet receiver control.
nBundleBundle number to receive. 0 indicates no bundle is being received.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_CobranetRx_SetChannelMap ( ASX_HANDLE  hCobranetRx,
const unsigned int  nMap[8] 
)

Sets a Cobranet receiver's channel mapping.

Parameters:
hCobranetRxA handle to an ASX cobranet receiver control.
nMapAudio channel mapping.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_CobranetRx_SetMinimumDelay ( ASX_HANDLE  hCobranetRx,
const unsigned int  nMinDelay 
)

Sets a Cobranet receiver's channel mapping.

Selects a minimum additional delay imposed on the received audio. Delay is expressed in units of isochronous cycles (1-1/3ms for standard 5-1/3ms latency mode, 2/3ms for 2-2/3ms latency mode and 1/3ms for 1-1/3ms latency mode). This variable is designed to allow configuration of a deterministic common delay for all Cobranet interfaces in larger network installations. rxDelay will never be reduced below this setting. This variable is not designed for actively delaying audio for architectural applications.

Parameters:
hCobranetRxA handle to an ASX cobranet receiver control.
nMinDelayMinium audio delay.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.
ASX32_API ASX_ERROR ASX_CobranetRx_SetSourceMAC ( ASX_HANDLE  hCobranetRx,
const unsigned int  dwMAC_MSBs,
const unsigned short  wMAC_LSBs 
)

Sets a Cobranet receiver's source MAC address for private bundles.

Parameters:
hCobranetRxA handle to an ASX cobranet receiver control.
dwMAC_MSBsSets the four most significant bytes of the source MAC address.
wMAC_LSBsSets the two least significant bytes of the source MAC address.
Returns:
Returns 0 if there is no error, otherwise one of asxERROR is returned.