BluezQt 5.109.0
Public Types | Properties | Signals | Public Slots | Public Member Functions | List of all members
BluezQt::MediaPlayer

Media player. More...

#include <BluezQt/MediaPlayer>

Public Types

enum  Equalizer { EqualizerOn , EqualizerOff }
 Equalizer state. More...
 
enum  Repeat { RepeatOff , RepeatSingleTrack , RepeatAllTracks , RepeatGroup }
 Repeat state. More...
 
enum  Shuffle { ShuffleOff , ShuffleAllTracks , ShuffleGroup }
 Shuffle state. More...
 
enum  Status {
  Playing , Stopped , Paused , ForwardSeek ,
  ReverseSeek , Error
}
 Player status. More...
 

Properties

Equalizer equalizer
 
QString name
 
quint32 position
 
Repeat repeat
 
Shuffle shuffle
 
Status status
 
MediaPlayerTrack track
 

Signals

void equalizerChanged (Equalizer equalizer)
 Indicates that player's equalizer state have changed.
 
void nameChanged (const QString &name)
 Indicates that player's name have changed.
 
void positionChanged (quint32 position)
 Indicates that player's playback position have changed.
 
void repeatChanged (Repeat repeat)
 Indicates that player's repeat state have changed.
 
void shuffleChanged (Shuffle shuffle)
 Indicates that player's shuffle state have changed.
 
void statusChanged (Status status)
 Indicates that player's status have changed.
 
void trackChanged (MediaPlayerTrack track)
 Indicates that player's current track have changed.
 

Public Slots

PendingCallfastForward ()
 Fast forwards playback.
 
PendingCallnext ()
 Switch to next track.
 
PendingCallpause ()
 Pauses playback.
 
PendingCallplay ()
 Resumes playback.
 
PendingCallprevious ()
 Switch to previous track.
 
PendingCallrewind ()
 Rewinds playback.
 
PendingCallstop ()
 Stops playback.
 

Public Member Functions

 ~MediaPlayer () override
 Destroys a MediaPlayer object.
 
Equalizer equalizer () const
 Returns the equalizer state of the player.
 
QString name () const
 Returns the name of the player.
 
quint32 position () const
 Returns the playback position in milliseconds.
 
Repeat repeat () const
 Returns the repeat state of the player.
 
PendingCallsetEqualizer (Equalizer equalizer)
 Sets the equalizer state of the player.
 
PendingCallsetRepeat (Repeat repeat)
 Sets the repeat state of the player.
 
PendingCallsetShuffle (Shuffle shuffle)
 Sets the shuffle state of the player.
 
Shuffle shuffle () const
 Returns the shuffle state of the player.
 
Status status () const
 Returns the status of the player.
 
MediaPlayerPtr toSharedPtr () const
 Returns a shared pointer from this.
 
MediaPlayerTrack track () const
 Returns the current track.
 

Detailed Description

Media player.

This class represents a media player interface.

Member Enumeration Documentation

◆ Equalizer

Equalizer state.

Enumerator
EqualizerOn 

Equalizer on.

EqualizerOff 

Equalizer off.

◆ Repeat

Repeat state.

Enumerator
RepeatOff 

Repeat off.

RepeatSingleTrack 

Repeat single track.

RepeatAllTracks 

Repeat all tracks.

RepeatGroup 

Repeat group.

◆ Shuffle

Shuffle state.

Enumerator
ShuffleOff 

Shuffle off.

ShuffleAllTracks 

Shuffle all tracks.

ShuffleGroup 

Shuffle group.

◆ Status

Player status.

Enumerator
Playing 

Player is playing.

Stopped 

Player is stopped.

Paused 

Player is paused.

ForwardSeek 

Player is forward seeking.

ReverseSeek 

Player is reverse seeking.

Error 

Error.

Constructor & Destructor Documentation

◆ ~MediaPlayer()

BluezQt::MediaPlayer::~MediaPlayer ( )
override

Destroys a MediaPlayer object.

Member Function Documentation

◆ equalizer()

Equalizer BluezQt::MediaPlayer::equalizer ( ) const

Returns the equalizer state of the player.

Returns
equalizer state of player

◆ equalizerChanged

void BluezQt::MediaPlayer::equalizerChanged ( Equalizer  equalizer)
signal

Indicates that player's equalizer state have changed.

◆ fastForward

PendingCall * BluezQt::MediaPlayer::fastForward ( )
slot

Fast forwards playback.

Possible errors: PendingCall::NotSupported, PendingCall::Failed

Returns
void pending call

◆ name()

QString BluezQt::MediaPlayer::name ( ) const

Returns the name of the player.

Returns
name of player

◆ nameChanged

void BluezQt::MediaPlayer::nameChanged ( const QString &  name)
signal

Indicates that player's name have changed.

◆ next

PendingCall * BluezQt::MediaPlayer::next ( )
slot

Switch to next track.

Possible errors: PendingCall::NotSupported, PendingCall::Failed

Returns
void pending call

◆ pause

PendingCall * BluezQt::MediaPlayer::pause ( )
slot

Pauses playback.

Possible errors: PendingCall::NotSupported, PendingCall::Failed

Returns
void pending call

◆ play

PendingCall * BluezQt::MediaPlayer::play ( )
slot

Resumes playback.

Possible errors: PendingCall::NotSupported, PendingCall::Failed

Returns
void pending call

◆ position()

quint32 BluezQt::MediaPlayer::position ( ) const

Returns the playback position in milliseconds.

Returns
playback position

◆ positionChanged

void BluezQt::MediaPlayer::positionChanged ( quint32  position)
signal

Indicates that player's playback position have changed.

◆ previous

PendingCall * BluezQt::MediaPlayer::previous ( )
slot

Switch to previous track.

Possible errors: PendingCall::NotSupported, PendingCall::Failed

Returns
void pending call

◆ repeat()

Repeat BluezQt::MediaPlayer::repeat ( ) const

Returns the repeat state of the player.

Returns
repeat state of player

◆ repeatChanged

void BluezQt::MediaPlayer::repeatChanged ( Repeat  repeat)
signal

Indicates that player's repeat state have changed.

◆ rewind

PendingCall * BluezQt::MediaPlayer::rewind ( )
slot

Rewinds playback.

Possible errors: PendingCall::NotSupported, PendingCall::Failed

Returns
void pending call

◆ setEqualizer()

PendingCall * BluezQt::MediaPlayer::setEqualizer ( Equalizer  equalizer)

Sets the equalizer state of the player.

Parameters
equalizerequalizer state
Returns
void pending call

◆ setRepeat()

PendingCall * BluezQt::MediaPlayer::setRepeat ( Repeat  repeat)

Sets the repeat state of the player.

Parameters
repeatrepeat state
Returns
void pending call

◆ setShuffle()

PendingCall * BluezQt::MediaPlayer::setShuffle ( Shuffle  shuffle)

Sets the shuffle state of the player.

Parameters
shuffleshuffle state
Returns
void pending call

◆ shuffle()

Shuffle BluezQt::MediaPlayer::shuffle ( ) const

Returns the shuffle state of the player.

Returns
shuffle state of player

◆ shuffleChanged

void BluezQt::MediaPlayer::shuffleChanged ( Shuffle  shuffle)
signal

Indicates that player's shuffle state have changed.

◆ status()

Status BluezQt::MediaPlayer::status ( ) const

Returns the status of the player.

Returns
status of player

◆ statusChanged

void BluezQt::MediaPlayer::statusChanged ( Status  status)
signal

Indicates that player's status have changed.

◆ stop

PendingCall * BluezQt::MediaPlayer::stop ( )
slot

Stops playback.

Possible errors: PendingCall::NotSupported, PendingCall::Failed

Returns
void pending call

◆ toSharedPtr()

MediaPlayerPtr BluezQt::MediaPlayer::toSharedPtr ( ) const

Returns a shared pointer from this.

Returns
MediaPlayerPtr

◆ track()

MediaPlayerTrack BluezQt::MediaPlayer::track ( ) const

Returns the current track.

Returns
current track

◆ trackChanged

void BluezQt::MediaPlayer::trackChanged ( MediaPlayerTrack  track)
signal

Indicates that player's current track have changed.