FriendlyName Property (AudioInput)

C#
Visual Basic
Objective-C
Java
C++

public string FriendlyName {get;}

'Declaration

Public ReadOnly Property FriendlyName As String

'Usage

Dim instance As AudioInput
Dim value As String
 
value = instance.FriendlyName

public:
property String^ FriendlyName {
   String^ get();
}

Property Value

The audio input friendly name.

The string obtained may be the same as that returned by the Name Property.

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Multimedia
Imports LeadtoolsMultimediaExamples.Fixtures

Public _result As Boolean = False
Public _form As CaptureCtrlForm = New CaptureCtrlForm()
Public Sub AudioInputsExample()
   Dim txtInfo As String = String.Empty

   ' reference the capture control
   Dim capturectrl As CaptureCtrl = _form.CaptureCtrl

   ' select an audio device, use your device name here instead of USB
   If capturectrl.AudioDevices("USB") Is Nothing Then
      Throw New Exception("No USB audio device available")
   End If

   capturectrl.AudioDevices("USB").Selected = True

   ' get the audio inputs object
   Dim audioinputs As AudioInputs = capturectrl.AudioInputs

   Try
      ' get master values
      txtInfo = String.Format("Enable state {0}" _
                              & Microsoft.VisualBasic.Constants.vbLf _
                              & "Loudness state {1}" _
                              & Microsoft.VisualBasic.Constants.vbLf _
                              & "Mixlevel value {2}" & Microsoft.VisualBasic.Constants.vbLf _
                              & "Mono state {3}" _
                              & Microsoft.VisualBasic.Constants.vbLf _
                              & "Pan value {4}" & Microsoft.VisualBasic.Constants.vbLf _
                              & "Bass value {5}" & Microsoft.VisualBasic.Constants.vbLf _
                              & "Bass range value {6}" & Microsoft.VisualBasic.Constants.vbLf _
                              & "Treble value {7}" & Microsoft.VisualBasic.Constants.vbLf _
                              & "Treble range value {8}" & Microsoft.VisualBasic.Constants.vbLf _
                              + Microsoft.VisualBasic.Constants.vbLf & "Are these values correct?", _
                              audioinputs.Enable, _
                              audioinputs.Loudness, _
                              audioinputs.MixLevel.ToString(), _
                              audioinputs.Mono, _
                              audioinputs.Pan.ToString(), _
                              audioinputs.Bass, _
                              audioinputs.BassRange, _
                              audioinputs.Treble, _
                              audioinputs.TrebleRange)

      ' display the named audio input properties
      _result = (MessageBox.Show(_form, txtInfo, "Test Verify", MessageBoxButtons.YesNo) = DialogResult.Yes)
   Catch e1 As Exception
      _result = False
   End Try

   ' we'll loop on the state and pump messages for this example.
   ' but you should not need to if running from a Windows Forms application.
   Do While capturectrl.State = CaptureState.Running
      Application.DoEvents()
   Loop
End Sub

using Leadtools;
using Leadtools.Multimedia;
using LeadtoolsMultimediaExamples.Fixtures;

public bool _result = false;
public CaptureCtrlForm _form = new CaptureCtrlForm();
public void AudioInputsExample()
{
   string txtInfo = string.Empty;

   // reference the capture control
   CaptureCtrl capturectrl = _form.CaptureCtrl;

   // select an audio device. use your device's name here instead of USB
   if (capturectrl.AudioDevices["USB"] == null)
      throw new Exception("No USB audio device available");

   capturectrl.AudioDevices["USB"].Selected = true;

   // get the audio inputs object
   AudioInputs audioinputs = capturectrl.AudioInputs;

   try
   {
      // get the master values
      txtInfo = string.Format("Enable state {0}\n" +
                              "Loudness state {1}\n" +
                              "Mixlevel value {2}\n" +
                              "Mono state {3}\n" +
                              "Pan value {4}\n" +
                              "Bass value {5}\n" +
                              "Bass range value {6}\n" +
                              "Treble value {7}\n" +
                              "Treble range value {8}\n\n" +
                              "Are these values correct?",
      audioinputs.Enable, audioinputs.Loudness, audioinputs.MixLevel.ToString(), audioinputs.Mono,
      audioinputs.Pan.ToString(), audioinputs.Bass, audioinputs.BassRange, audioinputs.Treble, audioinputs.TrebleRange);

      // display the named audio input properties
      _result = (MessageBox.Show(_form, txtInfo, "Test Verify", MessageBoxButtons.YesNo) == DialogResult.Yes);
   }
   catch (Exception)
   {
      _result = false;
   }

   // we'll loop on the state and pump messages for this example.
   // but you should not need to if running from a Windows Forms application.
   while (capturectrl.State == CaptureState.Running)
      Application.DoEvents();
}

Target Platforms

Reference

AudioInput Class
AudioInput Members