Rev | Line | |
---|
[159] | 1 | .\" roar_simple_play.3: |
---|
| 2 | |
---|
| 3 | .TH "roar_simple_connect" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" |
---|
| 4 | |
---|
| 5 | .SH NAME |
---|
| 6 | roar_simple_connect \- Opens a connection to RoarAudio's sound server |
---|
| 7 | |
---|
| 8 | .SH SYNOPSIS |
---|
| 9 | |
---|
| 10 | #include <roaraudio.h> |
---|
| 11 | |
---|
| 12 | int roar_simple_connect (struct roar_connection * con, char * server, char * name); |
---|
| 13 | |
---|
| 14 | .SH "DESCRIPTION" |
---|
| 15 | This call opens a connection to the RoarAudio's sound server. This is usefull for controlling the server or |
---|
| 16 | update meta data of any kind. For simple playback see \fBroar_simple_play\fR(3). |
---|
| 17 | To disconnect use \fBroar_disconnect\fR(3). |
---|
| 18 | |
---|
| 19 | .SH "PARAMETERS" |
---|
| 20 | .TP |
---|
| 21 | \fBcon\fR |
---|
| 22 | The roar_connection object to be filled on success with all data needed for comunicating with the server. |
---|
| 23 | This is used by nearly all other functions. |
---|
| 24 | |
---|
| 25 | .TP |
---|
| 26 | \fBserver\fR |
---|
| 27 | The host or filename of the socket of the server. Should normaly be \fBNULL\fR to try default locations. |
---|
| 28 | |
---|
| 29 | .TP |
---|
| 30 | \fBname\fR |
---|
| 31 | The name of this client. Should be the name of the player without any paths or filenames. |
---|
| 32 | |
---|
| 33 | .SH "RETURN VALUE" |
---|
| 34 | On success these calls return 0. On error, -1 is returned. |
---|
| 35 | |
---|
| 36 | .SH "EXAMPLES" |
---|
| 37 | FIXME |
---|
| 38 | |
---|
| 39 | .SH "SEE ALSO" |
---|
| 40 | \fBroar_disconnect\fR(3), |
---|
| 41 | \fBroar_simple_play\fR(3), |
---|
| 42 | \fBlibroar\fR(7), |
---|
| 43 | \fBRoarAudio\fR(7). |
---|
| 44 | |
---|
| 45 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.