alexaClientSDK::sampleApplications::common::EndpointAlexaRecordControllerHandler Class Reference

#include <EndpointAlexaRecordControllerHandler.h>

Inheritance diagram for alexaClientSDK::sampleApplications::common::EndpointAlexaRecordControllerHandler:

Collaboration diagram for alexaClientSDK::sampleApplications::common::EndpointAlexaRecordControllerHandler:

Public Member Functions
RecordControllerInterface methods
virtual alexaRecordControllerInterfaces::RecordControllerInterface::Response	startRecording () override
virtual alexaRecordControllerInterfaces::RecordControllerInterface::Response	stopRecording () override
virtual bool	isRecording () override
Public Member Functions inherited from alexaClientSDK::alexaRecordControllerInterfaces::RecordControllerInterface
virtual	~RecordControllerInterface ()=default

Static Public Member Functions
static std::shared_ptr< EndpointAlexaRecordControllerHandler >	create (std::string endpointName)

Detailed Description

Sample implementation of a RecordControllerInterface.

Member Function Documentation

create()

static std::shared_ptr<EndpointAlexaRecordControllerHandler> alexaClientSDK::sampleApplications::common::EndpointAlexaRecordControllerHandler::create ( std::string  endpointName )

static

Create a EndpointAlexaRecordController object.

Parameters

endpointName

The name of the endpoint.

Returns

A pointer to a new EndpointAlexaRecordController object if it succeeds; otherwise, nullptr.

isRecording()

virtual bool alexaClientSDK::sampleApplications::common::EndpointAlexaRecordControllerHandler::isRecording ( )

overridevirtual

Get the current recording state information of the endpoint.

Returns

whether the endpoint is currently recording.

Implements alexaClientSDK::alexaRecordControllerInterfaces::RecordControllerInterface.

startRecording()

virtual alexaRecordControllerInterfaces::RecordControllerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaRecordControllerHandler::startRecording ( )

overridevirtual

Start the recording of the content that is currently playing.

Returns

Whether the Recording was successfully started, or if an error was encountered in the process. RecordControllerInterface::Response.type should be set to SUCCESS if no errors were encountered. Otherwise, RecordControllerInterface::Response.type should contain the corresponding error code along with a log message in RecordControllerInterface::Response.message.

Implements alexaClientSDK::alexaRecordControllerInterfaces::RecordControllerInterface.

stopRecording()

virtual alexaRecordControllerInterfaces::RecordControllerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaRecordControllerHandler::stopRecording ( )

overridevirtual

Stop the current recording.

Returns

Whether the Recording was successfully stopped, or if an error was encountered in the process. RecordControllerInterface::Response.type should be set to SUCCESS if no errors were encountered. Otherwise, RecordControllerInterface::Response.type should contain the corresponding error code along with a log message in RecordControllerInterface::Response.message.

Implements alexaClientSDK::alexaRecordControllerInterfaces::RecordControllerInterface.

---

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

• /workplace/avs-device-sdk/SampleApplications/Common/Endpoint/include/acsdk/Sample/Endpoint/EndpointAlexaRecordControllerHandler.h