![]() |
AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <LocaleAssetsManagerInterface.h>
Public Types | |
using | Locale = std::string |
using | LanguageTag = std::string |
using | WakeWords = std::set< std::string > |
using | WakeWordsSets = std::set< WakeWords > |
using | Locales = std::vector< Locale > |
using | LocaleCombinations = std::set< Locales > |
Interface for locale sensitive assets manager.
A LocaleAssetsManagerInterface
implementation should provide methods to get the supported locales and wake words in the device. It should also implement a mechanism to change the current device locale and wake words.
The methods prepareAssets
and cancelPrepare
MUST be thread safe.
using alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::LanguageTag = std::string |
Alias for the language tag. The language tag should follow BCP 47 format.
using alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::Locale = std::string |
Alias for the locale. The locale should follow BCP 47 format and it's composed of a language tag and a region tag, e.g.: en-CA.
using alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::LocaleCombinations = std::set<Locales> |
Represent the combinations of locales.
using alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::Locales = std::vector<Locale> |
Represent a collection of locale. This needs to be a vector because the collection is ordered, the locale at index zero is the primary locale.
using alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::WakeWords = std::set<std::string> |
Represent a collection of wake words.
using alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsManagerInterface::WakeWordsSets = std::set<WakeWords> |
Represent a set of wake words.
|
virtualdefault |
Destructor.
|
pure virtual |
Add a locale assets observer to be notified when locale assets have updated.
observer | The observer to add. |
Implemented in alexaClientSDK::sampleApp::LocaleAssetsManager.
|
pure virtual |
Method used to cancel an ongoing prepareAssets
call.
This will get called when there is a change to the required assets. It's up to the implementation to decide how and when to cancel the ongoing operation.
Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::LocaleAssetsManager, and alexaClientSDK::sampleApp::LocaleAssetsManager.
|
pure virtual |
Method to change the current assets.
locales | The locales. |
wakeWords | The wake words that should be available and enabled. |
true
if it succeeds; false
otherwise. Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::LocaleAssetsManager, and alexaClientSDK::sampleApp::LocaleAssetsManager.
|
pure virtual |
Get the default locale.
Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::LocaleAssetsManager, and alexaClientSDK::sampleApp::LocaleAssetsManager.
|
inlinevirtual |
Get the default multilingual locales.
Reimplemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::LocaleAssetsManager, and alexaClientSDK::sampleApp::LocaleAssetsManager.
|
pure virtual |
Get the default valid concurrent wake words sets.
getLocaleSpecificWakeWords()
for locales that have a different set of supported wake words. Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::LocaleAssetsManager, and alexaClientSDK::sampleApp::LocaleAssetsManager.
|
pure virtual |
Function that return valid concurrent wake words sets per language (if and only if locale support a set of wake words that's different than the default set).
Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::LocaleAssetsManager, and alexaClientSDK::sampleApp::LocaleAssetsManager.
|
pure virtual |
Function that return the valid concurrent wake words sets per locale (if and only if locale support a set of wake words that's different than the default set or the language set).
Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::LocaleAssetsManager, and alexaClientSDK::sampleApp::LocaleAssetsManager.
|
pure virtual |
Get the supported locales combinations.
Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::LocaleAssetsManager, and alexaClientSDK::sampleApp::LocaleAssetsManager.
|
pure virtual |
Get the supported locales.
Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::LocaleAssetsManager, and alexaClientSDK::sampleApp::LocaleAssetsManager.
|
pure virtual |
Get the valid concurrent wake words sets for the given locale.
locale | The target locale. |
Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::LocaleAssetsManager, and alexaClientSDK::sampleApp::LocaleAssetsManager.
|
pure virtual |
Remove a previously registered observer.
observer | The observer to be removed. |
Implemented in alexaClientSDK::sampleApp::LocaleAssetsManager.
|
pure virtual |
Set the EndpointRegistrationManager
to update locales/wakewords capabilities.
manager | The pointer to EndpointRegistrationManager . |
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0