~ubuntu-branches/ubuntu/vivid/linphone/vivid

« back to all changes in this revision

Viewing changes to developer-docs/mediastreamer/sgml/running.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Samuel Mimram
  • Date: 2006-11-15 10:34:50 UTC
  • mfrom: (1.2.1 upstream) (2.1.8 feisty)
  • Revision ID: james.westby@ubuntu.com-20061115103450-qgafwcks2lkhctlj
* New upstream release.
* Enable video support.
* Fix mismatched #endif in mscommon.h, closes: #398307.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<refentry id="mediastreamer-Running-processing-chains">
2
 
<refmeta>
3
 
<refentrytitle>Running processing chains</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>MEDIASTREAMER Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>Running processing chains</refname><refpurpose></refpurpose>
10
 
</refnamediv>
11
 
 
12
 
<refsynopsisdiv><title>Synopsis</title>
13
 
 
14
 
<synopsis>
15
 
 
16
 
#include &lt;ms.h&gt;
17
 
 
18
 
 
19
 
void        <link linkend="ms-start">ms_start</link>                        (<link linkend="MSSync">MSSync</link> *sync);
20
 
void        <link linkend="ms-stop">ms_stop</link>                         (<link linkend="MSSync">MSSync</link> *sync);
21
 
</synopsis>
22
 
</refsynopsisdiv>
23
 
 
24
 
 
25
 
 
26
 
 
27
 
 
28
 
 
29
 
 
30
 
<refsect1>
31
 
<title>Description</title>
32
 
<para>
33
 
 
34
 
</para>
35
 
</refsect1>
36
 
 
37
 
<refsect1>
38
 
<title>Details</title>
39
 
<refsect2>
40
 
<title><anchor id="ms-start">ms_start ()</title>
41
 
<programlisting>void        ms_start                        (<link linkend="MSSync">MSSync</link> *sync);</programlisting>
42
 
<para>
43
 
Starts a thread that will shedule all processing chains attached to the synchronisation source <parameter>sync</parameter>.</para>
44
 
<para>
45
 
 
46
 
</para><variablelist role="params">
47
 
<varlistentry><term><parameter>sync</parameter>&nbsp;:</term>
48
 
<listitem><simpara> A synchronisation source to be started.
49
 
</simpara></listitem></varlistentry>
50
 
</variablelist></refsect2>
51
 
<refsect2>
52
 
<title><anchor id="ms-stop">ms_stop ()</title>
53
 
<programlisting>void        ms_stop                         (<link linkend="MSSync">MSSync</link> *sync);</programlisting>
54
 
<para>
55
 
Stop the thread that was sheduling the processing chains attached to the synchronisation source <parameter>sync</parameter>.
56
 
The processing chains are kept unchanged, no object is freed. The synchronisation source can be restarted using <link linkend="ms-start">ms_start</link>().</para>
57
 
<para>
58
 
 
59
 
</para><variablelist role="params">
60
 
<varlistentry><term><parameter>sync</parameter>&nbsp;:</term>
61
 
<listitem><simpara> A synchronisation source to be stopped.
62
 
</simpara></listitem></varlistentry>
63
 
</variablelist></refsect2>
64
 
 
65
 
</refsect1>
66
 
 
67
 
 
68
 
 
69
 
 
70
 
</refentry>