libshout - datatype - shout_conn_t

libshout documentation | libshout version 1.0.4 - 20000824

# shout_conn_t

declared in <shout/shout.h>

The shout_conn_t structure defines an icecast server connection.

Only the fields the program needs must be defined. If a field isn't defined by the application, it will either be blank (if it's a string value) or set to some reasonable default (usually 0).

    typedef struct {
        char *ip;           /* ip address of the server */
        int port;           /* data buffer to send */
        char *mount;        /* length of data buffer */
        char *password;     /* password to use for login */

        int connected;      /* connected flag */

        int icy_compat;     /* flag for icy protocol compatibility*/
        char *name;         /* name of the stream */
        char *genre;        /* genre of the stream */
        char *description;  /* description of the stream */
        char *url;          /* url of the homepage for the stream */
        int bitrate;        /* bitrate of the stream */
        int ispublic;         /* flag to list the stream in the directory servers */
        char *dumpfile;     /* dumpfile for the stream */

        int error;          /* read only - error code */
        int frames;         /* read only - number of frames processed */
    } shout_conn_t;

### Parameters

ip
  ip address of the server
port
  port on the server to connect to
mount
  the mountpoint to use (only with icy_compat == 0)
password
  the password to use to log into the server
connected
  connection flag
connected
  connection flag
icy_compat
  turns on icy compatibility
name
  name of the stream
genre
  genre of the stream
description
  description of the stream
url
  url of the stream
bitrate
  bitrate of the stream
ispublic
  flag to list the stream in directories
dumpfile
  file to record the stream to on the server
error
  error variable
frames
  the number of frames sent for this connection

### Notes

Most of the members of the shout_conn_t structure are self-explanatory. Here are some further explanations of the less obvious ones:

#### icy_compat

icy_compat is useful if you will be connecting to an older icecast server (before the 1.3.0 release) or to another streaming media server like the ones at live365.com that don't fully support the x-audiocast protocols. dumpfile will not work with icy_compat, since dumpfiles are a feature unique to icecast. description will also not work with icy_compat.

#### dumpfile

dumpfile is a special feature of recent icecast servers. When dumpfile is not NULL, and the x-audiocast protocol is being used, the icecast server will save the stream locally to a dumpfile (a dumpfile is just a raw mp3 stream dump). Using this feature will cause data to be written to the drive on the icecast server, so use with caution, or you will fill up your disk!

copyright © 2000 icecast team | www.icecast.org team@icecast.org
libshout documentation | libshout version 1.0.4 - 20000824