vc25pro_doc_unaencoderapi.html

Voice Commnucation Components for Delphi

	<LI>class <A HREF="#class_unaBassMusic"><SPAN class="class">unaBassMusic</SPAN></A>(<A HREF="#class_unaBassConsumer"><SPAN class="class">unaBassConsumer</SPAN></A>)</LI>
	<LI>class <A HREF="#class_unaBassSample"><SPAN class="class">unaBassSample</SPAN></A>(<A HREF="#class_unaBassConsumer"><SPAN class="class">unaBassConsumer</SPAN></A>)</LI>
	<LI>class <A HREF="#class_unaBassStream"><SPAN class="class">unaBassStream</SPAN></A>(<A HREF="#class_unaBassConsumer"><SPAN class="class">unaBassConsumer</SPAN></A>)</LI>
	<LI>class <A HREF="#class_unaBassChannel"><SPAN class="class">unaBassChannel</SPAN></A>(<A HREF="#class_unaBassConsumer"><SPAN class="class">unaBassConsumer</SPAN></A>)</LI>
	<LI>class <A HREF="#class_unaBassStreamDecoder"><SPAN class="class">unaBassStreamDecoder</SPAN></A>(<SPAN class="class">unaThread</SPAN>)</LI>
	<LI>class <A HREF="#class_unaBassDecoder"><SPAN class="class">unaBassDecoder</SPAN></A>(<SPAN class="class">tObject</SPAN>)</LI>
	<LI>class <A HREF="#class_una_openH323plugin"><SPAN class="class">una_openH323plugin</SPAN></A>(<A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>)</LI>
</UL>
<P />Routines:
<UL>	<LI><A HREF="#routine_tUnaEncoderDataAvailableEvent">tUnaEncoderDataAvailableEvent()</A>;</LI>
	<LI><A HREF="#routine_tUnaDataAvailableEvent">tUnaDataAvailableEvent()</A>;</LI>
	<LI><A HREF="#routine_unaBassDSPCallbackEvent">unaBassDSPCallbackEvent()</A>;</LI>
	<LI><A HREF="#routine_tUnaBassApplySampling">tUnaBassApplySampling()</A>;</LI>
	<LI><A HREF="#routine_tUnaBassDataAvailable">tUnaBassDataAvailable()</A>;</LI>
</UL>
<DIV><HR /><P />Unit classes<DIV><P /><H4>Class <A NAME="class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>(<SPAN class="class">tObject</SPAN>)</H4><P />
    Base abstract class for stream encoder/decoder.
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.doDAEvent(data: pointer; size: unsigned): bool; virtual;</SPAN><P />
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.doSetConfig(config: pointer): UNA_ENCODER_ERR; virtual; abstract;</SPAN><P />
      Override this method to provide implementation of encoder configuration.
      <BR>Returns status code of encoder after config information provided with config parameter was applied.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.doOpen(): UNA_ENCODER_ERR; virtual; abstract;</SPAN><P />
      Override this method to provide implementation of opening the encoder.
      <BR>Returns status code of encoder after it was opened.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.doClose(): UNA_ENCODER_ERR; virtual; abstract;</SPAN><P />
      Override this method to provide implementation of closing the encoder.
      <BR>Returns status code of encoder after was closed.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.doEncode(data: pointer; nBytes: unsigned; out bytesUsed: unsigned): UNA_ENCODER_ERR; virtual; abstract;</SPAN><P />
      Override this method to provide implementation of encoding the portion of data.
      <BR>Returns status code of encoding.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.enter(timeout: unsigned): bool;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.leave(): bool;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">constructor <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.create(priority: integer = THREAD_PRIORITY_NORMAL);</SPAN><P />
      Creates an encoder with specified priority.
      <BR>priority has meaning whit lazyWrite() method only.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.AfterConstruction(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.BeforeDestruction(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.setConfig(config: pointer): UNA_ENCODER_ERR;</SPAN><P />
      Configures encoder with specific stream parameters.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.open(): UNA_ENCODER_ERR;</SPAN><P />
      Activates the encoder.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.close(): UNA_ENCODER_ERR;</SPAN><P />
      Deactivates the encoder.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.encodeChunk(data: pointer; size: unsigned; lastOne: bool = false): unsigned;</SPAN><P />
      Returns number of bytes produced by encoder.
      Encoded data is first sent to onDataAvailable() event (if handler is assigned).
      If this event has no handler assigned, or handler returns writeToStream = true,
      data is also written into ouput stream.
      <BR>Check errorCode property if 0 was returned.
      <BR>Do not mix lazyWrite() and encodeChunk() calls.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.encodeChunkInPlace(data: pointer; var size: unsigned; outBuf: pointer; outBufSize: unsigned): unsigned;</SPAN><P />
      Encodes a chunk of data. Encoded data is copied into outBuf.
      Returns actual number of bytes produced by this function or zero if some error has occured.
      Writes encoded data into outBuf.
      Number of bytes written into outBuf will not exceed outBufSize (which could be less than required).
      This function does not call onDataAvailable() and does not write any data into output stream.
      Size parameter also used to return number of bytes used in input buffer. 
      <BR>Check errorCode property if 0 was returned.
      <BR>Do not mix lazyWrite() and encodeChunkInPlace() calls.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>.lazyWrite(buf: pointer; size: unsigned);</SPAN><P />
      Returns immediately after copying the data from buffer.
      <BR>Uses internal thread to feed the encoder.
      <BR>Do not mix lazyWrite() and encodeChunk() calls.