PrimoBurner(tm) for C++  4.6
CD, DVD and Blu-ray Software Development Kit
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Pages
AudioInputList Class Referenceabstract

Represents a list of AudioInput objects. More...

#include <PrimoBurnerAPI.h>

Public Member Functions

virtual void add (AudioInput *item)=0
 Adds a new AudioInput object to the list. More...
 
virtual AudioInputat (int32_t index) const =0
 Gets the element at the specified index. More...
 
virtual void clear ()=0
 Removes all items from the list.
 
virtual int32_t count () const =0
 Gets the number of elements in the list.
 
virtual int32_t indexOf (const AudioInput *item) const =0
 Determines the index of a specific item in the list. More...
 
virtual bool_t insert (int32_t index, AudioInput *item)=0
 Inserts an element at the specified position in the list. More...
 
virtual bool_t remove (int32_t index)=0
 Removes the element at the specified index. More...
 
virtual bool_t setAt (int32_t index, AudioInput *item)=0
 Sets the element at the specified index. More...
 

Detailed Description

Represents a list of AudioInput objects.

See Also
AudioInput
Object Management

Member Function Documentation

virtual void add ( AudioInput item)
pure virtual

Adds a new AudioInput object to the list.

Parameters
item[in] An AudioInput object that should be added to the list. If item is NULL it is not added to the list.
See Also
AudioInput
virtual AudioInput* at ( int32_t  index) const
pure virtual

Gets the element at the specified index.

This method returns a reference type.

Parameters
index[in] The zero-based index of the element to get.
Returns
An AudioInpu instance, or NULL if the index is out of range.
See Also
Object Management
virtual int32_t indexOf ( const AudioInput item) const
pure virtual

Determines the index of a specific item in the list.

Parameters
itemThe item that is searched in the list
Returns
The index of item if found in the list; otherwise, -1.
virtual bool_t insert ( int32_t  index,
AudioInput item 
)
pure virtual

Inserts an element at the specified position in the list.

Parameters
index[in] The zero-based index in the list where the new element should be inserted.
item[in] The new AudioInput object that should be inserted in the list.
Returns
1 Success
0 The item cannot be inserted in the list.
virtual bool_t remove ( int32_t  index)
pure virtual

Removes the element at the specified index.

Parameters
index[in] The zero-based index of the element to remove.
Returns
TRUE if the operation is successful, FALSE otherwise.
virtual bool_t setAt ( int32_t  index,
AudioInput item 
)
pure virtual

Sets the element at the specified index.

Parameters
index[in] The zero-based index of the element to set.
item[in] The new AudioInput object.
Returns
1 Success
0 The index is out of range or the item is not a valid AudioInput.