sipxmedialib  Version 3.3
Public Member Functions | Private Member Functions | List of all members
MpAudioResourceConstructor Class Referenceabstract

MpAudioResourceConstructor is used to construct a specific audio resource type. More...

#include <MpAudioResourceConstructor.h>

Inheritance diagram for MpAudioResourceConstructor:
Inheritance graph
[legend]
Collaboration diagram for MpAudioResourceConstructor:
Collaboration graph
[legend]

Public Member Functions

 MpAudioResourceConstructor (const UtlString &resourceType, int minInputs=1, int maxInputs=1, int minOutputs=1, int maxOutputs=1)
 
virtual ~MpAudioResourceConstructor ()
 
virtual OsStatus newResource (const UtlString &resourceName, int maxResourcesToCreate, int &numResourcesCreated, MpResource *resourcesCreated[])=0
 Create new resource(s) More...
 
- Public Member Functions inherited from MpResourceConstructor
 MpResourceConstructor (const UtlString &resourceType, int minInputs=1, int maxInputs=1, int minOutputs=1, int maxOutputs=1)
 
virtual ~MpResourceConstructor ()
 

Private Member Functions

 MpAudioResourceConstructor ()
 Disable default constructor. More...
 
 MpAudioResourceConstructor (const MpAudioResourceConstructor &rMpAudioResourceConstructor)
 
MpAudioResourceConstructoroperator= (const MpAudioResourceConstructor &rhs)
 

Additional Inherited Members

- Protected Attributes inherited from MpResourceConstructor
int mMinInputs
 
int mMaxInputs
 
int mMinOutputs
 
int mMaxOutputs
 

Detailed Description

MpAudioResourceConstructor is used to construct a specific audio resource type.

MpAudioResourceConstructors is an abstract class. Derived types construct a specific type of MpAudioResource.

Constructor & Destructor Documentation

MpAudioResourceConstructor ( const UtlString &  resourceType,
int  minInputs = 1,
int  maxInputs = 1,
int  minOutputs = 1,
int  maxOutputs = 1 
)
inline

Constructor

virtual ~MpAudioResourceConstructor ( )
inlinevirtual

Destructor

Disable default constructor.

MpAudioResourceConstructor ( const MpAudioResourceConstructor rMpAudioResourceConstructor)
private

Disabled copy constructor

Member Function Documentation

virtual OsStatus newResource ( const UtlString &  resourceName,
int  maxResourcesToCreate,
int &  numResourcesCreated,
MpResource resourcesCreated[] 
)
pure virtual

Create new resource(s)

Creates one or more resources as defined by the implementation of the resource constructor (typically of different resource types as opposed to duplicates). Some resources are created in sets as they work together in some way. This interface allows the constructor to create multiple resources and assocate or initialize them together.

Parameters
[in]resourceName- name to give the new resource, must be unique to the target flowgraph that this resource is to be inserted.
[in]maxResourcesToCreate- the size of the resourcesCreated passed in
[out]numResourcesCreated- the actual number of resource created and contained in the resourcesCreated array
[out]resourcesCreated- array containing the created resources.

Implements MpResourceConstructor.

Implemented in MprSpeakerSelectorConstructor, MprToOutputDeviceWithAecConstructor, MprBridgeConstructor, MprFromInputDeviceConstructor, MprRtpInputConnectionConstructor, MprSplitterConstructor, MprToOutputDeviceConstructor, MprNullAecConstructor, MprRtpOutputConnectionConstructor, MprSpeexPreProcessConstructor, MprToneGenConstructor, MprNullConstructor, MprDecodeConstructor, MprHookConstructor, MprDelayConstructor, MprEncodeConstructor, MprFromFileConstructor, MprVadConstructor, MprVoiceActivityNotifierConstructor, MprToneDetectConstructor, MprNotchFilterConstructor, and MprRecorderConstructor.

MpAudioResourceConstructor& operator= ( const MpAudioResourceConstructor rhs)
private

Disable assignment operator