VCDoc - myWaveOutDevice

VCDoc

Class Tree

Class

unaAudioFeedback.myWaveOutDevice

Class Hierarchy

/ unaWaveOutDevice / unaWaveDevice / unaMsAcmStreamDevice / unaThread / unaObject / TObject

Description

Members

Fields

Field

Description

Methods

Method	Description
unaObject.AfterConstruction	Makes sure "inherited" create() was called during object's creation.
unaObject.create	Creates an object.
unaThread.AfterConstruction	Makes sure "inherited" create() was called during object's creation.
unaThread.askStop	Notifies the thread should be stopped.
unaThread.BeforeDestruction	Destroys the thread. If thread is running, stops it by calling the stop() method.
unaThread.create	Creates new thread if active is true. If active is false thread should be created by calling the start() method.
unaThread.doSetStatus
unaThread.enter	Enters the gate associated with the thread.
unaThread.execute	This method will be called when execution starts in a new thread.
unaThread.getHandle
unaThread.getStatus
unaThread.getThreadId
unaThread.grantStart	Called just before execute() method.
unaThread.grantStop	Called just before shouldStop property will be set to true.
unaThread.g_shouldStop
unaThread.leave	Leaves the gate associated with the thread.
unaThread.onPause
unaThread.onResume
unaThread.pause	Suspends thread execution.
unaThread.resume	Resumes thread execution.
unaThread.setDefaultStopTimeout
unaThread.shouldStopThread
unaThread.sleepThread	Pauses the thread for specified amount of milliseconds.
unaThread.start	Starts the thread.
unaThread.startIn	Called just before execute() method.
unaThread.startOut	Called just after execute() method.
unaThread.stop	Stops the thread.
unaThread.wakeUp	If thread has entered the sleepThread() state, wakes the thread up, making the speep() method to return True.
unaMsAcmStreamDevice.addConsumer	Adds a new consumer for device output.
unaMsAcmStreamDevice.afterClose
unaMsAcmStreamDevice.AfterConstruction	Makes sure "inherited" create() was called during object's creation.
unaMsAcmStreamDevice.afterOpen	Called after the device was opened. Descendant classes may override this method to perform additional actions required by hardware/software.
unaMsAcmStreamDevice.assignStream	Assigns input or output stream for device.
unaMsAcmStreamDevice.assignStream	Assigns input or output stream for device.
unaMsAcmStreamDevice.BeforeDestruction	Destroys the thread. If thread is running, stops it by calling the stop() method.
unaMsAcmStreamDevice.beforeNewChunk	Adjusts volume as needed (if calcVolume is True).
unaMsAcmStreamDevice.close	Closes the device.
unaMsAcmStreamDevice.close2
unaMsAcmStreamDevice.create	Initializates class instance.
unaMsAcmStreamDevice.Destroy
unaMsAcmStreamDevice.doClose	Closes device. This method is usually overrided by descendant classes to perform the actual job.
unaMsAcmStreamDevice.doGetErrorText	Uses mmGetErrorCodeText2() to produce the error message.
unaMsAcmStreamDevice.doGetPosition
unaMsAcmStreamDevice.doOpen	Opens device. This method is usually overrided by descendant classes to perform the actual job.
unaMsAcmStreamDevice.doWrite
unaMsAcmStreamDevice.flush
unaMsAcmStreamDevice.flush2
unaMsAcmStreamDevice.formatChooseDef	Default implementation of format choosing routine.
unaMsAcmStreamDevice.formatChooseDef2
unaMsAcmStreamDevice.getDataAvailable	Returns number of bytes available to read from the device.
unaMsAcmStreamDevice.getDspProperty
unaMsAcmStreamDevice.getDspProperty
unaMsAcmStreamDevice.getErrorText	Returns error message text corresponding to given errorCode parameter.
unaMsAcmStreamDevice.getMasterIsSrc	Returns true if device is output device (playback or codec).
unaMsAcmStreamDevice.getMasterIsSrc2
unaMsAcmStreamDevice.getPosition	Returns current position in samples.
unaMsAcmStreamDevice.getPrevVolume	Returns previous volume level for open device.
unaMsAcmStreamDevice.getVolume	Returns current volume level for open device.
unaMsAcmStreamDevice.isOpen	Returns true if device was opened successfully.
unaMsAcmStreamDevice.okToRead	Use this method to check if you can read new data from device.
unaMsAcmStreamDevice.open	Opens the device.
unaMsAcmStreamDevice.open2
unaMsAcmStreamDevice.prepareHeader	Prepares the buffer header before first use. Descendant classes must override this method.
unaMsAcmStreamDevice.READ	Reads data from device.
unaMsAcmStreamDevice.removeConsumer	Removes consumer from consumers list.
unaMsAcmStreamDevice.removeHeader
unaMsAcmStreamDevice.setDspProperty
unaMsAcmStreamDevice.setDspProperty
unaMsAcmStreamDevice.setFormat	Sets the source or destination PCM format for device. Format is given as WAVEFORMATEX structure.
unaMsAcmStreamDevice.setFormat	Sets the source or destination PCM format for device. Format is given in string representation using base64 encoding.
unaMsAcmStreamDevice.setFormatExt
unaMsAcmStreamDevice.setFormatExt
unaMsAcmStreamDevice.setRealTime
unaMsAcmStreamDevice.setVolume100	Changes the volume of specified channel.
unaMsAcmStreamDevice.startIn	Called just before execute() method.
unaMsAcmStreamDevice.startOut	Called just after execute() method.
unaMsAcmStreamDevice.unprepareHeader	Unprepares the buffer header after last use. Descendant classes must override this method.
unaMsAcmStreamDevice.waitForData	Waits for data either in inStream or in outStream.
unaMsAcmStreamDevice.WRITE	Sends data to device.
unaWaveDevice.addHeader
unaWaveDevice.close2
unaWaveDevice.create	From Microsoft MSDN:
unaWaveDevice.execute	This method will be called when execution starts in a new thread.
unaWaveDevice.onHeaderDone
unaWaveDevice.open2
unaWaveDevice.removeHeader
unaWaveDevice.setSampling
unaWaveDevice.setSampling
unaWaveDevice.setSampling	Since most wave devices supports PCM formats only it is handy to have this method.
unaWaveDevice.setSamplingExt
unaWaveOutDevice.addHeader
unaWaveOutDevice.afterOpen	Called after the device was opened. Descendant classes may override this method to perform additional actions required by hardware/software.
unaWaveOutDevice.create
unaWaveOutDevice.doClose	Closes device. This method is usually overrided by descendant classes to perform the actual job.
unaWaveOutDevice.doGetErrorText	Uses mmGetErrorCodeText2() to produce the error message.
unaWaveOutDevice.doGetPosition
unaWaveOutDevice.doOpen	Opens device. This method is usually overrided by descendant classes to perform the actual job.
unaWaveOutDevice.doWrite	//
unaWaveOutDevice.flush2	Flushes all data pending to be played back.
unaWaveOutDevice.formatChoose
unaWaveOutDevice.formatChooseDef2	Displays a format choose dialog.
unaWaveOutDevice.getCaps
unaWaveOutDevice.getCCaps
unaWaveOutDevice.getDeviceCount
unaWaveOutDevice.getErrorText	Returns error message text corresponding to given errorCode parameter.
unaWaveOutDevice.getMasterIsSrc2	Returns true.
unaWaveOutDevice.onHeaderDone
unaWaveOutDevice.prepareHeader	Prepares the buffer header before first use. Descendant classes must override this method.
unaWaveOutDevice.startIn	Called just before execute() method.
unaWaveOutDevice.startOut	Called just after execute() method.
unaWaveOutDevice.unprepareHeader	Unprepares the buffer header after last use. Descendant classes must override this method.
onHeaderDone

Properties

Property	Description
unaObject._classID	Returns string description of this instance.
unaObject._this	Returns pointer to self (this instance of object). Useful is some cases where self will refer to method's owner object instead.
unaThread.globalIndex
unaThread.onExecute	Fires when execution starts in a new thread. See comments for execute() method for details.
unaThread.priority	Specifies the priority of the thread.
unaThread.shouldStop	True when thread is (about to be) stopped.
unaMsAcmStreamDevice.calcVolume	Specifies whether volume level calculation should be performed.
unaMsAcmStreamDevice.chunkPerSecond	Specifies number of chunks produced by component per second.
unaMsAcmStreamDevice.chunkSize	Size in bytes of internal buffer used to handle the audio stream data.
unaMsAcmStreamDevice.dstChunkSize
unaMsAcmStreamDevice.dstFormatExt	Returns destination format for device.
unaMsAcmStreamDevice.dstFormatInfo	Returns string representation of destination wave format.
unaMsAcmStreamDevice.flushBeforeClose	Specifies whether component will flush unfinished data before closing.
unaMsAcmStreamDevice.inBytes	Number of bytes passed to device (as input). Playback and codec devices increase this value.
unaMsAcmStreamDevice.inOverloadTotal
unaMsAcmStreamDevice.inProgress	Number of chunks passed to Windows ACM or wave device.
unaMsAcmStreamDevice.inStream	Data passed to device first is strored in inStream
unaMsAcmStreamDevice.isSilence	Returns true if components is currently not producing any audio chunks due to low signal level.
unaMsAcmStreamDevice.minActiveTime	Specifies the minimum amount of time (in milliseconds) for silence detection to be active once activated.
unaMsAcmStreamDevice.minVolumeLevel	Specifies the minimum value of volume level for silence detection.
unaMsAcmStreamDevice.onDataAvailable	This event is called when new data is available.
unaMsAcmStreamDevice.onThreshold	This event is fired when current level of signal is crossing the "silence" mark.
unaMsAcmStreamDevice.outBytes	Number of bytes produced by device (as output). Recording and codec devices increase this value.
unaMsAcmStreamDevice.outOverloadTotal
unaMsAcmStreamDevice.outStream	Data produced by device first is stored in outStream
unaMsAcmStreamDevice.overNumIn
unaMsAcmStreamDevice.overNumOut
unaMsAcmStreamDevice.realTime
unaMsAcmStreamDevice.silenceDetectionMode	Specifies which method will be used to detect silence.
unaMsAcmStreamDevice.srcFormatExt	Returns source format for device.
unaMsAcmStreamDevice.srcFormatInfo	Returns string representation of source format.
unaWaveDevice.deviceId	Device Id.
unaWaveDevice.direct	From Microsoft MSDN:
unaWaveDevice.mapped	From Microsoft MSDN:
unaWaveOutDevice.onAfterChunkDone	Fires every time chunk was just played out by wave-out device.
unaWaveOutDevice.onAfterChunkFeed	Fires every time new chunk was feed to wave-out device.
unaWaveOutDevice.outOfData	Amount of audio data which appear too late to be played back in real time.
unaWaveOutDevice.pitch	Not supported yet.
unaWaveOutDevice.playbackRate	Not supported yet.
unaWaveOutDevice.volume	Not supported yet. Use getVolume() instead.

Events

Event

Description