In This Topic ▼

Mute Property

Summary

Gets or sets the audio stream mute state for the preview output.

Syntax

C++

public virtual bool Mute { get; set; }

Public Overridable Property Mute As Boolean

public: 
virtual property bool Mute { 
   bool get(); 
   void set (    bool ); 
}

Property Value

true if the audio stream is muted; false, otherwise.

Example

using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void CaptureAudioExample() 
{ 
   // reference the capture control 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
   // output file for capture 
   string outFile = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_CaptureAudioExample.mp3"); 
 
   try 
   { 
      // select a audio capture device 
      if (capturectrl.AudioDevices["USB"] == null) 
         throw new Exception("No USB audio device available"); 
 
      capturectrl.AudioDevices["USB"].Selected = true; 
 
      // set the audio compressor 
      capturectrl.AudioCompressors.AC3.Selected = true; 
 
      // set the target output file and format 
      capturectrl.TargetFile = outFile; 
      capturectrl.TargetFormat = TargetFormatType.MP3; 
 
      // unmute the audio, balanced and full volume 
      capturectrl.Mute = false; 
      capturectrl.Balance = 0; 
      capturectrl.Volume = 0; 
 
      // check whether we can capture audio 
      if (capturectrl.IsModeAvailable(CaptureMode.Audio)) 
      { 
         capturectrl.TimeLimit = 5;      // just 5 seconds of capture time 
         capturectrl.UseTimeLimit = true; 
 
         // start the capture process 
         capturectrl.StartCapture(CaptureMode.Audio); 
 
         // 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(); 
 
         // set the result 
         _result = File.Exists(outFile); 
      } 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string MediaDir = @"C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media"; 
}

Imports Leadtools 
Imports Leadtools.Multimedia 
Imports LeadtoolsMultimediaExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As CaptureCtrlForm = New CaptureCtrlForm() 
 
Public Sub CaptureAudioExample() 
   ' reference the capture control 
   Dim capturectrl As CaptureCtrl = _form.CaptureCtrl 
 
   ' output file for capture 
   Dim outFile As String = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_CaptureAudioExample.mp3") 
 
   Try 
      ' select a audio capture 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 audio compressor 
      capturectrl.AudioCompressors.AC3.Selected = True 
 
      ' set the target output file and format 
      capturectrl.TargetFile = outFile 
      capturectrl.TargetFormat = TargetFormatType.MP3 
 
      ' unmute the audio, balanced and full volume 
      capturectrl.Mute = False 
      capturectrl.Balance = 0 
      capturectrl.Volume = 0 
 
      ' check if we have can capture audio 
      If capturectrl.IsModeAvailable(CaptureMode.Audio) Then 
         capturectrl.TimeLimit = 5 ' just 5 seconds of capture time 
         capturectrl.UseTimeLimit = True 
 
         ' start the capture process 
         capturectrl.StartCapture(CaptureMode.Audio) 
 
         ' 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 
 
         ' set the result 
         _result = File.Exists(outFile) 
      End If 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media" 
End Class

Requirements

Target Platforms

Reference

CaptureCtrl Class

CaptureCtrl Members

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies