PlayerGStreamer Class Reference

Interface for PlayerGStreamer implementations. More...

#include <H:/WOSH/win32_vc2010/src/bundles/PlayerGStreamer/PlayerGStreamer.h>

List of all members.

Public Member Functions

Playlist management
virtual WRESULT play ()
 Play the current media.
virtual WRESULT play (unsigned int index)
virtual WRESULT play (const std::string &file_url, int volume=-1, bool override_current=false)=0
 Play a resource.
virtual WRESULT enqueue (const std::string &file_url)
virtual WRESULT remove (unsigned int index)
virtual WRESULT clear ()
 Clear the playlist. Won't necessary stop current playback.
virtual WRESULT first ()
 Play the first element in the playlist.
virtual WRESULT next ()
 Play the next element in the playlist.
virtual WRESULT prev ()
 Play the previous element in the playlist.
virtual WRESULT last ()
 Play the last element in the playlist.
Getters
virtual long getPlayListIndex () const
virtual long getPlayListLength () const
virtual int getCrossfade () const
virtual short getRepeat () const
virtual short getRandom () const
virtual const
wosh::entertainment::MediaList
getPlayList () const
virtual
wosh::entertainment::MediaList
getPlayList ()
virtual std::string getDeviceDriver () const
virtual std::string getDeviceOutput () const
virtual WRESULT getAPIInfo (std::map< std::string, std::string > &fields) const =0
bool isValidFile (const std::string &) const

Setters

MediaList playlist
 the playlist
std::string device_sink
 output driver GST name (default: alsasink)
std::string device_output
 ALSA device name (default; ..)
short currentRepeat
 flag: repeat current item forever
short playListRepeat
 flag: repeat whole playlist forever
bool playListRandom
int volume_init
 (default) volume value (used only while starting thread)
int volume_muted
 cache of last volume while muted, 0 when not muted
IPlayerGStreamerListener * playerListener
virtual void setPlayerListener (IPlayerGStreamerListener *Listener)
virtual WRESULT setRepeat (short value)
virtual WRESULT setRandom (short value)
virtual WRESULT setCrossfade (int)
virtual WRESULT setDeviceDriver (const std::string &dev_driver)=0
virtual WRESULT setDeviceOutput (const std::string &dev_file)=0
 PlayerGStreamer (BundleGeneric &bundle)
virtual ~PlayerGStreamer ()
int enqueue_ (const std::string &file_url)
WRESULT play_index_ (unsigned int index, bool synch=true, bool resume_next=false)
virtual WRESULT play_ (wosh::entertainment::MediaTrack *item, bool synch=true)=0

Detailed Description

Interface for PlayerGStreamer implementations.

See also:
IPlayerGStreamerListener
Version:
Id:
PlayerGStreamer.h 3775 2011-01-01 16:38:17Z alex
Author:
Alessandro Polo
Date:
Released on 2009-09-28

Definition at line 55 of file PlayerGStreamer.h.


Member Function Documentation

WRESULT PlayerGStreamer::clear (  ) [virtual]

Clear the playlist. Won't necessary stop current playback.

Returns:
WRET_OK if playlist has been cleared. Check custom implementation error codes.

Implements wosh::interfaces::entertainment::PlayerAudio.

Definition at line 217 of file PlayerGStreamer.cpp.

References wosh::LOG_INFO, and WRET_OK.

WRESULT PlayerGStreamer::first (  ) [virtual]

Play the first element in the playlist.

Returns:
WRET_ERR_ILLEGAL_USE when playlist is empty/invalid; WRET_OK when playback is starting

Implements wosh::interfaces::entertainment::PlayerAudio.

Definition at line 229 of file PlayerGStreamer.cpp.

WRESULT PlayerGStreamer::last (  ) [virtual]

Play the last element in the playlist.

Returns:
WRET_ERR_ILLEGAL_USE when playlist is empty/invalid; WRET_OK when playback is starting

Implements wosh::interfaces::entertainment::PlayerAudio.

Definition at line 234 of file PlayerGStreamer.cpp.

WRESULT PlayerGStreamer::next (  ) [virtual]

Play the next element in the playlist.

Returns:
WRET_ERR_ILLEGAL_USE when playlist is empty/invalid; WRET_ERR_PARAM when out of index; WRET_OK when playback is starting

Implements wosh::interfaces::entertainment::PlayerAudio.

Definition at line 246 of file PlayerGStreamer.cpp.

Referenced by PlayerGStreamer010::gst_Error().

WRESULT PlayerGStreamer::play (  ) [virtual]

Play the current media.

Returns:

Implements wosh::interfaces::entertainment::PlayerAudio.

Definition at line 264 of file PlayerGStreamer.cpp.

virtual WRESULT PlayerGStreamer::play ( const std::string &  file_url,
int  volume = -1,
bool  override_current = false 
) [pure virtual]

Play a resource.

Parameters:
file_url[in] the URI of the resource to be played. Multiple protocols are supported:

Implements wosh::interfaces::entertainment::PlayerAudio.

Implemented in PlayerGStreamer010.

WRESULT PlayerGStreamer::prev (  ) [virtual]

Play the previous element in the playlist.

Returns:
WRET_ERR_ILLEGAL_USE when playlist is empty/invalid; WRET_ERR_PARAM when out of index; WRET_OK when playback is starting

Implements wosh::interfaces::entertainment::PlayerAudio.

Definition at line 239 of file PlayerGStreamer.cpp.

References WRET_ERR_ILLEGAL_USE.


Member Data Documentation

short PlayerGStreamer::currentRepeat [protected]

flag: repeat current item forever

Definition at line 166 of file PlayerGStreamer.h.

Referenced by PlayerGStreamer010::item_EndOfStream().

std::string PlayerGStreamer::device_output [protected]

ALSA device name (default; ..)

Definition at line 164 of file PlayerGStreamer.h.

std::string PlayerGStreamer::device_sink [protected]

output driver GST name (default: alsasink)

Definition at line 163 of file PlayerGStreamer.h.

flag: repeat whole playlist forever

Definition at line 167 of file PlayerGStreamer.h.

Referenced by PlayerGStreamer010::item_EndOfStream().

(default) volume value (used only while starting thread)

Definition at line 171 of file PlayerGStreamer.h.

Referenced by PlayerGStreamer010::setVolume().

cache of last volume while muted, 0 when not muted

Definition at line 172 of file PlayerGStreamer.h.


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

Generated on Tue Feb 8 2011 09:33:27 for WOSH system 0.8.888 [wolf] by Alessandro Polo, using DoxyGen 1.7.2 hosted by WOSH Framework