Class e.p.p.s.p.PicturePlayer(gobject.GObject, Loggable):

Part of elisa.plugins.poblesec.slideshow.player View In Hierarchy 

PicturePlayer is the main interface to slideshow handling. It is responsible
for registration, creation and switching of slideshows. It acts as a stable
proxy to the currently selected slideshow forwarding user requests to it.

Emit the signals:
 - current-picture-changed: when the current picture displayed/in focus is
                            changed; at that point the actual picture file
                            starts being loaded
     params: L{elisa.plugins.base.models.image.ImageModel} of the picture
             C{int} index of the picture in the playlist

 - current-picture-loaded: when the current picture is finally loaded
     params: L{pgm.timing.implicit.AnimatedObject} wrapping the image
             drawable containing the loaded picture

 - status-changed: when L{status} changes
     params: one of [Slideshow.STOPPED, Slideshow.PLAYING]

 - playlist-size-changed: when the size of the playlist changes
     params: size of the playlist

 - available-slideshows-changed: when a slideshow has been added or removed
                                 from the list of available slideshows
     params: the list of available slideshows

 - slideshow-changed: when the currently selected slideshow has changed
     params: the newly selected slideshow type

 - current-picture-rotated: when the currently displayed/in focus picture
                            has been rotated
     params: final orientation of the picture; rotation constant from
             L{elisa.plugins.base.models.image}


@ivar status: whether the current slideshow was started or not
@type status: one of [Slideshow.STOPPED, Slideshow.PLAYING]
Line # Kind Name Docs
123 Method __init__
166 Method set_playlist Set the list of pictures to display during the slideshow and display one
181 Method clear_playlist Empty the playlist and removes any displayed picture from the playground.
190 Method get_playlist_size Return the size of the playlist.
198 Method set_interval Set the time during which a picture should be displayed/in focus for the
209 Method start_slideshow Start the currently selected automated slideshow.
222 Method stop_slideshow Stop the currently selected slideshow.
231 Method next Display the next picture in the playlist.
237 Method previous Display the previous picture in the playlist.
243 Method get_current_picture Return the model of the current picture in the playlist.
251 Method rotate_current_picture Visually rotate the current picture.
263 Method set_slideshow Switch the currently selected slideshow for another one.
306 Method get_slideshow Return the type of the currently selected slideshow.
315 Method get_available_slideshows Return the list of available slideshows.
324 Method register_slideshow Register a slideshow in the list of available slideshows.
338 Method _get_status Undocumented
343 Method _apply_rotation Undocumented
361 Method _on_slideshow_picture_changed Undocumented
368 Method _update_playcount_and_timestamp Undocumented
391 Method _on_slideshow_picture_loaded Undocumented
402 Method _on_slideshow_status_changed Undocumented
405 Method _on_slideshow_end_reached Undocumented
def __init__(self, playground):
overrides elisa.core.log.Loggable.__init__
Parametersplaygroundnode of the scene where the pictures will be displayed (type: elisa.plugins.pigment.graph.group.Group )
def set_playlist(self, playlist, picture_index=0):
Set the list of pictures to display during the slideshow and display one of them immediately, by default the first one.
Parametersplaylistlist of pictures to display during the slideshow (type: list of elisa.plugins.base.models.image.ImageModel )
picture_indexindex in the playlist of the picture to display immediately (type: int )
def clear_playlist(self):
Empty the playlist and removes any displayed picture from the playground.
def get_playlist_size(self):
Return the size of the playlist.
Returns (type: int )
def set_interval(self, interval):
Set the time during which a picture should be displayed/in focus for the user.
Parametersintervaltime in seconds (type: float )
def start_slideshow(self, index=None):
Start the currently selected automated slideshow.
Parametersindexindex in the playlist of the picture to start the slideshow with (type: int )
def stop_slideshow(self):
Stop the currently selected slideshow.
def next(self):
Display the next picture in the playlist.
def previous(self):
Display the previous picture in the playlist.
def get_current_picture(self):
Return the model of the current picture in the playlist.
Returns (type: elisa.plugins.base.models.image.ImageModel )
def rotate_current_picture(self, orientation):
Visually rotate the current picture.
Parametersorientationfinal orientation of the picture (type: rotation constant from elisa.plugins.base.models.image )
def set_slideshow(self, slideshow_class):
Switch the currently selected slideshow for another one.
Parametersslideshow_classclass of the slideshow that should become the current one (type: a class inheriting from elisa.plugins.poblesec.slideshow.transition_slideshow.Slideshow )
def get_slideshow(self):
Return the type of the currently selected slideshow.
Returns (type: a class inheriting from elisa.plugins.poblesec.slideshow.transition_slideshow.Slideshow )
def get_available_slideshows(self):
Return the list of available slideshows.
Returns (type: a list of classes inheriting from elisa.plugins.poblesec.slideshow.transition_slideshow.Slideshow )
def register_slideshow(self, slideshow_class):
Register a slideshow in the list of available slideshows.
Parametersslideshow_classclass of the slideshow that is to be registered (type: a class inheriting from elisa.plugins.poblesec.slideshow.transition_slideshow.Slideshow )
def _get_status(self):
Undocumented
def _apply_rotation(self, drawable, orientation):
Undocumented
def _on_slideshow_picture_changed(self, slideshow, model, index):
Undocumented
def _update_playcount_and_timestamp(self, picture):
Undocumented
def _on_slideshow_picture_loaded(self, slideshow, animated):
Undocumented
def _on_slideshow_status_changed(self, slideshow, status):
Undocumented
def _on_slideshow_end_reached(self, slideshow):
Undocumented
API Documentation for Elisa Media Center, generated by pydoctor at 2009-04-27 17:55:12.