ChannelVolumeManager.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
 
#ifndef ALEXA_CLIENT_SDK_CAPABILITYAGENTS_SPEAKERMANAGER_INCLUDE_SPEAKERMANAGER_CHANNELVOLUMEMANAGER_H_
#define ALEXA_CLIENT_SDK_CAPABILITYAGENTS_SPEAKERMANAGER_INCLUDE_SPEAKERMANAGER_CHANNELVOLUMEMANAGER_H_
 
#include <AVSCommon/SDKInterfaces/ChannelVolumeInterface.h>
#include <mutex>
 
namespace alexaClientSDK {
namespace capabilityAgents {
namespace speakerManager {
class ChannelVolumeManager : public avsCommon::sdkInterfaces::ChannelVolumeInterface {
public:
    static std::shared_ptr<ChannelVolumeManager> create(
        std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> speaker,
        avsCommon::sdkInterfaces::ChannelVolumeInterface::Type type =
            avsCommon::sdkInterfaces::ChannelVolumeInterface::Type::AVS_SPEAKER_VOLUME,
        std::function<int8_t(int8_t)> volumeCurve = nullptr);
 
    avsCommon::sdkInterfaces::ChannelVolumeInterface::Type getSpeakerType() const override;
    size_t getId() const override;
    bool startDucking() override;
    bool stopDucking() override;
    bool setUnduckedVolume(int8_t volume) override;
    bool setMute(bool mute) override;
    bool getSpeakerSettings(avsCommon::sdkInterfaces::SpeakerInterface::SpeakerSettings* settings) const override;
 
private:
    using VolumeCurveFunction = std::function<int8_t(int8_t unduckedVolume)>;
 
    ChannelVolumeManager(
        std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> speaker,
        avsCommon::sdkInterfaces::ChannelVolumeInterface::Type type,
        VolumeCurveFunction volumeCurve);
 
    static int8_t defaultVolumeAttenuateFunction(int8_t unduckedVolume);
 
    mutable std::mutex m_mutex;
 
    std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> m_speaker;
 
    bool m_isDucked;
 
    int8_t m_unduckedVolume;
 
    VolumeCurveFunction m_volumeCurveFunction;
 
    const avsCommon::sdkInterfaces::ChannelVolumeInterface::Type m_type;
};
}  // namespace speakerManager
}  // namespace capabilityAgents
}  // namespace alexaClientSDK
 
#endif  // ALEXA_CLIENT_SDK_CAPABILITYAGENTS_SPEAKERMANAGER_INCLUDE_SPEAKERMANAGER_CHANNELVOLUMEMANAGER_H_