alexaClientSDK::acsdkAlexaSeekControllerInterfaces::AlexaSeekControllerInterface Class Reference

#include <AlexaSeekControllerInterface.h>

Inheritance diagram for alexaClientSDK::acsdkAlexaSeekControllerInterfaces::AlexaSeekControllerInterface:

Classes
struct	Response

Public Member Functions
virtual	~AlexaSeekControllerInterface ()=default
virtual Response	adjustSeekPosition (const std::chrono::milliseconds &deltaPosition)=0

Detailed Description

The AlexaSeekControllerInterface carries out actions such as navigating to a specific position in a media item. You should implement this interface for your devices and services that can seek to a specific position. If a device or service can only fast forward or rewind a media item, implement the Alexa.PlaybackController interface instead.

An implementation of the AlexaSeekControllerInterface lets the user control media content interactions for seek navigation such as AdjustSeekPosition.

Note

Implementations of this interface must be thread-safe. As a new adjustSeekPosition operation can be invoked before the current operation completes on the device, the seek controller must handle concurrent operations, either by canceling the currently processing operation with an appropriate error Response or wait for completion of the first operation before handling the second operation.

Constructor & Destructor Documentation

~AlexaSeekControllerInterface()

virtual alexaClientSDK::acsdkAlexaSeekControllerInterfaces::AlexaSeekControllerInterface::~AlexaSeekControllerInterface ( )

virtualdefault

Virtual destructor to assure proper cleanup of derived types.

Member Function Documentation

adjustSeekPosition()

virtual Response alexaClientSDK::acsdkAlexaSeekControllerInterfaces::AlexaSeekControllerInterface::adjustSeekPosition ( const std::chrono::milliseconds &  deltaPosition )

pure virtual

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.

Implemented in alexaClientSDK::sampleApplications::common::EndpointAlexaSeekControllerHandler.

---

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

• /workplace/avs-device-sdk/capabilities/AlexaSeekController/acsdkAlexaSeekControllerInterfaces/include/acsdkAlexaSeekControllerInterfaces/AlexaSeekControllerInterface.h