IRCBot Plugin API  v5
Public Attributes | List of all members
API_ss Struct Reference

#include <plugins.h>

Public Attributes

int(* GetSSInfo )(int32 ssnum, SOUND_SERVER *ss)
 
STATS *(* GetStreamInfo )()
 Get's information on the stream status, do not modify/free/etc. the pointer. More...
 
REQUEST_MODES(* GetRequestMode )()
 
void(* EnableRequests )(bool activate)
 If activate is true, it activates requests and sets the mode to hooked. This is used for source plugins that don't provide a REQUEST_INTERFACE. If activate is false, disables requests. More...
 
void(* EnableRequestsHooked )(REQUEST_INTERFACE *)
 Activates requests in hooked mode. This is used for source plugins like AutoDJ, SimpleDJ, SAM, etc., to take requests. If activate is false, disables requests. More...
 
bool(* AreRatingsEnabled )()
 
int(* GetMaxRating )()
 
void(* RateSongByID )(uint32 id, const char *nick, uint32 rating)
 
void(* RateSong )(const char *song, const char *nick, uint32 rating)
 
void(* GetSongRatingByID )(uint32 id, SONG_RATING *r)
 
void(* GetSongRating )(const char *song, SONG_RATING *r)
 

Member Data Documentation

REQUEST_MODES(* API_ss::GetRequestMode)()
bool(* API_ss::AreRatingsEnabled)()
int(* API_ss::GetMaxRating)()
void(* API_ss::RateSongByID)(uint32 id, const char *nick, uint32 rating)
Parameters
idid should only be gotten from a successful SOURCE_GET_SONGID call.
void(* API_ss::RateSong)(const char *song, const char *nick, uint32 rating)
void(* API_ss::GetSongRatingByID)(uint32 id, SONG_RATING *r)
Parameters
idid should only be gotten from a successful SOURCE_GET_SONGID call.
void(* API_ss::GetSongRating)(const char *song, SONG_RATING *r)

The documentation for this struct was generated from the following file: