Package flumotion :: Package component :: Package common :: Package avproducer :: Module avproducer :: Class AVProducerBase
[hide private]

Class AVProducerBase

source code

             object --+                
                      |                
common.common.InitMixin --+            
                          |            
extern.log.log.Loggable --+            
                          |            
    component.BaseComponent --+        
                              |        
 feedcomponent010.FeedComponent --+    
                                  |    
 feedcomponent.ParseLaunchComponent --+
                                      |
                                     AVProducerBase
Known Subclasses:

Nested Classes [hide private]

Inherited from feedcomponent010.FeedComponent: componentMediumClass

Instance Methods [hide private]
 
get_raw_video_element(self) source code
 
get_pipeline_template(self) source code
 
do_check(self)
Subclasses can implement me to run any checks before the component performs setup.
source code
 
check_properties(self, props, addMessage)
BaseComponent convenience vmethod for running checks.
source code
 
get_pipeline_string(self, props)
Method that must be implemented by subclasses to produce the gstparse string for the component's pipeline.
source code
 
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.
source code
 
getVolume(self) source code
 
setVolume(self, value) source code
 
_checkCallback(self, results) source code
list
_do_extra_checks(self)
Subclasses should override this method to perform aditional checks
source code
 
_parse_aditional_properties(self, props)
Subclasses should overrride this method to parse aditional properties
source code
 
_add_video_effects(self, pipeline) source code
 
_add_audio_effects(self, pipeline) source code

Inherited from feedcomponent.ParseLaunchComponent: add_default_eater_feeder, create_pipeline, get_eater_srcpad, get_eater_template, get_feeder_sinkpad, get_feeder_template, get_queue_string, init, parse_pipeline, parse_tmpl, set_pipeline

Inherited from feedcomponent010.FeedComponent: addEffect, attachPadMonitorToElement, attachPadMonitorToFeeder, bus_message_received_cb, cleanup, connect_feeders, do_pipeline_playing, do_setup, do_stop, dump_gstreamer_debug_dot_file, eatFromFD, feedToFD, get_element, get_element_property, get_master_clock, get_pipeline, install_eater_continuity_watch, install_eater_event_probes, make_message_for_gstreamer_error, modify_element_property, provide_master_clock, reconnectEater, set_element_property, set_master_clock, setup_completed, stop_pipeline, try_start_pipeline, unblock_eater

Inherited from component.BaseComponent: __init__, __provides__, addMessage, adminCallRemote, checkPropertyType, fixRenamedProperties, getMood, getName, getWorkerName, modifyProperty, observerAppend, observerRemove, removeMessage, setMedium, setMood, setShutdownHook, setWorkerName, setup, stop, waitForHappy, warnDeprecatedProperties

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Inherited from extern.log.log.Loggable: __providedBy__, debug, doLog, error, info, log, logFunction, logObjectName, warning, warningFailure, writeMarker

Class Variables [hide private]

Inherited from feedcomponent.ParseLaunchComponent: DELIMITER, DEPAY_TMPL, EATER_TMPL, FDSRC_TMPL, FEEDER_TMPL, checkOffset, checkTimestamp

Inherited from feedcomponent010.FeedComponent: FEEDER_STATS_UPDATE_FREQUENCY, dropStreamHeaders, eaters, feeders, logCategory, swallowNewSegment

Inherited from component.BaseComponent: __implemented__

Instance Variables [hide private]

Inherited from component.BaseComponent: medium, name, uiState

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

do_check(self)

source code 

Subclasses can implement me to run any checks before the component performs setup.

Messages can be added to the component state's 'messages' list key. Any error messages added will trigger the component going to sad, with flumotion.common.errors.ComponentSetupError being raised before getting to setup stage; do_setup() will not be called.

In the event of a fatal problem that can't be expressed through an error message, this method should raise an exception or return a failure.

It is not necessary to chain up in this function. The return value may be a deferred.

Overrides: component.BaseComponent.do_check
(inherited documentation)

check_properties(self, props, addMessage)

source code 

BaseComponent convenience vmethod for running checks.

A component implementation can override this method to run any checks that it needs to. Typically, a check_properties implementation will call the provided addMessage() callback to note warnings or errors. For errors, addMessage() will set component's mood to sad, which will abort the init process before getting to do_setup().

Parameters:
  • properties - The component's properties
  • addMessage - Thunk to add a message to the component state. Will raise an exception if the message is of level ERROR.
Overrides: component.BaseComponent.check_properties
(inherited documentation)

get_pipeline_string(self, props)

source code 

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.

Overrides: feedcomponent.ParseLaunchComponent.get_pipeline_string
(inherited documentation)

configure_pipeline(self, pipeline, properties)

source code 

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.

Overrides: feedcomponent.ParseLaunchComponent.configure_pipeline
(inherited documentation)

setVolume(self, value)

source code 
Parameters:
  • value - float between 0.0 and 4.0

_do_extra_checks(self)

source code 

Subclasses should override this method to perform aditional checks

Returns: list
A list of checks' defers