StringParameter Class Referenceabstract
The parameter represents an untyped value which is stored in a char_t string. More...
Inheritance diagram for StringParameter:
Public Member Functions | |
| virtual bool_t | setValue (const char_t *value)=0 |
| Sets the parameter value. More... | |
| virtual const char_t * | value () const =0 |
| Returns the parameter value. More... | |
 Public Member Functions inherited from Parameter | |
| virtual Parameter * | clone () const =0 |
| Creates a deep copy of the underlying StringParameter, IntParameter, FloatParameter, or MediaBufferParameter object. More... | |
| virtual const char * | name () const =0 |
| Returns the parameter name. More... | |
| virtual bool_t | 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 | release () const =0 |
| Releases the instance. More... | |
| virtual int32_t | retain () const =0 |
| Retains 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 an untyped value which is stored in a char_t string.
The parameter name constant documents how this value should be interpreted.
Member Function Documentation
|
pure virtual |
Sets the parameter value.
- Parameters
-
value [in] A pointer to zero terminated string. If NULL it is interpreted as if an empty string is provided. The string pointed by value is copied internally and is not required to be valid after the method returns.
|
pure virtual |
Returns the parameter value.
- Returns
- A pointer to zero terminated string. The returned pointer cannot be NULL but the string can be empty.