qsoundeffect.h - mozsearch

Enable keyboard shortcuts

// Copyright (C) 2016 The Qt Company Ltd.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#ifndef QSOUNDEFFECT_H

#define QSOUNDEFFECT_H

#include <QtMultimedia/qaudio.h>

#include <QtMultimedia/qtmultimediaglobal.h>

#include <QtCore/qobject.h>

#include <QtCore/qstringlist.h>

#include <QtCore/qurl.h>

QT_BEGIN_NAMESPACE

class QSoundEffectPrivate;

class QAudioDevice;

class Q_MULTIMEDIA_EXPORT QSoundEffect : public QObject

    Q_OBJECT

    Q_CLASSINFO("DefaultMethod", "play()")

    Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged)

    Q_PROPERTY(int loops READ loopCount WRITE setLoopCount NOTIFY loopCountChanged)

    Q_PROPERTY(int loopsRemaining READ loopsRemaining NOTIFY loopsRemainingChanged)

    Q_PROPERTY(float volume READ volume WRITE setVolume NOTIFY volumeChanged)

    Q_PROPERTY(bool muted READ isMuted WRITE setMuted NOTIFY mutedChanged)

    Q_PROPERTY(bool playing READ isPlaying NOTIFY playingChanged)

    Q_PROPERTY(Status status READ status NOTIFY statusChanged)

    Q_PROPERTY(QAudioDevice audioDevice READ audioDevice WRITE setAudioDevice NOTIFY audioDeviceChanged)

public:

    enum Loop

        Infinite = -2

};

    Q_ENUM(Loop)

    enum Status

        Null,

        Loading,

        Ready,

        Error

};

    Q_ENUM(Status)

    explicit QSoundEffect(QObject *parent = nullptr);

    explicit QSoundEffect(const QAudioDevice &audioDevice, QObject *parent = nullptr);

    ~QSoundEffect() override;

    static QStringList supportedMimeTypes();

    QUrl source() const;

    void setSource(const QUrl &url);

    int loopCount() const;

    int loopsRemaining() const;

    void setLoopCount(int loopCount);

    QAudioDevice audioDevice();

    void setAudioDevice(const QAudioDevice &device);

    float volume() const;

    void setVolume(float volume);

    bool isMuted() const;

    void setMuted(bool muted);

    bool isLoaded() const;

    bool isPlaying() const;

    Status status() const;

Q_SIGNALS:

    void sourceChanged();

    void loopCountChanged();

    void loopsRemainingChanged();

    void volumeChanged();

    void mutedChanged();

    void loadedChanged();

    void playingChanged();

    void statusChanged();

    void audioDeviceChanged();

public Q_SLOTS:

    void play();

    void stop();

private:

    Q_DISABLE_COPY(QSoundEffect)

    Q_DECLARE_PRIVATE(QSoundEffect)

    // ### Qt7: remove unused member

    QT6_ONLY(Q_DECL_UNUSED_MEMBER void *unused = nullptr;) // for ABI compatibility

};

QT_END_NAMESPACE

#endif // QSOUNDEFFECT_H