The EncoderCMDLN type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | EncoderCMDLN |
Creates an instance of the generic command-line encoder implementation.
|
Methods
| Name | Description | |
|---|---|---|
| Dispose |
Implement IDisposable.
(Inherited from BaseEncoder.) |
 | Finalize |
Finalization code.
(Inherited from BaseEncoder.) |
| Pause |
Pauses or resumes an encoder.
(Inherited from BaseEncoder.) |
| SettingsString |
Returns the string representation of the current encoder settings.
(Overrides BaseEncoder SettingsString .) |
| Start |
This method starts the actual command-line encoder.
After the encoder was started successfully the EncoderHandle returns a valid HENCODE handle.
(Overrides BaseEncoder Start(ENCODEPROC, IntPtr, Boolean).) |
| Stop |
Stops the encoder (if started).
(Inherited from BaseEncoder.) |
| Stop(Boolean) |
Stops the encoder (if started).
(Inherited from BaseEncoder.) |
| ToString |
Returns the name of the Encoder.
(Overrides  Object ToString .) |
Fields
| Name | Description | |
|---|---|---|
 | CMDLN_Bitrate |
Gets or Sets the effective bitrate (in kbps) for the ${bps} and ${kbps} macro to be used with the CMDLN_CBRString resp. CMDLN_VBRString.
|
| CMDLN_CBRString |
Gets or Sets the constant bitrate (CBR) command-line string to be used with the encoder (not containing the executable to be used, e.g. "-b ${bps} - output.xyz").
|
| CMDLN_DefaultOutputExtension |
Gets or Sets the default output extension to be used by the encoder (e.g. ".mp3").
|
| CMDLN_EncoderType |
Gets or Sets the BASSChannelType which will be supported by the encoder.
|
| CMDLN_Executable |
Gets or Sets the command-line executable name to be used with the encoder (not containing the path, e.g. "encoder.exe").
|
| CMDLN_Mode |
Gets or Sets the ${mode} macro value to be used in the CMDLN_CBRString resp. CMDLN_VBRString.
|
| CMDLN_Option |
Gets or Sets the ${option} macro value to be used in the CMDLN_CBRString resp. CMDLN_VBRString.
|
| CMDLN_ParamSTDIN |
Gets or sets the ${input} parameter to be used with STDIN.
|
| CMDLN_ParamSTDOUT |
Gets or sets the ${output} parameter to be used with STDOUT.
|
| CMDLN_Quality |
Gets or Sets the ${quality} macro value to be used in the CMDLN_CBRString resp. CMDLN_VBRString.
|
| CMDLN_SupportsSTDOUT |
Gets or Sets if the encoder supports output of the encoded data to STDOUT.
|
| CMDLN_UseA |
Gets or Sets, if the CMDLN_UserA or the CMDLN_UserB macro string should be used.
|
| CMDLN_UseFP_24BIT |
Gets or Sets if the encoder should be started using the FP_24BIT flag.
|
| CMDLN_UseFP_32BIT |
Gets or Sets if the encoder should be started using the FP_32BIT flag.
|
| CMDLN_UseNOHEAD |
Gets or Sets if the encoder should be started using the NOHEAD flag.
|
| CMDLN_UserA |
Gets or Sets the ${user} macro value to be used in the CMDLN_CBRString resp. CMDLN_VBRString.
|
| CMDLN_UserB |
Gets or Sets the ${user} macro value to be used in the CMDLN_CBRString resp. CMDLN_VBRString.
|
| CMDLN_UseVBR |
Gets or Sets, if the CMDLN_CBRString or the CMDLN_VBRString command-line string should be used.
|
| CMDLN_VBRString |
Gets or Sets the variable bitrate (VBR) command-line string to be used with the encoder (not containing the executable to be used, e.g. "-b ${bps} - output.xyz").
|
Properties
| 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 (e.g. ".wav"). Here the CMDLN_DefaultOutputExtension value is returned.
(Overrides BaseEncoder DefaultOutputExtension.) |
| EffectiveBitrate |
Returns the effective encoder bitrate (in kbps) of the output. Here the CMDLN_Bitrate value is returned.
(Overrides BaseEncoder EffectiveBitrate.) |
| EncoderCommandLine |
Returns the specified command-line string to use. Depending on the CMDLN_UseVBR property the CMDLN_VBRString or the CMDLN_CBRString value is evaluated and all contained macros are replaced.
(Overrides BaseEncoder EncoderCommandLine.) |
| EncoderDirectory |
Gets or Sets the encoder's base directory.
(Inherited from BaseEncoder.) |
| EncoderExists |
This property return , if the specifiec command-line tool is availabel - else .
(Overrides BaseEncoder EncoderExists.) |
| EncoderHandle |
Gets or sets the current HENCODE encoder handle.
(Inherited from BaseEncoder.) |
| EncoderType |
Gets a value indicating the type of content. Here the CMDLN_EncoderType value is returned.
(Overrides BaseEncoder EncoderType.) |
| 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.) |
| 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 |
A command-line encoder might implement STDOUT, so here the CMDLN_SupportsSTDOUT value is returned.
(Overrides BaseEncoder SupportsSTDOUT.) |
| 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.) |
See Also