alexaClientSDK::avsCommon::avs::BlockingPolicy Class Reference

#include <BlockingPolicy.h>

Classes
struct	Medium

Public Types
using	Mediums = std::bitset< Medium::COUNT >
	The mediums used by the policy owner. More...

Public Member Functions
	BlockingPolicy (const Mediums &mediums=MEDIUMS_NONE, bool isBlocking=true)
bool	isValid () const
bool	isBlocking () const
Mediums	getMediums () const

Static Public Attributes
static const avscommon_EXPORT Mediums	MEDIUM_AUDIO
	Policy uses AUDIO medium. More...
static const avscommon_EXPORT Mediums	MEDIUM_VISUAL
	Policy uses VISUAL medium. More...
static const avscommon_EXPORT Mediums	MEDIUMS_AUDIO_AND_VISUAL
	Policy uses AUDIO and VISUAL mediums. More...
static const avscommon_EXPORT Mediums	MEDIUMS_NONE

Detailed Description

A Blocking policy is a way to express what mediums are required by the policy owner and whether the policy owner is blocking subsequent directives using the medium.

Member Typedef Documentation

Mediums

using alexaClientSDK::avsCommon::avs::BlockingPolicy::Mediums = std::bitset<Medium::COUNT>

The mediums used by the policy owner.

Constructor & Destructor Documentation

BlockingPolicy()

alexaClientSDK::avsCommon::avs::BlockingPolicy::BlockingPolicy	(	const Mediums &	mediums = MEDIUMS_NONE,
		bool	isBlocking = true
	)

Constructor

Parameters

mediums	The Mediums used by the policy owner.
isBlocking	Should this policy block another usage of owned mediums until completion.

Member Function Documentation

getMediums()

Mediums alexaClientSDK::avsCommon::avs::BlockingPolicy::getMediums

(

)

const

What Mediums are used by this policy.

Returns

The Mediums used by the policy

isBlocking()

bool alexaClientSDK::avsCommon::avs::BlockingPolicy::isBlocking

(

)

const

Is this policy blocking a Medium.

Returns

true if the given policy is blocking, false otherwise.

isValid()

bool alexaClientSDK::avsCommon::avs::BlockingPolicy::isValid

(

)

const

Is the policy valid.

Returns

true if the policy is valid, false otherwise.

Member Data Documentation

MEDIUM_AUDIO

const avscommon_EXPORT Mediums alexaClientSDK::avsCommon::avs::BlockingPolicy::MEDIUM_AUDIO

static

Policy uses AUDIO medium.

MEDIUM_VISUAL

const avscommon_EXPORT Mediums alexaClientSDK::avsCommon::avs::BlockingPolicy::MEDIUM_VISUAL

static

Policy uses VISUAL medium.

MEDIUMS_AUDIO_AND_VISUAL

const avscommon_EXPORT Mediums alexaClientSDK::avsCommon::avs::BlockingPolicy::MEDIUMS_AUDIO_AND_VISUAL

static

Policy uses AUDIO and VISUAL mediums.

MEDIUMS_NONE

const avscommon_EXPORT Mediums alexaClientSDK::avsCommon::avs::BlockingPolicy::MEDIUMS_NONE

static

Policy uses no medium. This should be used for System of setting-type directives.

---

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

• /workplace/avs-device-sdk/AVSCommon/AVS/include/AVSCommon/AVS/BlockingPolicy.h