AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
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 {MEDIUM_FLAG_AUDIO}
 Policy uses AUDIO medium. More...
 
static const avscommon_EXPORT Mediums MEDIUM_VISUAL {MEDIUM_FLAG_VISUAL}
 Policy uses VISUAL medium. More...
 
static const avscommon_EXPORT Mediums MEDIUMS_AUDIO_AND_VISUAL {MEDIUM_FLAG_AUDIO | MEDIUM_FLAG_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

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
mediumsThe Mediums used by the policy owner.
isBlockingShould this policy block another usage of owned mediums until completion.

Member Function Documentation

◆ getMediums()

BlockingPolicy::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 BlockingPolicy::Mediums alexaClientSDK::avsCommon::avs::BlockingPolicy::MEDIUM_AUDIO {MEDIUM_FLAG_AUDIO}
static

Policy uses AUDIO medium.

◆ MEDIUM_VISUAL

const BlockingPolicy::Mediums alexaClientSDK::avsCommon::avs::BlockingPolicy::MEDIUM_VISUAL {MEDIUM_FLAG_VISUAL}
static

Policy uses VISUAL medium.

◆ MEDIUMS_AUDIO_AND_VISUAL

const BlockingPolicy::Mediums alexaClientSDK::avsCommon::avs::BlockingPolicy::MEDIUMS_AUDIO_AND_VISUAL {MEDIUM_FLAG_AUDIO | MEDIUM_FLAG_VISUAL}
static

Policy uses AUDIO and VISUAL mediums.

◆ MEDIUMS_NONE

const BlockingPolicy::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 files:

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