Changeset 5032:b2c8bbc7907f in roaraudio
- Timestamp:
- 05/28/11 17:23:34 (13 years ago)
- Branch:
- default
- Phase:
- public
- Location:
- doc/man3
- Files:
-
- 21 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/man3/roar_connect.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_connect" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_connect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME 6 roar_connect \- connects to RoarAudio's sound server6 roar_connect, roar_connect2 \- connects to RoarAudio's sound server 7 7 8 8 .SH SYNOPSIS … … 11 11 12 12 int roar_connect(struct roar_connection * con, char * server); 13 int roar_connect2 (struct roar_connection * con, char * server, int flags, uint_least32_t timeout); 13 14 14 15 .SH "DESCRIPTION" 15 16 Connects to RoarAudio's sound server. 16 This call just connects to the sound server without any author identify.17 Do not use this from end user applications. Use \fBroar_simple_connect\fR(3) .17 This calls just connects to the sound server without any authentication or identify. 18 Do not use this from end user applications. Use \fBroar_simple_connect\fR(3) or \fBroar_simple_connect2\fR(3). 18 19 19 20 … … 26 27 \fBserver\fR 27 28 The server to connect to. 28 This may be in form "host[:port]" (TCP/IP), "/path/to/sock" (UNIX Domain Socket) or any other supported.29 For a full list see \fBroartips\fR(7).30 29 30 .TP 31 \fBflags\fR 32 Flags used to connect to the server. Currently only ROAR_ENUM_FLAG_NONE and ROAR_ENUM_FLAG_NONBLOCK are supported. 33 ROAR_ENUM_FLAG_NONBLOCK disables some of the server location features. 34 35 .TP 36 \fBtimeout\fR 37 Timeout for the connection. A value of zero means no timeout. Currently timeouts are not supported. 31 38 32 39 .SH "RETURN VALUE" -
doc/man3/roar_disconnect.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_disconnect" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_disconnect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME … … 13 13 14 14 .SH "DESCRIPTION" 15 Closes es connection previously opend via \fBBroar_simple_connect\fR(3) .15 Closes es connection previously opend via \fBBroar_simple_connect\fR(3) or \fBBroar_simple_connect2\fR(3). 16 16 17 17 -
doc/man3/roar_exit.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_exit" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_exit" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME … … 19 19 Ask the sound server to quit. 20 20 21 roar_exit() let the server quit .... 21 roar_exit() let the server quit without waiting for any clients. 22 All streams and client connections will be closed cleanly. 22 23 23 24 roar_terminate() will let the server quit as soon as all clients disconnects -
doc/man3/roar_get_standby.3
r4017 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_get_standby" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_get_standby" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME -
doc/man3/roar_get_vol.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_get_vol" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_get_vol" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME 6 roar_get_vol, roar_set_vol \- Set mixer levels or RoarAudio streams6 roar_get_vol, roar_set_vol, roar_set_vol2 \- Set mixer levels or RoarAudio streams 7 7 8 8 .SH SYNOPSIS … … 12 12 int roar_set_vol(struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int channels); 13 13 14 int roar_set_vol2 (struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int channels, int mode); 15 14 16 int roar_get_vol(struct roar_connection * con, int id, struct roar_mixer_settings * mixer, int * channels); 15 17 … … 17 19 This call gets or sets the mixing levels for a stream. 18 20 19 \fBNOTE: This call is not marked as forzen, it's interface may change in newer versions!\fR 21 roar_set_vol() is marked obsolete and will be removed soon, use roar_set_vol2(). 20 22 21 23 .SH "PARAMETERS" … … 28 30 The ID of the stream to change. 29 31 30 \fBNOTE:\fR the type of this argument may change in newer versions of the lib!31 32 32 .TP 33 33 \fBmixer\fR 34 FIXME 34 The mixer state for the stream. 35 35 36 36 .TP 37 37 \fBchannels\fR 38 FIXME 38 The number of channels to set mixer data for or the number of channels mixer data is returned. 39 40 .TP 41 \fBmode\fR 42 The mode of operating. Currently the following modes are supported: 43 ROAR_SET_VOL_ALL, ROAR_SET_VOL_MS, ROAR_SET_VOL_UNMAPPED. 39 44 40 45 .SH "RETURN VALUE" -
doc/man3/roar_server_oinfo.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_server_oinfo " "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_server_oinfo2" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME 6 roar_server_oinfo \- Gets information on the output stream of RoarAudio's sound server6 roar_server_oinfo, roar_server_oinfo2 \- Gets information on the output stream of RoarAudio's sound server 7 7 8 8 .SH SYNOPSIS … … 11 11 12 12 int roar_server_oinfo(struct roar_connection * con, struct roar_stream * s); 13 int roar_server_oinfo2(struct roar_connection * con, struct roar_stream * s, int dir); 13 14 14 15 .SH "DESCRIPTION" 15 Gets information on the output stream of the sound server. The output stream is the stream it sends 16 to the soundcard. This can be used to get optimal parameters for all operations so the server don't need to resample. 16 Gets information about the default mixer stream for the given stream direction. 17 This can be used to get optimal parameters for all operations so the server don't need to resample. 18 19 roar_server_oinfo() is marked as obsolete and will be removed soon. 17 20 18 21 .SH "PARAMETERS" … … 25 28 A stream object to be filled with information on the output stream. 26 29 30 .TP 31 \fBdir\fR 32 The stream direction to query mixer data for. 33 27 34 .SH "RETURN VALUE" 28 35 On success these calls return 0. On error, \-1 is returned. … … 32 39 33 40 .SH "SEE ALSO" 34 \fBroar_simple_filter\fR(3),35 \fBroar_simple_monitor\fR(3),36 41 \fBlibroar\fR(7), 37 42 \fBRoarAudio\fR(7). -
doc/man3/roar_simple_close.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_simple_close" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_simple_close" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME … … 14 14 .SH "DESCRIPTION" 15 15 Closes a filehandle opened via \fBroar_simple_play\fR(3), \fBroar_simple_monitor\fR(3), \fBroar_simple_record\fR(3), \fBroar_simple_filter\fR(3) or \fBroar_simple_new_stream\fR(3). 16 17 This function is marked obsolete and will be removed soon. Use \fBroar_vs_close\fR(3). 16 18 17 19 .SH "PARAMETERS" … … 28 30 29 31 .SH "SEE ALSO" 32 \fBroar_vs_close\fR(3), 30 33 \fBroar_simple_play\fR(3), 31 34 \fBroar_simple_monitor\fR(3), -
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). -
doc/man3/roar_simple_get_standby.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_simple_get_standby" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_simple_get_standby" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME … … 15 15 Asks the server for it's standby state. 16 16 17 This function is marked obsolete and will be removed soon. Use \fRroar_get_standby\fR(3). 18 17 19 .SH "PARAMETERS" 18 20 .TP … … 27 29 28 30 .SH "SEE ALSO" 31 \fRroar_get_standby\fR(3), 29 32 \fBlibroar\fR(7), 30 33 \fBRoarAudio\fR(7). -
doc/man3/roar_simple_new_stream.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_simple_new_stream" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_simple_new_stream" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME … … 19 19 some meta data or the volume to be updated after the stream is open. 20 20 21 This functions are marked obsolete and will be removed in later releases. 22 Please upgrade to VS API. See \fBroar_vs_new_simple\fR(3). 21 23 22 24 .SH "PARAMETERS" 23 25 .TP 24 26 \fBcon\fR 25 The "parent" connection. This is a valid open control lconnection as opend via \fBroar_simple_connect\fR(3).27 The "parent" connection. This is a valid open control connection as opend via \fBroar_simple_connect\fR(3). 26 28 27 29 .TP … … 45 47 46 48 .SH "SEE ALSO" 49 \fBroar_vs_new_simple\fR(3), 47 50 \fBroar_simple_connect\fR(3), 48 51 \fBroar_simple_play\fR(3), -
doc/man3/roar_simple_play.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_simple_play" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_simple_play" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME … … 22 22 After you are done you need to close the connection via \fBroar_simple_close\fR(3). 23 23 In case you just don't do anything with the stream the server will kick your connection, or, in case of playback 24 warns the user avout underruns. 24 warns the user about underruns. 25 26 All those functions are marked obsolete and will be removed soon. 27 Please upgrade to VS API. See \fBroar_vs_new_simple\fR(3). 25 28 26 29 .SH "PARAMETERS" … … 67 70 68 71 .SH "SEE ALSO" 72 \fBroar_vs_new_simple\fR(3), 69 73 \fBroarcat\fR(1), \fBroarmon\fR(1), \fBroarrec\fR(1), \fBroarfilt\fR(1), 70 74 \fBroar_server_oinfo\fR(3), -
doc/man3/roar_simple_stream.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_simple_stream" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_simple_stream" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME … … 13 13 14 14 .SH "DESCRIPTION" 15 This creates a new stream to RoarAudio. Normaly you want to use one of \fBroar_simple_play\fR(3), \fBroar_simple_monitor\fR(3), \fBroar_simple_record\fR(3) or \fBroar_simple_filter\fR(3). 15 This creates a new stream to RoarAudio. Normally you want to use one of \fBroar_simple_play\fR(3), \fBroar_simple_monitor\fR(3), \fBroar_simple_record\fR(3) or \fBroar_simple_filter\fR(3). 16 17 his functions are marked obsolete and will be removed very soon. 18 Please upgrade to VS API. See \fBroar_vs_new_simple\fR(3). 16 19 17 20 .SH "PARAMETERS" … … 56 59 57 60 .SH "SEE ALSO" 61 \fBroar_vs_new_simple\fR(3), 58 62 \fBroar_simple_play\fR(3), 59 63 \fBroar_simple_close\fR(3), -
doc/man3/roar_socket_listen.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_socket_listen" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_socket_listen" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME -
doc/man3/roar_socket_nonblock.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_socket_nonblock" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_socket_nonblock" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME -
doc/man3/roar_str2codec.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_str2codec" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_str2codec" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME -
doc/man3/roar_stream_add_data.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_stream_add_data" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_stream_add_data" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME -
doc/man3/roar_stream_connect.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_stream_connect" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_stream_connect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME -
doc/man3/roar_stream_connect_to.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_stream_connect_to" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_stream_connect_to" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME -
doc/man3/roar_stream_exec.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_stream_exec" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_stream_exec" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME -
doc/man3/roar_stream_new.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_stream_new" "3" " July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_stream_new" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME -
doc/man3/roar_vio_close.3
r4013 r5032 1 1 .\" roar_simple_play.3: 2 2 3 .TH "roar_vio_close" "3" "Ma rch 2009" "RoarAudio" "System Manager's Manual: RoarAuido"3 .TH "roar_vio_close" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" 4 4 5 5 .SH NAME
Note: See TracChangeset
for help on using the changeset viewer.