AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerInterface::NotificationProperties Struct Reference

#include <SpeakerManagerInterface.h>

Public Member Functions

 NotificationProperties (SpeakerManagerObserverInterface::Source source=SpeakerManagerObserverInterface::Source::LOCAL_API, bool notifyAVS=true, bool notifyObservers=true)
 

Public Attributes

bool notifyAVS
 
bool notifyObservers
 
SpeakerManagerObserverInterface::Source source
 

Detailed Description

The NotificationProperties struct defines the properties about the source that invokes the APIs and how to send volume or mute change notifications. The APIs of SpeakerManagerInterface uses the properties to decide whether AVS and observers should be notified or not.

Constructor & Destructor Documentation

◆ NotificationProperties()

alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerInterface::NotificationProperties::NotificationProperties ( SpeakerManagerObserverInterface::Source  source = SpeakerManagerObserverInterface::Source::LOCAL_API,
bool  notifyAVS = true,
bool  notifyObservers = true 
)
inline

Constructor.

Parameters
sourceWhether the call is a result from an AVS directive or local interaction.
notifyAVSWhether AVS should be notified or not.
notifyObserversWhether observers should be notified or not.

Member Data Documentation

◆ notifyAVS

bool alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerInterface::NotificationProperties::notifyAVS

◆ notifyObservers

bool alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerInterface::NotificationProperties::notifyObservers

◆ source

SpeakerManagerObserverInterface::Source alexaClientSDK::avsCommon::sdkInterfaces::SpeakerManagerInterface::NotificationProperties::source

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

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