In This Topic ▼

CopyTo Method

Summary

Copies the items of the collection to an AudioFormat array.

Syntax

C++

public void CopyTo( 
   AudioFormat[] array, 
   int arrayIndex 
)

Public Sub CopyTo( _ 
   ByVal array() As AudioFormat, _ 
   ByVal arrayIndex As Integer _ 
)

public: 
void CopyTo(  
   array<AudioFormat^>^ array, 
   int arrayIndex 
)

Parameters

array
The one-dimensional, zero-based array that is the destination of the items to be copied from the collection.

arrayIndex
The zero-based index in the destination array at which copying begins.

Exceptions

Exception	Description
System.ArgumentNullException	The exception that is thrown when a null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
System.ArgumentOutOfRangeException	The exception that is thrown when the value of an argument is outside the allowable range of values as defined by the invoked method.
System.ArgumentException	The exception that is thrown when one of the arguments provided to a method is not valid.

Remarks

The elements are copied to the array in the same order in which they are found in the collection and the collection will start at the specified index.

Example

using Leadtools; 
using Leadtools.MediaFoundation; 
using LeadtoolsMediaFoundationExamples.Fixtures; 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void CopyToExample() 
{ 
   // reference the capture control and it's audio formats 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
   try 
   { 
      // set an audio device first, you should use your audio device name here 
      if (capturectrl.AudioDevices["USB"] == null) 
         throw new Exception("No USB audio device available"); 
 
      capturectrl.AudioDevices["USB"].Selected = true; 
 
      // reference the audio formats collection 
      AudioFormats audioformats = capturectrl.AudioCaptureFormats; 
 
      // allocate a new array for the copied audio formats 
      AudioFormat[] copiedFormats = new AudioFormat[audioformats.Count]; 
 
      // copy them 
      audioformats.CopyTo(copiedFormats, 0); 
 
      // set the result to what we expect 
      _result = (copiedFormats.Length == audioformats.Count); 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
}

Imports Leadtools 
Imports Leadtools.MediaFoundation 
Imports LeadtoolsMediaFoundationExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As CaptureCtrlForm = New CaptureCtrlForm() 
 
Public Sub CopyToExample() 
   ' reference the capture control and it's audio formats 
   Dim capturectrl As CaptureCtrl = _form.CaptureCtrl 
 
   Try 
      ' set an audio device first, you should use your audio device name here 
      If capturectrl.AudioDevices("USB") Is Nothing Then 
         Throw New Exception("No USB audio device available") 
      End If 
 
      capturectrl.AudioDevices("USB").Selected = True 
 
      ' reference the audio formats collection 
      Dim audioformats As AudioFormats = capturectrl.AudioCaptureFormats 
 
      ' allocate a new array for the copied audio formats 
      Dim copiedFormats As AudioFormat() = New AudioFormat(audioformats.Count - 1) {} 
 
      ' copy them 
      audioformats.CopyTo(copiedFormats, 0) 
 
      ' set the result to what we expect 
      _result = (copiedFormats.Length = audioformats.Count) 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub

Requirements

Target Platforms

Reference

AudioFormats Class

AudioFormats Members

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools.MediaFoundation Assembly

Introduction

Getting Started

Namespaces

Leadtools.MediaFoundation Namespace

Leadtools.MediaFoundation.Common Namespace

Assemblies