mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
fc9e379fd8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@315005 c90b9560-bf6c-de11-be94-00142212c4b1
89 lines
2.4 KiB
XML
89 lines
2.4 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.openal-stream" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>openal_stream</refname>
|
|
<refpurpose>
|
|
Begin streaming on a source
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>openal_stream</methodname>
|
|
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>format</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>rate</parameter></methodparam>
|
|
</methodsynopsis>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>source</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An <link linkend="openal.resources">Open AL(Source)</link> resource
|
|
(previously created by <function>openal_source_create</function>).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>format</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Format of <parameter>data</parameter>, one of:
|
|
<constant>AL_FORMAT_MONO8</constant>,
|
|
<constant>AL_FORMAT_MONO16</constant>,
|
|
<constant>AL_FORMAT_STEREO8</constant>&listendand;
|
|
<constant>AL_FORMAT_STEREO16</constant>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>rate</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Frequency of data to stream given in Hz.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a stream resource on success&return.falseforfailure;.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>openal_source_create</function></member>
|
|
<member><function>fwrite</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|