alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension Class Reference

#include <AplLiveViewExtension.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension:

Collaboration diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension:

Public Member Functions
	AplLiveViewExtension (std::shared_ptr< AplLiveViewExtensionObserverInterface > observer)
	~AplLiveViewExtension ()=default
void	setCameraState (const std::string &cameraState)
void	setCameraMicrophoneState (bool enabled)
void	setAsrProfile (const std::string &asrProfile)
void	onCameraFirstFrameRendered ()
void	onCameraCleared ()
AplCoreExtensionInterface Functions
std::string	getUri () override
apl::Object	getEnvironment () override
std::list< apl::ExtensionCommandDefinition >	getCommandDefinitions () override
std::list< apl::ExtensionEventHandler >	getEventHandlers () override
std::unordered_map< std::string, apl::LiveObjectPtr >	getLiveDataObjects () override
void	applySettings (const apl::Object &settings) override
AplCoreExtensionEventCallbackInterface Functions
void	onExtensionEvent (const std::string &uri, const std::string &name, const apl::Object &source, const apl::Object &params, unsigned int event, std::shared_ptr< AplCoreExtensionEventCallbackResultInterface > resultCallback) override

Detailed Description

An APL Extension designed for communication with a Camera

Constructor & Destructor Documentation

AplLiveViewExtension()

alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::AplLiveViewExtension ( std::shared_ptr< AplLiveViewExtensionObserverInterface >  observer )

explicit

Constructor

~AplLiveViewExtension()

alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::~AplLiveViewExtension ( )

default

Member Function Documentation

applySettings()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::applySettings ( const apl::Object &  settings )

override

getCommandDefinitions()

std::list<apl::ExtensionCommandDefinition> alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::getCommandDefinitions ( )

override

getEnvironment()

apl::Object alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::getEnvironment ( )

override

getEventHandlers()

std::list<apl::ExtensionEventHandler> alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::getEventHandlers ( )

override

getLiveDataObjects()

std::unordered_map<std::string, apl::LiveObjectPtr> alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::getLiveDataObjects ( )

override

getUri()

std::string alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::getUri ( )

override

onCameraCleared()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::onCameraCleared

(

)

Informs the APL document that the camera has been cleared and is no longer displayed.

onCameraFirstFrameRendered()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::onCameraFirstFrameRendered

(

)

Informs the APL document that the first frame of the camera has rendered.

onExtensionEvent()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::onExtensionEvent ( const std::string &  uri, const std::string &  name, const apl::Object &  source, const apl::Object &  params, unsigned int  event, std::shared_ptr< AplCoreExtensionEventCallbackResultInterface >  resultCallback  )

override

setAsrProfile()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::setAsrProfile

(

const std::string &

asrProfile

)

Informs the APL document of the current ASR Profile for the device relative to audio input. Used to determine UI state and display characteristics. See: https://developer.amazon.com/en-US/docs/alexa/alexa-voice-service/audio-hardware-configurations.html

Parameters

asrProfile

the current asrProfile for the device.

setCameraMicrophoneState()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::setCameraMicrophoneState

(

bool

enabled

)

Informs the APL document of changes in camera microphone state.

Parameters

enabled

true if camera microphone is enabled and unmuted.

setCameraState()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::extensions::liveView::AplLiveViewExtension::setCameraState

(

const std::string &

cameraState

)

Informs the APL document of changes in camera state

Parameters

cameraState

enumerated

---

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

• /workplace/avs-device-sdk/SampleApplications/IPCServerSampleApplication/LibIPCServerSampleApp/include/IPCServerSampleApp/Extensions/LiveView/AplLiveViewExtension.h