AVBlocks for C++  1.13
Audio and Video Software Development Kit
ByteArrayParameter Class Referenceabstract

The parameter represents a byte array (buffer). More...

Inherits Parameter.

Public Member Functions

virtual uint8_t * data () const =0
 Returns the start of the byte array. More...
 
virtual void setData (uint8_t *data)=0
 Sets the start of the byte array. More...
 
virtual int32_t size () const =0
 Returns the number of bytes in the array. More...
 
virtual void setSize (int32_t dataSize)=0
 Sets the number of bytes in the array. More...
 
- Public Member Functions inherited from Parameter
virtual const char * name () const =0
 Returns the parameter name. More...
 
virtual void setName (const char *name)=0
 Sets the parameter name. More...
 
virtual ParamType::Enum type () const =0
 Returns the parameter type. More...
 
- Public Member Functions inherited from Reference
virtual int32_t retain () const =0
 Retains the instance. More...
 
virtual int32_t release () const =0
 Releases the instance. More...
 
virtual int32_t retainCount () const =0
 Returns the current reference count. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Parameter
 ~Parameter ()
 This object can be destroyed only by the AVBlocks library.
 

Detailed Description

The parameter represents a byte array (buffer).

Member Function Documentation

virtual uint8_t* data ( ) const
pure virtual

Returns the start of the byte array.

Returns
A pointer to the first byte in the array. The returned pointer can be NULL.
virtual void setData ( uint8_t *  data)
pure virtual

Sets the start of the byte array.

Parameters
data[in] A pointer to the first byte in the array. It is allowed to set NULL.
virtual void setSize ( int32_t  dataSize)
pure virtual

Sets the number of bytes in the array.

Parameters
dataSize[in] Number of bytes. It is allowed to set 0 in which case the byte array is empty.
virtual int32_t size ( ) const
pure virtual

Returns the number of bytes in the array.

Returns
Number of bytes. If 0 the array is empty.