mediaobject.h

Go to the documentation of this file.

/*  This file is part of the KDE project
    Copyright (C) 2005 Matthias Kretz <kretz@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) version 3, or any
    later version accepted by the membership of KDE e.V. (or its
    successor approved by the membership of KDE e.V.), Nokia Corporation 
    (or its successors, if any) and the KDE Free Qt Foundation, which shall
    act as a proxy defined in Section 6 of version 3 of the license.

    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_MEDIAOBJECT_H
#define Phonon_MEDIAOBJECT_H

#include "medianode.h"
#include "mediasource.h"
#include "phonon_export.h"
#include "phonondefs.h"
#include "phononnamespace.h"

QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE

namespace Phonon
{
    class MediaObjectPrivate;

    class PHONON_EXPORT MediaObject : public QObject, public MediaNode
    {
        friend class FrontendInterfacePrivate;
        Q_OBJECT
        K_DECLARE_PRIVATE(MediaObject)
        PHONON_OBJECT(MediaObject)
        Q_PROPERTY(qint32 transitionTime READ transitionTime WRITE setTransitionTime)

        Q_PROPERTY(qint32 prefinishMark READ prefinishMark WRITE setPrefinishMark)

        Q_PROPERTY(qint32 tickInterval READ tickInterval WRITE setTickInterval)
        public:
            ~MediaObject();

            State state() const;

            bool hasVideo() const;

            bool isSeekable() const;

            qint32 tickInterval() const;

            QStringList metaData(const QString &key) const;

            QStringList metaData(Phonon::MetaData key) const;

            QMultiMap<QString, QString> metaData() const;

            QString errorString() const;

            ErrorType errorType() const;

            MediaSource currentSource() const;

            void setCurrentSource(const MediaSource &source);

            QList<MediaSource> queue() const;

            void setQueue(const QList<MediaSource> &sources);

            void setQueue(const QList<QUrl> &urls);

            void enqueue(const MediaSource &source);

            void enqueue(const QList<MediaSource> &sources);

            void enqueue(const QList<QUrl> &urls);

            void clearQueue();

            qint64 currentTime() const;

            qint64 totalTime() const;

            qint64 remainingTime() const;

            qint32 prefinishMark() const;
            void setPrefinishMark(qint32 msecToEnd);

            qint32 transitionTime() const;
            void setTransitionTime(qint32 msec);

        public Q_SLOTS:

            void setTickInterval(qint32 newTickInterval);

            void play();

            void pause();

            void stop();

            void seek(qint64 time);

            void clear();

        Q_SIGNALS:
            void stateChanged(Phonon::State newstate, Phonon::State oldstate);

            void tick(qint64 time);

            void metaDataChanged();

            void seekableChanged(bool isSeekable);

#ifndef QT_NO_PHONON_VIDEO
            void hasVideoChanged(bool hasVideo);
#endif //QT_NO_PHONON_VIDEO
 // other names: bufferingProgress
            void bufferStatus(int percentFilled);

            void finished();

            void currentSourceChanged(const Phonon::MediaSource &newSource);

            void aboutToFinish();

            void prefinishMarkReached(qint32 msecToEnd);

            void totalTimeChanged(qint64 newTotalTime);

        protected:
            //MediaObject(Phonon::MediaObjectPrivate &dd, QObject *parent);

        private:
            Q_PRIVATE_SLOT(k_func(), void _k_resumePlay())
            Q_PRIVATE_SLOT(k_func(), void _k_resumePause())
            Q_PRIVATE_SLOT(k_func(), void _k_metaDataChanged(const QMultiMap<QString, QString> &))
#ifndef QT_NO_PHONON_ABSTRACTMEDIASTREAM
            Q_PRIVATE_SLOT(k_func(), void _k_stateChanged(Phonon::State, Phonon::State))
#endif //QT_NO_PHONON_ABSTRACTMEDIASTREAM
            Q_PRIVATE_SLOT(k_func(), void _k_aboutToFinish())
            Q_PRIVATE_SLOT(k_func(), void _k_currentSourceChanged(const MediaSource &))
    };

    PHONON_EXPORT MediaObject *createPlayer(Phonon::Category category, const MediaSource &source = MediaSource());
} //namespace Phonon

QT_END_NAMESPACE
QT_END_HEADER

// vim: sw=4 ts=4 tw=80
#endif // Phonon_MEDIAOBJECT_H