Putting the groove into tcl!
Home
News
Download
CVS Access
FAQ
Documentation
Example
Contact
Welcome to the Tclshout API Document

This document intends to explain the API for tclshout, which should make it easy for you to write an icecast source in tcl.

shout_init:

set conn shout_init ip port password

Initializes the basic connection and creates a shout object. returns the key to the shout object.

shout_connect:

shout_connect conn

connects to icecast server on given ip and port with password.

shout_send_data:

shout_send_data conn buffer length

Sends the buffer of data to the icecast server. Length is the length of the buffer.

shout_sleep:

shout_sleep conn

sleeps the amount of time shout needs to keep a stream in sync.

shout_disconnect:

shout_disconnect conn

disconnects from the icecast server.

shout_set_bitrate:

shout_set_bitrate conn bitrate

sets bitrate for the mp3 stream to bitrate.

shout_get_bitrate:

shout_get_bitrate conn

returns the bitrate set for this connection.

shout_is_connected:

shout_is_connected conn

returns a 0 if not connected, 1 if it is connected to icecast.

shout_set_description:

shout_set_description conn description

sets the description field for the icecast server.

shout_get_description:

shout_get_description conn

returns the given description for this conn.

shout_set_genre:

shout_set_genre conn genre

sets the genre for this connection.

shout_get_genre:

shout_get_genre conn

returns the genre for this connection

shout_set_icy_compat:

shout_set_icy_compat conn [0|1]

sets weather or not this is an older icy connection.

shout_get_icy_compat:

shout_get_icy_compat conn

returns 1 if this is an older icy connection. else returns 0.

SourceForge Logo
 
CopyrightŪ 2000 Dan Bradley. All Rights Reserved.