AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Static Public Member Functions | List of all members
alexaClientSDK::sampleApplications::common::EndpointAlexaVideoRecorderHandler Class Reference

#include <EndpointAlexaVideoRecorderHandler.h>

Inheritance diagram for alexaClientSDK::sampleApplications::common::EndpointAlexaVideoRecorderHandler:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::sampleApplications::common::EndpointAlexaVideoRecorderHandler:
Collaboration graph
[legend]

Public Member Functions

VideoRecorderHandlerInterface methods
acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::Response searchAndRecord (std::unique_ptr< acsdkAlexaVideoRecorderInterfaces::VideoRecorderRequest > context) override
 
acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::Response cancelRecording (std::unique_ptr< acsdkAlexaVideoRecorderInterfaces::VideoRecorderRequest > context) override
 
acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::Response deleteRecording (std::unique_ptr< acsdkAlexaVideoRecorderInterfaces::VideoRecorderRequest > context) override
 
bool isExtendedRecordingGUIShown () override
 
int getStorageUsedPercentage () override
 
- Public Member Functions inherited from alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface
virtual ~VideoRecorderInterface ()=default
 
virtual Response searchAndRecord (std::unique_ptr< VideoRecorderRequest > request)=0
 
virtual Response cancelRecording (std::unique_ptr< VideoRecorderRequest > request)=0
 
virtual Response deleteRecording (std::unique_ptr< VideoRecorderRequest > request)=0
 

Static Public Member Functions

static std::unique_ptr< EndpointAlexaVideoRecorderHandlercreate (const std::string endpointName)
 

Detailed Description

Sample implementation of an AlexaVideoRecorderInterface.

Member Function Documentation

◆ cancelRecording()

acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaVideoRecorderHandler::cancelRecording ( std::unique_ptr< acsdkAlexaVideoRecorderInterfaces::VideoRecorderRequest context)
override

◆ create()

static std::unique_ptr<EndpointAlexaVideoRecorderHandler> alexaClientSDK::sampleApplications::common::EndpointAlexaVideoRecorderHandler::create ( const std::string  endpointName)
static

Create a EndpointRemoteVideoPlayerHandler object.

Parameters
endpointNameThe name of the endpoint.
Returns
A pointer to a new EndpointRemoteVideoPlayerHandler object if it succeeds; otherwise, nullptr.

◆ deleteRecording()

acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaVideoRecorderHandler::deleteRecording ( std::unique_ptr< acsdkAlexaVideoRecorderInterfaces::VideoRecorderRequest context)
override

◆ getStorageUsedPercentage()

int alexaClientSDK::sampleApplications::common::EndpointAlexaVideoRecorderHandler::getStorageUsedPercentage ( )
overridevirtual

Gets the property for storage level which indicates the storage used on the recording device as a percentage.

Returns
Integer indicating storage used on the recording device as a percentage.

Implements alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface.

◆ isExtendedRecordingGUIShown()

bool alexaClientSDK::sampleApplications::common::EndpointAlexaVideoRecorderHandler::isExtendedRecordingGUIShown ( )
overridevirtual

Gets the property for extended GUI which indicates the type of graphical user interface shown to the user. true to indicate an extended recording GUI is shown, false if the extended recording GUI isn't shown.

Returns
true if extended GUI is shown.

Implements alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface.

◆ searchAndRecord()

acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaVideoRecorderHandler::searchAndRecord ( std::unique_ptr< acsdkAlexaVideoRecorderInterfaces::VideoRecorderRequest context)
override

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

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