BASS.NET API for the Un4seen BASS Audio LibraryEncoderMP3 ClassBASS.NET API for the Un4seen BASS Audio Library
Encoder class implementation for any generic MP3 command-line encoder tool using Un4seen.Bass.AddOn.Enc.
Inheritance Hierarchy

SystemObject
  Un4seen.Bass.MiscBaseEncoder
    Un4seen.Bass.MiscEncoderCMDLN
      Un4seen.Bass.MiscEncoderMP3

Namespace: Un4seen.Bass.Misc
Assembly: Bass.Net (in Bass.Net.dll) Version: 2.4.12.0
Syntax

[SerializableAttribute]
public class EncoderMP3 : EncoderCMDLN

The EncoderMP3 type exposes the following members.

Constructors

  NameDescription
Public methodEncoderMP3
Creates an instance of the generic MP3 command-line encoder implementation.
Top
Properties

  NameDescription
Public propertyChannelBitwidth
This property returns the actual bitwidth of the sample data of the channel (e.g. 8, 16, 32).
(Inherited from BaseEncoder.)
Public propertyChannelHandle
Gets or Sets the channel handle which is used to create the broadcast encoder class.
(Inherited from BaseEncoder.)
Public propertyChannelInfo
Returns the general channel info.
(Inherited from BaseEncoder.)
Public propertyChannelNumChans
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.)
Public propertyChannelSampleRate
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.)
Public propertyDefaultOutputExtension
This return the default extension of an output file for this encoder (e.g. ".wav"). Here the CMDLN_DefaultOutputExtension value is returned.
(Inherited from EncoderCMDLN.)
Public propertyEffectiveBitrate
Returns the effective encoder bitrate (in kbps) of the output. Here the CMDLN_Bitrate value is returned.
(Inherited from EncoderCMDLN.)
Public propertyEncoderCommandLine
Returns the specified command-line string to use. Depending on the CMDLN_UseVBR property the CMDLN_VBRString or the CMDLN_CBRString value is evaluated and all contained macros are replaced.
(Inherited from EncoderCMDLN.)
Public propertyEncoderDirectory
Gets or Sets the encoder's base directory.
(Inherited from BaseEncoder.)
Public propertyEncoderExists
This property return , if the specifiec command-line tool is availabel - else .
(Inherited from EncoderCMDLN.)
Public propertyEncoderHandle
Gets or sets the current HENCODE encoder handle.
(Inherited from BaseEncoder.)
Public propertyEncoderType
Gets a value indicating the type of content. Here the CMDLN_EncoderType value is returned.
(Inherited from EncoderCMDLN.)
Public propertyForce16Bit
Gets or Sets if a encoding in 16-bit sample data should be forced (default is ).
(Inherited from BaseEncoder.)
Public propertyInputFile
Gets or Sets the input file name to be processed by the encoder (null = STDIN, default).
(Inherited from BaseEncoder.)
Public propertyIsActive
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.)
Public propertyIsPaused
Gets a value indicating if the encoder has been paused (see Pause(Boolean)) - else must be returned.
(Inherited from BaseEncoder.)
Public propertyNoLimit
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.)
Public propertyOutputFile
Gets or Sets the output file name to be processed by the encoder (null = STDOUT, default).
(Inherited from BaseEncoder.)
Public propertySupportsSTDOUT
A command-line encoder might implement STDOUT, so here the CMDLN_SupportsSTDOUT value is returned.
(Inherited from EncoderCMDLN.)
Public propertyTAGs
Gets or Sets the TAG_INFO structure associated with the encoder.
(Inherited from BaseEncoder.)
Public propertyUseAsyncQueue
Gets or Sets if encoding should use an async queue (i.e. the BASS_ENCODE_QUEUE flag).
(Inherited from BaseEncoder.)
Top
Methods

  NameDescription
Public methodDispose
Implement IDisposable.
(Inherited from BaseEncoder.)
Protected methodFinalize
Finalization code.
(Inherited from BaseEncoder.)
Public methodPause
Pauses or resumes an encoder.
(Inherited from BaseEncoder.)
Public methodSettingsString
Returns the string representation of the current encoder settings.
(Overrides EncoderCMDLNSettingsString.)
Public methodStart
This method starts the actual command-line encoder. After the encoder was started successfully the EncoderHandle returns a valid HENCODE handle.
(Inherited from EncoderCMDLN.)
Public methodStop
Stops the encoder (if started).
(Inherited from BaseEncoder.)
Public methodStop(Boolean)
Stops the encoder (if started).
(Inherited from BaseEncoder.)
Public methodToString
Returns the name of the Encoder.
(Overrides EncoderCMDLNToString.)
Top
Fields

  NameDescription
Public fieldCMDLN_Bitrate
Gets or Sets the effective bitrate (in kbps) for the ${bps} and ${kbps} macro to be used with the CMDLN_CBRString resp. CMDLN_VBRString.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_CBRString
Gets or Sets the constant bitrate (CBR) command-line string to be used with the encoder (not containing the executable to be used, e.g. "-b ${bps} - output.xyz").
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_DefaultOutputExtension
Gets or Sets the default output extension to be used by the encoder (e.g. ".mp3").
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_EncoderType
Gets or Sets the BASSChannelType which will be supported by the encoder.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_Executable
Gets or Sets the command-line executable name to be used with the encoder (not containing the path, e.g. "encoder.exe").
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_Mode
Gets or Sets the ${mode} macro value to be used in the CMDLN_CBRString resp. CMDLN_VBRString.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_Option
Gets or Sets the ${option} macro value to be used in the CMDLN_CBRString resp. CMDLN_VBRString.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_ParamSTDIN
Gets or sets the ${input} parameter to be used with STDIN.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_ParamSTDOUT
Gets or sets the ${output} parameter to be used with STDOUT.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_Quality
Gets or Sets the ${quality} macro value to be used in the CMDLN_CBRString resp. CMDLN_VBRString.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_SupportsSTDOUT
Gets or Sets if the encoder supports output of the encoded data to STDOUT.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_UseA
Gets or Sets, if the CMDLN_UserA or the CMDLN_UserB macro string should be used.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_UseFP_24BIT
Gets or Sets if the encoder should be started using the FP_24BIT flag.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_UseFP_32BIT
Gets or Sets if the encoder should be started using the FP_32BIT flag.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_UseNOHEAD
Gets or Sets if the encoder should be started using the NOHEAD flag.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_UserA
Gets or Sets the ${user} macro value to be used in the CMDLN_CBRString resp. CMDLN_VBRString.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_UserB
Gets or Sets the ${user} macro value to be used in the CMDLN_CBRString resp. CMDLN_VBRString.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_UseVBR
Gets or Sets, if the CMDLN_CBRString or the CMDLN_VBRString command-line string should be used.
(Inherited from EncoderCMDLN.)
Public fieldCMDLN_VBRString
Gets or Sets the variable bitrate (VBR) command-line string to be used with the encoder (not containing the executable to be used, e.g. "-b ${bps} - output.xyz").
(Inherited from EncoderCMDLN.)
Top
Remarks

This class uses by default the BASS_CTYPE_STREAM_MP3 encoder type (DefaultOutputExtension is set to ".mp3").

This encoder is directly derived from EncoderCMDLN - so please take a look there for all other details.

See Also

Reference