AudioRecorder Class

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsScrollableControl
          System.Windows.FormsContainerControl
            System.Windows.FormsUserControl
              CSAudioRecorderAudioRecorder

Namespace: CSAudioRecorder
Assembly: CSAudioRecorder (in CSAudioRecorder.dll) Version: 1.0.1.0 (1.0.1.0)

Syntax

public class AudioRecorder : UserControl, 
	IDisposable

Public Class AudioRecorder
	Inherits UserControl
	Implements IDisposable

Dim instance As AudioRecorder

type AudioRecorder =  
    class
        inherit UserControl
        interface IDisposable
    end

public class AudioRecorder extends UserControl implements IDisposable

public class AudioRecorder extends UserControl implements IDisposable

CSAudioRecorder.AudioRecorder = function();

Type.createClass(
	'CSAudioRecorder.AudioRecorder',
	UserControl,
	IDisposable);

The AudioRecorder type exposes the following members.

Constructors

	Name	Description
	AudioRecorder	Constructor.

Top

Properties

	Name	Description
	ACMFormat	The selected ACM format of the selected ACM tag(for ACM encoding). The default format is 44.100 kHz, 16 Bit, Stereo.
	ACMTag	The selected ACM tag (for ACM encoding). The default tag is PCM.
	AudioSource	The audio device source.
	Bitrate	The bitrate of the destination audio file.
	BitrateVal	Set the bitrate of the destination audio file by value.
	Bits	The bit-depth of the destination audio file (for WAV format only).
	Channels	The channels of the destination audio file.
	DeleteEmptyRecordedFile	Delete or not a recorded file that empty in the end of the recording process
	DeviceIndex	The audio source device.
	FileName	The title tag of the opened multimedia file.
	Format	The format of the destination file, this can be AAC, ACM (WAV), APE, MP2, MP3, OGG, WAV (PCM), and WMA.
	IsRecording
	Latency	The audio source device.
	MessageArgs
	Mode	The mode of the capturing process. This can be WasapiLoopbackCapture (default), WasapiCapture or LineIn.
	ProgressArgs
	RatingStars	The rating stars of the opened multimedia file. This value can be 0 (unrated) to 5 (best).
	RatingUser	The user of the rating tag. The default value is: "Windows Media Player 9 Series".
	Samplerate	The samplerate of the destination audio file.
	SamplerateVal	The samplerate of the destination audio file by value.
	StartOnNoise	Start to record when noise is detected.
	StartOnNoiseVal	The noise value of the meter to start to record when noise is detected.
	StopOnSilence	Stop to record when silence is detected.
	StopOnSilenceSeconds	The number of seconds to detect the silence before stopping the record process.
	StopOnSilenceVal	The maximum noise value of the meter to start the timer to stop the record process.
	TagAlbum	The album name of the opened multimedia file.
	TagArtists	A list of strings for the TagArtists of the opened multimedia file.
	TagComment	The comment of the opened multimedia file.
	TagComposers	A list of strings for the TagComposers of the opened multimedia file.
	TagCopyright	The copyright of the opened multimedia file.
	TagGenres	A list of strings for the TagGenres of the opened multimedia file.
	TagLyrics	The lyrics of the opened multimedia file.
	TagPerformers	A list of strings for the TagPerformers of the opened multimedia file. In some cases this tag will be the TagArtists tag.
	TagRating	The rating value of the opened multimedia file. This value can be 0 (unrated) to 255 (best).
	TagTitle	The TagTitle tag of the opened multimedia file.
	TagTrack	The Track number of the opened multimedia file.
	TagYear	The created year of the opened multimedia file.
	TotalSizeIn	The total size of the recorded audio file. This will return the size in Bytes, KB, MB, GB, TB, PB, EB, ZB or YB.
	TotalTimeIn	The total time of the recorded audio file.
	UserKey	The user key.
	UserName	The user name.

Top

Methods

	Name	Description
	AddImageFromFile	Set the ID3 tags to the opened multimedia files.
	CheckLicense	Check the user license of the component.
	ClearAllTags	Clear all the tags of the selected multimedia file.
	ClearTag	Remove a tag type from the opened multimedia file.
	Dispose	Clean up any resources being used. (Overrides ContainerControlDispose(Boolean).)
	GetACMFormats	Get the ACM formats according to the ACMTag.
	GetACMTags	Get ACM tags according to the ACMFormat. You can also set the audio propitiates to get the best results according to the source audio file.
	GetBitrates	Get the supported bitrates to a list.
	GetBits	Get the supported bits to a list.
	GetChannels	Get the supported channels to a list.
	GetDeviceDefaultIndex	Get the default input device index. This works when the mode of the recorder is on WASAPI.
	GetDevices	Get the all audio devices that installed on the local machine according to the capture mode.
	GetEnumValue(Enum)	Get the value of the selected item of the Enum
	GetEnumValueT(String)	Get the value of the selected item of the Enum
	GetFormats	Get the supported formats to a list.
	GetModes	Get the supported recorder modes to a list.
	GetSamplerates	Get the supported samplerates to a list.
	OpenID3Tags	Open a multimedia file. You can add/get/set tags only after calling this function. The supported format are: avi, mp3, mpc, mp4, asf, aiff, aif, aifc, tta, wv, ogg, flac, spx, opus, ape, xiph, wma, jpg, jpeg, png, mpg, mpeg and many other multimedia files.
	Pause	Pause the record operation.
	RaiseError	Raise an error
	ResetFont	(Overrides Control.ResetFont.)
	SetID3Tags	Set the ID3 tags to the opened multimedia files.
	SizeSuffix
	Start	Start the record operation.
	Stop	Stop the record operation.
	UnPause	Unpause the record operation.

Top

Events

	Name	Description
	RecordDone
	RecordError
	RecordPaused
	RecordProgress
	RecordStart

Top

Fields

	Name	Description
	_audiorecoder

Top

Reference

CSAudioRecorder Namespace