SpeakerManagerInterface.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_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEAKERMANAGERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEAKERMANAGERINTERFACE_H_

#include <future>
#include <memory>

#include <AVSCommon/SDKInterfaces/ChannelVolumeInterface.h>
#include <AVSCommon/SDKInterfaces/SpeakerManagerObserverInterface.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

class SpeakerManagerInterface {
public:
    struct NotificationProperties {
        NotificationProperties(
            SpeakerManagerObserverInterface::Source source = SpeakerManagerObserverInterface::Source::LOCAL_API,
            bool notifyAVS = true,
            bool notifyObservers = true) :
                notifyAVS{notifyAVS},
                notifyObservers{notifyObservers},
                source{source} {
        }

        // Setting this to true will ensure AVS to be notified of the change.
        bool notifyAVS;
        // Setting this to true will ensure observers to be notified of the change.
        bool notifyObservers;
        // Whether the call is a result from an AVS directive or local interaction.
        SpeakerManagerObserverInterface::Source source;
    };

    virtual std::future<bool> setVolume(
        ChannelVolumeInterface::Type type,
        int8_t volume,
        const NotificationProperties& properties) = 0;

    virtual void onExternalSpeakerSettingsUpdate(
        ChannelVolumeInterface::Type type,
        const SpeakerInterface::SpeakerSettings& speakerSettings,
        const NotificationProperties& properties){};

    virtual std::future<bool> adjustVolume(
        ChannelVolumeInterface::Type type,
        int8_t delta,
        const NotificationProperties& properties) = 0;

    virtual std::future<bool> setMute(
        ChannelVolumeInterface::Type type,
        bool mute,
        const NotificationProperties& properties) = 0;

    virtual std::future<bool> setVolume(
        ChannelVolumeInterface::Type type,
        int8_t volume,
        bool forceNoNotifications = false,
        SpeakerManagerObserverInterface::Source source = SpeakerManagerObserverInterface::Source::LOCAL_API) = 0;

    virtual std::future<bool> adjustVolume(
        ChannelVolumeInterface::Type type,
        int8_t delta,
        bool forceNoNotifications = false,
        SpeakerManagerObserverInterface::Source source = SpeakerManagerObserverInterface::Source::LOCAL_API) = 0;

    virtual std::future<bool> setMute(
        ChannelVolumeInterface::Type type,
        bool mute,
        bool forceNoNotifications = false,
        SpeakerManagerObserverInterface::Source source = SpeakerManagerObserverInterface::Source::LOCAL_API) = 0;

#ifdef ENABLE_MAXVOLUME_SETTING

    virtual std::future<bool> setMaximumVolumeLimit(const int8_t maximumVolumeLimit) = 0;
#endif  // ENABLE_MAXVOLUME_SETTING

    virtual std::future<bool> getSpeakerSettings(
        ChannelVolumeInterface::Type type,
        SpeakerInterface::SpeakerSettings* settings) = 0;

    virtual void addSpeakerManagerObserver(std::shared_ptr<SpeakerManagerObserverInterface> observer) = 0;

    virtual void removeSpeakerManagerObserver(std::shared_ptr<SpeakerManagerObserverInterface> observer) = 0;

    virtual void addChannelVolumeInterface(std::shared_ptr<ChannelVolumeInterface> channelVolumeInterface) = 0;

    virtual ~SpeakerManagerInterface() = default;
};

}  // namespace sdkInterfaces
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEAKERMANAGERINTERFACE_H_