Data Exchange Receiver interface: Vst::IDataExchangeReceiver. More...

#include <ivstdataexchange.h>

Inheritance diagram for IDataExchangeReceiver:

Public Member Functions
virtual void	queueOpened (DataExchangeUserContextID userContextID, uint32 blockSize, TBool &dispatchOnBackgroundThread)=0
	queue opened notification More...

virtual void	queueClosed (DataExchangeUserContextID userContextID)=0
	queue closed notification More...

virtual void	onDataExchangeBlocksReceived (DataExchangeUserContextID userContextID, uint32 numBlocks, DataExchangeBlock *blocks, TBool onBackgroundThread)=0
	one or more blocks were received More...

Public Member Functions inherited from FUnknown
virtual tresult	queryInterface (const TUID _iid, void **obj)=0

virtual uint32	addRef ()=0

virtual uint32	release ()=0

Static Public Attributes
static const FUID	iid

Static Public Attributes inherited from FUnknown
static const FUID	iid

Detailed Description

Data Exchange Receiver interface: Vst::IDataExchangeReceiver.

The receiver interface is required to receive data from the realtime audio process via the IDataExchangeHandler.

Member Function Documentation

virtual void queueOpened	(	DataExchangeUserContextID	userContextID,
		uint32	blockSize,
		TBool &	dispatchOnBackgroundThread
	)

pure virtual

queue opened notification

called on the main thread when the processor has opened a queue

Parameters

userContextID	the user context ID of the queue
blockSize	the size of one block of the queue
dispatchedOnBackgroundThread	if true on output the blocks are dispatched on a background thread [defaults to false in which case the blocks are dispatched on the main thread]

virtual void queueClosed ( DataExchangeUserContextID userContextID )

pure virtual

queue closed notification

called on the main thread when the processor has closed a queue

Parameters

userContextID the user context ID of the queue

virtual void onDataExchangeBlocksReceived	(	DataExchangeUserContextID	userContextID,
		uint32	numBlocks,
		DataExchangeBlock *	blocks,
		TBool	onBackgroundThread
	)

pure virtual

one or more blocks were received

called either on the main thread or a background thread depending on the dispatchOnBackgroundThread value in the queueOpened call.

the data of the blocks are only valid inside this call and the blocks only become available to the queue afterwards.

Parameters

userContextID	the user context ID of the queue
numBlocks	number of blocks
blocks	the blocks
onBackgroundThread	true if the call is done on a background thread

const FUID iid

static