vc25pro_doc_unavcide.html

Voice Commnucation Components for Delphi

    Base abstract class for all VCL components in VC set.
  <P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.doWrite(data: pointer; len: unsigned; provider: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A> = nil): int; virtual; abstract;</SPAN><P />
      Writes data into the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.doRead(data: pointer; len: unsigned): unsigned; virtual; abstract;</SPAN><P />
      Reads data from the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.getAvailableDataLen(index: int): unsigned; virtual; abstract;</SPAN><P />
      Returns available data size in the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.doOpen(): bool; virtual;</SPAN><P />
      Opens the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.doClose(); virtual;</SPAN><P />
      Closes the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.isActive(): bool; virtual; abstract;</SPAN><P />
      Returns true if component was activated.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.doEnter(timeOut: unsigned = 1000): bool; virtual; abstract;</SPAN><P />
      Restricts the execution of the pipe to one thread.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.doLeave(); virtual; abstract;</SPAN><P />
      Removes the restrictions on the execution of the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.onNewData(data: pointer; len: unsigned; provider: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A> = nil): bool; virtual;</SPAN><P />
      Processes new data available from the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.applyFormat(data: pointer; len: unsigned; provider: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A> = nil; restoreActiveState: bool = false): bool; virtual;</SPAN><P />
      Applies new format of the stream to the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.getFormatExchangeData(out data: pointer): unsigned; virtual;</SPAN><P />
      Fills the format of the pipe stream.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.doGetPosition(): int64; virtual;</SPAN><P />
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.Notification(component: tComponent; operation: tOperation); override;</SPAN><P />
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.doAddProvider(provider: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>): bool; virtual;</SPAN><P />
      Assigns new provider for the pipe. Only mixer can support more that one providers.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.doRemoveProvider(provider: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>); virtual;</SPAN><P />
      Removes one of pipe's providers.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.doAddConsumer(consumer: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>; forceNewFormat: bool = true): bool; virtual;</SPAN><P />
      Adds new consumer for the pipe. Only one consumer is currently supported.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.doRemoveConsumer(consumer: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>); virtual;</SPAN><P />
      Removes consumer from the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.doSetEnableDP(value: bool); virtual;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.Loaded(); override;</SPAN><P />
      Usually creates an internal device of the pipe, and activates the component if needed.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.AfterConstruction(); override;</SPAN><P />
      Creates a pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.BeforeDestruction(); override;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.enter(timeOut: unsigned = 1000): bool;</SPAN><P />
      Enters the pipe one-thread execution mode.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.leave();</SPAN><P />
      Leaves the pipe one-thread execution mode.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.write(data: pointer; len: unsigned; provider: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A> = nil): int; overload;</SPAN><P />
      Writes data into the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.write(const data: string; provider: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A> = nil): unsigned; overload;</SPAN><P />
      Writes data into the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.read(data: pointer; len: unsigned): unsigned; overload;</SPAN><P />
      If you did not specify the consumer for component, you must call read() method periodically to access the stream data.
      Best place to do that is onDataAvailable() event handler.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.read(): string; overload;</SPAN><P />
      Reads data as a string.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.open(): bool;</SPAN><P />
      Opens the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.close(timeout: int = 0);</SPAN><P />
      Closes the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.addProvider(provider: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>): bool;</SPAN><P />
      Assigns new provider for the pipe. Only mixer can support more that one providers.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.removeProvider(provider: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>);</SPAN><P />
      Removes one of pipe's providers.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.addConsumer(consumer: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>; forceNewFormat: bool = true): bool;</SPAN><P />
      Adds new consumer for the pipe. Only one consumer is currently supported.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.removeConsumer(consumer: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>);</SPAN><P />
      Removes consumer from the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.getConsumer(index: unsigned = 0): <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>;</SPAN><P />
      Returns consumer of a pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.getProvider(index: unsigned = 0): <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>;</SPAN><P />
      Returns provider of a pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.getConsumerCount(): unsigned;</SPAN><P />
      Returns number of consumers.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.getProviderCount(): unsigned;</SPAN><P />
      Returns number of providers.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.getConsumerIndex(value: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>): int;</SPAN><P />
      Returns index of specified consumer.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.getProviderIndex(value: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>): int;</SPAN><P />
      Returns index of specified provider.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">function <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.getPosition(): int64;</SPAN><P />
      Returns current position for stream.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">procedure <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.clearFormatCRC();</SPAN><P />
      Forces component to assign a format to consumers. Call this method before activation.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.availableDataLenIn: unsigned;</SPAN><P />
      Returns data written into but not yet processed by the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.availableDataLenOut: unsigned;</SPAN><P />
      Returns data size available to read from the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.inBytes: int64;</SPAN><P />
      Number of bytes received by the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.outBytes: int64;</SPAN><P />
      Number of bytes produced by the pipe.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.enableDataProcessing: bool;</SPAN><P />
      Specifies whether the component would perform any data processing.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.position: int64;</SPAN><P />
      Current position in stream.
    </TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.providerOneAndOnly: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>;</SPAN><P /></TD></TR></TABLE><P /><TABLE BORDER="1" width="100%"><TR><TD><SPAN class="source">property <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>.consumers[]: <A HREF="#class_unavclInOutPipe"><SPAN class="class">unavclInOutPipe</SPAN></A>;</SPAN><P />