AAX SDK 2.6.1
Avid Audio Extensions Development Kit
Loading...
Searching...
No Matches
List of all members | Public Member Functions
AAX_CStringDataBuffer Class Reference

#include <AAX_CStringDataBuffer.h>

Inheritance diagram for AAX_CStringDataBuffer:
[legend]
Collaboration diagram for AAX_CStringDataBuffer:
[legend]

Description

A convenience class for string data buffers.

The data payload is a char* C string

Public Member Functions

 AAX_CStringDataBuffer (AAX_CTypeID inType, std::string const &inData)
 
 AAX_CStringDataBuffer (AAX_CTypeID inType, std::string &&inData)
 
 AAX_CStringDataBuffer (AAX_CTypeID inType, const char *inData)
 
 AAX_CStringDataBuffer (AAX_CStringDataBuffer const &)=delete
 
 AAX_CStringDataBuffer (AAX_CStringDataBuffer &&)=delete
 
 ~AAX_CStringDataBuffer (void) AAX_OVERRIDE=default
 
AAX_CStringDataBufferoperator= (AAX_CStringDataBuffer const &other)=delete
 
AAX_CStringDataBufferoperator= (AAX_CStringDataBuffer &&other)=delete
 
AAX_Result Type (AAX_CTypeID *oType) const AAX_OVERRIDE
 
AAX_Result Size (int32_t *oSize) const AAX_OVERRIDE
 
AAX_Result Data (void const **oBuffer) const AAX_OVERRIDE
 
- Public Member Functions inherited from AAX_IDataBuffer
 ACF_DECLARE_STANDARD_UNKNOWN () ACFMETHOD(InternalQueryInterface)(const acfIID &riid
 
 AAX_DELETE (AAX_IDataBuffer &operator=(const AAX_IDataBuffer &))
 
virtual AAX_Result Type (AAX_CTypeID *oType) const =0
 
virtual AAX_Result Size (int32_t *oSize) const =0
 
virtual AAX_Result Data (void const **oBuffer) const =0
 
- Public Member Functions inherited from IACFUnknown
virtual BEGIN_ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE QueryInterface (const acfIID &iid, void **ppOut)=0
 Returns pointers to supported interfaces.
 
virtual acfUInt32 ACFMETHODCALLTYPE AddRef (void)=0
 Increments reference count.
 
virtual acfUInt32 ACFMETHODCALLTYPE Release (void)=0
 Decrements reference count.
 

Additional Inherited Members

- Public Attributes inherited from AAX_IDataBuffer
void **ppvObjOut AAX_OVERRIDE
 

Constructor & Destructor Documentation

◆ AAX_CStringDataBuffer() [1/5]

AAX_CStringDataBuffer::AAX_CStringDataBuffer ( AAX_CTypeID  inType,
std::string const &  inData 
)
inline

◆ AAX_CStringDataBuffer() [2/5]

AAX_CStringDataBuffer::AAX_CStringDataBuffer ( AAX_CTypeID  inType,
std::string &&  inData 
)
inline

◆ AAX_CStringDataBuffer() [3/5]

AAX_CStringDataBuffer::AAX_CStringDataBuffer ( AAX_CTypeID  inType,
const char *  inData 
)
inline

◆ AAX_CStringDataBuffer() [4/5]

AAX_CStringDataBuffer::AAX_CStringDataBuffer ( AAX_CStringDataBuffer const &  )
delete

◆ AAX_CStringDataBuffer() [5/5]

AAX_CStringDataBuffer::AAX_CStringDataBuffer ( AAX_CStringDataBuffer &&  )
delete

◆ ~AAX_CStringDataBuffer()

AAX_CStringDataBuffer::~AAX_CStringDataBuffer ( void  )
default

Member Function Documentation

◆ operator=() [1/2]

AAX_CStringDataBuffer & AAX_CStringDataBuffer::operator= ( AAX_CStringDataBuffer const &  other)
delete

◆ operator=() [2/2]

AAX_CStringDataBuffer & AAX_CStringDataBuffer::operator= ( AAX_CStringDataBuffer &&  other)
delete

◆ Type()

AAX_Result AAX_CStringDataBuffer::Type ( AAX_CTypeID oType) const
inlinevirtual

The type of data contained in this buffer

This identifier must be sufficient for a client that knows the type to correctly interpret and use the data.

Implements AAX_IACFDataBuffer.

References AAX_ERROR_NULL_ARGUMENT, and AAX_SUCCESS.

◆ Size()

AAX_Result AAX_CStringDataBuffer::Size ( int32_t *  oSize) const
inlinevirtual

The number of bytes of data in this buffer

Implements AAX_IACFDataBuffer.

References AAX_ERROR_NULL_ARGUMENT, AAX_ERROR_SIGNED_INT_OVERFLOW, and AAX_SUCCESS.

◆ Data()

AAX_Result AAX_CStringDataBuffer::Data ( void const **  oBuffer) const
inlinevirtual

The buffer of data

Implements AAX_IACFDataBuffer.

References AAX_ERROR_NULL_ARGUMENT, and AAX_SUCCESS.


The documentation for this class was generated from the following file: