TSignalCoreAudioOut Class

type TSignalCoreAudioOut = class(TSignalCoreAudio);

Audio playback component based on WASAPI drivers.

Component uses CoreAudio audio drivers for playback. Output channel data is obtained from Inputs property which must be assigned before the playback starts. Typically <see cref="TSignalDemuxList"/> would be assigned to Inputs and TSignalDemuxList.Inputs to <see cref="TSignalRead"/>. Before the playback can start: The SamplingFrequency for the CoreAudio component must always be set manually and needs to be supported by the driver. The component will perform rate conversion if input signal does not have the same SamplingFrequency. ChannelCount and Inputs.Count need to match. An exception is the mono single channel signal. Mono signal will always play on all channels. <see cref="Precision"/> property must be set to reflect the format of the data to be played back. In case of 16bit, it should be set to prSmallInt. If data is stored as double precision and normalized to have a maximum value of 1 then this setting should be prDouble. Define <see cref="PrecisionHw"/> property. This is the precision of the audio engine. Choose values supported by the audio drivers and hardware. Precision and PrecisionHW are used together to determine the correct scaling. * Exclusive can be set to true or false. When access to the device is exclusive, the latency can be less, audio quality higher, but audio device cannot be shared with other applications. Most importantly, all pre and post processing filters used by Windows are bypassed. (Like Dolby Digital, Room Correction, etc...) Once a new buffer is ready, the driver will call <see cref="OnProcessRealTime"/> event. This event is executed within the drivers thread and should not interact directly with the user interface. From this event <see cref="OutputBuffers"/> can be accessed and processed with minimum delay time.

Properties

NameTypeDescription
ActiveBooleanSet active to false to suppress the propagation of the Pull request and the subsequent call to the Update method.
BlockAssignBooleanBlock streaming of specific properties when storing only a "template".
ComplexBooleanSet this property to true, to request computation using complex numbers.
ContinuousBooleanIf True, the component will pass on the udpate request to the connected component.
CountIntegerDefines the size of the list.
DeviceIndexintegerReturns the index of the currently open CoreAudio driver in the list of available drivers.
DisabledOrDisconnectedbooleanReturns true, if the hardware appears disabled or disconnected.
EditIndexIntegerSpecifies index of the item in the list for which to display the design-time editor.
EditorActiveBooleanReturns True, if the component editor is displayed.
FirstTMtxComponentReturns the pointer to Items[0].
FloatPrecisionTMtxFloatPrecisionSet this property to request computation in 32bit/64bit precision with real/complex numbers.
FloatPrecisionLockBooleanSet this property to true to lock changes to FloatPrecision property.
IsDoubleBooleanSet this property to false, to request computation in 32bit floating point precision, 64bit, if true.
ItemTSignalAccess TSignal objects by Index.
ItemsTSignalChannelDefault array property allows access to individual list items.
ItemsCollectionTMtxComponentCollectionContent serialization and designer editor support.
LastTMtxComponentReturns Items[Count - 1].
OnAfterUpdateTNotifyEventThe event is triggered after the call to the Update method.
OnBeforeUpdateTNotifyEventThe event is triggered just before the call to the Update method.
OnDisplayUpdateTNotifyEventThe event is triggered after the OnAfterUpdate event.
OnItemAddTMtxComponentAddEventEvent triggered after a new item has been added.
OnItemDeleteTMtxComponentDeleteEventEvent triggered before the Item will be deleted.
OnNotifyUpdateTNotifyEventThe event is called after a call to InternalUpdate, OnAfterUpdate and OnDisplayUpdate from within the Update method.
OnParameterUpdateTNotifyEventThe event is triggered when ParamUpdate method is called.
PausedbooleanSet this property to True, to pause the playback and/or recording.
ProcessingTimedoubleReturns processing time of the real-time loop in miliseconds.
PropagateTemplateBooleanDefines how TMtxComponentList.Propagate will proparage properties.
ReferenceTReferenceListStores a list of components that have to be notified, when this component is destroyed.
SuspendNotifyUpdateBooleanSet this property to True, to prevent calling OnNotifyUpdate from the Update Method.
VolumesingleSet this property to to change the playback/recording volume.

Methods

NameDescription
ActualLatencyReturns actual buffer latency in miliseconds.
AllowStreamingReturns the negatated value of BlockAssign.
AssignAssign values of all published properties from Source.
AssignTemplateAssign values of "template-like" published properties from Source.
BufferStatsSee abstract method TSignalCoreAudio.BufferStats for more info.
ClearDeletes all items from the list.
Create
DeleteDeletes the item from the list.
Destroy
EditorClassTo be overriden in descendanr classses.
ElapsedSamplesReturns total number of samples elapsed since start.
ElapsedTimeReturns time elapsed since start in seconds.
ExchangeSwaps the position of two items in the Items array.
ExtractExtracts the item from the list.
GetDeviceListReturns a list of CoreAudio devices.
GetDriverLatencyReturns latency in miliseconds as reported by the driver.
GetSupportedPrecisionHWsReturns list of supported PrecisionHW values.
GetSupportedSamplingFrequenciesReturns list of supported sampling frequencies for the currently selected PrecisionHW.
InsertInserts an item at position Index
IsFormatSupportedReturns true if current setting of SamplingFrequency, ChannelCount and PrecisionHW properties is valid for the selected device.
LoadFromStreamLoad the component from Src stream.
LoadTemplateFromFileLoad a template from file.
LoadTemplateFromStreamLoad a template from stream.
MatchInputsMatch the connections of Inputs with the component.
MonitorOutputReturns most current data, just to be played back.
MonitorOutputBufferThread safe method to obtain CoreAudio buffer for monitoring.
MoveChanges the position of an item in the Items array.
OutputBufferSkippedReturns number of output buffers skipped due to CPU overload.
Propagate (2)Propagates the settings of the component at SrcIndex to all other components.
PullDistribute Pull request to all objects in the list.
PullBufferCall to fill extended buffer exactly once from Inputs.
PullUntilEndCalls Pull until pipeEnd is returned.
RateConverterFilterDelayReturns rate conversion filter delay in number of samples.
RefillBuffers
RefreshDevices
RemoveDeletes the first reference to the Item parameter from the Items array.
RenumerateAssign consecutive numbers to individual items.
ResetReset is called after loading the data from stream or file.
RotateRotate the list up or down.
SaveTemplateToFileSave template to file.
SaveTemplateToStreamSave template to stream.
SaveToStreamSave the component to Dst stream.
StartStart the recording or playback.
StopStop the recording or playback.
StopGracefullyStop the recording or playback.
UpdateDistribute Update request to all objects in the list.
UpdateNotifyCall this method only, if SuspendNotifyUpdate is True.

Constants

NameTypeDescription
smplCountinteger