MediaUplCalculator.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_METRICS_UPLCALCULATOR_INCLUDE_METRICS_MEDIAUPLCALCULATOR_H_
#define ALEXA_CLIENT_SDK_METRICS_UPLCALCULATOR_INCLUDE_METRICS_MEDIAUPLCALCULATOR_H_

#include <AVSCommon/Utils/Metrics/MetricEventBuilder.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>
#include <AVSCommon/Utils/Metrics/UplCalculatorInterface.h>
#include <AVSCommon/Utils/Metrics/UplData.h>

namespace alexaClientSDK {
namespace metrics {
namespace implementations {

class MediaUplCalculator : public avsCommon::utils::metrics::UplCalculatorInterface {
public:
    static std::unique_ptr<avsCommon::utils::metrics::UplCalculatorInterface> createMediaUplCalculator(
        std::shared_ptr<alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder);

    virtual ~MediaUplCalculator() = default;

    std::shared_ptr<alexaClientSDK::avsCommon::utils::metrics::UplData> getUplData() const;

    void inspectMetric(
        const std::shared_ptr<alexaClientSDK::avsCommon::utils::metrics::MetricEvent>& metricEvent) override;
    void setUplData(const std::shared_ptr<alexaClientSDK::avsCommon::utils::metrics::UplData>& uplData) override;
private:
    enum MediaUplType {
        STOP,
        PLAY,
        PLAY_AFTER_TTS
    };

    explicit MediaUplCalculator(
        std::shared_ptr<alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder);

    void addDuration(
        alexaClientSDK::avsCommon::utils::metrics::MetricEventBuilder& metricEventBuilder,
        const std::string& name,
        const std::string& startTimepointName,
        const std::string& endTimepointName);

    void addDuration(
        alexaClientSDK::avsCommon::utils::metrics::MetricEventBuilder& metricEventBuilder,
        const std::string& name,
        const UplTimePoint& startTimepoint,
        const UplTimePoint& endTimepoint);

    UplTimePoint getTimePointAdjustedForTtsDuration(const UplTimePoint& timepoint) const;

    void calculateMediaUpl(MediaUplType type);

    void inhibitSubmission();

    std::weak_ptr<avsCommon::utils::metrics::MetricRecorderInterface> m_metricRecorder;

    UplTimePoint m_ttsStarted;

    UplTimePoint m_ttsFinished;

    bool m_uplInhibited;
};

}  // namespace implementations
}  // namespace metrics
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_METRICS_UPLCALCULATOR_INCLUDE_METRICS_MEDIAUPLCALCULATOR_H_