QStreamer::QPin Class Reference

#include <qpin.h>

Inheritance diagram for QStreamer::QPin:

List of all members.

Public Types
enum	Direction { Source, Sink }
	The direction of the pin. More...
Public Member Functions
	~QPin ()
	Destructor.
Direction	direction () const
	Returns the direction which the pin is functioning.
const QString &	name () const
	Returns the name given to the pin when it was cosntructed.
class QElement *	parent () const
	Returns a constant pointer to the element which the pin belongs to.
class QElement *	parent ()
	Returns a pointer to the element which the pin belongs to.
Protected Member Functions
	QPin (Direction direction, const QString &name, class QElement *parent)
class QMediaError &	error ()
	Returns the QMediaError instance to use for outputing error messages.
void	setParent (QElement *parent)
Friends
class	QPinList

---

Detailed Description

Provides the base class for the basic path of communication between elements.

Pins are the basic element of communication between elements within the pipeline. The basic flow of data within the pipeline occurs by pushing buffers (QMediaBuffer) from the source pins (QSourcePin) of "upstream" elements to their connected sink pins (QSinkPin) of their "downstream" elements.

While the basic functionality of pins are to push buffers containing data. They can also be used to send and receive events within the pipeline as well as provide a means of querying properties from other elements in their path of travel.

---

Member Enumeration Documentation

enum QStreamer::QPin::Direction

The direction of the pin.

Enumerator:

Source	Source pins provide a data source from elements.
Sink	Sink pins provide a data input for elements.

---

Constructor & Destructor Documentation

QStreamer::QPin::~QPin

(

)

[inline]

Destructor.

QStreamer::QPin::QPin	(	Direction	direction,
		const QString &	name,
		class QElement *	parent
	)		[inline, protected]

Constructor.

Note:

Should only be called from within an element

Parameters:

direction	the direction of the dataflow of the pin.
name	the name of the pin for connecting and debugging
parent	the element which owns the pin.

---

Member Function Documentation

QPin::Direction QStreamer::QPin::direction

(

)

const [inline]

Returns the direction which the pin is functioning.

class QMediaError & QStreamer::QPin::error

(

)

[protected]

Returns the QMediaError instance to use for outputing error messages.

const QString & QStreamer::QPin::name

(

)

const [inline]

Returns the name given to the pin when it was cosntructed.

class QElement * QStreamer::QPin::parent

(

)

[inline]

Returns a pointer to the element which the pin belongs to.

class QElement * QStreamer::QPin::parent

(

)

const [inline]

Returns a constant pointer to the element which the pin belongs to.

void QStreamer::QPin::setParent

(

QElement *

parent )

[protected]

Sets the parent element of the pin. This function is provided to remove association to an element while the pin is being deleted.

Parameters:

parent

the new parent of the pin. Typically 0.

---

Friends And Related Function Documentation

friend class QPinList [friend]

---

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

• QStreamer/include/qpin.h
• QStreamer/source/qpin.cpp