alexaClientSDK::avsCommon::utils::mediaPlayer::SourceConfig Struct Reference

#include <SourceConfig.h>

Collaboration diagram for alexaClientSDK::avsCommon::utils::mediaPlayer::SourceConfig:

Classes
struct	AudioNormalizationConfig
struct	FadeInConfig

Static Public Member Functions
static SourceConfig	createWithFadeIn (short startGain, short endGain, const std::chrono::milliseconds &duration)

Public Attributes
FadeInConfig	fadeInConfig
	Fade-In configuration. More...
AudioNormalizationConfig	audioNormalizationConfig
	Audio normalization configuration. More...
std::chrono::milliseconds	endOffset
	End offset for where playback should be stopped. More...
MediaDescription	mediaDescription
	Media description information. More...

Member Function Documentation

createWithFadeIn()

SourceConfig alexaClientSDK::avsCommon::utils::mediaPlayer::SourceConfig::createWithFadeIn ( short  startGain, short  endGain, const std::chrono::milliseconds &  duration  )

inlinestatic

Builds a Source Config object with fade in enabled.

Parameters

startGain	The starting percentage volume when the media starts playing (range 0-100).
endGain	The ending percentage volume when the media played to the fade-in duration (range 0-100).
duration	The fade-in duration time.

Builds a Source Config object with fade in enabled and with the provided valid values.

Parameters

startGain	The starting percentage volume when the media starts playing (range 0-100) Will become valid.
endGain	The ending percentage volume when the media played to the fade-in duration (range 0-100). Will become valid.
duration	The fade-in duration time.

Returns

a Source Config object with fade in set for the given valid values

Member Data Documentation

audioNormalizationConfig

AudioNormalizationConfig alexaClientSDK::avsCommon::utils::mediaPlayer::SourceConfig::audioNormalizationConfig

Audio normalization configuration.

endOffset

std::chrono::milliseconds alexaClientSDK::avsCommon::utils::mediaPlayer::SourceConfig::endOffset

End offset for where playback should be stopped.

fadeInConfig

FadeInConfig alexaClientSDK::avsCommon::utils::mediaPlayer::SourceConfig::fadeInConfig

Fade-In configuration.

mediaDescription

MediaDescription alexaClientSDK::avsCommon::utils::mediaPlayer::SourceConfig::mediaDescription

Media description information.

---

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

• /workplace/avs-device-sdk/AVSCommon/Utils/include/AVSCommon/Utils/MediaPlayer/SourceConfig.h