FriendlyName Property (CaptureInput)

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public string FriendlyName {get;}

'Declaration
 
Public ReadOnly Property FriendlyName As String

'Usage
 
Dim instance As CaptureInput
Dim value As String
 
value = instance.FriendlyName

public string FriendlyName {get;}

 get_FriendlyName();

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

Property Value

String value of the capture input friendly name.

Gets the friendly name for the capture input. The string obtained is the same as that returned by the Name property.

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

Copy Code

Public _result As Boolean = False
Public _form As CaptureCtrlForm = New CaptureCtrlForm()
Public Sub CaptureInputsExample()
  Dim inputName, inputFriendlyName As String
  Dim selection As Integer

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

  ' select a video device, use your device name here instead of Analog
  If capturectrl.VideoDevices("Analog") Is Nothing Then
     Throw New Exception("No Analog video tuner device available")
  End If

  capturectrl.VideoDevices("Analog").Selected = True

  ' get the audio inputs object
  Dim inputs As CaptureInputs = capturectrl.VideoInputs

  Try
     ' select an input by name if possible
     If Not inputs("Video Composite") Is Nothing Then
       inputs("Video Composite").Selected = True
     End If

     ' get the current selected input
     selection = inputs.Selection

     For Each ci As CaptureInput In inputs
       ' get the inputs properties
       inputName = ci.Name
       inputFriendlyName = ci.FriendlyName

       ' if we found the video tuner input
       If inputFriendlyName = "Video Tuner" Then
         ' select it and break
         ci.Selected = True
         Exit For
       End If
     Next ci

     ' set the result to what we expect
     _result = (selection <> inputs.Selection)

  Catch e1 As Exception
     _result = False
  End Try
End Sub

public bool _result = false;
public CaptureCtrlForm _form = new CaptureCtrlForm();
public void CaptureInputsExample()
{
   string inputName, inputFriendlyName;
   int selection;

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

   // select a video device, use your device's name here instead of Analog
   if (capturectrl.VideoDevices["Analog"] == null)
      throw new Exception("No Analog video tuner device available");

   capturectrl.VideoDevices["Analog"].Selected = true;

   // get the audio inputs object
   CaptureInputs inputs = capturectrl.VideoInputs;

   try
   {
      // select an input by name if possible
      if (inputs["Video Composite"] != null)
         inputs["Video Composite"].Selected = true;

      // get the current selected input
      selection = inputs.Selection;

      foreach (CaptureInput ci in inputs)
      {
         // get the inputs properties
         inputName = ci.Name;
         inputFriendlyName = ci.FriendlyName;

         // if we found the video tuner input
         if (inputFriendlyName == "Video Tuner")
         {
            // select it and break
            ci.Selected = true;
            break;
         }
      }

      // set the result to what we expect
      _result = (selection != inputs.Selection);

   }
   catch (Exception)
   {
      _result = false;
   }
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

CaptureInput Class
CaptureInput Members