• Site en Français
• English Site
• Doc

MAudioInputPort Class Reference

An abstract audio input port.

#include <MAudioInputPort.h>

Inheritance diagram for MAudioInputPort:

List of all members.

Public Slots
virtual bool	Connect (MAudioOutputPort *port)=0
virtual bool	Disconnect (MAudioOutputPort *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 MPort *	Connection (const unsigned int n) const
Protected Member Functions
	MAudioInputPort (string name, MModule *module)
Protected Attributes
vector< MAudioOutputPort * >	_connection

---

Constructor & Destructor Documentation

MAudioInputPort::MAudioInputPort (  string  name, MModule *  module )  [inline, protected]

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

---

Member Function Documentation

virtual bool MAudioInputPort::IsAudio (   )  const [inline, virtual]

Is the port an audio port ? Returns: TRUE Implements MPort.

virtual bool MAudioInputPort::IsControl (   )  const [inline, virtual]

Is the port a control port ? Returns: FALSE Implements MPort.

virtual bool MAudioInputPort::IsInput (   )  const [inline, virtual]

Is the port an input port ? Returns: TRUE Implements MPort.

virtual bool MAudioInputPort::IsOutput (   )  const [inline, virtual]

Is the port an output port ? Returns: FALSE Implements MPort.

bool MAudioInputPort::IsConnectedTo (  const MPort *  port  )  const [virtual]

Is the port connected to port ? Implements MPort.

unsigned int MAudioInputPort::NumberOfConnections (   )  const [virtual]

The number of ports connected from or to this port. Implements MPort.

MPort * MAudioInputPort::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 MAudioInputPort::Connect (  MAudioOutputPort *  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 MClientAudioInputPort, MExternalAudioInputPort, and MPluginAudioInputPort.

virtual bool MAudioInputPort::Disconnect (  MAudioOutputPort *  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 MClientAudioInputPort, MExternalAudioInputPort, and MPluginAudioInputPort.

---

Member Data Documentation

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

The audio output ports connected to this port.

---

The documentation for this class was generated from the following files:

• MAudioInputPort.h
• MAudioInputPort.cpp

---