Kodi Documentation 23.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CSeekHandler Class Reference

#include <SeekHandler.h>

Inheritance diagram for CSeekHandler:
ISettingCallback KODI::ACTION::IActionListener

Public Member Functions

 CSeekHandler ()=default
 
void OnSettingChanged (const std::shared_ptr< const CSetting > &setting) override
 The value of the given setting has changed.
 
bool OnAction (const CAction &action) override
 Handle a GUI action.
 
void Seek (bool forward, float amount, float duration=0, bool analogSeek=false, SeekType type=SeekType::VIDEO)
 
void SeekSeconds (int seconds, int seekStepValue=0)
 
void FrameMove ()
 
void Reset ()
 
void Configure ()
 
void ClearSeekStepValue ()
 
void CancelSeekAndClearSeekStepValue ()
 
void ResetAndClearSeekStepValue ()
 
int GetSeekSize () const
 
int GetSeekStepValue () const
 
bool InProgress () const
 
bool HasTimeCode () const
 
int GetTimeCodeSeconds () const
 
- Public Member Functions inherited from ISettingCallback
virtual ~ISettingCallback ()=default
 
virtual bool OnSettingChanging (const std::shared_ptr< const CSetting > &setting)
 The value of the given setting is being changed.
 
virtual void OnSettingAction (const std::shared_ptr< const CSetting > &setting)
 The given setting has been activated.
 
virtual bool OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode)
 The given setting needs to be updated.
 
virtual void OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName)
 The given property of the given setting has changed.
 
- Public Member Functions inherited from KODI::ACTION::IActionListener
virtual ~IActionListener ()=default
 

Static Public Member Functions

static void SettingOptionsSeekStepsFiller (const std::shared_ptr< const CSetting > &setting, std::vector< IntegerSettingOption > &list, int &current)
 

Protected Member Functions

 CSeekHandler (const CSeekHandler &)=delete
 
CSeekHandler & operator= (CSeekHandler const &)=delete
 
bool SeekTimeCode (const CAction &action)
 
void ChangeTimeCode (int remote)
 

Constructor & Destructor Documentation

◆ CSeekHandler() [1/2]

CSeekHandler::CSeekHandler ( )
default

◆ CSeekHandler() [2/2]

CSeekHandler::CSeekHandler ( const CSeekHandler & )
protecteddelete

Member Function Documentation

◆ CancelSeekAndClearSeekStepValue()

void CSeekHandler::CancelSeekAndClearSeekStepValue ( )

◆ ChangeTimeCode()

void CSeekHandler::ChangeTimeCode ( int remote)
protected

◆ ClearSeekStepValue()

void CSeekHandler::ClearSeekStepValue ( )

◆ Configure()

void CSeekHandler::Configure ( )

◆ FrameMove()

void CSeekHandler::FrameMove ( )

◆ GetSeekSize()

int CSeekHandler::GetSeekSize ( ) const

◆ GetSeekStepValue()

int CSeekHandler::GetSeekStepValue ( ) const

◆ GetTimeCodeSeconds()

int CSeekHandler::GetTimeCodeSeconds ( ) const

◆ HasTimeCode()

bool CSeekHandler::HasTimeCode ( ) const

◆ InProgress()

bool CSeekHandler::InProgress ( ) const

◆ OnAction()

bool CSeekHandler::OnAction ( const CAction & action)
overridevirtual

Handle a GUI action.

Parameters
actionThe GUI action
Returns
True if the action was handled, false otherwise

Implements KODI::ACTION::IActionListener.

◆ OnSettingChanged()

void CSeekHandler::OnSettingChanged ( const std::shared_ptr< const CSetting > & setting)
overridevirtual

The value of the given setting has changed.

This callback is triggered whenever the value of a setting has been successfully changed (i.e. none of the OnSettingChanging() handlers) has reverted the change.

Parameters
settingThe setting whose value has been changed

Reimplemented from ISettingCallback.

◆ operator=()

CSeekHandler & CSeekHandler::operator= ( CSeekHandler const & )
protecteddelete

◆ Reset()

void CSeekHandler::Reset ( )

◆ ResetAndClearSeekStepValue()

void CSeekHandler::ResetAndClearSeekStepValue ( )

◆ Seek()

void CSeekHandler::Seek ( bool forward,
float amount,
float duration = 0,
bool analogSeek = false,
SeekType type = SeekType::VIDEO )

◆ SeekSeconds()

void CSeekHandler::SeekSeconds ( int seconds,
int seekStepValue = 0 )

◆ SeekTimeCode()

bool CSeekHandler::SeekTimeCode ( const CAction & action)
protected

◆ SettingOptionsSeekStepsFiller()

void CSeekHandler::SettingOptionsSeekStepsFiller ( const std::shared_ptr< const CSetting > & setting,
std::vector< IntegerSettingOption > & list,
int & current )
static

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