ApplicationAudioPipelineFactoryInterface.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 ACSDKAPPLICATIONAUDIOPIPELINEFACTORYINTERFACES_APPLICATIONAUDIOPIPELINEFACTORYINTERFACE_H_
#define ACSDKAPPLICATIONAUDIOPIPELINEFACTORYINTERFACES_APPLICATIONAUDIOPIPELINEFACTORYINTERFACE_H_

#include <string>

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

#include "PooledApplicationMediaInterfaces.h"

namespace alexaClientSDK {
namespace acsdkApplicationAudioPipelineFactoryInterfaces {

class ApplicationAudioPipelineFactoryInterface {
public:
    virtual ~ApplicationAudioPipelineFactoryInterface() = default;

    virtual std::shared_ptr<avsCommon::sdkInterfaces::ApplicationMediaInterfaces> createApplicationMediaInterfaces(
        const std::string& name,
        bool equalizerAvailable = false,
        bool enableLiveMode = false,
        bool isCaptionable = false,
        avsCommon::sdkInterfaces::ChannelVolumeInterface::Type channelVolumeType =
            avsCommon::sdkInterfaces::ChannelVolumeInterface::Type::AVS_SPEAKER_VOLUME,
        std::function<int8_t(int8_t)> volumeCurve = nullptr) = 0;

    virtual std::shared_ptr<PooledApplicationMediaInterfaces> createPooledApplicationMediaInterfaces(
        const std::string& name,
        int numMediaPlayers,
        bool equalizerAvailable = false,
        bool enableLiveMode = false,
        bool isCaptionable = false,
        avsCommon::sdkInterfaces::ChannelVolumeInterface::Type channelVolumeType =
            avsCommon::sdkInterfaces::ChannelVolumeInterface::Type::AVS_SPEAKER_VOLUME,
        std::function<int8_t(int8_t)> volumeCurve = nullptr) = 0;
};

}  // namespace acsdkApplicationAudioPipelineFactoryInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDKAPPLICATIONAUDIOPIPELINEFACTORYINTERFACES_APPLICATIONAUDIOPIPELINEFACTORYINTERFACE_H_