class IceCast2

Class representing output to an IceCast2 server with ice login More...

Definition#include <IceCast2.h>
InheritsCastSink [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Protected Methods

Private Methods

Private Members


Detailed Description

Class representing output to an IceCast2 server with ice login

enum StreamFormat { mp3, oggVorbis }

StreamFormat

Type for specifying the format of the stream.

StreamFormat format

format

[private]

char * mountPoint

mountPoint

[private]

char * description

description

[private]

void  init ( StreamFormat format, const char * mountPoint, const char * description )
throw ( Exception )

init

[private]

Initalize the object.

Parameters:
mountPointmount point of the stream on the server.
remoteDumpFileremote dump file (may be NULL).
descriptiondescription of the stream.

Throws: Exception

Reimplemented from CastSink.

void  strip ( void )
throw ( Exception )

strip

[private]

De-initalize the object.

Throws: Exception

Reimplemented from CastSink.

inline  IceCast2 ( void )
throw ( Exception )

IceCast2

[protected]

Default constructor. Always throws an Exception.

Throws: Exception

bool  sendLogin ( void )
throw ( Exception )

sendLogin

[protected virtual]

Log in to the server using the socket avialable.

Returns: true if login was successful, false otherwise.

Throws: Exception

Reimplemented from CastSink.

inline  IceCast2 ( TcpSocket * socket, const char * password, const char * mountPoint, StreamFormat format, unsigned int bitRate, const char * name = 0, const char * description = 0, const char * url = 0, const char * genre = 0, bool isPublic = false, Sink * streamDump = 0, unsigned int bufferDuration = 10 )
throw ( Exception )

IceCast2

Constructor.

Parameters:
socketsocket connection to the server.
passwordpassword to the server.
mountPointmount point of the stream on the server.
namename of the stream.
descriptiondescription of the stream.
urlURL associated with the stream.
genregenre of the stream.
bitRatebitrate of the stream (e.g. mp3 bitrate).
isPublicis the stream public?
bufferDurationduration of the BufferedSink buffer in seconds.

Throws: Exception

inline  IceCast2 ( const IceCast2 & cs )
throw ( Exception )

IceCast2

Copy constructor.

Parameters:
csthe IceCast2 to copy.

inline  ~IceCast2 ( void )
throw ( Exception )

~IceCast2

[virtual]

Destructor.

Throws: Exception

inline IceCast2 &  operator= ( const IceCast2 & cs )
throw ( Exception )

operator=

[virtual]

Assignment operator.

Parameters:
csthe IceCast2 to assign this to.

Returns: a reference to this IceCast2.

Throws: Exception

Reimplemented from CastSink.

inline StreamFormat  getFormat ( void )
throw ()

getFormat

[const]

Get the format of the stream.

Returns: the format of the stream.

inline const char *  getMountPoint ( void )
throw ()

getMountPoint

[const]

Get the mount point of the stream on the server.

Returns: the mount point of the stream on the server.

inline const char *  getDescription ( void )
throw ()

getDescription

[const]

Get the description of the stream.

Returns: the description of the stream.