alexaClientSDK::acsdkNotifications Namespace Reference

Namespaces
	test

Classes
struct	NotificationIndicator
class	NotificationRenderer
class	NotificationsCapabilityAgent
class	NotificationsNotifier
class	SQLiteNotificationsStorage

Typedefs
using	NotificationsComponent = acsdkManufactory::Component< std::shared_ptr< acsdkNotificationsInterfaces::NotificationsNotifierInterface >, acsdkManufactory::Import< std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface > >, acsdkManufactory::Import< std::shared_ptr< acsdkNotificationsInterfaces::NotificationsStorageInterface > >, acsdkManufactory::Import< std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > >, acsdkManufactory::Import< acsdkManufactory::Annotated< avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::audio::AudioFactoryInterface > >, acsdkManufactory::Import< acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > >, acsdkManufactory::Import< std::shared_ptr< registrationManager::CustomerDataManagerInterface > >>

Enumerations
enum	IndicatorState { IndicatorState::OFF = 0, IndicatorState::ON = 1, IndicatorState::UNDEFINED }
enum	NotificationsCapabilityAgentState {   NotificationsCapabilityAgentState::IDLE, NotificationsCapabilityAgentState::PLAYING, NotificationsCapabilityAgentState::CANCELING_PLAY, NotificationsCapabilityAgentState::SHUTTING_DOWN,   NotificationsCapabilityAgentState::SHUTDOWN }

Functions
int	indicatorStateToInt (IndicatorState state)
const IndicatorState	intToIndicatorState (int stateNum)
std::ostream &	operator<< (std::ostream &stream, IndicatorState state)
std::string	stateToString (NotificationsCapabilityAgentState state)
std::ostream &	operator<< (std::ostream &stream, const NotificationsCapabilityAgentState &state)
NotificationsComponent	getComponent ()

Variables
static const constexpr char *	NOTIFICATIONS_MEDIA_PLAYER_NAME = "NotificationsMediaPlayer"
	String to identify the notifications media player to render audio. More...

Typedef Documentation

NotificationsComponent

using alexaClientSDK::acsdkNotifications::NotificationsComponent = typedef acsdkManufactory::Component< std::shared_ptr<acsdkNotificationsInterfaces::NotificationsNotifierInterface>, acsdkManufactory::Import< std::shared_ptr<acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface> >, acsdkManufactory::Import<std::shared_ptr<acsdkNotificationsInterfaces::NotificationsStorageInterface> >, acsdkManufactory::Import<std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> >, acsdkManufactory::Import<acsdkManufactory::Annotated< avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::audio::AudioFactoryInterface> >, acsdkManufactory::Import<acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> >, acsdkManufactory::Import<std::shared_ptr<registrationManager::CustomerDataManagerInterface> >>

Definition of a Manufactory Component for Notifications.

Enumeration Type Documentation

IndicatorState

enum alexaClientSDK::acsdkNotifications::IndicatorState

strong

An enum class used to represent the state of the notification indicator.

Note

These values shouldn't be changed before evaluating the effect a change will have on existing databases.

Enumerator
OFF
ON
UNDEFINED

NotificationsCapabilityAgentState

enum alexaClientSDK::acsdkNotifications::NotificationsCapabilityAgentState

strong

Enumerator
IDLE
PLAYING
CANCELING_PLAY
SHUTTING_DOWN
SHUTDOWN

Function Documentation

getComponent()

NotificationsComponent alexaClientSDK::acsdkNotifications::getComponent

(

)

Creates an manufactory component that exports a NotificationsNotifierInterface.

Returns

A component.

indicatorStateToInt()

int alexaClientSDK::acsdkNotifications::indicatorStateToInt ( IndicatorState  state )

inline

Convert an IndicatorState to an int.

Parameters

state

The IndicatorState to convert.

Returns

The int representation of state

intToIndicatorState()

const IndicatorState alexaClientSDK::acsdkNotifications::intToIndicatorState ( int  stateNum )

inline

Convert an int into an IndicatorState.

Parameters

stateNum

The int to convert.

Returns

The IndicatorState representation of stateNum or nullptr if stateNum is invalid.

operator<<() [1/2]

std::ostream& alexaClientSDK::acsdkNotifications::operator<< ( std::ostream &  stream, const NotificationsCapabilityAgentState &  state  )

inline

operator<<() [2/2]

std::ostream& alexaClientSDK::acsdkNotifications::operator<< ( std::ostream &  stream, IndicatorState  state  )

inline

stateToString()

std::string alexaClientSDK::acsdkNotifications::stateToString ( NotificationsCapabilityAgentState  state )

inline

Variable Documentation

NOTIFICATIONS_MEDIA_PLAYER_NAME

const constexpr char* alexaClientSDK::acsdkNotifications::NOTIFICATIONS_MEDIA_PLAYER_NAME = "NotificationsMediaPlayer"

static

String to identify the notifications media player to render audio.