EncoderBassEnc_Mp3 Class

[SerializableAttribute]
public class EncoderBassEnc_Mp3 : BaseEncoder

<SerializableAttribute>
Public Class EncoderBassEnc_Mp3
	Inherits BaseEncoder

The EncoderBassEnc_Mp3 type exposes the following members.

	Name	Description
	EncoderBassEnc_Mp3	Creates an instance of the BassEnc_Mp3 encoder implementation.

	Name	Description
	ChannelBitwidth	This property returns the actual bitwidth of the sample data of the channel (e.g. 8, 16, 32). (Inherited from BaseEncoder.)
	ChannelHandle	Gets or Sets the channel handle which is used to create the broadcast encoder class. (Inherited from BaseEncoder.)
	ChannelInfo	Returns the general channel info. (Inherited from BaseEncoder.)
	ChannelNumChans	This property returns the actual number of channles of the sample data BASS is using with the channel (e.g. 1=mono, 2=stereo, etc.). (Inherited from BaseEncoder.)
	ChannelSampleRate	This property returns the actual sample rate in Hz of the sample data BASS is using with the channel (e.g. 44100). (Inherited from BaseEncoder.)
	DefaultOutputExtension	This return the default extension of an output file for this encoder (".mp3"). (Overrides BaseEncoderDefaultOutputExtension.)
	EffectiveBitrate	Returns the effective encoder bitrate (in kbps) of the output. (Overrides BaseEncoderEffectiveBitrate.)
	EncoderCommandLine	Gets the actual encoder command-line string (using all LAME_xxx properties). (Overrides BaseEncoderEncoderCommandLine.)
	EncoderDirectory	Gets or Sets the encoder's base directory. (Inherited from BaseEncoder.)
	EncoderExists	This property always return . (Overrides BaseEncoderEncoderExists.)
	EncoderHandle	Gets or sets the current HENCODE encoder handle. (Inherited from BaseEncoder.)
	EncoderType	Gets a value indicating the type of content. Here BASS_CTYPE_STREAM_MP3 is always returned. (Overrides BaseEncoderEncoderType.)
	Force16Bit	Gets or Sets if a encoding in 16-bit sample data should be forced (default is ). (Inherited from BaseEncoder.)
	InputFile	Gets or Sets the input file name to be processed by the encoder (null = STDIN, default). (Inherited from BaseEncoder.)
	IsActive	Gets a value indicating if the encoder has been started (see Start(ENCODEPROC, IntPtr, Boolean)) and is active - else will be returned. (Inherited from BaseEncoder.)
	IsPaused	Gets a value indicating if the encoder has been paused (see Pause(Boolean)) - else must be returned. (Inherited from BaseEncoder.)
	IsStreaming	Is this instance used for streaming? When set to true, some internal encoder options might be set. Default is false. (Inherited from BaseEncoder.)
	NoLimit	Gets or Sets if encoding should use the CAST_NOLIMIT flag (which is only needed, if the encoder is used for streaming). (Inherited from BaseEncoder.)
	OutputFile	Gets or Sets the output file name to be processed by the encoder (null = STDOUT, default). (Inherited from BaseEncoder.)
	SupportsSTDOUT	LAME implements STDOUT, so is always returned. (Overrides BaseEncoderSupportsSTDOUT.)
	TAGs	Gets or Sets the TAG_INFO structure associated with the encoder. (Inherited from BaseEncoder.)
	UseAsyncQueue	Gets or Sets if encoding should use an async queue (i.e. the BASS_ENCODE_QUEUE flag). (Inherited from BaseEncoder.)

	Name	Description
	Dispose	Implement IDisposable. (Inherited from BaseEncoder.)
	Finalize	Finalization code. (Inherited from BaseEncoder.)
	Pause	Pauses or resumes an encoder. (Inherited from BaseEncoder.)
	SettingsString	Returns the string representation of the current encoder settings. (Overrides BaseEncoderSettingsString.)
	Start	This method starts the actual LibMP3Lame encoder. (Overrides BaseEncoderStart(ENCODEPROC, IntPtr, Boolean).)
	Stop	Stops the encoder immediately (if started). (Inherited from BaseEncoder.)
	Stop(Boolean)	Stops the encoder (if started). (Inherited from BaseEncoder.)
	ToString	Returns the name of the Encoder. (Overrides ObjectToString.)

	Name	Description
	LAME_ABRBitrate	--abr: Specify average target bitrate in kbps desired (instead of quality). Set to 0, if this option should be disabled (default).
	LAME_Bitrate	-b: Constant (or minimum allowed) bitrate in kbps, default 128 kbps.
	LAME_CustomOptions	The custom parameter string, which should be used, if the LAME_UseCustomOptionsOnly property is set to .
	LAME_LimitVBR	Use variable bitrate (VBR) limitation (Default is ).
	LAME_Mode	-m: The encoding mode (stereo, joint stereo, mono etc.).
	LAME_PresetName	--preset: Preset name must be "medium", "standard", "extreme", "insane" or a value for an average desired bitrate and depending on the value specified, appropriate quality settings will be used.
	LAME_Protect	-p: error protection. Adds 16-bit checksum to every frame (default=).
	LAME_Quality	-q: Noise shaping and psycho acoustic algorithms (default is Quality).
	LAME_ReplayGain	--replaygain: ReplayGain analysis (Default is None).
	LAME_TargetSampleRate	--resample: target sampling frequency of output (in Hz). Set to 0 (zero) to use automatic resampling (default).
	LAME_UseCustomOptionsOnly	Use the LAME_CustomOptions parameter string only (default=).
	LAME_UseVBR	Use variable bitrate (VBR) (Default is ).
	LAME_VBRDisableTag	-t: disable writing VBR LAME Tag? (Default is ).
	LAME_VBRMaxBitrate	Specify maximum allowed bitrate in kbps, default 320 kbps.
	LAME_VBRQuality	-V: Quality setting for VBR (default is VBR_Q4).

BASSenc_MP3 (bassenc_mp3.dll) must be available.

MP3 encoding is based on libmp3lame, Copyright (C) 1999-2017 The LAME Project: lame.sourceforge.net

libmp3lame is under the LGPL v2 licence: www.gnu.org/licenses/lgpl-2.0.html

This implementation uses the automatic DSP system for encoding. Meaning the sending of sample data to the encoder is done automatically when you play the channel (BASS_ChannelPlay(Int32, Boolean)) or call BASS_ChannelGetData(Int32, IntPtr, Int32) (if it's a decoding channel). So there is no need to call BASS_Encode_Write(Int32, IntPtr, Int32) manually!

If you simply want to encode a physical file please also take a look to the EncodeFile(String, String, BaseEncoder, BaseEncoderENCODEFILEPROC, Boolean, Boolean).

Reference