Argus::IBuffer 类参考

详细描述

Interface，为 Buffer 对象提供核心方法。

定义于文件 354 行 BufferStream.h。

Argus::IBuffer 的继承关系图

Argus::IBuffer 的协作关系图

公共成员函数
virtual BufferType	getBufferType () const =0
	返回 Buffer 的 BufferType。更多...
virtual SyncType	getSyncType () const =0
	返回 Buffer 的 SyncType。更多...
virtual void	setClientData (const void *clientData)=0
	设置 Buffer 的客户端数据。更多...
virtual const void *	getClientData () const =0
	从 Buffer 返回客户端数据。更多...
virtual const CaptureMetadata *	getMetadata () const =0
	返回 CaptureMetadata 对象，该对象在上一次成功捕获请求的结果中输出到流时附加到此 Buffer。更多...

静态公共成员函数
static const InterfaceID &	id ()

保护成员函数
	~IBuffer ()

构造函数 & 析构函数文档

~IBuffer()

Argus::IBuffer::~IBuffer ( )

内联protected

定义于文件 403 行 BufferStream.h。

成员函数文档

getBufferType()

virtual BufferType Argus::IBuffer::getBufferType ( ) const

纯虚函数

返回 Buffer 的 BufferType。

getClientData()

virtual const void* Argus::IBuffer::getClientData ( ) const

纯虚函数

从 Buffer 返回客户端数据。

getMetadata()

virtual const CaptureMetadata* Argus::IBuffer::getMetadata ( ) const

纯虚函数

返回 CaptureMetadata 对象，该对象在上一次成功捕获请求的结果中输出到流时附加到此 Buffer。

此方法应仅在 Buffer 处于 acquired 状态时调用；即，从 IBufferOutputStream::acquireBuffer 获取 Buffer 到通过 IBufferOutputStream::releaseBuffer 释放 Buffer 之间的时间。如果在 acquired 状态之外调用，将返回 NULL。同样，返回的对象仅在 Buffer 处于 acquired 状态时保持有效 – 如果在此对象或其任何接口在 acquired 状态之外被访问，则可能会发生未定义的結果或异常进程终止。

仅当为流启用元数据时，才会写入元数据（请参阅 IBufferOutputStreamSettings::setMetadataEnable）。如果存在任何捕获错误或元数据不可用，则可能仍会返回 NULL。

getSyncType()

virtual SyncType Argus::IBuffer::getSyncType ( ) const

纯虚函数

返回 Buffer 的 SyncType。

id()

static const InterfaceID& Argus::IBuffer::id ( )

内联static

定义于文件 357 行 BufferStream.h。

setClientData()

virtual void Argus::IBuffer::setClientData ( const void *  clientData )

纯虚函数

设置 Buffer 的客户端数据。

这作为应用程序能够将 Buffers 映射到其他客户端管理的数据的便利方式提供。libargus 实现根本不使用它，并且由 getClientData 按原样返回。默认值：NULL

参数

[in]

clientData

要在缓冲区中设置的客户端数据指针。

---

此类的文档从以下文件生成

• Argus/BufferStream.h