ISampleBuffer

The SampleBuffer is the memory block object for the data of a ISample. More...

#include <samplebuffer_intf.h>

Inheritance diagram for ISampleBuffer:

Public Member Functions
	ADTF_IID (ISampleBuffer, "samplebuffer.ant.streaming.adtf.iid")
	Defintion of interface ID.
virtual tResult	Write (const base::ant::IRawMemory &oBufferWrite)=0
	Copy Writing Access.
virtual tResult	Read (base::ant::IRawMemory &&oBufferRead) const =0
	Copy Reading Access.
virtual void *	GetPtr ()=0
	Direct Writing Access.
virtual const void *	GetPtr () const =0
	Direct Reading Access.
virtual size_t	GetSize () const =0
	Returns the current size in bytes.
virtual size_t	GetCapacity () const =0
	Returns the current maximal capacity in bytes.
virtual tResult	Reserve (size_t szSize)=0
	Reserves memory.
virtual tResult	Resize (size_t szSize)=0
	Resizes the Buffer.
Public Member Functions inherited from ISharedLockedObject
	ADTF_IID (ISharedLockedObject, "sharedlockedobject.ant.ucom.adtf.iid")
	Marks the ISharedLockedObject to be castable with the ucom_cast<>
virtual tResult	LockShared () const =0
	Locks the object for shared use.
virtual tResult	UnlockShared () const =0
	Unlocks the object for shared use.
Public Member Functions inherited from ILockedObject
	ADTF_IID (ILockedObject, "lockedobject.ant.ucom.adtf.iid")
	Marks the ILockedObject to be castable with the ucom_cast<>
virtual tResult	Lock () const =0
	Locks the object for exclusive use.
virtual tResult	Unlock () const =0
	Unlocks the object for exclusive use.
Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the IObject to be castable with the ucom_cast()

Protected Member Functions
	~ISampleBuffer ()=default
	not destructable
Protected Member Functions inherited from ISharedLockedObject
	~ISharedLockedObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!
Protected Member Functions inherited from ILockedObject
	~ILockedObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

The SampleBuffer is the memory block object for the data of a ISample.

Definition at line 21 of file samplebuffer_intf.h.

Member Function Documentation

GetPtr() [1/2]

virtual const void * GetPtr ( ) const

pure virtual

Direct Reading Access.

Retrieves the raw buffer content pointer.

Returns

the buffers raw pointer.

GetPtr() [2/2]

virtual void * GetPtr ( )

pure virtual

Direct Writing Access.

Retrieves the raw buffer content pointer.

Warning

Do not write more than GetSize() bytes !

Returns

the buffers raw pointer.

Read()

virtual tResult Read ( base::ant::IRawMemory && oBufferRead ) const

pure virtual

Copy Reading Access.

The buffer content will be copied to the given memory. Depending on implemntation of the buffer, it will grow automatically.

Parameters

[in,out]

oBufferRead

Memory to copy to.

Returns

Standard Result Code.

Reserve()

virtual tResult Reserve ( size_t szSize )

pure virtual

Reserves memory.

Capacity will be at least szSize bytes. Current data will be lost.

Parameters

szSize

[in] Size in bytes.

Returns

standard result.

Resize()

virtual tResult Resize ( size_t szSize )

pure virtual

Resizes the Buffer.

Capacity will be at least szSize bytes. Current data will be retained.

Parameters

szSize

[in] Size in bytes.

Returns

standard result.

Write()

virtual tResult Write ( const base::ant::IRawMemory & oBufferWrite )

pure virtual

Copy Writing Access.

The given memory will be copied to the buffer. Depending on implemntation of the buffer, it will grow automatically.

Parameters

[in]

oBufferWrite

Memory to copy from.

Returns

Standard Result Code.