#include <plugins.h>

Public Attributes
bool(*	AddToYP )(YP_HANDLE yp, SOUND_SERVER sc, YP_CREATE_INFO *ypinfo)

int(*	TouchYP )(YP_HANDLE yp, const char cur_playing)

void(*	DelFromYP )(YP_HANDLE *yp)

Detailed Description

These functions let you create/update/delete a YP listing in the ShoutIRC.com Stream List.

Member Data Documentation

bool(* API_yp::AddToYP)(YP_HANDLE *yp, SOUND_SERVER *sc, YP_CREATE_INFO *ypinfo)

Called by your source plugin when it starts playing with listing information.

Parameters

yp	An empty YP_HANDLE struct for AddToYP to fill in.
sc	A pointer to the SOUND_SERVER the plugin is feeding.
ypinfo	A pointer to a YP_CREATE_INFO structure you have filled out.

int(* API_yp::TouchYP)(YP_HANDLE *yp, const char *cur_playing)

Update your YP listing with the current song.

Parameters

yp	A YP_HANDLE struct previously filled in by a successful call to AddToYP.
cur_playing	A pointer to the title of the current song the source plugin is playing.

Returns: 0 on success, -1 on general error (but should be tried again in the future), -2 for a hard error where you should call AddToYP again and start over

void(* API_yp::DelFromYP)(YP_HANDLE *yp)

Delete/deactivate your YP listing.

Parameters

yp	A YP_HANDLE struct previously filled in by a successful call to AddToYP.

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