NUGU SDK Linux  1.7.5
NuguCapability::IAudioPlayerListener Class Referenceabstract

audioplayer listener interface More...

#include <audio_player_interface.hh>

+ Inheritance diagram for NuguCapability::IAudioPlayerListener:
+ Collaboration diagram for NuguCapability::IAudioPlayerListener:

Public Member Functions

virtual void durationChanged (int duration)=0
 The audio player reports the total duration of the content being played to the user. More...
 
virtual void favoriteChanged (bool favorite, const std::string &dialog_id)=0
 The audio player reports to the user the current content's favorite setting changed. More...
 
virtual void mediaEventReport (AudioPlayerEvent event, const std::string &dialog_id)=0
 The audio player reports player's event being played to the user.
 
virtual void mediaStateChanged (AudioPlayerState state, const std::string &dialog_id)=0
 Report this to the user when the state of the audio player changes. More...
 
virtual void positionChanged (int position)=0
 The audio player reports to the user the current playing time of the content being played. More...
 
virtual void repeatChanged (RepeatType repeat, const std::string &dialog_id)=0
 The audio player reports to the user the current content's repeat setting changed. More...
 
virtual void requestContentCache (const std::string &key, const std::string &playurl)=0
 The audio player request to the user to cache the content if possible. More...
 
virtual bool requestToGetCachedContent (const std::string &key, std::string &filepath)=0
 The audio player request to the user to get the cached content. More...
 
virtual void shuffleChanged (bool shuffle, const std::string &dialog_id)=0
 The audio player reports to the user the current content's shuffle setting changed. More...
 
- Public Member Functions inherited from NuguClientKit::ICapabilityListener
virtual ICapabilityInterfacegetCapabilityHandler ()
 Get capability interface object. More...
 
virtual void setCapabilityHandler (ICapabilityInterface *handler)
 Set capability interface object. More...
 

Detailed Description

audioplayer listener interface

See also
IAudioPlayerHandler

Member Function Documentation

◆ mediaStateChanged()

virtual void NuguCapability::IAudioPlayerListener::mediaStateChanged ( AudioPlayerState  state,
const std::string &  dialog_id 
)
pure virtual

Report this to the user when the state of the audio player changes.

Parameters
[in]stateaudioplayer's state
[in]dialog_iddialog request id

◆ durationChanged()

virtual void NuguCapability::IAudioPlayerListener::durationChanged ( int  duration)
pure virtual

The audio player reports the total duration of the content being played to the user.

Parameters
[in]durationmedia content's duration

◆ positionChanged()

virtual void NuguCapability::IAudioPlayerListener::positionChanged ( int  position)
pure virtual

The audio player reports to the user the current playing time of the content being played.

Parameters
[in]positionmedia content's position

◆ favoriteChanged()

virtual void NuguCapability::IAudioPlayerListener::favoriteChanged ( bool  favorite,
const std::string &  dialog_id 
)
pure virtual

The audio player reports to the user the current content's favorite setting changed.

Parameters
[in]favoritemedia content's favorite
[in]dialog_iddialog request id

◆ shuffleChanged()

virtual void NuguCapability::IAudioPlayerListener::shuffleChanged ( bool  shuffle,
const std::string &  dialog_id 
)
pure virtual

The audio player reports to the user the current content's shuffle setting changed.

Parameters
[in]shufflemedia content's shuffle
[in]dialog_iddialog request id

◆ repeatChanged()

virtual void NuguCapability::IAudioPlayerListener::repeatChanged ( RepeatType  repeat,
const std::string &  dialog_id 
)
pure virtual

The audio player reports to the user the current content's repeat setting changed.

Parameters
[in]repeatmedia content's repeat
[in]dialog_iddialog request id

◆ requestContentCache()

virtual void NuguCapability::IAudioPlayerListener::requestContentCache ( const std::string &  key,
const std::string &  playurl 
)
pure virtual

The audio player request to the user to cache the content if possible.

Parameters
[in]keycontent's unique key
[in]playurlcontent's playurl

◆ requestToGetCachedContent()

virtual bool NuguCapability::IAudioPlayerListener::requestToGetCachedContent ( const std::string &  key,
std::string &  filepath 
)
pure virtual

The audio player request to the user to get the cached content.

Parameters
[in]keycontent's unique key
[out]filepathcached content's filepath
Returns
return true if cached content, otherwise false

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