Alexa Auto SDK  2.0.0
Public Types | Public Member Functions | List of all members
aace::alexa::Notifications Class Referenceabstract

Public Types

enum  IndicatorState {
  IndicatorState::OFF = 0,
  IndicatorState::ON = 1,
  IndicatorState::UNKNOWN
}
 

Public Member Functions

virtual void setIndicator (IndicatorState state)=0
 

Detailed Description

Notifications should be extended to handle rendering indicators for notifications from AVS.

The platform implementation is responsible for rendering visual cues for an active notification. The Notifications MediaPlayer will receive directives from the Engine for rendering audio indicators required by a change in Notifications::IndicatorState.

Note
This interface provides indicators that a notification was received, not the content of the notification.
See also
AudioChannel

Member Enumeration Documentation

◆ IndicatorState

Specifies whether a notification indicator should be rendered on the platform

Enumerator
OFF 

The notification indicator should be turned off

ON 

The notification indicator should be turned on

UNKNOWN 

The notification indicator state is unknown.

Member Function Documentation

◆ setIndicator()

virtual void aace::alexa::Notifications::setIndicator ( IndicatorState  state)
pure virtual

Notifies the platform implementation of whether a notification indicator should be rendered

Parameters
[in]stateThe new notification indicator state

Alexa Auto SDK 2.0.0 - Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0