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:
-
| hCobranetRx | A handle to an ASX cobranet receiver control. |
| pnBundle | Bundle 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:
-
| hCobranetRx | A handle to an ASX cobranet receiver control. |
| nMap | Audio 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:
-
| hCobranetRx | A handle to an ASX cobranet receiver control. |
| pnMinDelay | Minimum 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:
-
| hCobranetRx | A handle to an ASX cobranet receiver control. |
| pdwMAC_MSBs | Gets the four most significant bytes of the source MAC address. |
| pwMAC_LSBs | Gets 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:
-
| hCobranetRx | A handle to an ASX cobranet receiver control. |
| pnStatus | 1 indicates a bundle is being received. 0 indicates no bundle is being received. |
| pnDropouts | Counts the number of times bundle reception has been interrupted. |
| pnDelay | A 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. |
| nFormat | The 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
|
| 0 | invalid | invalid | invalid |
| 0x044000 | 16-bit | 48 kHz | 5-1/3 ms |
| 0x054000 | 20-bit | 48 kHz | 5-1/3 ms |
| 0x064000 | 24-bit | 48 kHz | 5-1/3 ms |
| 0x148000 | 16-bit | 96 kHz | 5-1/3 ms |
| 0x158000 | 20-bit | 96 kHz | 5-1/3 ms |
| 0x168000 | 24-bit | 96 kHz | 5-1/3 ms |
| 0x042000 | 16-bit | 48 kHz | 2-2/3 ms |
| 0x052000 | 20-bit | 48 kHz | 2-2/3 ms |
| 0x062000 | 24-bit | 48 kHz | 2-2/3 ms |
| 0x144000 | 16-bit | 96 kHz | 2-2/3 ms |
| 0x154000 | 20-bit | 96 kHz | 2-2/3 ms |
| 0x164000 | 24-bit | 96 kHz | 2-2/3 ms |
| 0x041000 | 16-bit | 48 kHz | 1-1/3 ms |
| 0x051000 | 20-bit | 48 kHz | 1-1/3 ms |
| 0x061000 | 24-bit | 48 kHz | 1-1/3 ms |
| 0x142000 | 16-bit | 96 kHz | 1-1/3 ms |
| 0x152000 | 20-bit | 96 kHz | 1-1/3 ms |
| 0x162000 | 24-bit | 96 kHz | 1-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:
-
| hCobranetRx | A handle to an ASX cobranet receiver control. |
| nBundle | Bundle 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:
-
| hCobranetRx | A handle to an ASX cobranet receiver control. |
| nMap | Audio 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:
-
| hCobranetRx | A handle to an ASX cobranet receiver control. |
| nMinDelay | Minium 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:
-
| hCobranetRx | A handle to an ASX cobranet receiver control. |
| dwMAC_MSBs | Sets the four most significant bytes of the source MAC address. |
| wMAC_LSBs | Sets the two least significant bytes of the source MAC address. |
- Returns:
- Returns 0 if there is no error, otherwise one of asxERROR is returned.