Shared Buffer

Functions
uint32	mxfEmbeddedSharedBufferRead (HMXF_DEVICE device, uint64 offset, uint64 size, uint32 *data)
uint32	mxfEmbeddedSharedBufferWrite (HMXF_DEVICE device, uint64 offset, uint64 size, uint32 *data)

Detailed Description

Function Documentation

uint32 mxfEmbeddedSharedBufferRead	(	HMXF_DEVICE	device,
		uint64	offset,
		uint64	size,
		uint32 *	data
	)

C#

public static extern UInt32 mxfEmbeddedSharedBufferRead(UInt64 device, UInt64 offset, UInt64 size, [Out] UInt32[] data);

Reads data from shared buffer memory on the specified device.

A specific region of memory must be reserved on the device before the initialization by using the mxfSystemInitAttributeUint64CallbackHandler() and KMXF_DEVICE_EMBEDDED_SHARED_SIZE attribute.

Parameters

[in]	device	device handle
[in]	offset	offset from the beginning of the shared memory in 32-bit basis
[in]	size	number of 32-bit word to read
[out]	data	pointer to read buffer

Returns

MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:

Available in MX Foundation 4.0 and later.

See also

mxfEmbeddedSharedBufferWrite()

uint32 mxfEmbeddedSharedBufferWrite	(	HMXF_DEVICE	device,
		uint64	offset,
		uint64	size,
		uint32 *	data
	)

C#

public static extern UInt32 mxfEmbeddedSharedBufferWrite(UInt64 device, UInt64 offset, UInt64 size, UInt32[] data);

Writes data to the shared buffer memory on the specified device.

A specific region of memory must be reserved on the device before the initialization by using the mxfSystemInitAttributeUint64CallbackHandler() and KMXF_DEVICE_EMBEDDED_SHARED_SIZE attribute.

The data in the buffer is copied using 32-bit access. To avoid any endianness mapping issues, it is recommended to use only 32-bit data format for this buffer.

Parameters

[in]	device	device handle
[in]	offset	offset from the beginning of the shared memory in 32-bit basis
[in]	size	number of 32-bit word to write
[in]	data	pointer to write buffer

Returns

MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:

Available in MX Foundation 4.0 and later.

See also

mxfEmbeddedSharedBufferRead()