AudioPlayer Class

Inheritance Hierarchy

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

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

Syntax

public class AudioPlayer : UserControl

Public Class AudioPlayer
	Inherits UserControl

Dim instance As AudioPlayer

type AudioPlayer =  
    class
        inherit UserControl
    end

public class AudioPlayer extends UserControl

public class AudioPlayer extends UserControl

CSAudioPlayer.AudioPlayer = function();

Type.createClass(
	'CSAudioPlayer.AudioPlayer',
	UserControl);

The AudioPlayer type exposes the following members.

Constructors

	Name	Description
	AudioPlayer	Constructor.

Top

Properties

	Name	Description
	AudioDevice	Play to the selected audio device index.
	Bits	The bit-depth of the destination audio file (for WAV format only).
	Channels	The number of channels of the destination audio file.
	DecodeMode	The decoding mode of the operation. This can be from local codecs or by using the FFMpeg libraries.
	DriveIndex
	FileName	The multimedia file name and path to play.
	Length	The time length of the media file.
	MessageArgs
	Mode	The mode of the capturing process.
	PlaybackState	The state of the player.
	Position	The position of the player.
	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.
	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.
	TrackIndex
	UserKey	The user key.
	UserName	The user name.
	Volume	The volume of the player.

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).)
	GetBits	Get the supported bits to a list.
	GetChannels	Get the supported channels to a list.
	GetDecoderModes	Get the supported player modes to a list.
	GetDeviceDefaultIndex	Get the default output device index. This works when the mode is WASAPI, LineOut will return always 0.
	GetDevices	Get all the output devices that installed on the local system.
	GetEnumValue(Enum)	Get the value of the selected item of the Enum
	GetEnumValueT(String)	Get the value of the selected item of the Enum
	GetFFMpegFormatsT	Get all the supported formats, codecs and extensions of the FFMpeg library.
	GetPlayerModes	Get the supported player modes to a list.
	GetSamplerates	Get the supported samplerates to a list.
	Open
	Pause
	Play
	ResetFont	(Overrides Control.ResetFont.)
	Resume
	SetID3Tags	Set the ID3 tags to the opened multimedia files.
	Stop	Stop the playing operation.

Top

Events

	Name	Description
	PlayDone
	PlayError
	PlayPaused
	PlayProgress
	PlayStart
	PlayStopped

Top

Fields

	Name	Description
	_audioplayer
	_length

Top

Reference

CSAudioPlayer Namespace