Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members

MAudioOutputPort Class Reference

An abstract audio output port.

#include <MAudioOutputPort.h>

Inheritance diagram for MAudioOutputPort:

MPort MClientAudioOutputPort MPluginAudioOutputPort MExternalAudioOutputPort List of all members.

Public Slots

virtual bool Connect (MAudioInputPort *port)=0
virtual bool Disconnect (MAudioInputPort *port)=0

Public Member Functions

virtual bool IsAudio () const
virtual bool IsControl () const
virtual bool IsInput () const
virtual bool IsOutput () const
virtual bool IsConnectedTo (const MPort *port) const
virtual unsigned int NumberOfConnections () const
virtual MPortConnection (const unsigned int n) const

Protected Member Functions

 MAudioOutputPort (string name, MModule *module)

Protected Attributes

vector< MAudioInputPort * > _connection

Constructor & Destructor Documentation

MAudioOutputPort::MAudioOutputPort string  name,
MModule module
[inline, protected]
 

Creates a port called name and belonging to the module module.


Member Function Documentation

virtual bool MAudioOutputPort::IsAudio  )  const [inline, virtual]
 

Is the port an audio port ?

Returns:
TRUE

Implements MPort.

virtual bool MAudioOutputPort::IsControl  )  const [inline, virtual]
 

Is the port a control port ?

Returns:
FALSE

Implements MPort.

virtual bool MAudioOutputPort::IsInput  )  const [inline, virtual]
 

Is the port an input port ?

Returns:
FALSE

Implements MPort.

virtual bool MAudioOutputPort::IsOutput  )  const [inline, virtual]
 

Is the port an output port ?

Returns:
TRUE

Implements MPort.

bool MAudioOutputPort::IsConnectedTo const MPort port  )  const [virtual]
 

Is the port connected to port ?

Implements MPort.

unsigned int MAudioOutputPort::NumberOfConnections  )  const [virtual]
 

The number of ports connected from or to this port.

Implements MPort.

MPort * MAudioOutputPort::Connection const unsigned int  n  )  const [virtual]
 

The nth port connected to this port.

Returns:
A pointer to the nth port connected to this port.
Precondition:
n < NumberOfConnections( )
Postcondition:
result != NULL

Implements MPort.

virtual bool MAudioOutputPort::Connect MAudioInputPort port  )  [pure virtual, slot]
 

Tries to connect port to this port.

Returns:
TRUE if the connection was successfully established else returns FALSE
Precondition:
! IsConnectedTo( port )

Implemented in MClientAudioOutputPort, and MPluginAudioOutputPort.

virtual bool MAudioOutputPort::Disconnect MAudioInputPort port  )  [pure virtual, slot]
 

Tries to disconnect port from this port.

Returns:
TRUE if the ports were actually disconnected else returns FALSE ( the ports were probably not connected ).
Postcondition:
! IsConnectedTo( port )

Implemented in MClientAudioOutputPort, and MPluginAudioOutputPort.


Member Data Documentation

vector< MAudioInputPort * > MAudioOutputPort::_connection [protected]
 

The audio input ports connected to this port.


The documentation for this class was generated from the following files:
Generated on Mon Jan 31 12:43:31 2005 for la Marmite by Doxygen 1.4.1