BASS.NET API for the Un4seen BASS Audio Library

SHOUTcast Class

BASS.NET API for the Un4seen BASS Audio Library
SHOUTcast streaming parameter class. To be used when creating an instance of the BroadCast class.
Inheritance Hierarchy

SystemObject
  Un4seen.Bass.MiscStreamingServer
    Un4seen.Bass.MiscSHOUTcast

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

[SerializableAttribute]
public sealed class SHOUTcast : StreamingServer

The SHOUTcast type exposes the following members.

Constructors

  NameDescription
Public methodCode exampleSHOUTcast(IBaseEncoder)
Creates an instance for a SHOUTcast configuration parameter setting.
Public methodCode exampleSHOUTcast(IBaseEncoder, Boolean)
Creates an instance for a SHOUTcast configuration parameter setting.
Top
Properties

  NameDescription
Public propertyAdminPassword
SHOUTcast server admin password (the "AdminPassword" config item on the server's config file).
Public propertyAdminUsername
SHOUTcast server admin user name (the "admin" username which should be used for certain actions).
Public propertyEncoder
Returns the encoder interface which is used with this instance.
(Inherited from StreamingServer.)
Public propertyForceUTF8TitleUpdates
Gets or Sets if title updates (via UpdateTitle(String, String)) should in any case use UTF-8 (default is ).
(Inherited from StreamingServer.)
Public propertyIsConnected
Returns , if connected and logged into the SHOUTcast server - else .
(Overrides StreamingServerIsConnected.)
Public propertyLastError
Gets or Sets the last streaming error.
(Inherited from StreamingServer.)
Public propertyLastErrorMessage
Gets or Sets the last streaming error message.
(Inherited from StreamingServer.)
Public propertyLocalNetworkCardIPAddress
Gets or Sets a local IP address to use for cast server connections (=any, default):
(Inherited from StreamingServer.)
Public propertySongTitle
The current/last song title.
(Inherited from StreamingServer.)
Public propertySongUrl
The current/last song url.
(Inherited from StreamingServer.)
Public propertyUseBASS
Gets if native BASSenc should be used to connect and stream to the server (as specified in the constructor).
(Inherited from StreamingServer.)
Public propertyUseSHOUTcastv2
Gets or sets, if the SHOUTcast v2 protocol should be used?
Top
Methods

  NameDescription
Public methodConnect
Establishes a TCP socket connection to the SHOUTcast server.
(Overrides StreamingServerConnect.)
Public methodDisconnect
Disconnects from a SHOUTcast server.
(Overrides StreamingServerDisconnect.)
Public methodDispose
Implement IDisposable.
(Inherited from StreamingServer.)
Protected methodFinalize
Finalization code.
(Inherited from StreamingServer.)
Public methodGetListeners
Returns the number of listeners currently connected.
(Overrides StreamingServerGetListeners(String).)
Public methodGetStats
Returns the XML stats of the server.
(Overrides StreamingServerGetStats(String).)
Public methodLogin
Performs a login and initializes the SHOUTcast server.
(Overrides StreamingServerLogin.)
Public methodSendData
Sends encoded sample data to the SHOUTcast server (e.g. the data as received in an own ENCODEPROC).
(Overrides StreamingServerSendData(IntPtr, Int32).)
Public methodUpdateStationArtwork
Updates the station logo picture of the streaming server.
Public methodUpdateTitle(String, String)
Updates the song title of the streaming server.
(Overrides StreamingServerUpdateTitle(String, String).)
Public methodUpdateTitle(TAG_INFO, String)
Updates the song title of the streaming server.
(Overrides StreamingServerUpdateTitle(TAG_INFO, String).)
Top
Fields

  NameDescription
Public fieldAim
Your AOL Instant Messenger (AIM) name for listeners to interact with you. (aim.aol.com)
Public fieldGenre
A genre list of the variety of content you're providing (usually 1-3 words like Rock, 80s, etc.)
Public fieldIcq
If you have one, your ICQ number for listeners to interact with you through. (www.icq.com)
Public fieldIrc
A channel on Efnet IRC for your listeners to interact with (don't worry if you don't understand this).
Public fieldPassword
SHOUTcast server broadcast password (the "Password" config item on the server's config file).
Public fieldPublicFlag
, if you want your broadcast to be listed in the public directory of SHOUTcast broadcasts (default). Else , which means private.
Public fieldServerAddress
SHOUTcast server address (of the form 192.168.1.100 or shoutcast-server.domain.com).
Public fieldServerPort
SHOUTcast server TCP port (usually 8000).
Public fieldSID
SHOUTcast v2 SID.
Public fieldStationName
A brief description of your station or of what content you'll be broadcasting (usually 10-20 words).
Public fieldUrl
A URL of a website that contains information about your broadcast.
Public fieldUsername
SHOUTcast server broadcast user name (the "source" username which should be used).
Public fieldUseSSL
Use SSL/TLS encryption.
Public fieldv2SendArtwork
Should in-stream artwork be send to a SHOUTcast v2 server?
Public fieldv2SendSongTitleOnly
Should SHOUTcast v2 metadata updates only use the SongTitle value?
Public fieldv2SongTitleNext
The next song title ('artist - title') to report within the SHOUTcast v2 metadata.
Public fieldv2StationArtwork
Fully qualified path and file name of the station logo picture.
Public fieldv2StreamArtwork
Fully qualified path and file name of an alternative artwork picture.
Top
Remarks

An instance of the class will providing all necessary setup and configuration data in order to connect to a SHOUTcast v1 or v2 server.

For more information about the SHOUTcast streaming parameters take a look to the www.shoutcast.com documentation.

Note: in order to use the SHOUTcast v2 protocol the SID property must be set!

See Also

Reference