In This Topic ▼

SubTypeFriendlyName Property

Summary

This property is updated with a string that represents the video format type's friendly name.

Syntax

C++/CLI

public string SubTypeFriendlyName { get; }

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

Property Value

A string that represents the video format type's friendly name.

Remarks

This property is updated with a string that represents the video format type's friendly name. Use the CaptureCtrl.VideoCaptureFormats property to update the VideoFormats object with all of the video formats available for the current capture device. The VideoFormats indexer obtains a VideoFormat object for each of the supported video formats. The VideoFormat properties of each VideoFormat object, obtained using the VideoFormats indexer, are updated with information about that specific video format. This information includes the following information:

SubTypeName
SubTypeFriendlyName
Height property
Width property
Compression
BitCount

The height and width of the video format are contained in the Height property and the Width property, respectively. The Compression property is updated with the video compression information for the video format. The SubTypeName property is updated with the GUID of the video format type.

Example

using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
public bool _result = false; 
 
public void VideoFormatExample() 
{ 
   // reference the capture control 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
   int count, compression = 0, bits = 0, width = 0, height = 0; 
   int found, selected = -1; 
 
   // set a video device, use the name of your device here 
   if (capturectrl.VideoDevices["USB"] != null) 
      capturectrl.VideoDevices["USB"].Selected = true; 
 
   // reference the videoformats property 
   VideoFormats videoformats = capturectrl.VideoCaptureFormats; 
 
   try 
   { 
      // get count of available video formats 
      count = videoformats.Count; 
 
      // enumerate formats and select one 
      foreach (VideoFormat vf in videoformats) 
      { 
         // get the properties 
         bits = vf.BitCount; 
         compression = vf.Compression; 
         width = vf.Width; 
         height = vf.Height; 
 
         // select the format if it matches some criteria 
         if (bits == 16 && width == 640 && height == 480) 
         { 
            vf.Selected = true; 
            break; 
         } 
      } 
 
      // get the currently selected format 
      selected = videoformats.Selection; 
 
      string videoFormatSubTypeFriendlyName = videoformats[selected].SubTypeFriendlyName; 
      _form.Text = videoFormatSubTypeFriendlyName; 
 
      // find a format based on subtype name, width and height (YUY2 320 x 240 video) 
      found = videoformats.IndexOf(videoformats[selected].SubTypeName, 320, 240); 
 
      // our found format is not selected, so select it 
      if (found != selected) 
         videoformats.Selection = found; 
 
      // get the new selected format 
      selected = videoformats.Selection; 
 
      // set our result based on what we expect 
      _result = (count > 0 && selected == found); 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
}

Requirements

Target Platforms

Reference

VideoFormat Class

VideoFormat 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