<?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.worker.checks.gst010</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.worker-module.html">Package worker</a> ::
<a href="flumotion.worker.checks-module.html">Package checks</a> ::
Module gst010
</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>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module gst010</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.worker.checks.gst010-pysrc.html">source code</a></span></p>
<hr />
<div class="fields"> <p><strong>Version:</strong>
$Rev: 8057 $
</p>
</div><!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.worker.checks.gst010.BusResolution-class.html" class="summary-name">BusResolution</a>
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">twisted.internet.defer.Deferred</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.worker.checks.gst010-module.html#do_element_check" class="summary-sig-name">do_element_check</a>(<span class="summary-sig-arg">pipeline_str</span>,
<span class="summary-sig-arg">element_name</span>,
<span class="summary-sig-arg">check_proc</span>,
<span class="summary-sig-arg">state</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">set_state_deferred</span>=<span class="summary-sig-default">False</span>)</span><br />
Parse the given pipeline and set it to the given state.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.checks.gst010-pysrc.html#do_element_check">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">twisted.internet.defer.Deferred</code> of <a
href="flumotion.common.messages.Result-class.html"
class="link">flumotion.common.messages.Result</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.worker.checks.gst010-module.html#check1394" class="summary-sig-name">check1394</a>(<span class="summary-sig-arg">mid</span>,
<span class="summary-sig-arg">guid</span>)</span><br />
Probe the firewire device.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.checks.gst010-pysrc.html#check1394">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">twisted.internet.defer.Deferred</code> of <a
href="flumotion.common.messages.Result-class.html"
class="link">flumotion.common.messages.Result</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.worker.checks.gst010-module.html#check1394devices" class="summary-sig-name">check1394devices</a>(<span class="summary-sig-arg">mid</span>)</span><br />
Fetch the available firewire devices.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.worker.checks.gst010-pysrc.html#check1394devices">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'flumotion.worker.checks'"><code class="variable-quote">'</code><code class="variable-string">flumotion.worker.checks</code><code class="variable-quote">'</code></code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="do_element_check"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">do_element_check</span>(<span class="sig-arg">pipeline_str</span>,
<span class="sig-arg">element_name</span>,
<span class="sig-arg">check_proc</span>,
<span class="sig-arg">state</span>=<span class="sig-default">None</span>,
<span class="sig-arg">set_state_deferred</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.checks.gst010-pysrc.html#do_element_check">source code</a></span>
</td>
</tr></table>
<p>Parse the given pipeline and set it to the given state. When the bin
reaches that state, perform the given check function on the element with
the given name.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>pipeline_str</code></strong> - description of the pipeline used to test</li>
<li><strong class="pname"><code>element_name</code></strong> - name of the element being checked</li>
<li><strong class="pname"><code>check_proc</code></strong> - a function to call with the GstElement as argument.</li>
<li><strong class="pname"><code>state</code></strong> - an unused keyword parameter that will be removed when support for
GStreamer 0.8 is dropped.</li>
<li><strong class="pname"><code>set_state_deferred</code></strong> (bool) - a flag to say whether the set_state is run in a deferToThread</li>
</ul></dd>
<dt>Returns: <code class="link">twisted.internet.defer.Deferred</code></dt>
<dd>a deferred that will fire with the result of check_proc, or fail.</dd>
</dl>
</td></tr></table>
</div>
<a name="check1394"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">check1394</span>(<span class="sig-arg">mid</span>,
<span class="sig-arg">guid</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.checks.gst010-pysrc.html#check1394">source code</a></span>
</td>
</tr></table>
<p>Probe the firewire device.</p>
<p>Return a deferred firing a result.</p>
<p>The result is either:</p>
<ul>
<li>
succesful, with a None value: no device found
</li>
<li>
succesful, with a dictionary of width, height, and par as a num/den
pair
</li>
<li>
failed
</li>
</ul>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>mid</code></strong> - the id to set on the message.</li>
<li><strong class="pname"><code>guid</code></strong> - the id of the selected device.</li>
</ul></dd>
<dt>Returns: <code class="link">twisted.internet.defer.Deferred</code> of <a
href="flumotion.common.messages.Result-class.html"
class="link">flumotion.common.messages.Result</a></dt>
</dl>
</td></tr></table>
</div>
<a name="check1394devices"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">check1394devices</span>(<span class="sig-arg">mid</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.worker.checks.gst010-pysrc.html#check1394devices">source code</a></span>
</td>
</tr></table>
<p>Fetch the available firewire devices.</p>
<p>Return a deferred firing a result.</p>
<p>The result is either:</p>
<ul>
<li>
succesful, with a list of tuples of guid and device-name
</li>
<li>
failed
</li>
</ul>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>mid</code></strong> - the id to set on the message.</li>
</ul></dd>
<dt>Returns: <code class="link">twisted.internet.defer.Deferred</code> of <a
href="flumotion.common.messages.Result-class.html"
class="link">flumotion.common.messages.Result</a></dt>
</dl>
</td></tr></table>
</div>
<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:11 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>
