EncoderOGG Class

[SerializableAttribute]
public sealed class EncoderOGG : BaseEncoder

<SerializableAttribute>
Public NotInheritable Class EncoderOGG
	Inherits BaseEncoder

The EncoderOGG type exposes the following members.

	Name	Description
	EncoderOGG	Creates an instance of a OGG 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 (".ogg"). (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 OGG_xxx properties). (Overrides BaseEncoderEncoderCommandLine.)
	EncoderDirectory	Gets or Sets the encoder's base directory. (Inherited from BaseEncoder.)
	EncoderExists	This property return , if the file "oggenc2.exe" exists in the EncoderDirectory - else is returned. (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_OGG 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	"oggenc2.exe" 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.)
	Kbps2Quality	Converts a bitrate (between 32 kbps and 498 kbps) to an approx. quality level.
	Pause	Pauses or resumes an encoder. (Inherited from BaseEncoder.)
	Quality2Kbps	Converts a quality setting (between -2.0 and 10.0) to an approx. bitrate (in kbps).
	SettingsString	Returns the string representation of the current encoder settings. (Overrides BaseEncoderSettingsString.)
	Start	This method starts the actual OGG 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
	OGG_Bitrate	-b: Choose a nominal bitrate to encode at. Attempt to encode at a bitrate averaging this. Takes an argument in kbps.
	OGG_Converter	-S: Specify the resampling engine to be used. Options are: Best, Medium (default) and Fast.
	OGG_CustomOptions	The custom parameter string, which should be used, if the OGG_UseCustomOptionsOnly property is set to .
	OGG_Downmix	--downmix: Downmix from stereo to mono? (default is ).
	OGG_MaxBitrate	-M: Specify a maximum bitrate in kbps. Useful for streaming applications. If set to 0 (zero, default) this property is not evaluated!
	OGG_MinBitrate	-m: Specify a minimum bitrate (in kbps). Useful for encoding for a fixed-size channel. If set to 0 (zero, default) this property is not evaluated!
	OGG_Quality	-q: Specify quality between -2 (low) and 10 (high) (default=4), instead of specifying a particular bitrate (OGG_Bitrate).
	OGG_Scale	--scale: Scale input data to n (n = between 0.00 and 1.00, multiply PCM data). Set to 1.0 (default) for no scaling.
	OGG_TargetSampleRate	--resample: target sampling frequency of output (in Hz). Set to 0 (zero) if you don't want to do any resampling (default).
	OGG_UseCustomOptionsOnly	Use the OGG_CustomOptions parameter string only (default=).
	OGG_UseManagedBitrate	--managed: Enable the bitrate management engine. This will allow much greater control over the precise bitrate(s) used, but encoding will be much slower. Don't use it unless you have a strong need for detailed control over bitrate, such as for streaming.
	OGG_UseQualityMode	Use Quality-Mode? (default is ).

"oggenc2.exe" must be downloaded separately (e.g. from www.rarewares.org or www.vorbis.com).

Since "oggenc2.exe" does support 8/, 16/ and 32-bit(IEEE float) sample data as input, no BASS_ENCODE_FP_ flag will be used.

Make sure to set the OGG_xxx flags before retrieving the EncoderCommandLine or calling Start(ENCODEPROC, IntPtr, Boolean).

There are several versions of "oggenc.exe" or "oggenc2.exe" out there (some are highly optimized for SSE etc.). This encoder implementation tries to support the latest version 2.x set of parameters. If you downloaded another OGG-Vorbis encoder version, just try it out and simply make sure that you rename the executable to "oggenc2.exe".

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