BaseEncoderEncodeFile Method (String, String, BaseEncoder, BaseEncoderENCODEFILEPROC, Boolean, Boolean)

BASS.NET API for the Un4seen BASS Audio Library

Encodes a given input file to a given output file using the specified encoder.

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

Syntax

public static bool EncodeFile(
	string inputFile,
	string outputFile,
	BaseEncoder encoder,
	BaseEncoderENCODEFILEPROC proc,
	bool overwriteOutput,
	bool deleteInput
)

Public Shared Function EncodeFile ( 
	inputFile As String,
	outputFile As String,
	encoder As BaseEncoder,
	proc As BaseEncoderENCODEFILEPROC,
	overwriteOutput As Boolean,
	deleteInput As Boolean
) As Boolean

Parameters

inputFile: Type: SystemString
The input filename to encode (must exist).
outputFile: Type: SystemString
The target output filename (if , the filename will be composed by changing the file extension to the DefaultOutputExtension).
encoder: Type: Un4seen.Bass.MiscBaseEncoder
The encoder to be used (make sure you set all the parameter members of the encoder before).
proc: Type: Un4seen.Bass.MiscBaseEncoderENCODEFILEPROC
An optional callback procedure which should be called during the encoding process in order to inform you about the encoding progress ( = no notifcation).
overwriteOutput: Type: SystemBoolean
Set to , if you want to force to overwrite any already existing output file (will delete the existing file). If set to and the output file already exists the method will fail, but the existing file will not be deleted.
deleteInput: Type: SystemBoolean
Set to , if you want to delete the input file after the encoding has been successfully completed.

Return Value

Type: Boolean
Returns , if the input file was successfully encoded. Returns if any error occured.

Exceptions

Exception	Condition
IOException	The output file already exists (only raised when the overwriteOutput is not used).

Remarks

The method will use BASS_StreamCreateFile(String, Int64, Int64, BASSFlag) in order to open the input file for encoding. 16-bit will always be used here to read the inputFile. So any file format supported by BASS or the BASS plugin system might be used.

Examples

Encodes a file using the EncoderWMA (CBR at 128 kbps):

Copy

EncoderWMA wma = new EncoderWMA(0);
wma.WMA_Bitrate = 128;
BaseEncoder.EncodeFile("test.wav", null, wma, 
                       new BaseEncoder.ENCODEFILEPROC(FileEncodingNotification), true, false);

public void FileEncodingNotification(long bytesTotal, long bytesDone)
{
  Console.Write("Encoding: {0:P}\r", Math.Round((double)bytesDone/(double)bytesTotal, 2));
}

Dim wma As New EncoderWMA(0)
wma.WMA_Bitrate = 128
BaseEncoder.EncodeFile("test.wav", Nothing, wma, 
                       New BaseEncoder.ENCODEFILEPROC(FileEncodingNotification), True, False)

Public Sub FileEncodingNotification(bytesTotal As Long, bytesDone As Long)
  Console.Write("Encoding: {0:P}\r", Math.Round(CDbl(bytesDone) / CDbl(bytesTotal), 2))
End Sub

Encodes OGG input to an MP3 output using EncoderLAME (with the 'standard' preset):

Copy

EncoderLAME enc = new EncoderLAME(0);
enc.LAME_PresetName = "standard";
BaseEncoder.EncodeFile("test.ogg", null, enc, null, true, false);

Dim enc As New EncoderLAME(0)
enc.LAME_PresetName = "standard"
BaseEncoder.EncodeFile("test.ogg", Nothing, enc, Nothing, True, False)

Reference

BaseEncoder Class

EncodeFile Overload

Un4seen.Bass.Misc Namespace

BaseEncoderAddLanguageSpecificTextSet("LST77F83EBE_0?cpp=::|nu=.");EncodeFile Method (String, String, BaseEncoder, BaseEncoderAddLanguageSpecificTextSet("LST77F83EBE_1?cpp=::|nu=.");ENCODEFILEPROC, Boolean, Boolean)

Parameters

Return Value

Reference

BaseEncoderEncodeFile Method (String, String, BaseEncoder, BaseEncoderENCODEFILEPROC, Boolean, Boolean)