Class BassEnc_Ogg

BassEnc_Ogg is an extension to the BassEnc add-on that allows BASS channels to be Ogg Vorbis encoded, with support for OGGENC options.

Inheritance

Object

BassEnc_Ogg

Namespace: System.Dynamic.ExpandoObject

Assembly: ManagedBass.Enc.dll

Syntax

public static class BassEnc_Ogg : object

Properties

Version

Gets the Version of BassEnc_Ogg that is loaded.

Declaration

public static Version Version { get; }

Property Value

Version

Methods

Start(Int32, String, EncodeFlags, EncodeProcedure, IntPtr)

Start Ogg Encoding to EncodeProcedure.

Declaration

public static int Start(int Handle, string Options, EncodeFlags Flags, EncodeProcedure Procedure, IntPtr User)

Parameters

Int32 Handle The channel handle... a HSTREAM, HMUSIC, or HRECORD.

String Options Encoder options... null = use defaults. The following OGGENC style options are supported: -b / --bitrate, -m / --min-bitrate, -M / --max-bitrate, -q / --quality, -s / --serial, -t / --title, -a / --artist, -G / --genre, -d / --date, -l / --album, -N / --tracknum, -c / --comment. Anything else that is included will be ignored.

EncodeFlags Flags A combination of EncodeFlags.

EncodeProcedure Procedure Optional callback function to receive the encoded data... null = no callback.

IntPtr User User instance data to pass to the callback function.

Returns

Int32 The encoder handle is returned if the encoder is successfully started, else 0 is returned. Use LastError to get the error code

Remarks

EncodeStart(Int32, String, EncodeFlags, EncoderProcedure, IntPtr) is used internally to apply the encoder to the source channel, so the remarks in its documentation also apply to this function.

Platform-specific Ogg Vorbis encoding involves extensive floating-point operations, so it is not supported on platforms/architectures that do not have an FPU, eg. older ARM platforms/architectures.

Start(Int32, String, EncodeFlags, String)

Start Ogg Encoding to File.

Declaration

public static int Start(int Handle, string Options, EncodeFlags Flags, string FileName)

Parameters

Int32 Handle The channel handle... a HSTREAM, HMUSIC, or HRECORD.

String Options Encoder options... null = use defaults. The following OGGENC style options are supported: -b / --bitrate, -m / --min-bitrate, -M / --max-bitrate, -q / --quality, -s / --serial, -t / --title, -a / --artist, -G / --genre, -d / --date, -l / --album, -N / --tracknum, -c / --comment. Anything else that is included will be ignored.

EncodeFlags Flags A combination of EncodeFlags.

String FileName Output filename... null = no output file.

Returns

Int32 The encoder handle is returned if the encoder is successfully started, else 0 is returned. Use LastError to get the error code

Remarks

EncodeStart(Int32, String, EncodeFlags, EncoderProcedure, IntPtr) is used internally to apply the encoder to the source channel, so the remarks in its documentation also apply to this function.

Platform-specific Ogg Vorbis encoding involves extensive floating-point operations, so it is not supported on platforms/architectures that do not have an FPU, eg. older ARM platforms/architectures.