Defines a generalized encoder class interface that a BaseEncoder class must implement.
Namespace: Un4seen.Bass.Misc
Assembly: Bass.Net (in Bass.Net.dll) Version: 2.4.17.5
Syntax
The IBaseEncoder type exposes the following members.
Properties
Name | Description | |
---|---|---|
ChannelBitwidth |
This property should return the actual bitwidth of the sample data BASS is using with the channel (e.g. 8, 16, 32).
| |
ChannelHandle |
This property should get or sets the channel handle which will be used to create the broadcast encoder class.
| |
ChannelNumChans |
This property should return the actual number of channles of the sample data BASS is using with the channel (e.g. 1=mono, 2=stereo, etc.).
| |
ChannelSampleRate |
This property should return the actual sample rate in Hz of the sample data BASS is using with the channel (e.g. 44100).
| |
DefaultOutputExtension |
This property should return the default extension of an output file for this encoder (e.g. ".mp3" or ".ogg" etc.).
| |
EffectiveBitrate |
Specifies the target effective bitrate of the encoder output (in kbps, e.g. 128 kbps).
| |
EncoderCommandLine |
This property should return an encoder command-line string,
which might be used with the BASS_Encode_Start(Int32, String, BASSEncode, ENCODEPROC, IntPtr) method in order to create and start the encoder.
| |
EncoderDirectory |
This property should get and set the encoder's base directory.
It might be used in the EncoderCommandLine implementation to return a fully qualified encoder command-line.
| |
EncoderExists |
This property should return , if the encoder exists and is available - else should be returned.
| |
EncoderHandle |
This property should get and set a HENCODE encoder handle as returned by the BASS_Encode_Start(Int32, String, BASSEncode, ENCODEPROC, IntPtr) method if the the encoder has been started (see Start(ENCODEPROC, IntPtr, Boolean)) or 0 (zero), if the encoder has not been started or was stopped (see Stop).
| |
EncoderType |
This property should return a value indicating which type of content the broadcast encoder implements.
| |
Force16Bit |
Gets or Sets if a encoding in 16-bit sample data should be forced (default is ).
| |
InputFile |
Specifies the input file name to be processed by the encoder (null = STDIN).
| |
IsActive |
This property should return , if the encoder has been started (see Start(ENCODEPROC, IntPtr, Boolean)) and is active - else must be returned.
| |
IsPaused |
This property should return , only if the encoder has been paused (see Pause(Boolean)) - else must be returned.
| |
NoLimit |
Gets or Sets if encoding should use the CAST_NOLIMIT flag (which is only needed, if the encoder is used for streaming).
| |
OutputFile |
Specifies the output file name to be processed by the encoder (null = STDOUT).
| |
SupportsSTDOUT |
This property should return , if the base encoder implementation (resp. the underlying command-line tool being used) support STDOUT for output of the encoded data - else must be returned.
| |
TAGs |
Gets or Sets the TAG_INFO structure associated with the encoder.
| |
UseAsyncQueue |
Gets or Sets if encoding should use an async queue (i.e. the BASS_ENCODE_QUEUE flag).
|
Methods
Name | Description | |
---|---|---|
Pause |
This method must implement the actual pauseing of the encoder.
After the encoder was paused successfully the EncoderHandle must still return a valid HENCODE handle (non-zero).
| |
Start |
This method must implement the actual start of the encoder.
After the encoder was started successfully the EncoderHandle must return a valid HENCODE handle.
| |
Stop |
This method must implement the actual stop of the encoder.
After the encoder was stopped successfully the EncoderHandle must return 0 (zero).
|
Remarks
See Also