In This Topic ▼

FriendlyName Property

Summary

Gets the capture subtype's descriptive name.

Syntax

C++/CLI

public string FriendlyName { get; }

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

Property Value

String value of the capture subtype friendly name.

Remarks

Gets the capture subtype's descriptive name. The CaptureCtrl.VideoCaptureSubTypes property is a CaptureSubTypes object that contains all the subtypes available for the current capture device. The CaptureSubTypes collection contains an CaptureSubType object for each of the supported subtypes.

Example

using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void CaptureSubTypesExample() 
{ 
   string name, friendlyName; 
   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 
   CaptureSubTypes subTypes = capturectrl.VideoCaptureSubTypes; 
 
   // save the current subtype selection 
   selection = subTypes.Selection; 
 
   try 
   { 
      // select an capture subtype by name for MPEG2Video if available 
      if (subTypes[Constants.MEDIASUBTYPE_MPEG2Video] != null 
         && capturectrl.VideoCaptureStreamType == Constants.MEDIATYPE_Stream) 
      { 
         subTypes[Constants.MEDIASUBTYPE_MPEG2Video].Selected = true; 
      } 
      else // else try YUY2 
      if (subTypes[Constants.MEDIASUBTYPE_YUY2] != null) 
      { 
         subTypes[Constants.MEDIASUBTYPE_YUY2].Selected = true; 
      } 
 
      foreach (CaptureSubType cst in subTypes) 
      { 
         // get the subtype properties 
         name = cst.Name; 
         friendlyName = cst.FriendlyName; 
 
         // if we found the video tuner input 
         if (friendlyName == "YUY2") 
         { 
            // select it and break 
            cst.Selected = true; 
            break; 
         } 
      } 
 
      // set the result to what we expect 
      _result = (selection == subTypes.Selection); 
 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
}

Requirements

Target Platforms

Reference

CaptureSubType Class

CaptureSubType Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies