qsound.h Include File

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# qsound.h

This is the verbatim text of the qsound.h include file. It is provided only for illustration; the copyright remains with Trolltech.

    /****************************************************************************
    ** $Id: qt/qsound.h   3.3.5   edited Aug 31 12:17 $
    **
    ** Definition of QSound class and QAuServer internal class
    **
    ** Created : 000117
    **
    ** Copyright (C) 1999-2005 Trolltech AS.  All rights reserved.
    **
    ** This file is part of the kernel module of the Qt GUI Toolkit.
    **
    ** This file may be distributed under the terms of the Q Public License
    ** as defined by Trolltech AS of Norway and appearing in the file
    ** LICENSE.QPL included in the packaging of this file.
    **
    ** This file may be distributed and/or modified under the terms of the
    ** GNU General Public License version 2 as published by the Free Software
    ** Foundation and appearing in the file LICENSE.GPL included in the
    ** packaging of this file.
    **
    ** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
    ** licenses may use this file in accordance with the Qt Commercial License
    ** Agreement provided with the Software.
    **
    ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
    ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
    **
    ** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
    **   information about Qt Commercial License Agreements.
    ** See http://www.trolltech.com/qpl/ for QPL licensing information.
    ** See http://www.trolltech.com/gpl/ for GPL licensing information.
    **
    ** Contact info@trolltech.com if any conditions of this licensing are
    ** not clear to you.
    **
    **********************************************************************/
    #ifndef QSOUND_H
    #define QSOUND_H

    #ifndef QT_H
    #include "qobject.h"
    #endif // QT_H

    #ifndef QT_NO_SOUND

    class QSoundData;

    class Q_EXPORT QSound : public QObject {
        Q_OBJECT
    public:
        static bool isAvailable();
        static void play(const QString& filename);

        QSound(const QString& filename, QObject* parent=0, const char* name=0);
        ~QSound();

        /* Coming soon...
    	?
        QSound(int hertz, Type type=Mono);
        int play(const ushort* data, int samples);
        bool full();
        signal void notFull();
    	?
        */

    #ifndef QT_NO_COMPAT
        static bool available() { return isAvailable(); }
    #endif

        int loops() const;
        int loopsRemaining() const;
        void setLoops(int);
        QString fileName() const;

        bool isFinished() const;

    public slots:
        void play();
        void stop();

    private:
        QSoundData* d;
        friend class QAuServer;
    };

    /*
      QAuServer is an INTERNAL class.  If you wish to provide support for
      additional audio servers, you can make a subclass of QAuServer to do
      so, HOWEVER, your class may need to be re-engineered to some degree
      with each new Qt release, including minor releases.

      QAuBucket is whatever you want.
    */

    class QAuBucket {
    public:
        virtual ~QAuBucket();
    };

    class QAuServer : public QObject {
        Q_OBJECT

    public:
        QAuServer(QObject* parent, const char* name);
        ~QAuServer();

        virtual void init(QSound*);
        virtual void play(const QString& filename);
        virtual void play(QSound*)=0;
        virtual void stop(QSound*)=0;
        virtual bool okay()=0;

    protected:
        void setBucket(QSound*, QAuBucket*);
        QAuBucket* bucket(QSound*);
        int decLoop(QSound*);
    };

    #endif // QT_NO_SOUND

    #endif