Subversion Repositories cheapmusic

Rev

Blame | Last modification | View Log | RSS feed

<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><title>EndStream</title><link rel="stylesheet" type="text/css" href="phplotdoc.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><link rel="home" href="index.html" title="PHPlot Reference Manual" /><link rel="up" href="reference.html" title="PHPlot Function Reference" /><link rel="prev" href="EncodeImage.html" title="EncodeImage" /><link rel="next" href="GetCallback.html" title="GetCallback" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">EndStream</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="EncodeImage.html">Prev</a> </td><th width="60%" align="center">PHPlot Function Reference</th><td width="20%" align="right"> <a accesskey="n" href="GetCallback.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="EndStream"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">EndStream</span></h2><p>EndStream &#8212; End a Motion-JPEG (or other type) plot stream</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">$plot-&gt;EndStream()</pre></div><div class="refsect1"><a id="idp1377701036"></a><h2>Description</h2><p>
<code class="function">EndStream</code> is used to end a plot stream, started
with <a class="xref" href="StartStream.html" title="StartStream"><span class="refentrytitle">StartStream</span></a> and containing frames produced by
<a class="xref" href="PrintImageFrame.html" title="PrintImageFrame"><span class="refentrytitle">PrintImageFrame</span></a>.
This function simply outputs the ending MIME boundary for the stream.
    </p></div><div class="refsect1"><a id="idp1377702836"></a><h2>Parameters</h2><p>
None
    </p></div><div class="refsect1"><a id="idp1377703444"></a><h2>Notes</h2><p>
The three functions <a class="xref" href="StartStream.html" title="StartStream"><span class="refentrytitle">StartStream</span></a>,
<a class="xref" href="PrintImageFrame.html" title="PrintImageFrame"><span class="refentrytitle">PrintImageFrame</span></a>, and <code class="function">EndStream</code>
are used together to produce streaming plots.
Scripts producing streaming plots must use a web server.
The PHP CLI will not work, because streaming plots require HTTP headers.
    </p><p>
For more on streaming plots, see <a class="xref" href="adv-streaming.html" title="4.9. Streaming Plots">Section 4.9, &#8220;Streaming Plots&#8221;</a>.
    </p></div><div class="refsect1"><a id="idp1377705892"></a><h2>Example</h2><p>
See <a class="xref" href="PrintImageFrame.html" title="PrintImageFrame"><span class="refentrytitle">PrintImageFrame</span></a> for a partial example, and
<a class="xref" href="adv-streaming.html#adv-streaming-example" title="4.9.3. Streaming Plots - Example">Section 4.9.3, &#8220;Streaming Plots - Example&#8221;</a> for the complete example.
    </p></div><div class="refsect1"><a id="idp1377707308"></a><h2>History</h2><p>
This function was added in PHPlot-5.8.0.
Prior releases are not able to produce streaming plots.
    </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="EncodeImage.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="GetCallback.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">EncodeImage </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> GetCallback</td></tr></table></div></body></html>