IRCBot Plugin API  v5
Classes | Enumerations | Variables
Sound Server/Stream API

Classes

struct  SOUND_SERVER
 
struct  STATS
 

Enumerations

enum  SS_TYPES {
  SS_TYPE_SHOUTCAST = 0x00, SS_TYPE_SHOUTCAST2 = 0x01, SS_TYPE_ICECAST = 0x02, SS_TYPE_STEAMCAST = 0x03,
  SS_TYPE_SP2P = 0x04
}
 

Variables

int(* API_ss::GetSSInfo )(int32 ssnum, SOUND_SERVER *ss)
 
STATS *(* API_ss::GetStreamInfo )()
 Get's information on the stream status, do not modify/free/etc. the pointer. More...
 

Detailed Description

Enumeration Type Documentation

enum SS_TYPES

The SS_TYPES identifies the different types of Sound Servers.

Enumerator
SS_TYPE_SHOUTCAST 

A SHOUTcast v1 server.

SS_TYPE_SHOUTCAST2 

A SHOUTcast v2 (Ultravox protocol) server.

SS_TYPE_ICECAST 

An icecast2 server.

SS_TYPE_STEAMCAST 
SS_TYPE_SP2P 

Variable Documentation

int(* API_ss::GetSSInfo)(int32 ssnum, SOUND_SERVER *ss)

Get's information on one of the sound servers in ircbot.conf

Parameters
ssnumThe sound server number. If you use -1 the function will return the number of servers defined in ircbot.conf (in this case the ss param can be NULL).
ssA SOUND_SERVER structure to be filled in
See also
SOUND_SERVER
SS_TYPES
STATS*(* API_ss::GetStreamInfo)()

Get's information on the stream status, do not modify/free/etc. the pointer.