MX Foundation 4
|
Functions | |
uint32 | mxfHDLCTxAperiodicWrite (HMXF_BUFFER buffer, uint64 options, uint64 startTime, uint64 count, MXF_HDLC_DATAREC *rec) |
uint32 | mxfHDLCRxAcqRead (HMXF_BUFFER buffer, uint64 maxMsgCount, uint64 maxBytesCount, uint64 *status, uint64 *msgCount, uint64 *byteCount, MXF_HDLC_DATAREC *rec) |
uint32 | mxfHDLCNextDataRecordPtrGet (MXF_HDLC_DATAREC *currentRec, MXF_HDLC_DATAREC **nextRec) |
uint32 | mxfHDLCEmbeddedNVStorageFileMsgRead (HMXF_NVSTORAGE nvStorage, uint64 fileIndex, uint64 maxMsgCount, uint64 maxBytesCount, uint64 *msgCount, uint64 *byteCount, MXF_HDLC_DATAREC *msg) |
uint32 | mxfHDLCEmbeddedNVStorageFileMsgWrite (HMXF_NVSTORAGE nvStorage, uint64 fileIndex, uint64 maxMsgCount, MXF_HDLC_DATAREC *msg, uint64 *count) |
uint32 | mxfHDLCChannelEnable (HMXF_CHANNEL channelHandle, uint64 clockSource) |
uint32 | mxfHDLCChannelDisable (HMXF_CHANNEL channelHandle) |
uint32 mxfHDLCTxAperiodicWrite | ( | HMXF_BUFFER | buffer, |
uint64 | options, | ||
uint64 | startTime, | ||
uint64 | count, | ||
MXF_HDLC_DATAREC * | rec | ||
) |
Sends aperiodic data record for transmission. The data items to be transmitted are specified within the records, along with an optional time tag. The first data item is transmitted at the specified starting time.
The records to transmit on time tag must be placed in chronological order in the array. The same time tag must not appear more than once in the array. When the start time is specified the time tag of the first record or the start time should be at least 50 msec in advance to be relatively precise, otherwise it will be sent as soon as possible. Also, the cumulative time of all record’s time tag and the start time must be smaller than 30 seconds.
[in] | buffer | buffer handle. |
[in] | options | options for controlling the transmitter before for sending the data records. The details of the options are explained below.
|
[in] | startTime | start time based on the timebase. This is the time at which the data held in the first record is transmitted by the device. The time is either expressed accordingly to the process time base or relative to the current real-time clock value (i.e. offset in the future). If the bit MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME of the transmit flag is set, then the start time is specified in absolute time (rather than relative). MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME or MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME options can't be used with a start time. |
[in] | count | number of records to write. |
[in] | rec | pointer to MXF_HDLC_DATAREC records to write. The records in the buffer need to be indexed using mxfHDLCNextDataRecordPtrGet() function. |
The options modify the transmission scheme as described below:
This flag can’t be used with MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME, MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME or a start time.Time rec1 = Transmission offset (min 50 msec)
Time rec2 = Time rec1 + (rec2 time tag – rec1 time tag )
Time rec3 = Time rec2 + (rec3 time tag – rec2 time tag )
…
Time recN = Time recN-1 + (recN time tag - recN-1 time tag )
uint32 mxfHDLCRxAcqRead | ( | HMXF_BUFFER | buffer, |
uint64 | maxMsgCount, | ||
uint64 | maxBytesCount, | ||
uint64 * | status, | ||
uint64 * | msgCount, | ||
uint64 * | byteCount, | ||
MXF_HDLC_DATAREC * | rec | ||
) |
Transfers the records from the channel acquisition buffer to the calling application.
[in] | buffer | buffer handle. |
[in] | maxMsgCount | maximum messages to read (0 means all messages). |
[in] | maxBytesCount | maximum number of bytes to be read. |
[out] | status | last status set. |
[out] | msgCount | number of records returned. |
[out] | byteCount | number of bytes returned. |
[out] | rec | address of data records. The records in the buffer need to be indexed using mxfHDLCNextDataRecordPtrGet() function. |
uint32 mxfHDLCNextDataRecordPtrGet | ( | MXF_HDLC_DATAREC * | currentRec, |
MXF_HDLC_DATAREC ** | nextRec | ||
) |
Returns the next buffer address in a MXF_HDLC_DATAREC buffer array.
[in] | currentRec | pointer to the beginning or the current record in the buffer. |
[out] | nextRec | pointer to next record in the buffer. |
uint32 mxfHDLCEmbeddedNVStorageFileMsgRead | ( | HMXF_NVSTORAGE | nvStorage, |
uint64 | fileIndex, | ||
uint64 | maxMsgCount, | ||
uint64 | maxBytesCount, | ||
uint64 * | msgCount, | ||
uint64 * | byteCount, | ||
MXF_HDLC_DATAREC * | msg | ||
) |
Reads the records from a specific file. The messages format must be of type MXF_EMBEDDED_NVSTORAGE_MSGTYPE_HDLC.
[in] | nvStorage | non-volatile storage handle |
[in] | fileIndex | file index |
[in] | maxMsgCount | maximum number of messages that can be returned |
[in] | maxBytesCount | maximum byte count that can be returned |
[out] | msgCount | count of messages returned |
[out] | byteCount | number of bytes returned in the msg buffer |
[out] | msg | pointer to read buffer containing messages. The records in the buffer need to be indexed using the mxfHDLCNextDataRecordPtrGet() function. |
uint32 mxfHDLCEmbeddedNVStorageFileMsgWrite | ( | HMXF_NVSTORAGE | nvStorage, |
uint64 | fileIndex, | ||
uint64 | maxMsgCount, | ||
MXF_HDLC_DATAREC * | msg, | ||
uint64 * | count | ||
) |
Writes messages to the specified file. The messages format must be of type MXF_EMBEDDED_NVSTORAGE_MSGTYPE_HDLC.
[in] | nvStorage | non-volatile storage handle |
[in] | fileIndex | file index |
[in] | maxMsgCount | maximum number of messages to write |
[in] | msg | pointer to messages to write. The records in the buffer need to be indexed using mxfHDLCNextDataRecordPtrGet() function. |
[out] | count | number of messages actually written |
uint32 mxfHDLCChannelEnable | ( | HMXF_CHANNEL | channelHandle, |
uint64 | clockSource | ||
) |
Enable the HDLC channel and, when necessary, its corresponding clock channel.
On Tx channel, when enabling with clockSource set to VMXF_HDLC_CLOCK_SOURCE_INTERNAL, this will start transmitting the clock. If the Tx channel is configured with KMXF_HDLC_TX_INTERFRAME_TIME_FILL set to VMXF_HDLC_TX_INTERFRAME_TIME_FILL_FLAGS, it will also start transmitting flags.
On Tx channel, when enabling with clockSource set to VMXF_HDLC_CLOCK_SOURCE_EXTERNAL, the clock signal must be present on corresponding Rx clock channel. If the Tx channel is configured with KMXF_HDLC_TX_INTERFRAME_TIME_FILL set to VMXF_HDLC_TX_INTERFRAME_TIME_FILL_FLAGS, it will also start transmitting flags based on receive clock.
On Rx channel, when enabling with clockSource set to VMXF_HDLC_CLOCK_SOURCE_INTERNAL, this will start transmitting the clock.
On Rx channel, when enabling with clockSource set to VMXF_HDLC_CLOCK_SOURCE_EXTERNAL, the clock signal must be present on corresponding Rx clock channel.
[in] | channelHandle | channel handle | ||||||||
[in] | clockSource | clock source
|
uint32 mxfHDLCChannelDisable | ( | HMXF_CHANNEL | channelHandle | ) |
Disable the HDLC channel and, when necessary, its corresponding clock channel
On Tx channel, this will stop data and clock transmission.
On Rx channel, this will stop clock transmission on corresponding Tx clock channel.
Note that if the opposite channel is also using the clock as an output, disabling the channel will not stop the clock transmission until both channels are disabled.
[in] | channelHandle | channel handle |