alexaClientSDK::settings::types Namespace Reference

Classes
class	LocaleWakeWordsSetting
class	NetworkInfo

Enumerations
enum	AlarmVolumeRampTypes { AlarmVolumeRampTypes::NONE, AlarmVolumeRampTypes::ASCENDING }

Functions
constexpr AlarmVolumeRampTypes	getAlarmVolumeRampDefault ()
constexpr bool	isEnabled (AlarmVolumeRampTypes volumeRamp)
constexpr AlarmVolumeRampTypes	toAlarmRamp (bool enabled)
std::ostream &	operator<< (std::ostream &stream, const AlarmVolumeRampTypes &value)
std::istream &	operator>> (std::istream &is, AlarmVolumeRampTypes &value)
std::ostream &	operator<< (std::ostream &os, const NetworkInfo &info)
std::istream &	operator>> (std::istream &is, NetworkInfo &info)

Enumeration Type Documentation

AlarmVolumeRampTypes

enum alexaClientSDK::settings::types::AlarmVolumeRampTypes

strong

Defines the values for alarm volume ramp setting.

Enumerator
NONE	Alarm should start with final volume.
ASCENDING	Alarm will include a fade-in period.

Function Documentation

getAlarmVolumeRampDefault()

constexpr AlarmVolumeRampTypes alexaClientSDK::settings::types::getAlarmVolumeRampDefault

(

)

Retrieves the default value of alarm volume ramp.

Returns

The default value ramp.

isEnabled()

constexpr bool alexaClientSDK::settings::types::isEnabled

(

AlarmVolumeRampTypes

volumeRamp

)

Convert AlarmVolumeRampTypes to boolean logic since the UI experience is enable / disable.

Parameters

volumeRamp

The setting value.

Returns

Whether the setting value is enabled (ASCENDING) or not (NONE).

operator<<() [1/2]

std::ostream& alexaClientSDK::settings::types::operator<< ( std::ostream &  stream, const AlarmVolumeRampTypes &  value  )

inline

Write a AlarmVolumeRampTypes value to the given stream.

Parameters

stream	The stream to write the value to.
value	The value to write to the stream as a string.

Returns

The stream that was passed in and written to.

operator<<() [2/2]

std::ostream& alexaClientSDK::settings::types::operator<<	(	std::ostream &	os,
		const NetworkInfo &	info
	)

Write a NetworkInfo value to the given stream in json format.

Parameters

stream	The stream to write the value to.
info	The network info to write to the stream as a string.

Returns

The stream that was passed in and written to.

operator>>() [1/2]

std::istream& alexaClientSDK::settings::types::operator>> ( std::istream &  is, AlarmVolumeRampTypes &  value  )

inline

Converts an input string stream value to AlarmVolumeRampTypes.

Parameters

	stream	The string stream to retrieve the value from.
[out]	value	The value to write to.

Returns

The stream that was passed in.

operator>>() [2/2]

std::istream& alexaClientSDK::settings::types::operator>>	(	std::istream &	is,
		NetworkInfo &	info
	)

Converts an input string stream value formatted as json document to NetworkInfo.

Parameters

	stream	The string stream to retrieve the value from.
[out]	info	The network info to write to.

Returns

The stream that was passed in.

toAlarmRamp()

constexpr AlarmVolumeRampTypes alexaClientSDK::settings::types::toAlarmRamp

(

bool

enabled

)

Convert boolean to AlarmVolumeRampTypes.

Parameters

enabled

Whether fade-in is enabled or not.

Returns

The corresponding setting value.