NUGU SDK Linux  1.7.6
NuguClientKit::IMediaPlayer Class Referenceabstract

mediaplayer interface More...

#include <media_player_interface.hh>

+ Inheritance diagram for NuguClientKit::IMediaPlayer:

Public Member Functions

virtual void addListener (IMediaPlayerListener *listener)=0
 Add the Listener object. More...
 
virtual int duration ()=0
 Get duration information of the media content from the media player. More...
 
virtual bool isPlaying ()=0
 Check whether the media player is playing media content. More...
 
virtual bool loop ()=0
 Get loop information of the media content from the media player. More...
 
virtual bool mute ()=0
 Get mute information of the media content from the media player. More...
 
virtual bool pause ()=0
 Request media player to pause the media content.
 
virtual bool play ()=0
 Request media player to play the media content.
 
virtual int position ()=0
 Get current position information of the media content from the media player. More...
 
virtual void removeListener (IMediaPlayerListener *listener)=0
 Remove the Listener object. More...
 
virtual bool resume ()=0
 Request media player to resume the media content.
 
virtual bool seek (int sec)=0
 Request the media player to move the current content section. More...
 
virtual void setAudioAttribute (NuguAudioAttribute attr)=0
 Sets the audio attribute in the media player. More...
 
virtual bool setDuration (int duration)=0
 Set duration of the media content to the media player. More...
 
virtual void setLoop (bool loop)=0
 Set loop of the media content to the media player. More...
 
virtual bool setMute (bool mute)=0
 Set mute of the media content to the media player. More...
 
virtual bool setPosition (int position)=0
 Set current position of the media content to the media player. More...
 
virtual bool setSource (const std::string &url)=0
 Sets the playurl of the media content to play in the media player. More...
 
virtual bool setState (MediaPlayerState state)=0
 Set state of the media player. More...
 
virtual bool setVolume (int volume)=0
 Set volume of the media content to the media player. More...
 
virtual MediaPlayerState state ()=0
 Get state of the media player. More...
 
virtual std::string stateString (MediaPlayerState state)=0
 Get state name of the media player. More...
 
virtual bool stop ()=0
 Request media player to stop the media content.
 
virtual std::string url ()=0
 Get url of media content from the media player. More...
 
virtual int volume ()=0
 Get volume information of the media content from the media player. More...
 

Detailed Description

mediaplayer interface

See also
IMediaPlayerListener

Member Function Documentation

◆ addListener()

virtual void NuguClientKit::IMediaPlayer::addListener ( IMediaPlayerListener listener)
pure virtual

Add the Listener object.

Parameters
[in]listenerlistener object

◆ removeListener()

virtual void NuguClientKit::IMediaPlayer::removeListener ( IMediaPlayerListener listener)
pure virtual

Remove the Listener object.

Parameters
[in]listenerlistener object

◆ setAudioAttribute()

virtual void NuguClientKit::IMediaPlayer::setAudioAttribute ( NuguAudioAttribute  attr)
pure virtual

Sets the audio attribute in the media player.

Parameters
[in]attraudio attribute

◆ setSource()

virtual bool NuguClientKit::IMediaPlayer::setSource ( const std::string &  url)
pure virtual

Sets the playurl of the media content to play in the media player.

Parameters
[in]urlmedia content url

◆ seek()

virtual bool NuguClientKit::IMediaPlayer::seek ( int  sec)
pure virtual

Request the media player to move the current content section.

Parameters
[in]seccontent's position. It is moved from the current media position.

◆ position()

virtual int NuguClientKit::IMediaPlayer::position ( )
pure virtual

Get current position information of the media content from the media player.

Returns
media content's current position

◆ setPosition()

virtual bool NuguClientKit::IMediaPlayer::setPosition ( int  position)
pure virtual

Set current position of the media content to the media player.

Parameters
[in]positionmedia content's position.

◆ loop()

virtual bool NuguClientKit::IMediaPlayer::loop ( )
pure virtual

Get loop information of the media content from the media player.

Returns
media content's loop

◆ setLoop()

virtual void NuguClientKit::IMediaPlayer::setLoop ( bool  loop)
pure virtual

Set loop of the media content to the media player.

Parameters
[in]loopmedia content's loop

◆ duration()

virtual int NuguClientKit::IMediaPlayer::duration ( )
pure virtual

Get duration information of the media content from the media player.

Returns
media content's duration

◆ setDuration()

virtual bool NuguClientKit::IMediaPlayer::setDuration ( int  duration)
pure virtual

Set duration of the media content to the media player.

Parameters
[in]durationmedia content's duration.

◆ volume()

virtual int NuguClientKit::IMediaPlayer::volume ( )
pure virtual

Get volume information of the media content from the media player.

Returns
media content's duration

◆ setVolume()

virtual bool NuguClientKit::IMediaPlayer::setVolume ( int  volume)
pure virtual

Set volume of the media content to the media player.

Parameters
[in]volumemedia content's volume.

◆ mute()

virtual bool NuguClientKit::IMediaPlayer::mute ( )
pure virtual

Get mute information of the media content from the media player.

Returns
media content's mute

◆ setMute()

virtual bool NuguClientKit::IMediaPlayer::setMute ( bool  mute)
pure virtual

Set mute of the media content to the media player.

Parameters
[in]mutemedia content's mute.

◆ isPlaying()

virtual bool NuguClientKit::IMediaPlayer::isPlaying ( )
pure virtual

Check whether the media player is playing media content.

Returns
Play or not

◆ state()

virtual MediaPlayerState NuguClientKit::IMediaPlayer::state ( )
pure virtual

Get state of the media player.

Returns
media player's state

◆ setState()

virtual bool NuguClientKit::IMediaPlayer::setState ( MediaPlayerState  state)
pure virtual

Set state of the media player.

Parameters
[in]statemedia player's state

◆ stateString()

virtual std::string NuguClientKit::IMediaPlayer::stateString ( MediaPlayerState  state)
pure virtual

Get state name of the media player.

Parameters
[in]statemedia player's state
Returns
media player's state name

◆ url()

virtual std::string NuguClientKit::IMediaPlayer::url ( )
pure virtual

Get url of media content from the media player.

Returns
media content's url

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