Changeset 5032:b2c8bbc7907f in roaraudio for doc/man3/roar_simple_connect.3
- Timestamp:
- 05/28/11 17:23:34 (13 years ago)
- Branch:
- default
- Phase:
- public
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/man3/roar_simple_connect.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_simple_connect" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_simple_connect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME 6 roar_simple_connect \- Opens a connection to RoarAudio's sound server6 roar_simple_connect, roar_simple_connect2 \- Opens a connection to RoarAudio's sound server 7 7 8 8 .SH SYNOPSIS … … 11 11 12 12 int roar_simple_connect (struct roar_connection * con, char * server, char * name); 13 int roar_simple_connect2(struct roar_connection * con, char * server, char * name, int flags, uint_least32_t timeout); 14 13 15 14 16 .SH "DESCRIPTION" 15 This call opens a connection to the RoarAudio's sound server. This is useful for controlling the server or 16 update meta data of any kind. For simple playback see \fBroar_simple_play\fR(3). 17 This calls opens a connection to the RoarAudio's sound server. 17 18 To disconnect use \fBroar_disconnect\fR(3). 18 19 … … 31 32 The name of this client. Should be the name of the player without any paths or filenames. 32 33 34 .TP 35 \fBflags\fR 36 Flags used to connect to the server. Currently only ROAR_ENUM_FLAG_NONE and ROAR_ENUM_FLAG_NONBLOCK are supported. 37 ROAR_ENUM_FLAG_NONBLOCK disables some of the server location features. 38 39 .TP 40 \fBtimeout\fR 41 Timeout for the connection. A value of zero means no timeout. Currently timeouts are not supported. 42 33 43 .SH "RETURN VALUE" 34 44 On success these calls return 0. On error, \-1 is returned. … … 39 49 .SH "SEE ALSO" 40 50 \fBroar_disconnect\fR(3), 41 \fBroar_simple_play\fR(3),42 51 \fBlibroar\fR(7), 43 52 \fBRoarAudio\fR(7).
Note: See TracChangeset
for help on using the changeset viewer.