AlexaProperties.h

/*
 * Copyright 2017-2019 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 AACE_ALEXA_PROPERTY_ALEXA_PROPERTIES_H
#define AACE_ALEXA_PROPERTY_ALEXA_PROPERTIES_H

/** @file */

namespace aace {
namespace alexa {
namespace property {

/**
 * This property is used with Engine::setProperty() to change the AVS endpoint. The value must be
 * a valid AVS endpoint URL. See https://developer.amazon.com/docs/alexa-voice-service/api-overview.html#endpoints
 */
static const std::string AVS_ENDPOINT = "aace.alexa.endpoint";

/**
 * This read-only property is used with Engine::getProperty() to check if the Engine has wake word support.
 * If wake word is not supported in the Engine, attempts to enable wake word detection by
 * the @c SpeechRecognizer will fail.
 */
static const std::string WAKEWORD_SUPPORTED = "aace.alexa.wakewordSupported";

/**
 * This property is used with Engine::setProperty() to change the firmware version that is reported
 * to AVS. The value must be a positive, signed 32-bit integer represented
 * as a string.
 */
static const std::string FIRMWARE_VERSION = "aace.alexa.system.firmwareVersion";

/**
 * This property is used with Engine::setProperty() to change the current locale setting for AVS.
 * The value should be a valid locale accepted by AVS. Calling Engine::getProperty() with the
 * SUPPORTED_LOCALES property provides the list of supported locales.
 */
static const std::string LOCALE = "aace.alexa.setting.locale";

/**
 *  This read-only property is used with Engine::getProperty() to see all AVS supported locales. The return
 *  value is a comma-separated list, e.g. "de-DE,en-AU,..."
 */
static const std::string SUPPORTED_LOCALES = "aace.alexa.supportedLocales";

/**
 *  This read-only property is used with Engine::getProperty() to check if the vehicle's country is supported.
 */
static const std::string COUNTRY_SUPPORTED = "aace.alexa.countrySupported";

} // aace::alexa::property
} // aace::alexa
} // aace

#endif // AACE_ALEXA_PROPERTY_ALEXA_PROPERTIES_H