def, format: Document how to leave PCM parameters to be decided by the server

[pulseaudio] / src / pulse / context.h

diff --git a/src/pulse/context.h b/src/pulse/context.h
index 6b5ad1727579641784023a2d75bac143ab1bd838..3b8b9be7f353d9c47eee4b2e2513007d763566ea 100644 (file)
--- a/src/pulse/context.h
+++ b/src/pulse/context.h
@@ -174,7 +174,7 @@ typedef void (*pa_context_event_cb_t)(pa_context *c, const char *name, pa_propli
 pa_context *pa_context_new(pa_mainloop_api *mainloop, const char *name);
 
 /** Instantiate a new connection context with an abstract mainloop API
- * and an application name, and specify the the initial client property
+ * and an application name, and specify the initial client property
  * list. \since 0.9.11 */
 pa_context *pa_context_new_with_proplist(pa_mainloop_api *mainloop, const char *name, pa_proplist *proplist);
 
@@ -265,7 +265,7 @@ pa_time_event* pa_context_rttime_new(pa_context *c, pa_usec_t usec, pa_time_even
  * mainloop->time_restart). \since 0.9.16 */
 void pa_context_rttime_restart(pa_context *c, pa_time_event *e, pa_usec_t usec);
 
-/* Return the optimal block size for passing around audio buffers. It
+/** Return the optimal block size for passing around audio buffers. It
  * is recommended to allocate buffers of the size returned here when
  * writing audio data to playback streams, if the latency constraints
  * permit this. It is not recommended writing larger blocks than this
@@ -280,6 +280,14 @@ void pa_context_rttime_restart(pa_context *c, pa_time_event *e, pa_usec_t usec);
  * pa_stream_get_sample_spec(ss)); \since 0.9.20 */
 size_t pa_context_get_tile_size(pa_context *c, const pa_sample_spec *ss);
 
+/** Load the authentication cookie from a file. This function is primarily
+ * meant for PulseAudio's own tunnel modules, which need to load the cookie
+ * from a custom location. Applications don't usually need to care about the
+ * cookie at all, but if it happens that you know what the authentication
+ * cookie is and your application needs to load it from a non-standard
+ * location, feel free to use this function. \since 5.0 */
+int pa_context_load_cookie_from_file(pa_context *c, const char *cookie_file_path);
+
 PA_C_DECL_END
 
 #endif