diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 9 insertions, 9 deletions
@@ -36,52 +36,52 @@ Define a connection to a Shoutcast or Icecast server. * Spassword : password; may be an empty string if not required * Smount : mount point; may be an empty string if not required -## shoutopen ishout +### shoutopen ishout Open a connection defined by shoutinit. * ishout : the connection handle created by shoutinit -## shoutclose ishout +### shoutclose ishout Close a connection to a server. * ishout : the connection handle created by shoutinit -## shoutsetname ishout, Sname +### shoutsetname ishout, Sname Set the name of the stream to be displayed in the server directory. Must be called on a connection before being opened with shoutopen. * ishout : the connection handle created by shoutinit * Sname : name of the stream to be displayed -## shoutseturl ishout, Surl +### shoutseturl ishout, Surl Set the URL of the stream to be displayed in the server directory. Must be called on a connection before being opened with shoutopen. * ishout : the connection handle created by shoutinit * Surl : URL to be displayed -## shoutsetgenre ishout, Sgenre +### shoutsetgenre ishout, Sgenre Set the genre of the stream to be displayed in the server directory. Must be called on a connection before being opened with shoutopen. * ishout : the connection handle created by shoutinit * Sgenre : genre to be displayed -## shoutsetdescription ishout, Sdescription +### shoutsetdescription ishout, Sdescription Set the description of the stream to be displayed in the server directory. Must be called on a connection before being opened with shoutopen. * ishout : the connection handle created by shoutinit * Sdescription : description to be displayed -## shoutsetpublic ishout, ipublic +### shoutsetpublic ishout, ipublic Set whether the stream is to be displayed in the server directory. Must be called on a connection before being opened with shoutopen. * ishout : the connection handle created by shoutinit * ipublic : 1 = public , 0 = private -## shoutsetmeta ishout, Skey, Svalue +### shoutsetmeta ishout, Skey, Svalue Set arbitrary metadata for the current track. Must be called on a connection after being opened with shoutopen. Currently "song" and "url" as Skey are known values to work with servers. * ishout : the connection handle created by shoutinit @@ -89,7 +89,7 @@ Set arbitrary metadata for the current track. Must be called on a connection aft * Skey : metadata key * Svalue : metadata value -## shoutsend ishout, aleft, aright [, iquality=4] +### shoutsend ishout, aleft, aright [, iquality=4] Stream audio data to the server. It will be encoded as VBR MP3 using LAME with the quality set to iquality. * ishout : the connection handle created by shoutinit |