Line | |
---|
1 | .\" roar_simple_play.3: |
---|
2 | |
---|
3 | .TH "roar_stream_exec" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" |
---|
4 | |
---|
5 | .SH NAME |
---|
6 | roar_stream_exec \- Set a stream as master stream of a client |
---|
7 | |
---|
8 | .SH SYNOPSIS |
---|
9 | |
---|
10 | #include <roaraudio.h> |
---|
11 | |
---|
12 | int roar_stream_exec(struct roar_connection * con, struct roar_stream * s); |
---|
13 | |
---|
14 | .SH "DESCRIPTION" |
---|
15 | This sets a stream to be the master stream of a client. |
---|
16 | A master stream is a stream send via the client's controll channel. |
---|
17 | If a master stream is closed the client and all it's streams are closed. |
---|
18 | Setting a master stream can not be undone nor can any controll commands be send |
---|
19 | anymore. This is used mainly for opening a connection for just playback without |
---|
20 | need to change things later like \fBroar_simple_play\fR(3) does it. |
---|
21 | |
---|
22 | .SH "PARAMETERS" |
---|
23 | .TP |
---|
24 | \fBcon\fR |
---|
25 | The connection to the server. |
---|
26 | |
---|
27 | .TP |
---|
28 | \fBs\fR |
---|
29 | The stream to be set as master stream. |
---|
30 | |
---|
31 | .SH "RETURN VALUE" |
---|
32 | On success these calls return 0. On error, \-1 is returned. |
---|
33 | |
---|
34 | .SH "EXAMPLES" |
---|
35 | FIXME |
---|
36 | |
---|
37 | .SH "SEE ALSO" |
---|
38 | \fBroar_simple_play\fR(3), |
---|
39 | \fBlibroar\fR(7), |
---|
40 | \fBRoarAudio\fR(7). |
---|
41 | |
---|
42 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.