Interface that exposes the configuration available to Buffer-based OutputStreams.
Definition at line 156 of file BufferStream.h.
◆ ~IBufferOutputStreamSettings()
Argus::IBufferOutputStreamSettings::~IBufferOutputStreamSettings |
( |
| ) |
|
|
inlineprotected |
◆ getBufferType()
virtual BufferType Argus::IBufferOutputStreamSettings::getBufferType |
( |
| ) |
const |
|
pure virtual |
Returns the BufferType to be used for the stream.
◆ getMetadataEnable()
virtual bool Argus::IBufferOutputStreamSettings::getMetadataEnable |
( |
| ) |
const |
|
pure virtual |
Returns the metadata enable.
◆ getSyncType()
virtual SyncType Argus::IBufferOutputStreamSettings::getSyncType |
( |
| ) |
const |
|
pure virtual |
Returns the SyncType to be used for the stream.
◆ id()
static const InterfaceID& Argus::IBufferOutputStreamSettings::id |
( |
| ) |
|
|
inlinestatic |
◆ setBufferType()
virtual Status Argus::IBufferOutputStreamSettings::setBufferType |
( |
const BufferType & |
type | ) |
|
|
pure virtual |
Sets the BufferType for the stream.
This controls which type of native buffer type will be wrapped by this OutputStream, and thus will dictate which interfaces are supported by the OutputStream and child BufferSettings and Buffer objects. This value defaults to BUFFER_TYPE_NONE and must be set by the application to a BufferType supported by this libargus implementation.
- Parameters
-
◆ setMetadataEnable()
virtual void Argus::IBufferOutputStreamSettings::setMetadataEnable |
( |
bool |
enable | ) |
|
|
pure virtual |
Sets the metadata enable for the stream.
When metadata is enabled, a CaptureMetadata object may be attached to each Buffer when it is output from libargus as the result of a successful capture request (see IBuffer::getMetadata).
- Parameters
-
[in] | enable | Whether or not metadata is enabled for the stream. |
◆ setSyncType()
virtual Status Argus::IBufferOutputStreamSettings::setSyncType |
( |
const SyncType & |
type | ) |
|
|
pure virtual |
Sets the SyncType for the stream.
This controls which type of native sync information will be attached to Buffers for sync support between libargus and the application. This value defaults to SYNC_TYPE_NONE, which means that no sync information will be supported. In this case, both the application and libargus are expected to be done all read and/or write operations before passing the Buffer to the other.
- Parameters
-
The documentation for this class was generated from the following file: