Package flumotion :: Package component :: Module feedcomponent :: Class ParseLaunchComponent
[show private | hide private]
[frames | no frames]

Type ParseLaunchComponent

object --+            
         |            
   GObject --+        
             |        
object --+   |        
         |   |        
 InitMixin --+        
             |        
  Loggable --+        
             |        
 BaseComponent --+    
                 |    
     FeedComponent --+
                     |
                    ParseLaunchComponent

Known Subclasses:
MultiInputParseLaunchComponent

A component using gst-launch syntax
Method Summary
  configure_pipeline(self, pipeline, properties)
Method that can be implemented by subclasses if they wish to interact with the pipeline after it has been created and set on the component.
gst.Pipeline create_pipeline(self)
Subclasses have to implement this method.
  do_start(self, clocking)
Tell the component to start.
  get_eater_template(self, eaterName)
  get_feeder_template(self, eaterName)
  get_pipeline_string(self, properties)
Method that must be implemented by subclasses to produce the gstparse string for the component's pipeline.
  get_queue_string(self, eaterName)
Return a parse-launch description of a queue, if this component wants an input queue on this eater, or None if not
  parse_pipeline(self, pipeline)
  parse_tmpl(self, pipeline, names, template_func, format)
Expand the given pipeline string representation by substituting blocks between '@' with a filled-in template.
  set_pipeline(self, pipeline)
Subclasses can override me.
    Inherited from FeedComponent
  addEffect(self, effect)
  bus_watch_func(self, bus, message)
  cleanup(self)
  do_setup(self)
Sets up component.
  do_stop(self)
BaseComponent vmethod for stopping.
  eaterOffsetDiscont(self, feedId, prevOffsetEnd, curOffset)
Inform of a timestamp discontinuity for the given eater.
  eaterSetActive(self, feedId)
The eater for the given feedId is now active and producing data.
  eaterSetInactive(self, feedId)
The eater for the given feedId is no longer active By default, the component will go hungry.
  eaterTimestampDiscont(self, feedId, prevTs, prevDuration, curTs)
Inform of a timestamp discontinuity for the given eater.
  eatFromFD(self, feedId, fd)
Tell the component to eat the given feedId from the given fd.
  effectPropertyChanged(self, effectName, propertyName, value)
Notify the manager that an effect property has changed to a new value.
  feedToFD(self, feedName, fd, cleanup, eaterId)
  get_eater_names(self)
Return the list of feeder names this component eats from.
  get_element(self, element_name)
Get an element out of the pipeline.
  get_element_property(self, element_name, property)
Gets a property of an element in the GStreamer pipeline.
  get_feed_names(self)
Return the list of feedeNames for feeds this component has.
  get_feeder_names(self)
Return the list of feedId's of feeders this component has.
  get_pipeline(self)
  init(self)
A subclass should do as little as possible in its init method.
twisted.internet.defer.Deferred link(self)
Make the component eat from the feeds it depends on and start producing feeds itself.
  parseEaterConfig(self, eater_config)
  parseFeederConfig(self, feeder_config)
  pipeline_stop(self)
  provide_master_clock(self, port)
Tell the component to provide a master clock on the given port.
  removeClientCallback(self, sink, fd)
Called (as a signal callback) when the FD is no longer in use by multifdsink.
  set_element_property(self, element_name, property, value)
Sets a property on an element in the GStreamer pipeline.
  set_master_clock(self, ip, port, base_time)
  setup_pipeline(self)
  unblock_eater(self, feedId)
After this function returns, the stream lock for this eater must have been released.
    Inherited from BaseComponent
  __init__(self)
Subclasses should not override __init__ at all.
  addMessage(self, message)
Add a message to the component.
  adminCallRemote(self, methodName, *args, **kwargs)
Call a remote method on all admin client views on this component.
  do_check(self)
Subclasses can implement me to run any checks before the component performs setup.
  emit(self, name, *args)
  fixRenamedProperties(self, properties, list)
Fix properties that have been renamed from a previous version, and add a warning for them.
int getMood(self)
Gets the mood on the component.
  getName(self)
  getWorkerName(self)
  setMedium(self, medium)
  setMood(self, mood)
Set the given mood on the component if it's different from the current one.
  setShutdownHook(self, shutdownHook)
Set the shutdown hook for this component (replacing any previous hook).
  setup(self, config, *args, **kwargs)
Sets up the component with the given config.
  setWorkerName(self, workerName)
  start(self, *args, **kwargs)
Tell the component to start.
  stop(self)
Tell the component to stop.
    Inherited from Loggable
  debug(self, *args)
Log a debug message.
dict doLog(self, level, where, format, *args, **kwargs)
Log a message at the given level, with the possibility of going higher up in the stack.
  error(self, *args)
Log an error.
  info(self, *args)
Log an informational message.
  log(self, *args)
Log a log message.
  logFunction(self, *args)
Overridable log function.
  logObjectName(self)
Overridable object name function.
  warning(self, *args)
Log a warning.
  warningFailure(self, failure, swallow)
Log a warning about a Failure.
    Inherited from GObject
  __cmp__(x, y)
x.__cmp__(y) <==> cmp(x,y)
  __gobject_init__(...)
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __repr__(x)
x.__repr__() <==> repr(x)
  chain(...)
  connect(...)
  connect_after(...)
  connect_object(...)
  connect_object_after(...)
  disconnect(...)
  disconnect_by_func(...)
  emit_stop_by_name(...)
  freeze_notify(...)
  get_data(...)
  get_property(...)
  handler_block(...)
  handler_block_by_func(...)
  handler_disconnect(...)
  handler_is_connected(...)
  handler_unblock(...)
  handler_unblock_by_func(...)
  notify(...)
  set_data(...)
  set_property(...)
  stop_emission(...)
  thaw_notify(...)
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Instance Variable Summary
    Inherited from BaseComponent
BaseComponentMedium medium: the component's medium
string name: the name of the component

Class Variable Summary
str DELIMITER = '@'
    Inherited from FeedComponent
GType __gtype__ = <GType flumotion+component+feedcomponent010+...
float BUFFER_CHECK_FREQUENCY = 12.5                                                                  
int BUFFER_PROBE_ADD_FREQUENCY = 5                                                                     
float BUFFER_TIME_THRESHOLD = 12.5                                                                  
bool checkOffset: whether to check continuity of offsets for eaters
bool checkTimestamp: whether to check continuity of timestamps for eaters
str DEPAY_TMPL = 'gdpdepay name=%(name)s-depay'
str FDSRC_TMPL = 'fdsrc name=%(name)s'
str FEEDER_TMPL = 'gdppay ! multifdsink sync=false name=%(na...
str logCategory: Implementors can provide a category to log their messages under.
    Inherited from Loggable
Implements __implemented__ = <implementedBy flumotion.common.log.Lo...
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
    Inherited from GObject
str __gdoc__ = 'Object GObject\n\nSignals from GObject:\n  n...
getset_descriptor __grefcount__ = <attribute '__grefcount__' of 'gobject.G...
GProps props = <gobject.GProps object at 0x570477ec>

Method Details

configure_pipeline(self, pipeline, properties)

Method that can be implemented by subclasses if they wish to interact with the pipeline after it has been created and set on the component.

This could include attaching signals and bus handlers.

create_pipeline(self)

Subclasses have to implement this method.
Returns:
gst.Pipeline
Overrides:
flumotion.component.feedcomponent010.FeedComponent.create_pipeline (inherited documentation)

do_start(self, clocking)

Tell the component to start. Whatever is using the component is responsible for making sure all eaters have received their file descriptor to eat from.
Parameters:
clocking - tuple of (ip, port, base_time) of a master clock, or None not to slave the clock
           (type=tuple(str, int, long) or None.)
Overrides:
flumotion.component.component.BaseComponent.do_start

get_pipeline_string(self, properties)

Method that must be implemented by subclasses to produce the gstparse string for the component's pipeline. Subclasses should not chain up; this method raises a NotImplemented error.

Returns: a new pipeline string representation.

get_queue_string(self, eaterName)

Return a parse-launch description of a queue, if this component wants an input queue on this eater, or None if not

parse_tmpl(self, pipeline, names, template_func, format)

Expand the given pipeline string representation by substituting blocks between '@' with a filled-in template.
Parameters:
pipeline - a pipeline string representation with variables
names - the element names to substitute for @...@ segments
template_func - function to call to get the template to use for element factory info
format -

the format to use when substituting

Returns: a new pipeline string representation.

set_pipeline(self, pipeline)

Subclasses can override me. They should chain up first.
Overrides:
flumotion.component.feedcomponent010.FeedComponent.set_pipeline (inherited documentation)

Class Variable Details

DELIMITER

Type:
str
Value:
'@'                                                                    

Generated by Epydoc 2.1 on Sat Apr 14 13:16:06 2007 http://epydoc.sf.net