Interface that provides the core methods for Buffer objects.
Definition at line 354 of file BufferStream.h.
◆ ~IBuffer()
| Argus::IBuffer::~IBuffer |
( |
| ) |
|
|
inlineprotected |
◆ getBufferType()
| virtual BufferType Argus::IBuffer::getBufferType |
( |
| ) |
const |
|
pure virtual |
Returns the BufferType of the Buffer.
◆ getClientData()
| virtual const void* Argus::IBuffer::getClientData |
( |
| ) |
const |
|
pure virtual |
Returns the client data from the Buffer.
◆ getMetadata()
Returns the CaptureMetadata object that was attached to this Buffer when it was last output to the stream from the result of a successful capture request.
This method should only ever be called while the Buffer is in an acquired state; ie. the time between when the Buffer was acquired by IBufferOutputStream::acquireBuffer and when it was released by IBufferOutputStream::releaseBuffer. If called outside of the acquired state, NULL will be returned. Similarly, the returned object will only remain valid so long as the Buffer is acquired – if this object or any of its interfaces are accessed outside of the acquired state, undefined results or abnormal process termination may occur.
Metadata will only be written if metadata is enabled for the stream (see IBufferOutputStreamSettings::setMetadataEnable). NULL may also still be returned if there were any capture errors or metadata is otherwise unavailable.
◆ getSyncType()
| virtual SyncType Argus::IBuffer::getSyncType |
( |
| ) |
const |
|
pure virtual |
Returns the SyncType of the Buffer.
◆ id()
◆ setClientData()
| virtual void Argus::IBuffer::setClientData |
( |
const void * |
clientData | ) |
|
|
pure virtual |
Sets the client data for the Buffer.
This is provided as a convenience for applications to be able to map Buffers to other client-managed data. It is not used at all by the libargus implementation, and is returned as-is by getClientData. Default value: NULL
- Parameters
-
| [in] | clientData | The client data pointer to set in the buffer. |
The documentation for this class was generated from the following file:
