IsValidCompressor Method

Summary

Gets a value that indicates if the specified compressor is valid for the currently selected target format.

Syntax
C#
VB
C++
public TargetFormatCompressor IsValidCompressor( 
   string Name 
) 
Public Function IsValidCompressor( _ 
   ByVal Name As String _ 
) As TargetFormatCompressor 
public: 
TargetFormatCompressor IsValidCompressor(  
   String^ Name 
)  

Parameters

Name
A String value representing the name of the Compressor to check for validity.

Return Value

An TargetFormatCompressor enumeration value indicating Invalid, Indeterminate, or Valid.

Remarks

Gets a value that indicates if the specified compressor is valid for the currently selected target format. This includes the file format, any special settings used by that format, and which audio and video codec is in the CaptureCtrl or ConvertCtrl parent object.

Example
C#
VB
using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void HasCacheDialogExample() 
{ 
   // reference the capture control 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
   try 
   { 
      // set a video device first.  use your video device's name here 
      if (capturectrl.VideoDevices["Analog"] == null) 
         throw new Exception("No Analog audio device available"); 
 
      capturectrl.VideoDevices["Analog"].Selected = true; 
 
      // set the video compressor 
      capturectrl.VideoCompressors.Mpeg2.Selected = true; 
 
      // reference the target formats collection 
      TargetFormat fmt = capturectrl.TargetFormats.MPEG2Program; 
 
      // enumerate through the list of formats 
      foreach (TargetFormat af in capturectrl.TargetFormats) 
      { 
         // check the formats valid compressor and stream type 
         bool isValid = (af.IsValidCompressor(capturectrl.VideoCompressors.Mpeg2.Name) == TargetFormatCompressor.Valid); 
         StreamFormatType types = af.Streams; 
 
         // if valid, select it 
         if (isValid && ((types & StreamFormatType.Video) == StreamFormatType.Video)) 
         { 
            fmt = af; 
            fmt.Selected = true; 
            break; 
         } 
      } 
 
      // check to see if the current target format has a cache dialog 
      if (fmt != null && fmt.HasCacheDialog(TargetFormatDlg.VideoCompressor)) 
      { 
         // show the dialog 
         fmt.ShowCacheDialog(TargetFormatDlg.VideoCompressor, _form); 
 
         // set the result 
         _result = true; 
      } 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
} 
Imports Leadtools 
Imports Leadtools.Multimedia 
Imports LeadtoolsMultimediaExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As CaptureCtrlForm = New CaptureCtrlForm() 
 
Public Sub HasCacheDialogExample() 
   ' reference the capture control 
   Dim capturectrl As CaptureCtrl = _form.CaptureCtrl 
 
   Try 
      ' set a video device first, you should use your video device name here 
      If capturectrl.VideoDevices("Analog") Is Nothing Then 
         Throw New Exception("No Analog audio device available") 
      End If 
 
      capturectrl.VideoDevices("Analog").Selected = True 
 
      ' set the video compressor 
      capturectrl.VideoCompressors.Mpeg2.Selected = True 
 
      ' reference the target formats collection 
      Dim fmt As TargetFormat = capturectrl.TargetFormats.MPEG2Program 
 
      ' enumerate through the list of formats 
      For Each af As TargetFormat In capturectrl.TargetFormats 
         ' check the formats valid compressor and stream type 
         Dim isValid As Boolean = (af.IsValidCompressor(capturectrl.VideoCompressors.Mpeg2.Name) = TargetFormatCompressor.Valid) 
         Dim types As StreamFormatType = af.Streams 
 
         ' if valid, select it 
         If isValid AndAlso ((types And StreamFormatType.Video) = StreamFormatType.Video) Then 
            fmt = af 
            fmt.Selected = True 
            Exit For 
         End If 
      Next af 
 
      ' check to see if the current target format has a cache dialog 
      If Not fmt Is Nothing AndAlso fmt.HasCacheDialog(TargetFormatDlg.VideoCompressor) Then 
         ' show the dialog 
         fmt.ShowCacheDialog(TargetFormatDlg.VideoCompressor, _form) 
 
         ' set the result 
         _result = True 
      End If 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub 

Requirements

Target Platforms

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Multimedia Assembly