alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface Class Reference

#include <VideoRecorderInterface.h>

Inheritance diagram for alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface:

Classes
struct	Response

Public Member Functions
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
virtual bool	isExtendedRecordingGUIShown ()=0
virtual int	getStorageUsedPercentage ()=0

Detailed Description

The VideoRecorderInterface carries out video recorder actions such as search and record, cancel recording and delete recording.

A realization of the VideoRecorderInterface sends response events back to endpoint for search and record and is responsible for providing information regarding storage level and extended GUI.

Note

Implementations of this interface must be thread-safe.

Constructor & Destructor Documentation

~VideoRecorderInterface()

virtual alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::~VideoRecorderInterface ( )

virtualdefault

Virtual destructor to assure proper cleanup of derived types.

Member Function Documentation

cancelRecording()

virtual Response alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::cancelRecording ( std::unique_ptr< VideoRecorderRequest >  request )

pure virtual

Request to cancel a scheduled recording for a specified title. This request should result in the cancellation of the specified scheduled recording, or a title that best matches the requested entity.

Parameters

request

The request for cancel recording directive.

Returns

An instance of VideoRecorderInterface::Response with response.

deleteRecording()

virtual Response alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::deleteRecording ( std::unique_ptr< VideoRecorderRequest >  request )

pure virtual

Request to delete a recorded item. This request should result in the deletion of the specified title, or a title that best matches the requested entity.

Parameters

request

The request for delete recording directive.

Returns

An instance of VideoRecorderInterface::Response with response.

getStorageUsedPercentage()

virtual int alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::getStorageUsedPercentage ( )

pure virtual

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.

Implemented in alexaClientSDK::sampleApplications::common::EndpointAlexaVideoRecorderHandler.

isExtendedRecordingGUIShown()

virtual bool alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::isExtendedRecordingGUIShown ( )

pure virtual

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.

Implemented in alexaClientSDK::sampleApplications::common::EndpointAlexaVideoRecorderHandler.

searchAndRecord()

virtual Response alexaClientSDK::acsdkAlexaVideoRecorderInterfaces::VideoRecorderInterface::searchAndRecord ( std::unique_ptr< VideoRecorderRequest >  request )

pure virtual

Request to find and record a specified video item, given a set of search criteria.

Parameters

request

The request for search and record directive.

Returns

An instance of VideoRecorderInterface::Response with response. In case of success, the response message will be a string value indicating the status of the recording aka recordingStatus.

---

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

• /workplace/avs-device-sdk/capabilities/AlexaVideoRecorder/acsdkAlexaVideoRecorderInterfaces/include/acsdkAlexaVideoRecorderInterfaces/VideoRecorderInterface.h