sound_effect.h

/*
 * Copyright (C) 2025 Microchip Technology Inc. All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef EGT_SOUND_EFFECT_H
#define EGT_SOUND_EFFECT_H
 
#include <string>
 
#include <egt/detail/meta.h>
 
namespace egt
{
inline namespace v1
{
 
namespace detail
{
class SoundEffectImpl;
}
 
class EGT_API SoundEffect final
{
public:
 
    class SoundDevice
    {
    public:
 
        SoundDevice(int card_index = 0, int device_index = 0) noexcept
            : m_card_index(card_index), m_device_index(device_index)
        {
        }
 
        void card_index(int card_index)
        {
            m_card_index = card_index;
        }
 
        EGT_NODISCARD int card_index() const
        {
            return m_card_index;
        }
 
        void card_name(const std::string& card_name)
        {
            m_card_name = card_name;
        }
 
        EGT_NODISCARD std::string card_name() const
        {
            return m_card_name;
        }
 
        void device_index(int device_index)
        {
            m_device_index = device_index;
        }
 
        EGT_NODISCARD int device_index() const
        {
            return m_device_index;
        }
 
        void device_name(std::string device_name)
        {
            m_device_name = device_name;
        }
 
        EGT_NODISCARD std::string device_name() const
        {
            return m_device_name;
        }
 
    private:
 
        int m_card_index{0};
        std::string m_card_name{};
        int m_device_index{0};
        std::string m_device_name{};
    };
 
    explicit SoundEffect(const std::string& uri, const SoundDevice& sound_device = {});
 
    SoundEffect() noexcept;
 
    SoundEffect(const SoundEffect&) = delete;
 
    SoundEffect& operator=(const SoundEffect&) = delete;
 
    ~SoundEffect() noexcept;
 
    bool device(const SoundDevice& sound_device) noexcept;
 
    EGT_NODISCARD const SoundDevice& device() const;
 
    bool media(const std::string& uri) noexcept;
 
    std::string media() const;
 
    void repeat(bool value);
 
    EGT_NODISCARD bool repeat() const;
 
    void play();
 
    void stop();
 
    static std::vector<SoundDevice> sound_device_list();
 
private:
 
    std::unique_ptr<detail::SoundEffectImpl> m_impl;
};
 
}
}
 
#endif