Click or drag to resize

Dmps3Microphone Class

A class to describe the DMPS3 specific microphones.
Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.DM
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public class Dmps3Microphone : DmMdMicrophone

The Dmps3Microphone type exposes the following members.

Properties
 NameDescription
Public propertyClipFeedBack Indicates that the mic signal level has exceeded 50% of the maximum level supported by the hardware, or 2dB below the input clip level. This signifies a mic level that is too hot.
(Inherited from DmMdMicrophone)
Public propertyCompressorAttack Sets the attack time, which is the time in milliseconds that it takes the compressor to start compressing after the threshold has been reached. Valid values range from 1 (0.1ms) to 250 (25ms), where 1 = 0.1ms.
(Inherited from DmMdMicrophone)
Public propertyCompressorAttackFeedBack Reports the attack time for compression.
(Inherited from DmMdMicrophone)
Public propertyCompressorDisableFeedBack Indicates that compression is disabled.
(Inherited from DmMdMicrophone)
Public propertyCompressorEnableFeedBack Indicates that compression is enabled.
(Inherited from DmMdMicrophone)
Public propertyCompressorHold Sets the compression hold, the time (in milliseconds), over which the compression will start after the signal crosses under the threshold. Valid values range from 1 to 200, where 1 = 1 ms.
(Inherited from DmMdMicrophone)
Public propertyCompressorHoldFeedBack Reports the compression hold.
(Inherited from DmMdMicrophone)
Public propertyCompressorRatio Sets the compression ratio, which controls the amount of gain reduction to apply when the mic signal level exceeds the threshold. For example, with a 2:1 ratio, for every 2 decibels the input signal increases, the output is allowed to increase only by 1 decibel. Valid values range from 1 (1:1) to 10 (10:1).
(Inherited from DmMdMicrophone)
Public propertyCompressorRatioFeedBack Reports the compression ratio.
(Inherited from DmMdMicrophone)
Public propertyCompressorRelease Sets the release time, which is the time over which the compressor will stop compressing after the signal crosses under the threshold, where 1 = 1ms. Valid values range from 1 (1ms) to 1000 (1000ms).
(Inherited from DmMdMicrophone)
Public propertyCompressorReleaseFeedBack Reports the release time for compression.
(Inherited from DmMdMicrophone)
Public propertyCompressorSoftKneeOffFeedBack Indicates that soft knee compression is disabled.
(Inherited from DmMdMicrophone)
Public propertyCompressorSoftKneeOnFeedBack Indicates that soft knee compression is enabled.
(Inherited from DmMdMicrophone)
Public propertyCompressorThreshold Sets the threshold for compression (gain reduction). Valid values range from -800 (-80dB) to 0 (0dB), where 1 = 0.1dB. Once the microphone signal exceeds the threshold, its gain is reduced by the specified compression ratio.
(Inherited from DmMdMicrophone)
Public propertyCompressorThresholdFeedBack Reports the compression threshold.
(Inherited from DmMdMicrophone)
Public propertyCompressorThresholdReachedFeedBack Indicates that the compression threshold has been reached.
(Inherited from DmMdMicrophone)
Public propertyDelay Sets the delay for the mic. Valid values range from 0 (0ms) to 850 (85ms), where 1 = 0.1ms.
Public propertyDelayFeedBack Indicates the audio delay.
Public propertyEqHighBandFrequency Specifies the frequency for the corresponding High Band. Valid frequency ranges are as follows: 3200 (3.2kHz) to 12800 (12.8kHz)
(Inherited from DmMdMicrophone)
Public propertyEqHighBandFrequencyFeedBack Reports the current high band frequency.
(Inherited from DmMdMicrophone)
Public propertyEqHighBandGain Specifies the gain for the High Band Valid values are -120 to 120.
(Inherited from DmMdMicrophone)
Public propertyEqHighBandGainFeedBack Reports the current high band gain.
(Inherited from DmMdMicrophone)
Public propertyEqHighMidBandFrequency Specifies the frequency for the corresponding High-Mid Band. Valid frequency ranges are as follows: 800 (800Hz) to 3200 (3.2kHz)
(Inherited from DmMdMicrophone)
Public propertyEqHighMidBandFrequencyFeedBack Reports the current high-mid band frequency.
(Inherited from DmMdMicrophone)
Public propertyEqHighMidBandGain Specifies the gain for the High-Mid Band Valid values are -120 to 120.
(Inherited from DmMdMicrophone)
Public propertyEqHighMidBandGainFeedBack Reports the current high-mid band gain.
(Inherited from DmMdMicrophone)
Public propertyEqLowBandFrequency Specifies the frequency for the Low Band. Valid frequency ranges are as follows: 50 (50Hz) to 200 (200Hz)
(Inherited from DmMdMicrophone)
Public propertyEqLowBandFrequencyFeedBack Reports the current low band frequency.
(Inherited from DmMdMicrophone)
Public propertyEqLowBandGain Specifies the gain for the Low Band Valid values are -120 to 120.
(Inherited from DmMdMicrophone)
Public propertyEqLowBandGainFeedBack Reports the current low band gain.
(Inherited from DmMdMicrophone)
Public propertyEqLowMidBandFrequency Specifies the frequency for the Low-Mid Band. Valid frequency ranges are as follows: 200 (200Hz) to 800 (800HZ)
(Inherited from DmMdMicrophone)
Public propertyEqLowMidBandFrequencyFeedBack Reports the current low-mid band frequency.
(Inherited from DmMdMicrophone)
Public propertyEqLowMidBandGain Specifies the gain for the Low-Mid Band Valid values are -120 to 120.
(Inherited from DmMdMicrophone)
Public propertyEqLowMidBandGainFeedBack Reports the current low-mid band gain.
(Inherited from DmMdMicrophone)
Public propertyGain Sets the source gain compensation. Valid analog values range from 0 (0dB) to 600 (60dB).
(Inherited from MicrophoneBase)
Public propertyGainFeedBack GainFeedBack : TODO Insert Comment Here.
(Inherited from MicrophoneBase)
Public propertyGateAttack Sets the time, in milliseconds, that it takes for the noise gate to fully open after the signal exceeds the GatingThreshold. This prevents short spikes in the input signal level, such as coughing, from opening the gate. Valid values range from 1 (1ms) to 250 (250ms).
(Inherited from DmMdMicrophone)
Public propertyGateAttackFeedBack Reports the gating attack.
(Inherited from DmMdMicrophone)
Public propertyGateDecayObsolete.
Sets the time, in milliseconds, over which the noise gate will close. This prevents the sound from stopping too abruptly—for example, during brief pauses in speech. Valid values range from 0 (0ms) to 5000 (5000ms, or 5s), with 1000 to 3000 (1s to 3s) being the most usable range.
(Inherited from DmMdMicrophone)
Public propertyGateDecayFeedBackObsolete.
Reports the gating decay.
(Inherited from DmMdMicrophone)
Public propertyGateDepth Sets the decibel level to go to when the gate is closed (1 = 0.1dB). Valid values range from -800 (-80dB, full mute) to 0 (0dB, minimum noise attenuation). Setting the depth above a full mute can help eliminate a swooping sound that can occur when the gate closes and opens.
(Inherited from DmMdMicrophone)
Public propertyGateDepthFeedBack Reports the gating depth.
(Inherited from DmMdMicrophone)
Public propertyGateDisableFeedBack Indicates that noise gating has been disabled.
(Inherited from DmMdMicrophone)
Public propertyGateEnableFeedBack Indicates that noise gating has been enabled.
(Inherited from DmMdMicrophone)
Public propertyGateHold Sets the gate hold time in milliseconds. The gate hold time over which the gate will close. Valid analog values range from 1 (1 ms) to 200 (200 ms).
(Inherited from DmMdMicrophone)
Public propertyGateHoldFeedBack Reports the current hold time in milliseconds.
(Inherited from DmMdMicrophone)
Public propertyGateLevelObsolete.
Sets the threshold for gating. The noise gate is enabled for as long as the gate is enabled. Valid values range from -800 (-80dB, full mute) to 0 (0dB). Once the microphone audio rises above the set GateLevel the gate opens, allowing the signal to pass through.
(Inherited from DmMdMicrophone)
Public propertyGateLevelFeedBackObsolete.
Indicates the gate level for the Mic/Line input.
(Inherited from DmMdMicrophone)
Public propertyGateRelease Sets the time, in milliseconds, over which the noise gate will close. This prevents the sound from stopping too abruptly—for example, during brief pauses in speech. Valid values range from 0 (0ms) to 5000 (5000ms, or 5s), with 1000 to 3000 (1s to 3s) being the most usable range.
(Inherited from DmMdMicrophone)
Public propertyGateReleaseFeedBack Reports the gating release/decay.
(Inherited from DmMdMicrophone)
Public propertyGateThreshold Sets the threshold for gating. The noise gate is enabled for as long as the gate is enabled. Valid values range from -800 (-80dB, full mute) to 0 (0dB). Once the microphone audio rises above the set GateLevel the gate opens, allowing the signal to pass through.
(Inherited from DmMdMicrophone)
Public propertyGateThresholdFeedBack Indicates the gate level for the Mic/Line input.
(Inherited from DmMdMicrophone)
Public propertyGatingFeedBack If true, Indicates if the noise gate is enabled.
(Inherited from DmMdMicrophone)
Public propertyHighPassFilterDisableFeedBack Indicates that the high pass filter has been disabled.
(Inherited from DmMdMicrophone)
Public propertyHighPassFilterEnableFeedBack Indicates that the high pass filter has been enabled.
(Inherited from DmMdMicrophone)
Public propertyID ID of this microphone.
(Inherited from MicrophoneBase)
Public propertyMicrophoneType The type of microphone available. See the IMicrophone interface for further details.
(Inherited from MicrophoneBase)
Public propertyMuteOffFeedBack Retrieve the mute off state for the specified microphone.
(Inherited from MicrophoneBase)
Public propertyMuteOnFeedBack Retrieve the mute on state for the specified microphone.
(Inherited from MicrophoneBase)
Public propertyName Get or Set the name of this microphone. This will modify the return value of the ToString method.
(Inherited from MicrophoneBase)
Public propertyNominalFeedBack Indicates that the mic signal level has exceeded the nominal level. The nominal indication is reported when the incoming mic signal is between -10dBFS and -30dBFS.
(Inherited from DmMdMicrophone)
Public propertyOwner Switcher that owns this Microphone
(Inherited from MicrophoneBase)
Public propertyPhantomPowerOffFeedBack Indicates that phantom power has been disabled.
(Inherited from DmMdMicrophone)
Public propertyPhantomPowerOnFeedBack Indicates that phantom power has been enabled.
(Inherited from DmMdMicrophone)
Public propertyVuFeedBack Reports the VU meter feedback value (volume of the audio source), when VU feedback is enabled. Reported values will range from 0 to 8.
(Inherited from DmMdMicrophone)
Top
Methods
 NameDescription
Public methodCompressorDisable Disables compression (gain reduction)
(Inherited from DmMdMicrophone)
Public methodCompressorEnable Enables compression (gain reduction)
(Inherited from DmMdMicrophone)
Public methodCompressorSoftKneeOff Enables the soft knee compression. The input only has an effect if compression is enabled. When soft knee compression is enabled, this signifies that compression will be applied gradually, depending on how far the signal is from the threshold. The slower onset can make the compression less noticeable, especially when using high compression ratios. When soft knee compression is disabled, this will apply normal (hard knee) compression. This signifies that as soon as the signal exceeds the threshold, compression is immediately applied at the specified ratio.
(Inherited from DmMdMicrophone)
Public methodCompressorSoftKneeOn Enables the soft knee compression. The input only has an effect if compression is enabled. When soft knee compression is enabled, this signifies that compression will be applied gradually, depending on how far the signal is from the threshold. The slower onset can make the compression less noticeable, especially when using high compression ratios. When soft knee compression is disabled, this will apply normal (hard knee) compression. This signifies that as soon as the signal exceeds the threshold, compression is immediately applied at the specified ratio.
(Inherited from DmMdMicrophone)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGateDisable Disables the noise gate.
(Inherited from DmMdMicrophone)
Public methodGateEnable Enables the noise gate.
(Inherited from DmMdMicrophone)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodHighPassFilterDisable Disable the high pass filter.
(Inherited from DmMdMicrophone)
Public methodHighPassFilterEnable Enable the high pass filter.
(Inherited from DmMdMicrophone)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodMuteOff Unmute the specified microphone.
(Inherited from MicrophoneBase)
Public methodMuteOn Mute the specified microphone.
(Inherited from MicrophoneBase)
Public methodPhantomPowerOff Disables the 48V phantom power supply. (Phantom power is required by condenser microphones, but should be disengaged for dynamic microphones.)
(Inherited from DmMdMicrophone)
Public methodPhantomPowerOn Enables the 48V phantom power supply. (Phantom power is required by condenser microphones, but should be disengaged for dynamic microphones.)
(Inherited from DmMdMicrophone)
Public methodToString The name of this particular microphone.
(Inherited from MicrophoneBase)
Top
Fields
 NameDescription
Protected field_ClipFeedBack Protected variable returned from ClipFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_CompressorAttack Protected variable returned from CompressorAttack property.
(Inherited from DmMdMicrophone)
Protected field_CompressorAttackFeedBack Protected variable returned from CompressorAttackFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_CompressorDisable Protected variable returned from CompressorDisable property.
(Inherited from DmMdMicrophone)
Protected field_CompressorDisableFeedBack Protected variable returned from CompressorDisableFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_CompressorEnable Protected variable returned from CompressorEnable property.
(Inherited from DmMdMicrophone)
Protected field_CompressorEnableFeedBack Protected variable returned from CompressorEnableFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_CompressorHold Protected variable returned from CompressorHold property.
(Inherited from DmMdMicrophone)
Protected field_CompressorHoldFeedBack Protected variable returned from CompressorHoldFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_CompressorRatio Protected variable returned from CompressorRatio property.
(Inherited from DmMdMicrophone)
Protected field_CompressorRatioFeedBack Protected variable returned from CompressorRatioFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_CompressorRelease Protected variable returned from CompressorRelease property.
(Inherited from DmMdMicrophone)
Protected field_CompressorReleaseFeedBack Protected variable returned from CompressorReleaseFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_CompressorSoftKneeOff Protected variable returned from CompressorSoftKneeOff property.
(Inherited from DmMdMicrophone)
Protected field_CompressorSoftKneeOffFeedBack Protected variable returned from CompressorSoftKneeOffFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_CompressorSoftKneeOn Protected variable returned from CompressorSoftKneeOn property.
(Inherited from DmMdMicrophone)
Protected field_CompressorSoftKneeOnFeedBack Protected variable returned from CompressorSoftKneeOnFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_CompressorThreshold Protected variable returned from CompressorThreshold property.
(Inherited from DmMdMicrophone)
Protected field_CompressorThresholdFeedBack Protected variable returned from CompressorThresholdFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_CompressorThresholdReachedFeedBack Protected variable returned from CompressorThresholdReachedFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_EqHighBandFrequency Protected variable returned from EqHighBandFrequency property.
(Inherited from DmMdMicrophone)
Protected field_EqHighBandFrequencyFeedBack Protected variable returned from EqHighBandFrequencyFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_EqHighBandGain Protected variable returned from EqHighBandGain property.
(Inherited from DmMdMicrophone)
Protected field_EqHighBandGainFeedBack Protected variable returned from EqHighBandGainFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_EqHighMidBandFrequency Protected variable returned from EqHighMidBandFrequency property.
(Inherited from DmMdMicrophone)
Protected field_EqHighMidBandFrequencyFeedBack Protected variable returned from EqHighMidBandFrequencyFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_EqHighMidBandGain Protected variable returned from EqHighMidBandGain property.
(Inherited from DmMdMicrophone)
Protected field_EqHighMidBandGainFeedBack Protected variable returned from EqHighMidBandGainFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_EqLowBandFrequency Protected variable returned from EqLowBandFrequency property.
(Inherited from DmMdMicrophone)
Protected field_EqLowBandFrequencyFeedBack Protected variable returned from EqLowBandFrequencyFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_EqLowBandGain Protected variable returned from EqLowBandGain property.
(Inherited from DmMdMicrophone)
Protected field_EqLowBandGainFeedBack Protected variable returned from EqLowBandGainFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_EqLowMidBandFrequency Protected variable returned from EqLowMidBandFrequency property.
(Inherited from DmMdMicrophone)
Protected field_EqLowMidBandFrequencyFeedBack Protected variable returned from EqLowMidBandFrequencyFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_EqLowMidBandGain Protected variable returned from EqLowMidBandGain property.
(Inherited from DmMdMicrophone)
Protected field_EqLowMidBandGainFeedBack Protected variable returned from EqLowMidBandGainFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_GateAttack Protected variable returned from GateAttack property.
(Inherited from DmMdMicrophone)
Protected field_GateAttackFeedBack Protected variable returned from GateAttackFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_GateDecay Protected variable returned from GateDecay property.
(Inherited from DmMdMicrophone)
Protected field_GateDecayFeedBack Protected variable returned from GateDecayFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_GateDepth Protected variable returned from GateDepth property.
(Inherited from DmMdMicrophone)
Protected field_GateDepthFeedBack Protected variable returned from GateDepthFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_GateDisable Protected variable returned from GateDisable property.
(Inherited from DmMdMicrophone)
Protected field_GateDisableFeedBack Protected variable returned from GateDisableFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_GateEnable Protected variable returned from GateEnable property.
(Inherited from DmMdMicrophone)
Protected field_GateEnableFeedBack Protected variable returned from GateEnableFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_GateHold Protected variable returned from GateHold property.
(Inherited from DmMdMicrophone)
Protected field_GateHoldFeedBack Protected variable returned from GateHoldFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_GateLevel Protected variable returned from GateLevel property.
(Inherited from DmMdMicrophone)
Protected field_GateLevelFeedBack Protected variable returned from GateLevelFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_GatingFeedBack Protected variable returned from GatingFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_HighPassFilterDisable Protected variable returned from HighPassFilterDisable property.
(Inherited from DmMdMicrophone)
Protected field_HighPassFilterDisableFeedBack Protected variable returned from HighPassFilterDisableFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_HighPassFilterEnable Protected variable returned from HighPassFilterEnable property.
(Inherited from DmMdMicrophone)
Protected field_HighPassFilterEnableFeedBack Protected variable returned from HighPassFilterEnableFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_NominalFeedBack Protected variable returned from NominalFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_PhantomPowerOff Protected variable returned from PhantomPowerOff property.
(Inherited from DmMdMicrophone)
Protected field_PhantomPowerOffFeedBack Protected variable returned from PhantomPowerOffFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_PhantomPowerOn Protected variable returned from PhantomPowerOn property.
(Inherited from DmMdMicrophone)
Protected field_PhantomPowerOnFeedBack Protected variable returned from PhantomPowerOnFeedBack property.
(Inherited from DmMdMicrophone)
Protected field_VuFeedBack Protected variable returned from VuFeedBack property.
(Inherited from DmMdMicrophone)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also