AlexaClientSDK  1.19.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Functions | Variables
alexaClientSDK::capabilityAgents::alerts::renderer Namespace Reference

Namespaces

 test
 

Classes

class  Renderer
 
class  RendererInterface
 
class  RendererObserverInterface
 

Functions

std::ostream & operator<< (std::ostream &stream, const RendererObserverInterface::State &state)
 
static const std::string TAG ("Renderer")
 String to identify log entries originating from this file. More...
 
static bool isSourceIdOk (MediaPlayerInterface::SourceId sourceId)
 

Variables

static const auto ALARM_VOLUME_RAMP_TIME = std::chrono::minutes(1)
 The duration of time for the alarm volume ramp to reach the alert volume sound. More...
 

Function Documentation

◆ isSourceIdOk()

static bool alexaClientSDK::capabilityAgents::alerts::renderer::isSourceIdOk ( MediaPlayerInterface::SourceId  sourceId)
static

Local utility function to evaluate if a sourceId returned from the MediaPlayer is ok.

Parameters
sourceIdThe sourceId being tested.
Returns
Whether the sourceId is ok or not.

◆ operator<<()

std::ostream& alexaClientSDK::capabilityAgents::alerts::renderer::operator<< ( std::ostream &  stream,
const RendererObserverInterface::State state 
)
inline

Write a State value to an ostream.

Parameters
streamThe stream to write the value to.
stateThe State value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ TAG()

static const std::string alexaClientSDK::capabilityAgents::alerts::renderer::TAG ( "Renderer"  )
static

String to identify log entries originating from this file.

Variable Documentation

◆ ALARM_VOLUME_RAMP_TIME

const auto alexaClientSDK::capabilityAgents::alerts::renderer::ALARM_VOLUME_RAMP_TIME = std::chrono::minutes(1)
static

The duration of time for the alarm volume ramp to reach the alert volume sound.

AlexaClientSDK 1.19.0 - Copyright 2016-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0