In This Topic ▼

Volume Property

Summary

Gets or sets the volume level of the audio stream for the preview output.

Syntax

C++

public virtual int Volume { get; set; }

Public Overridable Property Volume As Integer

public: 
virtual property int Volume { 
   int get(); 
   void set (    int ); 
}

Property Value

A value representing the volume level.

Remarks

Allowed values range on a logarithmic scale from -10000 to 0. Divide the value by 100 to get the equivalent decibel value. Full volume is 0, and -10000 is silence. This property applied on the preview output only, the audio stream in the captured content will not be affected.

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:\LEADTOOLS21\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:\LEADTOOLS21\Media" 
End Class

Requirements

Target Platforms

Reference

CaptureCtrl Class

CaptureCtrl Members

Download our FREE evaluation

Help Version 21.0.2021.7.2

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies