source: roaraudio/doc/man3/roar_vs_close.3 @ 5038:9b8c150a0b13

Last change on this file since 5038:9b8c150a0b13 was 5038:9b8c150a0b13, checked in by phi, 11 years ago

typo

File size: 1.0 KB
Line 
1.\" roar_simple_play.3:
2
3.TH "roar_vs_close" "3" "May 2011" "RoarAudio" "RoarAudio Programmer's Manual"
4
5.SH NAME
6roar_vs_close \- Closes a VS object
7
8.SH SYNOPSIS
9
10#include <roaraudio.h>
11
12int roar_vs_close(roar_vs_t * vss, int killit, int * error);
13
14.SH "DESCRIPTION"
15This function closes a open VS object. The object can be closed and pending data
16(mainly network and server side buffers) is played or killed so no pending data is played.
17The later one is useful in case of handling errors.
18
19.SH "PARAMETERS"
20.TP
21\fBvss\fR
22The VS object to be closed.
23
24.TP
25\fBkillit\fR
26Specifies if the stream should be killed on the server side. Must be ROAR_VS_TRUE or ROAR_VS_FALSE.
27
28.TP
29\fBerror\fR
30This is a pointer to a integer used to store the error value in case of error.
31This can be NULL if not used but it is very recommended to use this error value to report
32good error messages to the user.
33
34.SH "RETURN VALUE"
35On success these calls return 0.  On error, \-1 is returned.
36
37.SH "EXAMPLES"
38FIXME
39
40.SH "SEE ALSO"
41\fBroarvs\fR(7),
42\fBlibroar\fR(7),
43\fBRoarAudio\fR(7).
44
45.\" ll
Note: See TracBrowser for help on using the repository browser.