BASS.NET API for the Un4seen BASS Audio LibraryBassEncBASS_Encode_CastInit Method BASS.NET API for the Un4seen BASS Audio Library
Initializes sending an encoder's output to a Shoutcast or Icecast server.

Namespace: Un4seen.Bass.AddOn.Enc
Assembly: Bass.Net (in Bass.Net.dll) Version: 2.4.12.0
Syntax

[DllImportAttribute("bassenc.dll", CharSet = CharSet.Auto)]
public static bool BASS_Encode_CastInit(
	int handle,
	string server,
	string pass,
	string content,
	string name,
	string url,
	string genre,
	string desc,
	string headers,
	int bitrate,
	bool pub
)

Parameters

handle
Type: SystemInt32
The encoder handle.
server
Type: SystemString
The server to send to, in the form of "address:port" (Shoutcast v1) resp. "address:port,sid" (Shoutcast v2) or "address:port/mount" (Icecast).
pass
Type: SystemString
The server password. A username can be included in the form of "username:password" when connecting to an Icecast or Shoutcast 2 server.
content
Type: SystemString
The MIME type of the encoder output. This can be one of the following:

BASS_ENCODE_TYPE_MP3, BASS_ENCODE_TYPE_OGG or BASS_ENCODE_TYPE_AAC.

name
Type: SystemString
The stream name... = no name.
url
Type: SystemString
The URL, for example, of the radio station's webpage... = no URL.
genre
Type: SystemString
The genre... = no genre.
desc
Type: SystemString
Description... = no description. This applies to Icecast only.
headers
Type: SystemString
Other headers to send to the server... = none. Each header should end with a carriage return and line feed ("\r\n").
bitrate
Type: SystemInt32
The bitrate (in kbps) of the encoder output... 0 = undefined bitrate. In cases where the bitrate is a "quality" (rather than CBR) setting, the headers parameter can be used to communicate that instead, eg. "ice-bitrate: Quality 0\r\n".
pub
Type: SystemBoolean
Public? If , the stream is added to the public directory of streams, at shoutcast.com or dir.xiph.org (or as defined in the server config).

Return Value

Type: Boolean
If successful, is returned, else is returned. Use BASS_ErrorGetCode to get the error code.
Remarks

This function sets up a Shoutcast/Icecast source client, sending the encoder's output to a server, which listeners can then connect to and receive the data from. The Shoutcast and Icecast server software is available from www.shoutcast.com/broadcast-tools and www.icecast.org/download, respectively.

An encoder needs to be started (but with no data sent to it yet) before using this function to setup the sending of the encoder's output to a Shoutcast or Icecast server. If BASS_Encode_Start(Int32, String, BASSEncode, ENCODEPROC, IntPtr) is used, the encoder should be setup to write its output to STDOUT. Due to the length restrictions of WAVE headers/files, the encoder should also be started with the BASS_ENCODE_NOHEAD flag, and the sample format details sent via the command-line.

Unless the BASS_ENCODE_CAST_NOLIMIT flag is set on the encoder, BASSenc automatically limits the rate that data is processed to real-time speed to avoid overflowing the server's buffer, which means that it is safe to simply try to process data as quickly as possible, eg. when the source is a decoding channel. Encoders set on recording channels are automatically exempt from the rate limiting, as they are inherently real-time. With BASS 2.4.6 or above, also exempt are encoders that are fed in a playback buffer update cycle (including BASS_Update(Int32) and BASS_ChannelUpdate(Int32, Int32) calls), eg. when the source is a playing channel; that is to avoid delaying the update thread, which could result in playback buffer underruns.

Normally, BASSenc will produce the encoded data (with the help of an encoder) that is sent to a Shoutcast/Icecast server, but it is also possible to send already encoded data to a server (without first decoding and re-encoding it) via the PCM encoding option. The encoder can be set on any BASS channel, as rather than feeding on sample data from the channel, BASS_Encode_Write(Int32, IntPtr, Int32) would be used to feed in the already encoded data. BASSenc does not know what the data's bitrate is in that case, so it is up to the user to process the data at the correct rate (real-time speed).

BASS_Encode_ServerInit(Int32, String, Int32, Int32, BASSEncodeServer, ENCODECLIENTPROC, IntPtr) can be used to setup a server that listeners can connect to directly, without a Shoutcast/Icecast server intermediary.

ERROR CODEDescription
BASS_ERROR_HANDLEhandle is not valid.
BASS_ERROR_ALREADYThere is already a cast set on the encoder.
BASS_ERROR_ILLPARAMserver doesn't include a port number.
BASS_ERROR_FILEOPENCouldn't connect to the server.
BASS_ERROR_CAST_DENIEDpass is not valid.
BASS_ERROR_UNKNOWNSome other mystery problem!

Examples

Start encoding a stereo 44100hz channel to 128kb/s MP3, and send the output to a Shoutcast server:
VB
' setup the encoder
Dim encoder As Integer = BassEnc.BASS_Encode_Start(channel, "lame -r -x -s 44100 -b 128 -", 
                                 BASS_ENCODE_NOHEAD, Nothing, 0)
' setup the encoder
BassEnc.BASS_Encode_CastInit(encoder, "server.com:8000", "password", BassEnc.BASS_ENCODE_TYPE_MP3, 
                             "name", "url", "genre", Nothing, Nothing, 128, True)
// setup the encoder
int encoder = BassEnc.BASS_Encode_Start(channel, "lame -r -x -s 44100 -b 128 -", 
                      BASS_ENCODE_NOHEAD, null, 0);
// setup the encoder
BassEnc.BASS_Encode_CastInit(encoder, "server.com:8000", "password", BassEnc.BASS_ENCODE_TYPE_MP3, 
                             "name", "url", "genre", null, null, 128, true);
See Also

Reference