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