These functions implement Cobranet transmitter configuration. More...

Functions
ASX32_API ASX_ERROR	ASX_CobranetTx_GetStatus (ASX_HANDLE hCobranetTx, unsigned int pnDropouts, unsigned int pnPosition, unsigned int *pnReceivers)
	Gets a Cobranet transmitter's status.
ASX32_API ASX_ERROR	ASX_CobranetTx_GetBundle (ASX_HANDLE hCobranetTx, unsigned int *pnBundle)
	Gets a Cobranet transmitter's bundle.
ASX32_API ASX_ERROR	ASX_CobranetTx_SetBundle (ASX_HANDLE hCobranetTx, const unsigned int nBundle)
	Sets a Cobranet transmitter's bundle.
ASX32_API ASX_ERROR	ASX_CobranetTx_GetChannelCount (ASX_HANDLE hCobranetTx, unsigned int *pnCount)
	Gets a Cobranet transmitter's channel count.
ASX32_API ASX_ERROR	ASX_CobranetTx_SetChannelCount (ASX_HANDLE hCobranetTx, const unsigned int nCount)
	Sets a Cobranet transmitter's channel count.
ASX32_API ASX_ERROR	ASX_CobranetTx_GetChannelMap (ASX_HANDLE hCobranetTx, unsigned int nMap[8])
	Gets a Cobranet transmitter's channel map.
ASX32_API ASX_ERROR	ASX_CobranetTx_SetChannelMap (ASX_HANDLE hCobranetTx, const unsigned int nMap[8])
	Sets a Cobranet transmitter's channel map.
ASX32_API ASX_ERROR	ASX_CobranetTx_GetFormat (ASX_HANDLE hCobranetTx, enum asxAUDIO_FORMAT *peFormat)
	Gets a Cobranet transmitter's sub format map.
ASX32_API ASX_ERROR	ASX_CobranetTx_SetFormat (ASX_HANDLE hCobranetTx, const enum asxAUDIO_FORMAT eFormat)
	Sets a Cobranet transmitter's channel format.
ASX32_API ASX_ERROR	ASX_CobranetTx_GetUnicastMode (ASX_HANDLE hCobranetTx, unsigned int pnUnicastMode, unsigned int pnMaxUnicast)
	Gets a Cobranet transmitter's unicast information.
ASX32_API ASX_ERROR	ASX_CobranetTx_SetUnicastMode (ASX_HANDLE hCobranetTx, const unsigned int nUnicastMode, const unsigned int nMaxUnicast)
	Sets a Cobranet transmitter's unicast information.

Detailed Description

These functions implement Cobranet transmitter configuration.

Function Documentation

ASX32_API ASX_ERROR ASX_CobranetTx_GetBundle	(	ASX_HANDLE	hCobranetTx,
		unsigned int *	pnBundle
	)

Gets a Cobranet transmitter's bundle.

Parameters:

hCobranetTx	A handle to an ASX cobranet transmitter control.
pnBundle	The transmitter's assigned bundle. A value of 0 indicates that the tranmitter is disabled.

Returns:: Returns 0 if there is no error, otherwise one of asxERROR is returned.

Examples:: cobranet/main.c.

ASX32_API ASX_ERROR ASX_CobranetTx_GetChannelCount	(	ASX_HANDLE	hCobranetTx,
		unsigned int *	pnCount
	)

Gets a Cobranet transmitter's channel count.

Parameters:

hCobranetTx	A handle to an ASX cobranet transmitter control.
pnCount	The number of audio channels to transmit in a bundle. This is SNMP variable txSubCount.

Returns:: Returns 0 if there is no error, otherwise one of asxERROR is returned.

Examples:: cobranet/main.c.

ASX32_API ASX_ERROR ASX_CobranetTx_GetChannelMap	(	ASX_HANDLE	hCobranetTx,
		unsigned int	nMap[8]
	)

Gets a Cobranet transmitter's channel map.

This controls which audio routing channels are transmitted.

Parameters:

hCobranetTx	A handle to an ASX cobranet transmitter control.
nMap	The channel map returned in an array of size 8.

Returns:: Returns 0 if there is no error, otherwise one of asxERROR is returned.

Examples:: cobranet/main.c.

ASX32_API ASX_ERROR ASX_CobranetTx_GetFormat	(	ASX_HANDLE	hCobranetTx,
		enum asxAUDIO_FORMAT *	peFormat
	)

Gets a Cobranet transmitter's sub format map.

This contains transmit format information.

Parameters:

hCobranetTx	A handle to an ASX cobranet transmitter control.
peFormat	The format returned, will be asxAUDIO_FORMAT_PCM16, asxAUDIO_FORMAT_PCM20, asxAUDIO_FORMAT_PCM24 or asxAUDIO_FORMAT_NONE.

Returns:: Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_CobranetTx_GetStatus	(	ASX_HANDLE	hCobranetTx,
		unsigned int *	pnDropouts,
		unsigned int *	pnPosition,
		unsigned int *	pnReceivers
	)

Gets a Cobranet transmitter's status.

This function reads SNMP variables txDropouts, txPosition, txReceivers.

Parameters:

hCobranetTx	A handle to an ASX cobranet transmitter control.
pnDropouts	Number of times transmission has been interrupted.
pnPosition	Transmission permission position.
pnReceivers	Number of receivers requesting the bundle transmitted by this transmitter.

Returns:: Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_CobranetTx_GetUnicastMode	(	ASX_HANDLE	hCobranetTx,
		unsigned int *	pnUnicastMode,
		unsigned int *	pnMaxUnicast
	)

Gets a Cobranet transmitter's unicast information.

This function reads SNMP variable txUnicastMode.

Parameters:

hCobranetTx	A handle to an ASX cobranet transmitter control.
pnUnicastMode	Specifies the number of unicast destinations served before switching to multicast.
pnMaxUnicast	Specifies the maximum number of unicast destinations.

Returns:: Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_CobranetTx_SetBundle	(	ASX_HANDLE	hCobranetTx,
		const unsigned int	nBundle
	)

Sets a Cobranet transmitter's bundle.

Parameters:

hCobranetTx	A handle to an ASX cobranet transmitter control.
nBundle	The bundle to assign to the transmitter. A value of 0 indicates that the tranmitter is disabled.

Returns:: Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_CobranetTx_SetChannelCount	(	ASX_HANDLE	hCobranetTx,
		const unsigned int	nCount
	)

Sets a Cobranet transmitter's channel count.

Parameters:

hCobranetTx	A handle to an ASX cobranet transmitter control.
nCount	The number of audio channels to transmit in a bundle. This is SNMP variable txSubCount.

Returns:: Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_CobranetTx_SetChannelMap	(	ASX_HANDLE	hCobranetTx,
		const unsigned int	nMap[8]
	)

Sets a Cobranet transmitter's channel map.

This controls which audio routing channels are transmitted.

Parameters:

hCobranetTx	A handle to an ASX cobranet transmitter control.
nMap	The channel map is passed as in an array of size 8.

Returns:: Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_CobranetTx_SetFormat	(	ASX_HANDLE	hCobranetTx,
		const enum asxAUDIO_FORMAT	eFormat
	)

Sets a Cobranet transmitter's channel format.

This controls the resolution, sample rate and latency of each transmitted channel. In practice all channels are set to the same value.

Parameters:

hCobranetTx	A handle to an ASX cobranet transmitter control.
eFormat	The channel format specification, can be asxAUDIO_FORMAT_PCM16, asxAUDIO_FORMAT_PCM20 or asxAUDIO_FORMAT_PCM24. Specify asxAUDIO_FORMAT_NONE to disable the transmitter (same effect as bundle==0).

Returns:: Returns 0 if there is no error, otherwise one of asxERROR is returned.

ASX32_API ASX_ERROR ASX_CobranetTx_SetUnicastMode	(	ASX_HANDLE	hCobranetTx,
		const unsigned int	nUnicastMode,
		const unsigned int	nMaxUnicast
	)

Sets a Cobranet transmitter's unicast information.

This function writes SNMP variable txUnicastMode.

Parameters:

hCobranetTx A handle to an ASX cobranet transmitter control.

nUnicastMode Specifies the number of unicast destinations served before switching to multicast. Value of 0x7FFFFF disables multicast addressing.

nMaxUnicast

Specifies the maximum number of unicast destinations.

nUnicastMode value

nMaxUnicast value

Effect

0

any

Always Multicast

0x7FFFFF

N (1 to 4)

Up to N receivers unicast. Additional receivers fail.

N

Up to N receivers unicast switch to multicast for more.

Returns:: Returns 0 if there is no error, otherwise one of asxERROR is returned.

Cobranet transmitter control functions

Functions

Detailed Description

Function Documentation