AIChannelCollection.CreateMicrophoneChannel Method (String, String, Double, Double, AITerminalConfiguration, AIExcitationSource, Double, String)
- Updated2023-02-21
- 2 minute(s) read
AIChannelCollectionCreateMicrophoneChannel Method (String, String, Double, Double, AITerminalConfiguration, AIExcitationSource, Double, String)
Namespace: NationalInstruments.DAQmx
Assembly: NationalInstruments.DAQmx (in NationalInstruments.DAQmx.dll) Version: 20.7.40.49302
Syntax
public AIChannel CreateMicrophoneChannel( string physicalChannelName, string nameToAssignChannel, double microphoneSensitivity, double maximumSoundPressureLevel, AITerminalConfiguration terminalConfiguration, AIExcitationSource currentExcitationSource, double currentExcitationValue, string customScaleName )
Public Function CreateMicrophoneChannel ( physicalChannelName As String, nameToAssignChannel As String, microphoneSensitivity As Double, maximumSoundPressureLevel As Double, terminalConfiguration As AITerminalConfiguration, currentExcitationSource As AIExcitationSource, currentExcitationValue As Double, customScaleName As String ) As AIChannel
Parameters
- physicalChannelName
- Type: SystemString
The names of one or more physical channels to use to create one or more local virtual channels. - nameToAssignChannel
- Type: SystemString
One or more names to assign to the created local virtual channels. To use the physical channel name as the local virtual channel name, set this value to Empty. - microphoneSensitivity
- Type: SystemDouble
The sensitivity of the microphone. Specify this value in millivolts per pascal. - maximumSoundPressureLevel
- Type: SystemDouble
The maximum instantaneous sound pressure level you expect to measure. This value is in decibels, referenced to 20 micropascals. - terminalConfiguration
- Type: NationalInstruments.DAQmxAITerminalConfiguration
The input terminal configuration. To use the default terminal configuration for the physical channel(s) being used, pass a value of -1 casted to an AITerminalConfiguration. - currentExcitationSource
- Type: NationalInstruments.DAQmxAIExcitationSource
The source of excitation. - currentExcitationValue
- Type: SystemDouble
The amount of excitation in amperes that the sensor requires. Refer to the sensor documentation to determine this value. - customScaleName
- Type: SystemString
The name of the custom scale to apply to the local virtual channel.
Return Value
Type: AIChannelThe newly created AIChannel.
Exceptions
| Exception | Condition |
|---|---|
| DaqException | The NI-DAQmx driver returned an error. |
Remarks
This method creates a local virtual channel for every physical channel name you specify. If you create multiple local virtual channels with one call to this method, you can specify a comma-delimited list of names for nameToAssignChannel. If you provide fewer local virtual channel names in nameToAssignChannel than you create, NI-DAQmx automatically assigns names to the local virtual channels.
If you do not provide a value for nameToAssignChannel, NI-DAQmx uses the physicalChannelName as the local virtual channel name. If you use nameToAssignChannel to create a name for the local virtual channel, you must use this name in other properties and methods.
The NI-DAQmx driver does not determine if the requested settings are possible until the task is verified. CreateMicrophoneChannel(String, String, Double, Double, AITerminalConfiguration, AIExcitationSource, Double, String) does not throw an exception for parameter values that are not compatible with your hardware or other settings in your task. To determine if all of the settings for a Task are valid, you must verify the task by starting the task, either with Start or by reading from or writing to the task, or by calling Control(TaskAction) with Verify.