audiodeviceinfo.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_AUDIO_AUDIODEVICE_H
#define SWIFT_MISC_AUDIO_AUDIODEVICE_H
 
#include <QMetaType>
#include <QString>
 
#include "misc/identifier.h"
#include "misc/metaclass.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::audio, CAudioDeviceInfo)
 
namespace swift::misc::audio
{
    class SWIFT_MISC_EXPORT CAudioDeviceInfo : public CValueObject<CAudioDeviceInfo>
    {
    public:
        enum ColumnIndex
        {
            IndexName = CPropertyIndexRef::GlobalIndexCAudioDeviceInfo,
            IndexDeviceType,
            IndexDeviceTypeAsString,
            IndexIdentifier
        };
 
        enum DeviceType
        {
            InputDevice,
            OutputDevice,
            Unknown
        };
 
        CAudioDeviceInfo();
 
        CAudioDeviceInfo(DeviceType type, const QString &name);
 
        const QString &getName() const { return m_deviceName; }
 
        const QString &getMachineName() const { return m_identifier.getMachineName(); }
 
        const CIdentifier &getIdentifier() const { return m_identifier; }
 
        DeviceType getType() const { return static_cast<DeviceType>(m_type); }
 
        const QString &getTypeAsString() const { return deviceTypeToString(this->getType()); }
 
        bool isInputDevice() const { return this->getType() == InputDevice; }
 
        bool isOutputDevice() const { return this->getType() == OutputDevice; }
 
        bool isValid() const { return !m_deviceName.isEmpty() && (m_type != Unknown); }
 
        bool isDefault() const;
 
        bool matchesNameTypeMachineName(const CAudioDeviceInfo &device) const;
 
        bool matchesNameTypeMachineProcess(const CAudioDeviceInfo &device) const;
 
        static CAudioDeviceInfo getDefaultOutputDevice();
 
        static CAudioDeviceInfo getDefaultInputDevice();
 
        QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
        QString convertToQString(bool i18n = false) const;
 
        int comparePropertyByIndex(CPropertyIndexRef index, const CAudioDeviceInfo &compareValue) const;
 
        static const QString &deviceTypeToString(DeviceType t);
 
    private:
        int m_type = static_cast<int>(Unknown); 
        QString m_deviceName; 
        CIdentifier m_identifier; 
 
        SWIFT_METACLASS(
            CAudioDeviceInfo,
            SWIFT_METAMEMBER(type),
            SWIFT_METAMEMBER(deviceName),
            SWIFT_METAMEMBER(identifier));
    };
} // namespace swift::misc::audio
 
Q_DECLARE_METATYPE(swift::misc::audio::CAudioDeviceInfo)
Q_DECLARE_METATYPE(swift::misc::audio::CAudioDeviceInfo::DeviceType)
 
#endif // SWIFT_MISC_AUDIO_AUDIODEVICE_H