VCDoc
Class Tree

Name
  unaVC_wave.unavclWaveInDevice

Class Hierarchy
  / unavclInOutWavePipe / unavclInOutPipe / TComponent / TPersistent / TObject

Description
 

Real time PCM audio stream recording from the sound card or other hardware device.

Usage: If components has no provider component with
formatProvider set to True, specify PCM stream parameters before
activating: pcm_SamplesPerSec, pcm_BitsPerSample and pcm_NumChannels.
Set deviceId property if required.

Example: refer to the vcTalkNow demo. It has waveIn_server
and waveIn_client components.
Both are used to record real-time PCM stream to be sent to remote side.
waveIn_server has c_codec_serverOut component as a consumer.
That means PCM stream produced by waveIn_server will be passed to
c_codec_serverOut component automatically.


Members
  Fields
 
Field Description

Methods
 
Method Description
unavclInOutPipe.addConsumer Adds new consumer for the pipe.
unavclInOutPipe.addProvider Adds new provider for the pipe.
unavclInOutPipe.AfterConstruction Creates list of consumers and providers, internal critical section and data proxy thread.
unavclInOutPipe.applyFormat Applies new format of the data stream.
unavclInOutPipe.BeforeDestruction Destroys the pipe.
unavclInOutPipe.checkIfAutoActivate Checks if autoActivate property is True and activates/deactivates consumers if yes.
unavclInOutPipe.checkIfFormatProvider Checks if component is format provider and applies format to consumer if it is (and format was not applied before).
unavclInOutPipe.clearFormatCRC Forces component to assign its format to consumers (if isFormatProvider is True).
unavclInOutPipe.close Closes the pipe.
unavclInOutPipe.doAddConsumer Adds new consumer for the pipe.
unavclInOutPipe.doAddProvider Assigns new provider for the pipe.
unavclInOutPipe.doBeforeAfterFC Calls f_beforeFormatChange or f_afterFormatChange if assigned.
unavclInOutPipe.doClose Closes the pipe.
unavclInOutPipe.doGetPosition Implements positions retrieval routine.
unavclInOutPipe.doOpen Opens the pipe.
unavclInOutPipe.doRead Reads data from the pipe.
unavclInOutPipe.doRemoveConsumer Removes consumer from the pipe.
unavclInOutPipe.doRemoveProvider Removes one of pipe's providers.
unavclInOutPipe.doSetActive Sets active state of the pipe.
unavclInOutPipe.doSetEnableDP Sets enableDataProcessing value.
unavclInOutPipe.doWrite Writes data into the pipe.
unavclInOutPipe.enter Enters the internal critical section.
unavclInOutPipe.getAvailableDataLen Returns data size available in the pipe (bytes).
unavclInOutPipe.getConsumerIndex Returns index of consumer.
unavclInOutPipe.getFormatExchangeData Fills the format of the data stream.
unavclInOutPipe.getPosition Returns position in stream.
unavclInOutPipe.getProviderIndex Returns index of provider.
unavclInOutPipe.incInOutBytes Increments (or decrements in/outBytes property by delta.
unavclInOutPipe.isActive Returns component's active state.
unavclInOutPipe.leaveRO Leaves the internal critical section.
unavclInOutPipe.leaveWO  
unavclInOutPipe.Loaded Usually creates an internal device of the pipe, and activates the component if needed.
unavclInOutPipe.Notification IDE/VCL notification for components removal/insertion.
unavclInOutPipe.notifyConsumers Notify all consumers there is no more such provider (self).
unavclInOutPipe.notifyProviders Notify all providers there is new consumer (self), or consumer is removed (value = nil).
unavclInOutPipe.onNewData Processes new data available from the pipe.
unavclInOutPipe.open Opens the pipe.
unavclInOutPipe.READ Reads data as a AnsiString.
unavclInOutPipe.READ If you did not specify the consumer for the pipe, you must call
unavclInOutPipe.removeConsumer Removes consumer from the pipe.
unavclInOutPipe.removeProvider Removes one of pipe's providers.
unavclInOutPipe.WRITE Writes data into the pipe.
unavclInOutPipe.WRITE Writes data into the pipe.
unavclInOutWavePipe.AfterConstruction Creates the wave device and assigns default values for properties.
unavclInOutWavePipe.applyDeviceFormat Applies new data stream format for the wave device.
unavclInOutWavePipe.applyFormat Applies new data stream format on the device.
unavclInOutWavePipe.BeforeDestruction Destroys the wave device.
unavclInOutWavePipe.createDevice Destroys previuosly created wave device, then creates new one.
unavclInOutWavePipe.createDriver Creates ACM or openH323plugin driver for device (if needed).
unavclInOutWavePipe.createNewDevice Does all the job of device creation.
unavclInOutWavePipe.destroyOldDevice Called when new device is about to be created.
unavclInOutWavePipe.doAddConsumer Adds consumer to the wave device.
unavclInOutWavePipe.doAddProvider Adds provider to the wave device.
unavclInOutWavePipe.doClose Closes the wave device.
unavclInOutWavePipe.doGetPosition Returns current position in device.
unavclInOutWavePipe.doOpen Creates and opens the wave device.
unavclInOutWavePipe.doRead Reads data from the wave device.
unavclInOutWavePipe.doRemoveProvider Removes provider from the wave device.
unavclInOutWavePipe.doSetAddSilence  
unavclInOutWavePipe.doSetDeviceId Sets new device ID and re-creates device object if needed.
unavclInOutWavePipe.doSetDriver  
unavclInOutWavePipe.doSetDriverLibrary  
unavclInOutWavePipe.doSetDriverMode  
unavclInOutWavePipe.doSetFormat  
unavclInOutWavePipe.doSetFormatTag Sets new format tag and re-creates device and driver objects if needed.
unavclInOutWavePipe.doSetLoop  
unavclInOutWavePipe.doSetSamplingParam  
unavclInOutWavePipe.doWrite If enableDataProcessing is True, writes data into the wave device using its write() method.
unavclInOutWavePipe.ensureFormat Refreshes the device format.
unavclInOutWavePipe.flush Flushes any data panding.
unavclInOutWavePipe.getAvailableDataLen Returns available data size.
unavclInOutWavePipe.getChunkSize Returns chunk size (in bytes).
unavclInOutWavePipe.getDstChunkSize Some devices (like codecs) may have different sife of input and output chunks.
unavclInOutWavePipe.getFormatExchangeData Fills format exchange data of the pipe stream.
unavclInOutWavePipe.getLogVolume Returns current volume of audio signal passing "through" wave device.
unavclInOutWavePipe.getUnVolume Returns unchenaged volume of audio signal passing "through" wave device.
unavclInOutWavePipe.getVolume Returns current volume of audio signal passing "through" wave device.
unavclInOutWavePipe.initWaveParams  
unavclInOutWavePipe.isActive Returns active state of the component.
unavclInOutWavePipe.Loaded Initializes the wave device.
unavclInOutWavePipe.onDriverChanged Triggers when device driver has been changed.
unavclInOutWavePipe.setVolume100 Changes the volume of specified channel.
AfterConstruction Creates the wave device and assigns default values for properties.
createNewDevice Creates waveIn (recording) device.

Properties
 
Property Description
unavclInOutPipe.active Returns or sets the active state of the pipe.
unavclInOutPipe.autoActivate When True tells the component it must activate consumer (if any)
unavclInOutPipe.availableDataLenIn Returns data written into but not yet processed by the pipe.
unavclInOutPipe.availableDataLenOut Returns data size available to read from the pipe.
unavclInOutPipe.closing True if component is being closed.
unavclInOutPipe.consumer Specifies the consumer of component.
unavclInOutPipe.consumerCount Number of consumers.
unavclInOutPipe.consumers Returns consumer.
unavclInOutPipe.dumpInput Specifies the file name to store the stream into.
unavclInOutPipe.dumpOutput Specifies the file name to store the stream into.
unavclInOutPipe.enableDataProcessing Specifies whether the component would perform any data processing.
unavclInOutPipe.enableDataProxy Data will be placed to proxy thread before processing.
unavclInOutPipe.ignoreProviderOptions Specifies which proviers options will be ignored.
unavclInOutPipe.inBytes Number of bytes received by the pipe.
unavclInOutPipe.isFormatProvider When True the component will assign stream format to the consumer (if any).
unavclInOutPipe.onDataAvailable This event is fired every time component has produced or received new chunk of data.
unavclInOutPipe.onDataDSP This event is fired every time component has produced or received new
unavclInOutPipe.onFormatChangeAfter This event is fired after new format was applied to a pipe.
unavclInOutPipe.onFormatChangeBefore This event is fired before new format is about to be applied to a pipe.
unavclInOutPipe.opt Internal.
unavclInOutPipe.outBytes Number of bytes produced by the pipe.
unavclInOutPipe.position Current position in stream (if applicable).
unavclInOutPipe.providerCount Number of providers.
unavclInOutPipe.providerOneAndOnly Returns first provider of a component (if any).
unavclInOutPipe.providers Returns provider.
unavclInOutPipe._consumers List of consumers.
unavclInOutPipe._providers List of providers.
unavclInOutWavePipe.acm ACM manager for the device (if any).
unavclInOutWavePipe.addSilence Specifies whether device should add silence when it runs out of audio data.
unavclInOutWavePipe.calcVolume When True tells the component to calculate audio volume of a data stream
unavclInOutWavePipe.chunkSize Input chunk size.
unavclInOutWavePipe.device Wave device associated with the pipe.
unavclInOutWavePipe.deviceId Specifies device ID for the wave device.
unavclInOutWavePipe.deviceWasCreated Internal.
unavclInOutWavePipe.direct Specifies whether wave device is direct (obsolete).
unavclInOutWavePipe.driver Device driver.
unavclInOutWavePipe.driverLibrary Specifies driver library for device.
unavclInOutWavePipe.driverMode Specifies driver mode for device.
unavclInOutWavePipe.dstChunkSize Output chunk size.
unavclInOutWavePipe.formatTag Specifies audio format tag for the wave device.
unavclInOutWavePipe.formatTagImmunable Specifies the device is immunable for format tag changes (usually useful for codecs).
unavclInOutWavePipe.inputIsPcm Specifies whether format of input stream of the device is PCM.
unavclInOutWavePipe.loop Specifies whether wave stream should be looped from end to beginning.
unavclInOutWavePipe.mapped Specifies whether wave device is mapped (obsolete).
unavclInOutWavePipe.minActiveTime Minimum active time for recording.
unavclInOutWavePipe.minVolumeLevel Minimum volume level for recording.
unavclInOutWavePipe.onThreshold This event is fired when current level of signal is crossing the "silence" mark.
unavclInOutWavePipe.overNum Specifies how many chunks of data (every chunk can hold 1/50 second of audio)
unavclInOutWavePipe.pcmFormatExt PCM format of the wave device.
unavclInOutWavePipe.pcm_bitsPerSample Specifies number of bits per sample for wave device.
unavclInOutWavePipe.pcm_channelMask Specifies channel mask for multi-channel data streams.
unavclInOutWavePipe.pcm_numChannels Specifies number of channels per sample for wave device.
unavclInOutWavePipe.pcm_samplesPerSec Specifies number of samples per second for wave device.
unavclInOutWavePipe.realTime Specifies whether device is working in real-time manner.
unavclInOutWavePipe.silenceDetectionMode Specifies which method will be used to detect silence.
unavclInOutWavePipe.startDeviceOnOpen Specifies whether device should be "started" after open.
unavclInOutWavePipe.waveError Last wave error.
unavclInOutWavePipe.waveErrorAsString Last wave error as AnsiString.
calcVolume  
deviceId  
enableDataProcessing Specifies whether the component would produce any data.
isFormatProvider waveIn component is usually a format provider--so this property value was changed to be true by default.
minActiveTime  
minVolumeLevel  
onThreshold  
silenceDetectionMode  
waveInDevice Returns waveIn device.

Events
 
Event Description



(c) 2001-2011 Lake of Soft
Created with DelphiCodeToDoc.