AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::CallStateObserverInterface Class Referenceabstract

#include <CallStateObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::CallStateObserverInterface:
Inheritance graph
[legend]

Classes

struct  CallStateInfo
 An struct containing call state information. More...
 

Public Types

enum  CallState {
  CallState::CONNECTING, CallState::INBOUND_RINGING, CallState::CALL_CONNECTED, CallState::CALL_DISCONNECTED,
  CallState::NONE
}
 An enumeration representing the state of a call. More...
 
typedef struct alexaClientSDK::avsCommon::sdkInterfaces::CallStateObserverInterface::CallStateInfo CallStateInfo
 An struct containing call state information. More...
 

Public Member Functions

virtual ~CallStateObserverInterface ()=default
 
virtual void onCallStateChange (CallState state)=0
 
virtual void onCallStateInfoChange (const CallStateInfo &stateInfo)
 

Static Public Member Functions

static bool isStateActive (const CallStateObserverInterface::CallState &state)
 

Detailed Description

An interface to allow being notified of changes to the state of a call.

Member Typedef Documentation

◆ CallStateInfo

An struct containing call state information.

Member Enumeration Documentation

◆ CallState

An enumeration representing the state of a call.

Enumerator
CONNECTING 

The call is connecting.

INBOUND_RINGING 

An incoming call is causing a ringtone to be played.

CALL_CONNECTED 

The call has successfully connected.

CALL_DISCONNECTED 

The call has ended.

NONE 

No current call state to be relayed to the user.

Constructor & Destructor Documentation

◆ ~CallStateObserverInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::CallStateObserverInterface::~CallStateObserverInterface ( )
virtualdefault

Destructor

Member Function Documentation

◆ isStateActive()

bool alexaClientSDK::avsCommon::sdkInterfaces::CallStateObserverInterface::isStateActive ( const CallStateObserverInterface::CallState state)
inlinestatic

Checks the state of the provided call state to determine if a call is in an "active" state Active states are: CONNECTING INBOUND_RINGING CALL_CONNETED

Parameters
stateThe new CallState.
Returns
True on states that are considered "active", false otherwise.

◆ onCallStateChange()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::CallStateObserverInterface::onCallStateChange ( CallState  state)
pure virtual

Allows the observer to react to a change in call state.

Parameters
stateThe new CallState.

Implemented in alexaClientSDK::sampleApp::InteractionManager, and alexaClientSDK::capabilityAgents::mrm::MRMCapabilityAgent.

◆ onCallStateInfoChange()

void alexaClientSDK::avsCommon::sdkInterfaces::CallStateObserverInterface::onCallStateInfoChange ( const CallStateInfo stateInfo)
inlinevirtual

Allows the observer to react to a change in call state info.

Parameters
stateInfoThe new CallStateInfo.

The documentation for this class 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