LEADTOOLS Multimedia (Leadtools.Multimedia assembly) Send comments on this topic. | Back to Introduction | Help Version 17.0.3.22
GetCacheObject Method
See Also 
Leadtools.Multimedia Namespace > TargetFormat Class : GetCacheObject Method



ObjType
Value that indicates which caching object to retrieve. This must be one of the TargetFormatObject constants.
ObjType
Value that indicates which caching object to retrieve. This must be one of the TargetFormatObject constants.
Gets the caching filter object.

Syntax

Visual Basic (Declaration) 
Public Function GetCacheObject( _
   ByVal ObjType As TargetFormatObject _
) As Object
Visual Basic (Usage)Copy Code
Dim instance As TargetFormat
Dim ObjType As TargetFormatObject
Dim value As Object
 
value = instance.GetCacheObject(ObjType)
C# 
public object GetCacheObject( 
   TargetFormatObject ObjType
)
C++/CLI 
public:
Object^ GetCacheObject( 
   TargetFormatObject ObjType
) 

Parameters

ObjType
Value that indicates which caching object to retrieve. This must be one of the TargetFormatObject constants.

Example

Visual BasicCopy Code
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
C#Copy Code
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, you should use your video device 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;
   }
}

Remarks

Use the UseFilterCache property to get a value that indicates whether the toolkit is currently caching filters; or set a value that indicates whether to enable or disable the caching of filters. Use the ShowCacheDialog method to display a specific property dialog for the caching filter. Use the HasCacheDialog method to query whether the specified property dialog for the caching filter is available. The user is responsible for releasing the retrieved caching filter object, when it is no longer needed.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also