MX Foundation 4
|
Functions | |
uint32 | mxfChannelInfoGet (HMXF_HANDLE handle, HMXF_DEVICE *device, HMXF_MODULE *module) |
uint32 | mxfChannelDirectionGet (HMXF_CHANNEL channel, uint64 *direction) |
uint32 | mxfChannelLocationGet (HMXF_CHANNEL channel, uint64 *deviceIndex, uint64 *moduleIndex, uint64 *channelIndex) |
uint32 | mxfChannelRecordSizeGet (HMXF_CHANNEL channel, uint64 *size) |
uint32 | mxfChannelRxStatusGet (HMXF_CHANNEL channel, uint64 *status) |
uint32 | mxfChannelTxStatusGet (HMXF_CHANNEL channel, uint64 *status) |
uint32 | mxfModuleTxStatusGet (HMXF_MODULE handle, uint64 *status) |
uint32 | mxfChannelTxPortEnableSet (HMXF_CHANNEL channel, uint64 enable) |
uint32 | mxfChannelTxPortEnableGet (HMXF_CHANNEL channel, uint64 *enable) |
uint32 | mxfChannelStatisticGet (HMXF_HANDLE handle, uint64 type, void *stat) |
uint32 | mxfChannelStatisticReset (HMXF_HANDLE handle, uint64 options) |
uint32 | mxfChannelStatisticEnableSet (HMXF_HANDLE handle, uint64 enable) |
uint32 | mxfChannelStatisticEnableGet (HMXF_HANDLE handle, uint64 *enable) |
uint32 | mxfChannelDiscreteOutputTriggerEnableSet (HMXF_CHANNEL channel, uint64 trigEvent, uint64 enable, uint64 discretePort) |
uint32 | mxfChannelDiscreteOutputTriggerEnableGet (HMXF_CHANNEL channel, uint64 trigEvent, uint64 *enable, uint64 *discretePort) |
uint32 | mxfChannelClassSet (HMXF_CHANNEL channelHandle, uint64 chnClassID) |
uint32 | mxfChannelClassGet (HMXF_CHANNEL channelHandle, uint64 *chnClassID) |
uint32 | mxfChannelClassListGet (HMXF_CHANNEL channelHandle, uint64 maxCount, uint64 *count, uint64 chnClassIDList[]) |
uint32 mxfChannelInfoGet | ( | HMXF_HANDLE | handle, |
HMXF_DEVICE * | device, | ||
HMXF_MODULE * | module | ||
) |
Returns the device and module handle related to a logical channel.
[in] | handle | channel, A664 vl or A664 port handle |
[out] | device | pointer to device handle. Pass NULL to ignore this parameter. |
[out] | module | pointer to module handle. Pass NULL to ignore this parameter. |
uint32 mxfChannelDirectionGet | ( | HMXF_CHANNEL | channel, |
uint64 * | direction | ||
) |
Returns the channel direction (TX or RX or both).
[in] | channel | logical channel handle | ||||||||
[out] | direction | direction
|
uint32 mxfChannelLocationGet | ( | HMXF_CHANNEL | channel, |
uint64 * | deviceIndex, | ||
uint64 * | moduleIndex, | ||
uint64 * | channelIndex | ||
) |
Returns the physical port location (device, module and port number) for the specified channel.
[in] | channel | channel handle |
[out] | deviceIndex | device index |
[out] | moduleIndex | module index |
[out] | channelIndex | channel index |
uint32 mxfChannelRecordSizeGet | ( | HMXF_CHANNEL | channel, |
uint64 * | size | ||
) |
Returns the channel data record structure size.
[in] | channel | channel handle |
[out] | size | returned record size, in bytes. |
uint32 mxfChannelRxStatusGet | ( | HMXF_CHANNEL | channel, |
uint64 * | status | ||
) |
Returns the RX channel status.
[in] | channel | channel handle | ||||||||||||
[out] | status | status bits
|
uint32 mxfChannelTxStatusGet | ( | HMXF_CHANNEL | channel, |
uint64 * | status | ||
) |
Returns the TX channel status.
[in] | channel | channel handle | ||||||||||||
[out] | status | status bits
|
uint32 mxfModuleTxStatusGet | ( | HMXF_MODULE | handle, |
uint64 * | status | ||
) |
Returns the TX module status.
[in] | handle | module handle | ||||||||
[out] | status | status bits
|
uint32 mxfChannelTxPortEnableSet | ( | HMXF_CHANNEL | channel, |
uint64 | enable | ||
) |
Enables or disables the channel physical port. Set value to FALSE to disable the transmitter and to TRUE to enable it. When the transmitter is disabled, everything will work exactly the same as if it's enabled, but the data will not be sent. This function has no effect when internal loopback is enabled.
[in] | channel | channel handle | ||||||
[in] | enable | new state for the channel
|
uint32 mxfChannelTxPortEnableGet | ( | HMXF_CHANNEL | channel, |
uint64 * | enable | ||
) |
Returns the channel physical port state.
[in] | channel | channel handle | ||||||
[out] | enable | port state
|
uint32 mxfChannelStatisticGet | ( | HMXF_HANDLE | handle, |
uint64 | type, | ||
void * | stat | ||
) |
Returns the statistics for the specified channel.
[in] | handle | channel or vl handle | ||||||||||||||||||||||||||||||||||||||
[in] | type | statistic type
| ||||||||||||||||||||||||||||||||||||||
[out] | stat | pointer to statistical structure returned
|
uint32 mxfChannelStatisticReset | ( | HMXF_HANDLE | handle, |
uint64 | options | ||
) |
Resets all statistical counters for the specified channel.
[in] | handle | channel or vl handle | ||||
[in] | options | reserved for future. Must be set to 0.
|
uint32 mxfChannelStatisticEnableSet | ( | HMXF_HANDLE | handle, |
uint64 | enable | ||
) |
Sets the statistics enable state for the specified channel.
[in] | handle | channel or vl handle | ||||||
[in] | enable | state
|
uint32 mxfChannelStatisticEnableGet | ( | HMXF_HANDLE | handle, |
uint64 * | enable | ||
) |
Gets the statistics enable state for the specified channel.
[in] | handle | channel or vl handle | ||||||
[out] | enable | pointer to the state variable
|
uint32 mxfChannelDiscreteOutputTriggerEnableSet | ( | HMXF_CHANNEL | channel, |
uint64 | trigEvent, | ||
uint64 | enable, | ||
uint64 | discretePort | ||
) |
Configures the discrete output trigger event.
This function is not supported for channels of IPM or FlexMAX modules.
[in] | channel | channel handle | ||||||||||||||||||||||||||||||
[in] | trigEvent | trigger event
| ||||||||||||||||||||||||||||||
[in] | enable | enable state
| ||||||||||||||||||||||||||||||
[in] | discretePort | Discrete output pin to use (pin 0 to 7) |
uint32 mxfChannelDiscreteOutputTriggerEnableGet | ( | HMXF_CHANNEL | channel, |
uint64 | trigEvent, | ||
uint64 * | enable, | ||
uint64 * | discretePort | ||
) |
Gets the configuration of the discrete output trigger event. This function is not supported for channels of IPM or FlexMAX modules.
[in] | channel | channel handle | ||||||||||||||||||||||||||||||
[in] | trigEvent | trigger event
| ||||||||||||||||||||||||||||||
[out] | enable | enable state
| ||||||||||||||||||||||||||||||
[out] | discretePort | Discrete output pin that is used |
uint32 mxfChannelClassSet | ( | HMXF_CHANNEL | channelHandle, |
uint64 | chnClassID | ||
) |
Sets the channel class for the specified channel.
[in] | channelHandle | channel handle | ||||||||||||||||||||
[in] | chnClassID | channel class to set
|
uint32 mxfChannelClassGet | ( | HMXF_CHANNEL | channelHandle, |
uint64 * | chnClassID | ||
) |
Gets the current channel class for the specified channel.
[in] | channelHandle | channel handle | ||||||||||||||||||||||||||||||||||||||||
[out] | chnClassID | pointer to the channel class variable
|
uint32 mxfChannelClassListGet | ( | HMXF_CHANNEL | channelHandle, |
uint64 | maxCount, | ||
uint64 * | count, | ||
uint64 | chnClassIDList[] | ||
) |
Gets the list of available channel class for the specified channel.
[in] | channelHandle | channel handle | ||||||||||||||||||||||||||||||||||||||||
[in] | maxCount | maximum count of channel class to be returned in chnClassIDList | ||||||||||||||||||||||||||||||||||||||||
[out] | count | actual count of channel class to be returned chnClassIDList | ||||||||||||||||||||||||||||||||||||||||
[out] | chnClassIDList | pointer to the channel class array variable
|