AudioOutputElement.h

Go to the documentation of this file.

// Copyright 2015 - 2026, GIBIS-UNIFESP and the wiRedPanda contributors
// SPDX-License-Identifier: GPL-3.0-or-later

 
#pragma once
 
#include "App/Element/GraphicElement.h"

class AudioOutputElement : public GraphicElement
{
    Q_OBJECT
 
public:
    static constexpr float kDefaultVolume = 0.5f;

    explicit AudioOutputElement(ElementType type, QGraphicsItem *parent = nullptr,
                                float initialVolume = kDefaultVolume);
 
    // --- State Queries ---

    bool isPlaying() const;
    bool isMuted() const;
    float volume() const override;
 
    // --- Playback Control ---

    void mute(const bool mute = true);
    void setVolume(float vol) override;

    void refresh() override;
 
protected:
    // --- Template Method hooks (backend-specific) ---

    virtual void startAudio() = 0;
    virtual void stopAudio() = 0;
    virtual void applyVolume() = 0;
    virtual void applyMute() = 0;
 
    // --- Shared state (accessible to derived classes) ---
 
    float m_volume; // set from the ctor's initialVolume (one source, one write)
    bool m_hasOutputDevice = false;
    bool m_isPlaying = false;
    bool m_muted = false;
 
    // --- Non-virtual play/stop (delegate to hooks above) ---
 
    void play();
    void stop();
};