TransportManager
index
/home/laszlo/Dev/joko-gtk-builder/Jokosher/TransportManager.py

#       THIS FILE IS PART OF THE JOKOSHER PROJECT AND LICENSED UNDER THE GPL. SEE
#       THE 'COPYING' FILE FOR DETAILS
#
#       TransportManager.py
#       
#       This class handles the current cursor position and the gstreamer
#       bits for rewinding, fast forwarding and seeking.
#       
#
#-------------------------------------------------------------------------------

 
Modules
       
gobject
gst
pygst

 
Classes
       
gobject._gobject.GObject(__builtin__.object)
TransportManager

 
class TransportManager(gobject._gobject.GObject)
    This class handles the current cursor position and the gstreamer
bits for rewinding, fast forwarding and seeking.
 
 
Method resolution order:
TransportManager
gobject._gobject.GObject
__builtin__.object

Methods defined here:
Forward(self, turnOn)
Called when fast forward button is
        a) pressed - turnOn = True
        b) released - turnOn = False
        
Parameters:
        turnOn -- state of the fast forward button.
GetPixelPosition(self, offset=None)
GetPosition(self)
Obtain the current playhead position.
 
Returns:
        the current playhead cursor position.
GetPositionAsBarsAndBeats(self)
Obtain the current position in bars, beats and ticks.
 
Returns:
        tuple of the current position as (bar, beats, ticks).
GetPositionAsHoursMinutesSeconds(self)
Obtain the current position in hours, minutes and seconds.
 
Returns:
        tuple of the current position as (hours, minutes, seconds, milliseconds).
GetPreviousPixelPosition(self, offset=None)
GetPreviousPosition(self)
Returns the previous playhead cursor position.
ie. The value of GetPosition() before the last position update.
OnUpdate(self)
The timeout callback - called every 1/FPS to move the 
playhead display on.
 
Returns:
        True -- pipeline is playing, keep calling this method.
        False -- pipeline is paused or stopped, stop calling this method.
Pause(self)
Pause the playback.
Play(self, newAudioState)
Called when play button has been pressed (or whilst exporting
in which case, newAudioState will be set to AUDIO_EXPORTING).
 
Parameters:
        newAudioState -- new audio state to set the Project to.
QueryPosition(self)
Reads the current playhead cursor position by querying pipeline.
Reverse(self, turnOn)
Called when rewind button is
        a) pressed - turnOn = True
        b) released - turnOn = False
        
Parameters:
        turnOn -- state of the rewind button.
SeekTo(self, pos, stopPos=0)
Performs a pipeline seek to alter position of the playhead cursor.
 
Parameters:
        pos -- position to place the playhead cursor.
        stopPos -- new stop position
SetMode(self, mode)
In most cases, for undo compatibility, use Project.SetTransportMode().
 
Parameters:
        mode -- new transport mode to be set.
SetPosition(self, pos, stopAction=False)
Change the current position variable.
 
Considerations:
        Calls emit to trigger response on all classes
        that are connected to this object.
 
Parameters:
        pos -- new playhead cursor position.
        stopAction -- true if this position change was a result of stopping
                        and sending the position back to zero.
StartUpdateTimeout(self)
Starts the timeout that will control the playhead display.
Stop(self)
Stops the playback.
__init__(self, initialMode, project)
Creates a new instance of TransportManager.
 
Parameters:
        initialMode --the initial mode for the timeline display.
                                Possible values:
                                MODE_HOURS_MINS_SECS
                                MODE_BARS_BEATS
        project -- reference to the current Project.

Data and other attributes defined here:
FPS = 30.0
MODE_BARS_BEATS = 2
MODE_HOURS_MINS_SECS = 1
SEEK_RATE = 5.0
TICKS_PER_BEAT = 256
__gtype__ = <GType TransportManager+TransportManager (33748080)>

Methods inherited from gobject._gobject.GObject:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
__copy__(...)
__deepcopy__(...)
__delattr__(...)
x.__delattr__('name') <==> del x.name
__gobject_init__(...)
__hash__(...)
x.__hash__() <==> hash(x)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
chain(...)
connect(...)
connect_after(...)
connect_object(...)
connect_object_after(...)
disconnect(...)
disconnect_by_func(...)
emit(...)
emit_stop_by_name(...)
freeze_notify(...)
get_data(...)
get_properties(...)
get_property(...)
handler_block(...)
handler_block_by_func(...)
handler_disconnect(...)
handler_is_connected(...)
handler_unblock(...)
handler_unblock_by_func(...)
notify(...)
set_data(...)
set_properties(...)
set_property(...)
stop_emission(...)
thaw_notify(...)
weak_ref(...)

Data descriptors inherited from gobject._gobject.GObject:
__dict__
__grefcount__

Data and other attributes inherited from gobject._gobject.GObject:
__gdoc__ = 'Object TransportManager+TransportManager\n\n\n\tThis...(gint)\n\nSignals from GObject:\n notify (GParam)\n\n'
__new__ = <built-in method __new__ of GObjectMeta object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
props = <gobject.GProps object>