File indexing completed on 2024-12-01 04:21:26

 /*
     Copyright (C) 2013 Harald Sitter <sitter@kde.org>
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Lesser General Public
     License as published by the Free Software Foundation; either
     version 2.1 of the License, or (at your option) any later version.
 
     This library is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Lesser General Public License for more details.
 
     You should have received a copy of the GNU Lesser General Public
     License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #ifndef PHONON_VLC_SINKNODE_H
 #define PHONON_VLC_SINKNODE_H
 
 #include <QPointer>
 
 namespace Phonon {
 namespace VLC {
 
 class Media;
 class MediaObject;
 class MediaPlayer;
 
 /** \brief The sink node is essentially an output for a media object
  *
  * This class handles connections for the sink to a media object. It remembers
  * the media object and the libVLC media player associated with it.
  *
  * \see MediaObject
  */
 class SinkNode
 {
 public:
     SinkNode();
     virtual ~SinkNode();
 
     /**
      * Associates the sink node to the provided media object. The m_mediaObject and m_vlcPlayer
      * attributes are set, and the sink is added to the media object's sinks.
      *
      * \param mediaObject The media object to connect to.
      *
      * \see disconnectFromMediaObject()
      */
     void connectToMediaObject(MediaObject *mediaObject);
 
     /**
      * Removes this sink from the specified media object's sinks.
      *
      * \param mediaObject The media object to disconnect from
      *
      * \see connectToMediaObject()
      */
     void disconnectFromMediaObject(MediaObject *mediaObject);
 
     /**
      * Does nothing. To be reimplemented in child classes.
      */
     void addToMedia(Media *media);
 
 protected:
     /**
      * Handling function for derived classes.
      * \note This handle is executed *after* the global handle.
      *       Meaning the SinkNode base will be done handling the connect.
      * \see connectToMediaObject
      */
     virtual void handleConnectToMediaObject(MediaObject *mediaObject) { Q_UNUSED(mediaObject); }
 
     /**
      * Handling function for derived classes.
      * \note This handle is executed *before* the global handle.
      *       Meaning the SinkNode base will continue handling the disconnect.
      * \see disconnectFromMediaObject
      */
     virtual void handleDisconnectFromMediaObject(MediaObject *mediaObject) { Q_UNUSED(mediaObject); }
 
     /**
      * Handling function for derived classes.
      * \note This handle is executed *after* the global handle.
      *       Meaning the SinkNode base will be done handling the connect.
      * \see addToMedia
      */
     virtual void handleAddToMedia(Media *media) { Q_UNUSED(media); }
 
     /** Available while connected to a MediaObject (until disconnected) */
     QPointer<MediaObject> m_mediaObject;
 
     /** Available while connected to a MediaObject (until disconnected) */
     MediaPlayer *m_player;
 };
 
 } // namespace VLC
 } // namespace Phonon
 
 #endif // PHONON_VLC_SINKNODE_H