alexaClientSDK::sampleApplications::common::EndpointAlexaSeekControllerHandler Class Reference

#include <EndpointAlexaSeekControllerHandler.h>

Inheritance diagram for alexaClientSDK::sampleApplications::common::EndpointAlexaSeekControllerHandler:

Collaboration diagram for alexaClientSDK::sampleApplications::common::EndpointAlexaSeekControllerHandler:

Public Member Functions
AlexaSeekControllerInterface methods
acsdkAlexaSeekControllerInterfaces::AlexaSeekControllerInterface::Response	adjustSeekPosition (const std::chrono::milliseconds &deltaPosition) override
Public Member Functions inherited from alexaClientSDK::acsdkAlexaSeekControllerInterfaces::AlexaSeekControllerInterface
virtual	~AlexaSeekControllerInterface ()=default

Static Public Member Functions
static std::shared_ptr< EndpointAlexaSeekControllerHandler >	create (const std::string &endpointName)

Detailed Description

Sample implementation of an AlexaSeekControllerInterface.

Member Function Documentation

adjustSeekPosition()

acsdkAlexaSeekControllerInterfaces::AlexaSeekControllerInterface::Response alexaClientSDK::sampleApplications::common::EndpointAlexaSeekControllerHandler::adjustSeekPosition ( const std::chrono::milliseconds &  deltaPosition )

overridevirtual

Execute seek operation for audio or video content on the device. If the seek delta deltaPosition would result in the adjusted timestamp position exceeding the timestamp boundaries of the media content, the operation should set the new media's position to the maximum allotted timestamp of the media. For example, the content's new timestamp position should be set to zero if the last position plus the seek delta is less than zero. This method must respond with the new timestamp position Response.currentMediaPosition.

Parameters

deltaPosition

The value to seek a media content. Negative to seek the content backward and positive to seek the content forward.

Returns

A AlexaSeekControllerInterface.Response to indicate whether seek operation was successfully executed or encountered an error while executing.

Implements alexaClientSDK::acsdkAlexaSeekControllerInterfaces::AlexaSeekControllerInterface.

create()

static std::shared_ptr<EndpointAlexaSeekControllerHandler> alexaClientSDK::sampleApplications::common::EndpointAlexaSeekControllerHandler::create ( const std::string &  endpointName )

static

Create a EndpointAlexaSeekControllerHandler object.

Parameters

endpointName

The name of the endpoint.

Returns

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

---

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

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