<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>flumotion.admin.assistant.interfaces</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package flumotion ::
<a href="flumotion.admin-module.html">Package admin</a> ::
<a href="flumotion.admin.assistant-module.html">Package assistant</a> ::
Module interfaces
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="flumotion.admin.assistant.interfaces-module.html">Module flumotion.admin.assistant.interfaces</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># -*- Mode: Python -*-</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"># vi:si:et:sw=4:sts=4:ts=4</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"># Flumotion - a streaming media server</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"># Copyright (C) 2008 Fluendo, S.L. (www.fluendo.com).</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"># All rights reserved.</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"># This file may be distributed and/or modified under the terms of</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment"># the GNU General Public License version 2 as published by</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-comment"># the Free Software Foundation.</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-comment"># This file is distributed without any warranty; without even the implied</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-comment"># warranty of merchantability or fitness for a particular purpose.</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"># See "LICENSE.GPL" in the source distribution for more information.</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-comment"># Licensees having purchased or holding a valid Flumotion Advanced</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-comment"># Streaming Server license may use this file in accordance with the</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-comment"># Flumotion Advanced Streaming Server Commercial License Agreement.</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-comment"># See "LICENSE.Flumotion" in the source distribution for more information.</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-comment"># Headers in this file shall remain intact.</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-docstring">"""Flumotion interfaces used by the configuration assistant</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">zope</tt><tt class="py-op">.</tt><tt class="py-name">interface</tt> <tt class="py-keyword">import</tt> <tt class="py-name">Interface</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-name">__version__</tt> <tt class="py-op">=</tt> <tt class="py-string">"$Rev: 7626 $"</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"> </tt>
<a name="IProducerPlugin"></a><div id="IProducerPlugin-def"><a name="L30"></a><tt class="py-lineno"> 30</tt> <a class="py-toggle" href="#" id="IProducerPlugin-toggle" onclick="return toggle('IProducerPlugin');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IProducerPlugin-class.html">IProducerPlugin</a><tt class="py-op">(</tt><tt class="py-base-class">Interface</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IProducerPlugin-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="IProducerPlugin-expanded"><a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"> <tt class="py-docstring">"""A producer plugin is how you extend the production assistant page.</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-docstring"> The main purpose of the plugin is to get a assistant step specific</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring"> to the plugin.</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring"> This entry point should be defined in the xml for the component</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring"> under the entry type "wizard".</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"> </tt>
<a name="IProducerPlugin.__call__"></a><div id="IProducerPlugin.__call__-def"><a name="L38"></a><tt class="py-lineno"> 38</tt> <a class="py-toggle" href="#" id="IProducerPlugin.__call__-toggle" onclick="return toggle('IProducerPlugin.__call__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IProducerPlugin-class.html#__call__">__call__</a><tt class="py-op">(</tt><tt class="py-param">assistant</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IProducerPlugin.__call__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IProducerPlugin.__call__-expanded"><a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates producer plugins</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring"> @param assistant: the assistant</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring"> @type assistant: L{ConfigurationAssistant}</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div><a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> </tt>
<a name="IProducerPlugin.getProductionStep"></a><div id="IProducerPlugin.getProductionStep-def"><a name="L44"></a><tt class="py-lineno"> 44</tt> <a class="py-toggle" href="#" id="IProducerPlugin.getProductionStep-toggle" onclick="return toggle('IProducerPlugin.getProductionStep');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IProducerPlugin-class.html#getProductionStep">getProductionStep</a><tt class="py-op">(</tt><tt class="py-param">type</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IProducerPlugin.getProductionStep-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IProducerPlugin.getProductionStep-expanded"><a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> <tt class="py-docstring">"""Asks the plugin for a step.</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring"> type is the kind of plugin, it's useful for components such as</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring"> firewire for which you can point both audio and video to the</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> same plugin.</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring"> @param type: audio or video</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring"> @type type: string</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring"> @returns: the assistant step</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: a L{WorkerWizardStep} subclass</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div></div><a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> </tt>
<a name="IEncoderPlugin"></a><div id="IEncoderPlugin-def"><a name="L56"></a><tt class="py-lineno"> 56</tt> <a class="py-toggle" href="#" id="IEncoderPlugin-toggle" onclick="return toggle('IEncoderPlugin');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IEncoderPlugin-class.html">IEncoderPlugin</a><tt class="py-op">(</tt><tt class="py-base-class">Interface</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IEncoderPlugin-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="IEncoderPlugin-expanded"><a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> <tt class="py-docstring">"""An encoder plugin is how you extend the encoding assistant page.</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> The main purpose of the plugin is to get a assistant step specific</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> to the plugin.</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> This entry point should be defined in the xml for the component</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> under the entry type "wizard".</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> </tt>
<a name="IEncoderPlugin.__call__"></a><div id="IEncoderPlugin.__call__-def"><a name="L64"></a><tt class="py-lineno"> 64</tt> <a class="py-toggle" href="#" id="IEncoderPlugin.__call__-toggle" onclick="return toggle('IEncoderPlugin.__call__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IEncoderPlugin-class.html#__call__">__call__</a><tt class="py-op">(</tt><tt class="py-param">assistant</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IEncoderPlugin.__call__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IEncoderPlugin.__call__-expanded"><a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates encoder plugins</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"> @param assistant: the assistant</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-docstring"> @type assistant: L{ConfigurationAssistant}</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div><a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> </tt>
<a name="IEncoderPlugin.getConversionStep"></a><div id="IEncoderPlugin.getConversionStep-def"><a name="L70"></a><tt class="py-lineno"> 70</tt> <a class="py-toggle" href="#" id="IEncoderPlugin.getConversionStep-toggle" onclick="return toggle('IEncoderPlugin.getConversionStep');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IEncoderPlugin-class.html#getConversionStep">getConversionStep</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IEncoderPlugin.getConversionStep-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IEncoderPlugin.getConversionStep-expanded"><a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> <tt class="py-docstring">"""Asks the plugin for a step.</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-docstring"> @returns: the assistant step</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: a L{WorkerWizardStep} subclass</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div></div><a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> </tt>
<a name="IHTTPConsumerPlugin"></a><div id="IHTTPConsumerPlugin-def"><a name="L77"></a><tt class="py-lineno"> 77</tt> <a class="py-toggle" href="#" id="IHTTPConsumerPlugin-toggle" onclick="return toggle('IHTTPConsumerPlugin');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IHTTPConsumerPlugin-class.html">IHTTPConsumerPlugin</a><tt class="py-op">(</tt><tt class="py-base-class">Interface</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IHTTPConsumerPlugin-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="IHTTPConsumerPlugin-expanded"><a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> <tt class="py-docstring">"""A http consumer plugin is how you extend the HTTP consumer page.</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> The main purpose of the plugin is to get a consumer model</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> (eg, a http server) specific for this plugin.</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"> This entry point should be defined in the xml for the component</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> under the entry type "wizard".</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> </tt>
<a name="IHTTPConsumerPlugin.__call__"></a><div id="IHTTPConsumerPlugin.__call__-def"><a name="L85"></a><tt class="py-lineno"> 85</tt> <a class="py-toggle" href="#" id="IHTTPConsumerPlugin.__call__-toggle" onclick="return toggle('IHTTPConsumerPlugin.__call__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IHTTPConsumerPlugin-class.html#__call__">__call__</a><tt class="py-op">(</tt><tt class="py-param">assistant</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IHTTPConsumerPlugin.__call__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IHTTPConsumerPlugin.__call__-expanded"><a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates http consumer plugins</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> @param assistant: the assistant</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> @type assistant: L{ConfigurationAssistant}</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div><a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> </tt>
<a name="IHTTPConsumerPlugin.workerChanged"></a><div id="IHTTPConsumerPlugin.workerChanged-def"><a name="L91"></a><tt class="py-lineno"> 91</tt> <a class="py-toggle" href="#" id="IHTTPConsumerPlugin.workerChanged-toggle" onclick="return toggle('IHTTPConsumerPlugin.workerChanged');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IHTTPConsumerPlugin-class.html#workerChanged">workerChanged</a><tt class="py-op">(</tt><tt class="py-param">worker</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IHTTPConsumerPlugin.workerChanged-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IHTTPConsumerPlugin.workerChanged-expanded"><a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-docstring">"""Called when the worker for the step changed.</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-docstring"> @param worker: the worker</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> @type worker: L{WorkerComponentUIState}</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div><a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> </tt>
<a name="IHTTPConsumerPlugin.getConsumer"></a><div id="IHTTPConsumerPlugin.getConsumer-def"><a name="L97"></a><tt class="py-lineno"> 97</tt> <a class="py-toggle" href="#" id="IHTTPConsumerPlugin.getConsumer-toggle" onclick="return toggle('IHTTPConsumerPlugin.getConsumer');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IHTTPConsumerPlugin-class.html#getConsumer">getConsumer</a><tt class="py-op">(</tt><tt class="py-param">streamer</tt><tt class="py-op">,</tt> <tt class="py-param">audio_producer</tt><tt class="py-op">,</tt> <tt class="py-param">video_producer</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IHTTPConsumerPlugin.getConsumer-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IHTTPConsumerPlugin.getConsumer-expanded"><a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-docstring">"""Asks the plugin for a consumer model</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> @param streamer: the http streamer</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"><tt class="py-docstring"> @type streamer: L{HTTPStreamer} subclass</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"><tt class="py-docstring"> @param audio_producer: audio producer for this stream</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"><tt class="py-docstring"> @type audio_producer: L{AudioProducer} subclass</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class="py-docstring"> @param video_producer: video producer for this stream</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"><tt class="py-docstring"> @type video_producer: L{VideoProducer} subclass</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"><tt class="py-docstring"> @returns: consumer</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: a L{HTTPServer} subclass</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div></div><a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> </tt>
<a name="IScenarioAssistantPlugin"></a><div id="IScenarioAssistantPlugin-def"><a name="L110"></a><tt class="py-lineno">110</tt> <a class="py-toggle" href="#" id="IScenarioAssistantPlugin-toggle" onclick="return toggle('IScenarioAssistantPlugin');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IScenarioAssistantPlugin-class.html">IScenarioAssistantPlugin</a><tt class="py-op">(</tt><tt class="py-base-class">Interface</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IScenarioAssistantPlugin-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="IScenarioAssistantPlugin-expanded"><a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"> <tt class="py-docstring">"""A pluggable scenario that can be listed at the first page of the wizard.</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-docstring"> It predefines the steps the wizard will take and the way it is saved.</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> </tt>
<a name="IScenarioAssistantPlugin.addSteps"></a><div id="IScenarioAssistantPlugin.addSteps-def"><a name="L115"></a><tt class="py-lineno">115</tt> <a class="py-toggle" href="#" id="IScenarioAssistantPlugin.addSteps-toggle" onclick="return toggle('IScenarioAssistantPlugin.addSteps');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IScenarioAssistantPlugin-class.html#addSteps">addSteps</a><tt class="py-op">(</tt><tt class="py-param">assistant</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IScenarioAssistantPlugin.addSteps-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IScenarioAssistantPlugin.addSteps-expanded"><a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> <tt class="py-docstring">"""Called to add the required steps to the wizard.</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"><tt class="py-docstring"> @param assistant: The assistant the steps have to be added to.</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-docstring"> @type assistant: L{ConfigurationAssistant}</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div><a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"> </tt>
<a name="IScenarioAssistantPlugin.save"></a><div id="IScenarioAssistantPlugin.save-def"><a name="L121"></a><tt class="py-lineno">121</tt> <a class="py-toggle" href="#" id="IScenarioAssistantPlugin.save-toggle" onclick="return toggle('IScenarioAssistantPlugin.save');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="flumotion.admin.assistant.interfaces.IScenarioAssistantPlugin-class.html#save">save</a><tt class="py-op">(</tt><tt class="py-param">assistant</tt><tt class="py-op">,</tt> <tt class="py-param">saver</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="IScenarioAssistantPlugin.save-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="IScenarioAssistantPlugin.save-expanded"><a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-docstring">"""Saves the scenario through an AdminSaver to get the configuration.</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"><tt class="py-docstring"> @param assistant: The assistant the steps have to be added to.</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"><tt class="py-docstring"> @type assistant: L{ConfigurationAssistant}</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"><tt class="py-docstring"> @param saver: The element which generates the xml configuration.</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"><tt class="py-docstring"> @type saver: L{AssistantSaver}</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div></div><a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Wed Aug 11 21:33:18 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
