source: roaraudio/doc/man3/roar_vs_pause.3 @ 5042:4d702bd52fdb

Last change on this file since 5042:4d702bd52fdb was 5042:4d702bd52fdb, checked in by phi, 13 years ago

commit pending new manpages

File size: 1.1 KB
Line 
1.TH "roar_vs_pause" "3" "May 2011" "RoarAudio" "RoarAudio Programmer's Manual"
2
3.SH NAME
4roar_vs_pause, roar_vs_mute \- Alter stream flags
5
6.SH SYNOPSIS
7
8#include <roaraudio.h>
9
10int     roar_vs_pause(roar_vs_t * vss, int val, int * error);
11
12int     roar_vs_mute (roar_vs_t * vss, int val, int * error);
13
14.SH "DESCRIPTION"
15roar_vs_pause() and roar_vs_mute() alters the stream flags PAUSE and MUTE, respectively.
16
17.SH "PARAMETERS"
18.TP
19\fBvss\fR
20The VS object pointing to the stream which flags should be altered.
21
22.TP
23\fBval\fR
24Specifies the new state. Value must be ROAR_VS_TRUE, ROAR_VS_FALSE, ROAR_VS_TOGGLE or ROAR_VS_ASK.
25
26.TP
27\fBerror\fR
28This is a pointer to a integer used to store the error value in case of error.
29This can be NULL if not used but it is very recommended to use this error value to report
30good error messages to the user.
31
32.SH "RETURN VALUE"
33On success these calls return the old (current if ROAR_VS_ASK is used) state of the stream flag\.
34On error, \-1 is returned.
35
36.SH "EXAMPLES"
37FIXME
38
39.SH "SEE ALSO"
40\fBroarvs\fR(7),
41\fBlibroar\fR(7),
42\fBRoarAudio\fR(7).
43
44.\" ll
Note: See TracBrowser for help on using the repository browser.