BASS.NET API for the Un4seen BASS Audio Library

ICEcast Class

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

SystemObject
  Un4seen.Bass.MiscStreamingServer
    Un4seen.Bass.MiscICEcast

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

[SerializableAttribute]
public sealed class ICEcast : StreamingServer

The ICEcast type exposes the following members.

Constructors

  NameDescription
Public methodCode exampleICEcast(IBaseEncoder)
Creates an instance for an ICEcast configuration parameter setting.
Public methodCode exampleICEcast(IBaseEncoder, Boolean)
Creates an instance for an ICEcast configuration parameter setting.
Top
Properties

  NameDescription
Public propertyAdminPassword
ICEcast server admin password (the "admin-password" which should be used for certain actions).
Public propertyAdminUsername
ICEcast server admin user name (the "admin-user" 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 ICEcast 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.)
Top
Methods

  NameDescription
Public methodConnect
Establishes a TCP socket connection to the ICEcast server.
(Overrides StreamingServerConnect.)
Public methodDisconnect
Disconnects from an ICEcast 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 ICEcast server.
(Overrides StreamingServerLogin.)
Public methodSendData
Sends encoded sample data to the ICEcast server (e.g. the data as received in an own ENCODEPROC).
(Overrides StreamingServerSendData(IntPtr, Int32).)
Public methodUpdateArtistTitle
Updates the artist and title 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)
Special handling for ICEcast and special encoders (Flac, Ogg, ...) who need new bitstream's.
(Overrides StreamingServerUpdateTitle(TAG_INFO, String).)
Top
Fields

  NameDescription
Public fieldMountPoint
The ICEcast mountpoint you want to use.
Public fieldPassword
ICEcast server broadcast password (the "source-password" config item on the server's config file).
Public fieldPublicFlag
, if you want your broadcast to be listed in the public directory of ICEcast broadcasts (default). Else , which means private.
Public fieldQuality
The bitrate quality name (e.g. "Quality").
Public fieldServerAddress
ICEcast server address (hostname, in the form 192.168.1.100 or icecast-server.domain.com).
Public fieldServerPort
ICEcast server TCP port (usually 8000).
Public fieldStreamDescription
A description of your stream or station or of what content you'll be broadcasting (usually 10-20 words).
Public fieldStreamGenre
A genre list of the variety of content you're providing (usually 1-3 words like Rock, 80s, etc.)
Public fieldStreamName
The name of your stream or station (usually 1-5 words).
Public fieldStreamUrl
A URL of a website that contains information about your broadcast.
Public fieldUpdateMetaDataUsingAdminInterface
Update the metadata (song title changes) by using the admin interface (e.g. supported for MP3 or AAC streams).
Public fieldUpdateMetaDataUsingNewBitstreams
Update the metadata (song title changes) by using a new bitstream for each change (e.g. ICEcast requires this for FLAC or OGG).
Public fieldUsePUT
Use the PUT method when connecting to an Icecast server (should be used with ICEcast v2.4 or above), else the SOURCE method is used. This flag is applied automatically when the UseSSL property is specified.
Public fieldUsername
ICEcast server user name (the "source" username which should be used).
Public fieldUseSSL
Use SSL/TLS encryption.
Top
Remarks

An instance of the class will providing all necessary setup and configuration data in order to connect to an ICEcast server.

For more information about the ICEcast streaming parameters take a look to the www.icecast.org documentation.

See Also

Reference