SpeakerManagerObserverInterface.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_SPEAKERMANAGEROBSERVERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEAKERMANAGEROBSERVERINTERFACE_H_

#include <AVSCommon/SDKInterfaces/ChannelVolumeInterface.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

class SpeakerManagerObserverInterface {
public:
    enum class Source {
        // The call occurred as a result of an AVS Directive.
        DIRECTIVE,
        // The call occurred as a result of a local API call.
        LOCAL_API,
        // The call occurred from an external client
        EXTERNAL_CLIENT
    };

    virtual void onSpeakerSettingsChanged(
        const Source& source,
        const ChannelVolumeInterface::Type& type,
        const SpeakerInterface::SpeakerSettings& settings) = 0;

    virtual ~SpeakerManagerObserverInterface() = default;
};

inline std::ostream& operator<<(std::ostream& stream, SpeakerManagerObserverInterface::Source source) {
    switch (source) {
        case SpeakerManagerObserverInterface::Source::DIRECTIVE:
            stream << "DIRECTIVE";
            return stream;
        case SpeakerManagerObserverInterface::Source::LOCAL_API:
            stream << "LOCAL_API";
            return stream;
        case SpeakerManagerObserverInterface::Source::EXTERNAL_CLIENT:
            stream << "EXTERNAL_CLIENT";
            return stream;
    }
    stream << "UNKNOWN";
    return stream;
}

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEAKERMANAGEROBSERVERINTERFACE_H_