1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
#ifndef foopolyplibcontexthfoo
#define foopolyplibcontexthfoo
/* $Id$ */
/***
This file is part of polypaudio.
polypaudio is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2 of the License,
or (at your option) any later version.
polypaudio is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with polypaudio; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA.
***/
#include <polyp/sample.h>
#include <polyp/polyplib-def.h>
#include <polyp/mainloop-api.h>
#include <polyp/cdecl.h>
#include <polyp/polyplib-operation.h>
/** \file
* Connection contexts for asynchrononous communication with a
* server. A pa_context object wraps a connection to a polypaudio
* server using its native protocol. A context may be used to issue
* commands on the server or to create playback or recording
* streams. Multiple playback streams may be piped through a single
* connection context. Operations on the contect involving
* communication with the server are executed asynchronously: i.e. the
* client function do not implicitely wait for completion of the
* operation on the server. Instead the caller specifies a call back
* function that is called when the operation is completed. Currently
* running operations may be canceled using pa_operation_cancel(). */
/** \example pacat.c
* A playback and recording tool using the asynchronous API */
/** \example paplay.c
* A sound file playback tool using the asynchronous API, based on libsndfile */
PA_C_DECL_BEGIN
/** \struct pa_context
* An opaque connection context to a daemon */
struct pa_context;
/** Instantiate a new connection context with an abstract mainloop API
* and an application name */
struct pa_context *pa_context_new(struct pa_mainloop_api *mainloop, const char *name);
/** Decrease the reference counter of the context by one */
void pa_context_unref(struct pa_context *c);
/** Increase the reference counter of the context by one */
struct pa_context* pa_context_ref(struct pa_context *c);
/** Set a callback function that is called whenever the context status changes */
void pa_context_set_state_callback(struct pa_context *c, void (*cb)(struct pa_context *c, void *userdata), void *userdata);
/** Return the error number of the last failed operation */
int pa_context_errno(struct pa_context *c);
/** Return non-zero if some data is pending to be written to the connection */
int pa_context_is_pending(struct pa_context *c);
/** Return the current context status */
enum pa_context_state pa_context_get_state(struct pa_context *c);
/** Connect the context to the specified server. If server is NULL,
connect to the default server. This routine may but will not always
return synchronously on error. Use pa_context_set_state_callback() to
be notified when the connection is established. If spawn is non-zero
and no specific server is specified or accessible a new daemon is
spawned. If api is non-NULL, the functions specified in the structure
are used when forking a new child process. */
int pa_context_connect(struct pa_context *c, const char *server, int spawn, const struct pa_spawn_api *api);
/** Terminate the context connection immediately */
void pa_context_disconnect(struct pa_context *c);
/** Drain the context. If there is nothing to drain, the function returns NULL */
struct pa_operation* pa_context_drain(struct pa_context *c, void (*cb) (struct pa_context*c, void *userdata), void *userdata);
/** Tell the daemon to exit. No operation object is returned as the
* connection is terminated when the daemon quits, thus this operation
* would never complete. */
void pa_context_exit_daemon(struct pa_context *c);
/** Set the name of the default sink. \since 0.4 */
struct pa_operation* pa_context_set_default_sink(struct pa_context *c, const char *name, void(*cb)(struct pa_context*c, int success, void *userdata), void *userdata);
/** Set the name of the default source. \since 0.4 */
struct pa_operation* pa_context_set_default_source(struct pa_context *c, const char *name, void(*cb)(struct pa_context*c, int success, void *userdata), void *userdata);
/** Returns 1 when the connection is to a local daemon. Returns negative when no connection has been made yet. \since 0.5 */
int pa_context_is_local(struct pa_context *c);
/** Set a different application name for context on the server. \since 0.5 */
struct pa_operation* pa_context_set_name(struct pa_context *c, const char *name, void(*cb)(struct pa_context*c, int success, void *userdata), void *userdata);
/** Return the server name this context is connected to. \since 0.7 */
const char* pa_context_get_server(struct pa_context *c);
PA_C_DECL_END
#endif
|
