mediasource.h

Go to the documentation of this file.

/*  This file is part of the KDE project
    Copyright (C) 2007 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_MEDIASOURCE_H
#define PHONON_MEDIASOURCE_H

#include "phonon_export.h"
#include "phononnamespace.h"
#include "objectdescription.h"
#include <QtCore/QSharedData>
#include <QtCore/QString>

QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE

class QUrl;
class QIODevice;

namespace Phonon
{

class MediaSourcePrivate;
class AbstractMediaStream;

class PHONON_EXPORT MediaSource
{
    friend class StreamInterface;
    public:
        enum Type {
            Invalid = -1,
            LocalFile,
            Url,
            Disc,
            Stream,
            Empty
/*          post 4.0:
            / **
             * Links multiple MediaSource objects together.
             * /
            Link
*/
        };

        MediaSource();

        MediaSource(const QString &fileName); //krazy:exclude=explicit

        MediaSource(const QUrl &url); //krazy:exclude=explicit

        MediaSource(Phonon::DiscType discType, const QString &deviceName = QString()); //krazy:exclude=explicit

#ifndef QT_NO_PHONON_ABSTRACTMEDIASTREAM

        MediaSource(AbstractMediaStream *stream); //krazy:exclude=explicit

        MediaSource(QIODevice *ioDevice); //krazy:exclude=explicit
#endif

        //MediaSource(const AudioCaptureDevice &, const VideoCaptureDevice &);

        ~MediaSource();

        MediaSource(const MediaSource &rhs);

        MediaSource &operator=(const MediaSource &rhs);

        bool operator==(const MediaSource &rhs) const;

        void setAutoDelete(bool enable);

        bool autoDelete() const;

        Type type() const;

        QString fileName() const;

        QUrl url() const;

        Phonon::DiscType discType() const;

        QString deviceName() const;

#ifndef QT_NO_PHONON_ABSTRACTMEDIASTREAM

        AbstractMediaStream *stream() const;
#endif

        //AudioCaptureDevice audioCaptureDevice() const;
        //VideoCaptureDevice videoCaptureDevice() const;

/*      post 4.0:
        MediaSource(const QList<MediaSource> &mediaList);
        QList<MediaSource> substreams() const;
*/

    protected:
        QExplicitlySharedDataPointer<MediaSourcePrivate> d;
        MediaSource(MediaSourcePrivate &);
};

} // namespace Phonon

QT_END_NAMESPACE
QT_END_HEADER

#endif // PHONON_MEDIASOURCE_H