BASS.NET API for the Un4seen BASS Audio LibraryEncoderMP3S MembersBASS.NET API for the Un4seen BASS Audio Library

The EncoderMP3S type exposes the following members.
Constructors

  NameDescription
Public methodEncoderMP3S
Creates an instance of a mp3sEncoder implementation.
Back to 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 BaseEncoder SettingsString .)
Public methodStart
This method starts the actual mp3sEncoder.
(Overrides BaseEncoder Start(ENCODEPROC, IntPtr, Boolean).)
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 OnlineObject ToString .)
Back to Top
Fields

  NameDescription
Public fieldMP3S_Bitrate
-b: Constant bitrate in kbps, default 128 kbps.
Public fieldMP3S_CustomOptions
The custom parameter string, which should be used, if the MP3S_UseCustomOptionsOnly property is set to  .
Public fieldMP3S_Mono
-mono: Create mono downmix from stereo input file before encoding? (default= ).
Public fieldMP3S_Quality
-q: Use high quality encoder setting? (default= ).
Public fieldMP3S_UseCustomOptionsOnly
Use the MP3S_CustomOptions parameter string only (default= ).
Public fieldMP3S_UseVBR
Use variable bitrate (VBR) (Default is  ).
Public fieldMP3S_VBRQuality
-m: Quality setting for VBR (default is High).
Public fieldMP3S_WriteVBRHeader
-vbri: Write a VBRI header? (Default is  ).
Back to 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 (".mp3").
(Overrides BaseEncoder DefaultOutputExtension.)
Public propertyEffectiveBitrate
Returns the effective encoder bitrate (in kbps) of the output.
(Overrides BaseEncoder EffectiveBitrate.)
Public propertyEncoderCommandLine
Gets the actual encoder command-line string (using all MP3S_xxx properties).
(Overrides BaseEncoder EncoderCommandLine.)
Public propertyEncoderDirectory
Gets or Sets the encoder's base directory.
(Inherited from BaseEncoder.)
Public propertyEncoderExists
This property return  , if the file "mp3sEncoder.exe" exists in the EncoderDirectory - else   is returned.
(Overrides BaseEncoder EncoderExists.)
Public propertyEncoderHandle
Gets or sets the current HENCODE encoder handle.
(Inherited from BaseEncoder.)
Public propertyEncoderType
Gets a value indicating the type of content. Here BASS_CTYPE_STREAM_MP3 is always returned.
(Overrides BaseEncoder EncoderType.)
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
Fraunhofer IIS MP3 Surround implements STDOUT, so   is always returned.
(Overrides BaseEncoder SupportsSTDOUT.)
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.)
Back to Top
See Also