classpsoundchannel.html

pwlib开发文档

       
    </td>
    <td>

<p>
Return names of all plugins that correspond to sound devices     </td>
  </tr>
</table>
<a name="z389_2" doxytag="PSoundChannel::GetHandle"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual int PSoundChannel::GetHandle </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the OS specific handle for the PSoundChannel.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 integer value of the handle. </dl>
<p>
Reimplemented from <a class="el" href="classPChannel.html#z47_2">PChannel</a>.    </td>
  </tr>
</table>
<a name="z395_1" doxytag="PSoundChannel::GetLastReadCount"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> PINDEX PSoundChannel::GetLastReadCount </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the number of bytes read by the last <a class="el" href="classPSoundChannel.html#z395_0">Read()</a> call. This will be from 0 to the maximum number of bytes as passed to the <a class="el" href="classPSoundChannel.html#z395_0">Read()</a> call.
<p>
Note that the number of bytes read may often be less than that asked for. Aside from the most common case of being at end of file, which the applications semantics may regard as an exception, there are some cases where this is normal. For example, if a <a class="el" href="classPTextFile.html">PTextFile</a> channel on the MSDOS platform is read from, then the translation of CR/LF pairs to <br>
 characters will result in the number of bytes returned being less than the size of the buffer supplied.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 the number of bytes read. </dl>
<p>
Reimplemented from <a class="el" href="classPChannel.html#z49_3">PChannel</a>.    </td>
  </tr>
</table>
<a name="z393_1" doxytag="PSoundChannel::GetLastWriteCount"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> PINDEX PSoundChannel::GetLastWriteCount </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the number of bytes written by the last <a class="el" href="classPSoundChannel.html#z393_0">Write()</a> call.
<p>
Note that the number of bytes written may often be less, or even more, than that asked for. A common case of it being less is where the disk is full. An example of where the bytes written is more is as follows. On a PTextFile# channel on the MSDOS platform, there is translation of <br>
 to CR/LF pairs. This will result in the number of bytes returned being more than that requested.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 the number of bytes written. </dl>
<p>
Reimplemented from <a class="el" href="classPChannel.html#z51_3">PChannel</a>.    </td>
  </tr>
</table>
<a name="z391_3" doxytag="PSoundChannel::GetSampleRate"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual unsigned PSoundChannel::GetSampleRate </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the sample rate in samples per second.
<p>
    </td>
  </tr>
</table>
<a name="z391_4" doxytag="PSoundChannel::GetSampleSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual unsigned PSoundChannel::GetSampleSize </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the sample size in bits per sample.
<p>
    </td>
  </tr>
</table>
<a name="z391_8" doxytag="PSoundChannel::GetVolume"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual BOOL PSoundChannel::GetVolume </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>volume</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the volume of the play/read process. The volume range is 0 == quiet. 100 == LOUD.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if there were no errors. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>volume</em>&nbsp;</td><td>
Variable to receive volume level. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z393_4" doxytag="PSoundChannel::HasPlayCompleted"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual BOOL PSoundChannel::HasPlayCompleted </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Indicate if the sound play begun with PlayBuffer() or <a class="el" href="classPSoundChannel.html#z393_3">PlayFile()</a> has completed.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the sound has completed playing. </dl>    </td>
  </tr>
</table>
<a name="z389_1" doxytag="PSoundChannel::IsOpen"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual BOOL PSoundChannel::IsOpen </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Test if this instance of PSoundChannel is open.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if this instance is open. </dl>
<p>
Reimplemented from <a class="el" href="classPChannel.html#z47_0">PChannel</a>.    </td>
  </tr>
</table>
<a name="z395_5" doxytag="PSoundChannel::IsRecordBufferFull"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual BOOL PSoundChannel::IsRecordBufferFull </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Determine if a record buffer has been filled, so that the next <a class="el" href="classPSoundChannel.html#z395_0">Read()</a> call will not block. Provided that the amount of data read is less than the buffer size.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the sound driver has filled a buffer. </dl>    </td>
  </tr>
</table>
<a name="z389_0" doxytag="PSoundChannel::Open"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual BOOL PSoundChannel::Open </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>device</em>, </td>
        </tr>
        <tr>