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



Gets the selected preview audio processor collection object.

Syntax

Visual Basic (Declaration) 
Public ReadOnly Property PreviewAudioProcessors As AudioProcessors
Visual Basic (Usage)Copy Code
Dim instance As CaptureCtrl
Dim value As AudioProcessors
 
value = instance.PreviewAudioProcessors
C# 
public AudioProcessors PreviewAudioProcessors {get;}
C++/CLI 
public:
property AudioProcessors^ PreviewAudioProcessors {
   AudioProcessors^ get();
}

Property Value

A Leadtools.Multimedia.CaptureCtrl.AudioProcessors collection object representing the available preview audio processors.

Example

Visual BasicCopy Code
Public _result As Boolean = False
      Public _form As CaptureCtrlForm = New CaptureCtrlForm()
      Public Sub ProcessorsExample()
         Dim capturectrl As CaptureCtrl = _form.CaptureCtrl
         Dim outFile As String = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_ProcessorsExample.avi")

         Try
            ' try to find a USB camera
            If capturectrl.VideoDevices("USB") Is Nothing Then
               Throw New Exception("No USB video device available")
            End If

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

            ' try to find a USB audio device
            If capturectrl.AudioDevices("USB") Is Nothing Then
               Throw New Exception("No USB audio device available")
            End If

            capturectrl.AudioDevices("USB").Selected = True

            ' set the video processor to the Dizzy filter 
            capturectrl.SelectedVideoProcessors.Add(capturectrl.VideoProcessors.EFXDizzy)
            Dim vproc As Processor = capturectrl.SelectedVideoProcessors.EFXDizzy

            ' set the audio processor to the Chorus filter 
            capturectrl.SelectedAudioProcessors.Add(capturectrl.AudioProcessors.Chorus)
            Dim aproc As Processor = capturectrl.SelectedAudioProcessors.Chorus

            ' set the video processor properties
            If vproc.HasDialog(ProcessorDlg.Properties) Then
               vproc.ShowDialog(ProcessorDlg.Properties, _form)
            End If

            ' set the audio processor properties
            If aproc.HasDialog(ProcessorDlg.Properties) Then
               aproc.ShowDialog(ProcessorDlg.Properties, _form)
            End If

            ' set MPEG2 as the video compressor
            capturectrl.VideoCompressors.Mpeg2.Selected = True

            ' set AC3 as the audio compressor
            capturectrl.AudioCompressors.AC3.Selected = True

            ' set the target output file and format
            capturectrl.TargetFile = outFile

            ' set the target output format
            capturectrl.TargetFormat = TargetFormatType.AVI

            ' check if we have can capture video
            If capturectrl.IsModeAvailable(CaptureMode.VideoAndAudio) Then
               capturectrl.FrameRate = 5 ' 5 frames per second
               capturectrl.UseFrameRate = True
               capturectrl.TimeLimit = 10 ' just 10 seconds of capture time
               capturectrl.UseTimeLimit = True

               ' subscribte to the compete event
               AddHandler capturectrl.Complete, AddressOf CaptureCtrl_Complete

               ' start the capture process
               capturectrl.StartCapture(CaptureMode.VideoAndAudio)

               ' we'll loop on the state and pump messages for this example.
               ' but you should not need to if running from a Windows Forms application.
               Do While capturectrl.State = CaptureState.Running
                  Application.DoEvents()
               Loop
            End If
         Catch e1 As Exception
            _result = False
         End Try
      End Sub

      Public Sub CaptureCtrl_Complete(ByVal sender As Object, ByVal e As EventArgs)
         ' set result
         _result = True
      End Sub

Public NotInheritable Class LEAD_VARS
   Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 17\Media"
End Class
C#Copy Code
public bool _result = false;
      public CaptureCtrlForm _form = new CaptureCtrlForm();
      public void ProcessorsExample()
      {
         CaptureCtrl capturectrl = _form.CaptureCtrl;
         string outFile = Path.Combine(LEAD_VARS.MediaDir,"CaptureCtrl_ProcessorsExample.avi");

         try
         {
            // try to find a USB camera
            if (capturectrl.VideoDevices["USB"] == null)
               throw new Exception("No USB video device available");

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

            // try to find a USB audio device
            if (capturectrl.AudioDevices["USB"] == null)
               throw new Exception("No USB audio device available");

            capturectrl.AudioDevices["USB"].Selected = true;

            // set the video processor to the Dizzy filter 
            capturectrl.SelectedVideoProcessors.Add(capturectrl.VideoProcessors.EFXDizzy);
            Processor vproc = capturectrl.SelectedVideoProcessors.EFXDizzy;

            // set the audio processor to the Chorus filter 
            capturectrl.SelectedAudioProcessors.Add(capturectrl.AudioProcessors.Chorus);
            Processor aproc = capturectrl.SelectedAudioProcessors.Chorus;

            // set the video processor properties
            if (vproc.HasDialog(ProcessorDlg.Properties))
               vproc.ShowDialog(ProcessorDlg.Properties, _form);

            // set the audio processor properties
            if (aproc.HasDialog(ProcessorDlg.Properties))
               aproc.ShowDialog(ProcessorDlg.Properties, _form);

            // set MPEG2 as the video compressor
            capturectrl.VideoCompressors.Mpeg2.Selected = true;

            // set AC3 as the audio compressor
            capturectrl.AudioCompressors.AC3.Selected = true;

            // set the target output file and format
            capturectrl.TargetFile = outFile;

            // set the target output format
            capturectrl.TargetFormat = TargetFormatType.AVI;

            // check if we have can capture video
            if (capturectrl.IsModeAvailable(CaptureMode.VideoAndAudio))
            {
               capturectrl.FrameRate = 5;       // 5 frames per second 
               capturectrl.UseFrameRate = true;
               capturectrl.TimeLimit = 10;      // just 10 seconds of capture time
               capturectrl.UseTimeLimit = true;

               // subscribte to the compete event
               capturectrl.Complete += new EventHandler(CaptureCtrl_Complete);

               // start the capture process
               capturectrl.StartCapture(CaptureMode.VideoAndAudio);

               // we'll loop on the state and pump messages for this example.
               // but you should not need to if running from a Windows Forms application.
               while (capturectrl.State == CaptureState.Running)
                  Application.DoEvents();
            }
         }
         catch (Exception)
         {
            _result = false;
         }
      }

      public void CaptureCtrl_Complete(object sender, EventArgs e)
      {
         // set result
         _result = true;
      }

static class LEAD_VARS
{
   public const string MediaDir = @"C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 17\Media";
}

Remarks

This AudioProcessors collection is used for preview audio playback. Use of processors as preview processors will not affect the final captured audio output. The Leadtools.Multimedia.CaptureCtrl.AudioProcessors object is used to enumerate all available audio processing filters. .

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