Package flumotion :: Package wizard :: Module save :: Class WizardSaver
[hide private]

Class WizardSaver

source code

object --+
         |
        WizardSaver

I am used to link components together and generate XML for them. To use me, add some components by some of the methods and then call my getXML() method to get the xml configuration.

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
setFlowName(self, flowName)
Sets the name of the flow we're saving.
source code
 
setAudioProducer(self, audioProducer)
Attach a audio producer for this flow
source code
 
setVideoProducer(self, videoProducer)
Attach a video producer for this flow
source code
 
setVideoOverlay(self, videoOverlay) source code
 
setAudioEncoder(self, audioEncoder)
Attach a audio encoder for this flow
source code
 
setVideoEncoder(self, videoEncoder)
Attach a video encoder for this flow
source code
 
setMuxer(self, muxerType, muxerWorker)
Adds the necessary state to be able to create a muxer for this flow.
source code
 
addServerConsumer(self, server, consumerType)
Add a server consumer.
source code
 
addPorter(self, porter, consumerType)
Add a porter
source code
 
addConsumer(self, consumer, consumerType)
Add a consumer
source code
 
setUseCCLicense(self, useCCLicense)
Sets if we should use a Creative Common license on the created flow.
source code
string
getXML(self)
Creates an XML configuration of the state set
source code
 
setExistingComponentNames(self, componentNames)
Tells the saver about the existing components available, so we can resolve naming conflicts before fetching the configuration xml
source code
list of components
getFlowComponents(self)
Gets the flow components of the save instance
source code
list of components
getAtmosphereComponents(self)
Gets the atmosphere components of the save instance
source code
 
_getAllComponents(self) source code
 
_getMuxer(self, name) source code
 
_handleProducers(self) source code
 
_handleAudioProducer(self) source code
 
_handleVideoProducer(self) source code
 
_handleVideoOverlay(self) source code
 
_handleSameProducers(self) source code
 
_handleMuxers(self) source code
 
_resolveNameConflicts(self) source code
 
_resolveComponentName(self, component) source code
 
_suggestName(self, suggestedName) source code
 
_validateComponents(self) source code

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

setFlowName(self, flowName)

source code 

Sets the name of the flow we're saving.

Parameters:
  • flowName (string)

setAudioProducer(self, audioProducer)

source code 

Attach a audio producer for this flow

Parameters:
  • audioProducer (AudioProducer subclass or None) - audio producer

setVideoProducer(self, videoProducer)

source code 

Attach a video producer for this flow

Parameters:
  • videoProducer (VideoProducer subclass or None) - video producer

setAudioEncoder(self, audioEncoder)

source code 

Attach a audio encoder for this flow

Parameters:
  • audioEncoder (AudioEncoder subclass or None) - audio encoder

setVideoEncoder(self, videoEncoder)

source code 

Attach a video encoder for this flow

Parameters:
  • videoEncoder (VideoEncoder subclass or None) - video encoder

setMuxer(self, muxerType, muxerWorker)

source code 

Adds the necessary state to be able to create a muxer for this flow.

Parameters:
  • muxerType (string)
  • muxerWorker (string) - name of the worker

addServerConsumer(self, server, consumerType)

source code 

Add a server consumer. Currently limited a to http-server server consumers

Parameters:
  • server () - server consumer
  • consumerType (string) - the type of the consumer, one of audio/video/audio-video

addPorter(self, porter, consumerType)

source code 

Add a porter

Parameters:
  • porter () - porter
  • consumerType (string) - the type of the consumer, one of audio/video/audio-video

addConsumer(self, consumer, consumerType)

source code 

Add a consumer

Parameters:
  • consumer () - consumer
  • consumerType (string) - the type of the consumer, one of audio/video/audio-video

setUseCCLicense(self, useCCLicense)

source code 

Sets if we should use a Creative Common license on the created flow. This will overlay an image if we do video streaming.

Parameters:
  • useCCLicense (bool) - if we should use a CC license

getXML(self)

source code 

Creates an XML configuration of the state set

Returns: string
the xml configuration

setExistingComponentNames(self, componentNames)

source code 

Tells the saver about the existing components available, so we can resolve naming conflicts before fetching the configuration xml

Parameters:
  • componentNames (list of strings) - existing component names

getFlowComponents(self)

source code 

Gets the flow components of the save instance

Returns: list of components
the flow components

getAtmosphereComponents(self)

source code 

Gets the atmosphere components of the save instance

Returns: list of components
the atmosphere components