vc25pro_doc_unaencoderapi.html

Voice Commnucation Components for Delphi

    </TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>(<A HREF="#class_unaAbstractEncoder"><SPAN class="class">unaAbstractEncoder</SPAN></A>)</H4><P />
    Provides access to Vorbis library API.
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.loadDLL(): int; virtual;</SPAN><P />
      Loads Vorbis DLL into process memory.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.unloadDLL(): int; virtual;</SPAN><P />
      Unloads Vorbis DLL from process memory.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.doClose(): UNA_ENCODER_ERR; override;</SPAN><P />
      Closes Vorbis library.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.doPopPacket(var packet: tOgg_packet): bool;</SPAN><P />
      Pops Ogg packet (if any) from output stream.
      NOTE: All packets share same buffer, so only one packet at a time must be popped.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">constructor <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.create(const vorbisDll: string = ''; priority: integer = THREAD_PRIORITY_NORMAL);</SPAN><P />
      Creates Vorbis library API provider.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.AfterConstruction(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.BeforeDestruction(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.popPacket(var packet: tOgg_packet): bool;</SPAN><P />
      same as doPopPacket();
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.version: int;</SPAN><P />
      Version of Vorbis library.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.vi: pVorbis_info;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.vc: pVorbis_comment;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.vd: pVorbis_dsp_state;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>.vb: pVorbis_block;</SPAN><P /></TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaVorbisEnc"><SPAN class="class">unaVorbisEnc</SPAN></A>(<A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>)</H4><P />
    Provides interface of Vorbis/Ogg stream encoding.
    <BR>Requires Vorbis/Ogg libraries DLLs (ogg.dll, vorbis.dll and vorbisenc.dll)
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisEnc"><SPAN class="class">unaVorbisEnc</SPAN></A>.loadDLL(): int; override;</SPAN><P />
      Loads Vorbis encoder DLLs into process memory.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisEnc"><SPAN class="class">unaVorbisEnc</SPAN></A>.unloadDLL(): int; override;</SPAN><P />
      Unloads Vorbis DLLs from process memory.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisEnc"><SPAN class="class">unaVorbisEnc</SPAN></A>.doOpen(): UNA_ENCODER_ERR; override;</SPAN><P />
      Opens Vorbis encoder.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisEnc"><SPAN class="class">unaVorbisEnc</SPAN></A>.doSetConfig(config: pointer): UNA_ENCODER_ERR; override;</SPAN><P />
      Configures Vorbis encoder.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisEnc"><SPAN class="class">unaVorbisEnc</SPAN></A>.doClose(): UNA_ENCODER_ERR; override;</SPAN><P />
      Closes Vorbis encoder.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisEnc"><SPAN class="class">unaVorbisEnc</SPAN></A>.doEncode(data: pointer; nBytes: unsigned; out bytesUsed: unsigned): UNA_ENCODER_ERR; override;</SPAN><P />
      Encodes a chunk of data.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">constructor <A HREF="#class_unaVorbisEnc"><SPAN class="class">unaVorbisEnc</SPAN></A>.create(const vorbisDll: string = ''; const vorbisEncDll: string = ''; priority: integer = THREAD_PRIORITY_NORMAL);</SPAN><P />
      Creates Vorbis/Ogg encoder interface.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unaVorbisEnc"><SPAN class="class">unaVorbisEnc</SPAN></A>.vorbis_addComment(const tagName, tagValue: string);</SPAN><P />
      Adds comments to Vorbis stream header.
    </TD></TR></TABLE></DIV>
<DIV><P /><H4>Class <A NAME="class_unaVorbisDecoder"><SPAN class="class">unaVorbisDecoder</SPAN></A>(<A HREF="#class_unaVorbisAbstract"><SPAN class="class">unaVorbisAbstract</SPAN></A>)</H4><P />
    Provides interface of Vorbis/Ogg stream decoding.
    <BR>Requires Vorbis/Ogg libraries DLLs (ogg.dll and vorbis.dll)
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisDecoder"><SPAN class="class">unaVorbisDecoder</SPAN></A>.doOpen(): UNA_ENCODER_ERR; override;</SPAN><P />
      Opens Vorbis decoder.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisDecoder"><SPAN class="class">unaVorbisDecoder</SPAN></A>.doSetConfig(config: pointer): UNA_ENCODER_ERR; override;</SPAN><P />
      Configures Vorbis decoder.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisDecoder"><SPAN class="class">unaVorbisDecoder</SPAN></A>.doClose(): UNA_ENCODER_ERR; override;</SPAN><P />
      Closes Vorbis decoder.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisDecoder"><SPAN class="class">unaVorbisDecoder</SPAN></A>.doEncode(data: pointer; nBytes: unsigned; out bytesUsed: unsigned): UNA_ENCODER_ERR; override;</SPAN><P />
      Decodes a chunk of data.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisDecoder"><SPAN class="class">unaVorbisDecoder</SPAN></A>.readDecode(buf: pointer; size: unsigned): unsigned;</SPAN><P />
      Reads specified amount of data from decoder output.
      Returns number of bytes actually read, or 0 if no more data is available.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisDecoder"><SPAN class="class">unaVorbisDecoder</SPAN></A>.synthesis_packet(const packet: tOgg_packet): int;</SPAN><P />
      Feeds decoder with new packet.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisDecoder"><SPAN class="class">unaVorbisDecoder</SPAN></A>.synthesis_blockin(): int;</SPAN><P />
      Feeds decoder with new data from buffer.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unaVorbisDecoder"><SPAN class="class">unaVorbisDecoder</SPAN></A>.synthesis_pcmout(var pcm: pSingleSamples): int;</SPAN><P />
      Reads PCM data (if any) from decoder. Returns number of samples read.