webradio/receiver.h-Dateireferenz


Ausführliche Beschreibung

Audio data receiver.

 *
 * $Log$
 *
 * 

Definiert in Datei receiver.h.

gehe zum Quellcode dieser Datei

Datenstrukturen

struct  RECEIVERPLUGIN
 Receiver plug-in reference structure. Mehr ...
struct  RECEIVERINFO
 Receiver information structure. Mehr ...

Receiver Status



#define RSTAT_IDLE   0x0001
 Receiver is idle.
#define RSTAT_START   0x0002
 Request to start receiver.
#define RSTAT_BUFFERING   0x0004
 Receiver is running.
#define RSTAT_RUNNING   0x0008
 Receiver is running.
#define RSTAT_STOP   0x0010
 Request to stop receiver.

Funktionen

RECEIVERINFOReceiverCreate (RECEIVERPLUGIN *plugin)
 Create stream receiver instance with the specified plug-in.
RECEIVERINFOReceiverStart (RECEIVERINFO *ritab[], STATIONINFO *sip)
 Start receiver for the connected stream.
int ReceiverStop (RECEIVERINFO *rip)
 Stop receiver.
u_int ReceiverStatus (RECEIVERINFO *rip)
 Retrieve the current receiver status.


Makro-Dokumentation

#define RSTAT_IDLE   0x0001

Receiver is idle.

Definiert in Zeile 55 der Datei receiver.h.

Wird benutzt von main(), ReceiverStop() und ShoutCastThread().

#define RSTAT_START   0x0002

Request to start receiver.

Definiert in Zeile 57 der Datei receiver.h.

Wird benutzt von ReceiverStart() und ShoutCastThread().

#define RSTAT_BUFFERING   0x0004

Receiver is running.

Definiert in Zeile 59 der Datei receiver.h.

Wird benutzt von ReceiverStart() und ShoutCastThread().

#define RSTAT_RUNNING   0x0008

Receiver is running.

Definiert in Zeile 61 der Datei receiver.h.

Wird benutzt von ReceiverStart() und ShoutCastThread().

#define RSTAT_STOP   0x0010

Request to stop receiver.

Definiert in Zeile 63 der Datei receiver.h.

Wird benutzt von main(), ReceiverStop() und ShoutCastThread().


Dokumentation der Funktionen

RECEIVERINFO* ReceiverCreate ( RECEIVERPLUGIN plugin  ) 

Create stream receiver instance with the specified plug-in.

Parameter:
plugin Pointer to a receiver plug-in.
Rückgabe:
Pointer to the receiver info structure or NULL, if the creation failed.

Definiert in Zeile 86 der Datei receiver.c.

Benutzt RECEIVERINFO::ri_rpp und RECEIVERPLUGIN::rp_create.

RECEIVERINFO* ReceiverStart ( RECEIVERINFO ritab[],
STATIONINFO sip 
)

Start receiver for the connected stream.

Parameter:
ritab Table of available receivers.
sip Information structure of the connected station .
Rückgabe:
Pointer to the receiver entry that had been started. NULL is returned in case any error.

Definiert in Zeile 162 der Datei receiver.c.

Benutzt LOG_WARN, LogMsg(), ReceiverPlugInControl(), ReceiverStop(), RECEIVERINFO::ri_rpp, RECEIVERINFO::ri_sip, RECEIVERPLUGIN::rp_setup, RSTAT_BUFFERING, RSTAT_RUNNING und RSTAT_START.

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

LogMsgReceiverPlugInControlReceiverStop

int ReceiverStop ( RECEIVERINFO rip  ) 

Stop receiver.

Parameter:
rip Receiver to stop.
Rückgabe:
0 on success, -1 otherwise.

Definiert in Zeile 148 der Datei receiver.c.

Benutzt ReceiverPlugInControl(), RSTAT_IDLE und RSTAT_STOP.

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

ReceiverPlugInControlLogMsg

u_int ReceiverStatus ( RECEIVERINFO rip  ) 

Retrieve the current receiver status.

Parameter:
rip Pointer to the receiver information structure.
Rückgabe:
Receiver status.

Definiert in Zeile 136 der Datei receiver.c.

Benutzt RECEIVERINFO::ri_status.


© 2008 by egnite GmbH - besuchen Sie www.ethernut.de