~ubuntu-branches/ubuntu/trusty/csound-manual/trusty-proposed

 

<refentry id="filevalid">

<indexterm id="IndexFilevalid"><primary>filevalid</primary></indexterm>

  <refentryinfo><title>Signal I/O:Soundfile Queries</title></refentryinfo>

  <refmeta>

    <refentrytitle>filevalid</refentrytitle>

  </refmeta>

 

 

 

  <refnamediv>

    <refname>filevalid</refname>

    <refpurpose>

      Checks that a file can be used.

          </refpurpose>

  </refnamediv>

 

  <refsect1>

    <title>Description</title>

    <para>

      Returns 1 if the sound file is valid, or 0 if not.

    </para>

  </refsect1>

 

  <refsect1>

    <title>Syntax</title>

    <synopsis>ir <command>filevalid</command> ifilcod</synopsis>

  </refsect1>

 

  <refsect1>

    <title>Initialization</title>

    <para>

      <emphasis>ifilcod</emphasis> -- sound file to be queried

    </para>

  </refsect1>

 

  <refsect1>

    <title>Performance</title>

    <para>

      <emphasis>filevalid</emphasis> returns 1 if the sound file <emphasis>ifilcod</emphasis> can be used.

    </para>

  </refsect1>

 

  <refsect1>

    <title>Examples</title>

    <para>

      Here is an example of the filevalid opcode. It uses the file <ulink url="examples/filevalid.csd"><citetitle>filevalid.csd</citetitle></ulink>, and <ulink url="examples/mary.wav"><citetitle>mary.wav</citetitle></ulink>.

 

      <example>

        <title>Example of the filevalid opcode.</title>

 

        

 

        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>

          <xi:include href="examples-xml/filevalid.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

      </example>

 

    </para>

  </refsect1>

 

  <refsect1>

    <title>See Also</title>

    <para>

      <link linkend="filebit"><citetitle>filebit</citetitle></link>,

      <link linkend="filelen"><citetitle>filelen</citetitle></link>,

      <link linkend="filenchnls"><citetitle>filenchnls</citetitle></link>,

     <link linkend="filepeak"><citetitle>filepeak</citetitle></link>,

      <link linkend="filesr"><citetitle>filesr</citetitle></link>

    </para>

  </refsect1>

 

  <refsect1>

    <title>Credits</title>

    <para>

      <simplelist>

        <member>Author: &namematt;</member>

        <member>July 2010</member>

      </simplelist>

    </para>

    <para>Example written by &namejohn;.</para>

 

    <para>New in Csound version 4.13</para>

  </refsect1>

</refentry>