AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::sampleApplications::ipcServerSampleApp::SmartScreenCaptionStateManager Class Reference

#include <SmartScreenCaptionStateManager.h>

Public Member Functions

 SmartScreenCaptionStateManager (std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface > miscStorage)
bool areCaptionsEnabled ()
void setCaptionsState (bool enabled)

Detailed Description

This class manages if captions are turned on or off. It stores the status persistently in disk

Constructor & Destructor Documentation

◆ SmartScreenCaptionStateManager()

alexaClientSDK::sampleApplications::ipcServerSampleApp::SmartScreenCaptionStateManager::SmartScreenCaptionStateManager ( std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface miscStorage)


miscStoragethe storage where Captions settings are stored

Member Function Documentation

◆ areCaptionsEnabled()

bool alexaClientSDK::sampleApplications::ipcServerSampleApp::SmartScreenCaptionStateManager::areCaptionsEnabled ( )

Retrieves the current captions status

whether or not Captions are enabled

◆ setCaptionsState()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::SmartScreenCaptionStateManager::setCaptionsState ( bool  enabled)

Set the state of captions in the DB.

enabledtrue if captions should be enabled

The documentation for this class was generated from the following file:

AlexaClientSDK 3.0.0 - Copyright 2016-2022, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0