Package flumotion :: Package admin :: Package assistant :: Module interfaces
[hide private]

Source Code for Module flumotion.admin.assistant.interfaces

  1  # -*- Mode: Python -*- 
  2  # vi:si:et:sw=4:sts=4:ts=4 
  3  # 
  4  # Flumotion - a streaming media server 
  5  # Copyright (C) 2008 Fluendo, S.L. (www.fluendo.com). 
  6  # All rights reserved. 
  7   
  8  # This file may be distributed and/or modified under the terms of 
  9  # the GNU General Public License version 2 as published by 
 10  # the Free Software Foundation. 
 11  # This file is distributed without any warranty; without even the implied 
 12  # warranty of merchantability or fitness for a particular purpose. 
 13  # See "LICENSE.GPL" in the source distribution for more information. 
 14   
 15  # Licensees having purchased or holding a valid Flumotion Advanced 
 16  # Streaming Server license may use this file in accordance with the 
 17  # Flumotion Advanced Streaming Server Commercial License Agreement. 
 18  # See "LICENSE.Flumotion" in the source distribution for more information. 
 19   
 20  # Headers in this file shall remain intact. 
 21   
 22  """Flumotion interfaces used by the configuration assistant 
 23  """ 
 24   
 25  from zope.interface import Interface 
 26   
 27  __version__ = "$Rev: 7626 $" 
 28   
 29   
30 -class IProducerPlugin(Interface):
31 """A producer plugin is how you extend the production assistant page. 32 The main purpose of the plugin is to get a assistant step specific 33 to the plugin. 34 This entry point should be defined in the xml for the component 35 under the entry type "wizard". 36 """ 37
38 - def __call__(assistant):
39 """Creates producer plugins 40 @param assistant: the assistant 41 @type assistant: L{ConfigurationAssistant} 42 """
43
44 - def getProductionStep(type):
45 """Asks the plugin for a step. 46 type is the kind of plugin, it's useful for components such as 47 firewire for which you can point both audio and video to the 48 same plugin. 49 @param type: audio or video 50 @type type: string 51 @returns: the assistant step 52 @rtype: a L{WorkerWizardStep} subclass 53 """
54 55
56 -class IEncoderPlugin(Interface):
57 """An encoder plugin is how you extend the encoding assistant page. 58 The main purpose of the plugin is to get a assistant step specific 59 to the plugin. 60 This entry point should be defined in the xml for the component 61 under the entry type "wizard". 62 """ 63
64 - def __call__(assistant):
65 """Creates encoder plugins 66 @param assistant: the assistant 67 @type assistant: L{ConfigurationAssistant} 68 """
69
70 - def getConversionStep():
71 """Asks the plugin for a step. 72 @returns: the assistant step 73 @rtype: a L{WorkerWizardStep} subclass 74 """
75 76
77 -class IHTTPConsumerPlugin(Interface):
78 """A http consumer plugin is how you extend the HTTP consumer page. 79 The main purpose of the plugin is to get a consumer model 80 (eg, a http server) specific for this plugin. 81 This entry point should be defined in the xml for the component 82 under the entry type "wizard". 83 """ 84
85 - def __call__(assistant):
86 """Creates http consumer plugins 87 @param assistant: the assistant 88 @type assistant: L{ConfigurationAssistant} 89 """
90
91 - def workerChanged(worker):
92 """Called when the worker for the step changed. 93 @param worker: the worker 94 @type worker: L{WorkerComponentUIState} 95 """
96
97 - def getConsumer(streamer, audio_producer, video_producer):
98 """Asks the plugin for a consumer model 99 @param streamer: the http streamer 100 @type streamer: L{HTTPStreamer} subclass 101 @param audio_producer: audio producer for this stream 102 @type audio_producer: L{AudioProducer} subclass 103 @param video_producer: video producer for this stream 104 @type video_producer: L{VideoProducer} subclass 105 @returns: consumer 106 @rtype: a L{HTTPServer} subclass 107 """
108 109
110 -class IScenarioAssistantPlugin(Interface):
111 """A pluggable scenario that can be listed at the first page of the wizard. 112 It predefines the steps the wizard will take and the way it is saved. 113 """ 114
115 - def addSteps(assistant):
116 """Called to add the required steps to the wizard. 117 @param assistant: The assistant the steps have to be added to. 118 @type assistant: L{ConfigurationAssistant} 119 """
120
121 - def save(assistant, saver):
122 """Saves the scenario through an AdminSaver to get the configuration. 123 @param assistant: The assistant the steps have to be added to. 124 @type assistant: L{ConfigurationAssistant} 125 @param saver: The element which generates the xml configuration. 126 @type saver: L{AssistantSaver} 127 """
128