stream: clarify the meaning of NULL device
authorTanu Kaskinen <tanuk@iki.fi>
Sat, 21 Dec 2019 07:58:57 +0000 (09:58 +0200)
committerTanu Kaskinen <tanuk@iki.fi>
Sat, 21 Dec 2019 07:58:57 +0000 (09:58 +0200)
The old wording could be understood so that the default sink/source
would always be used, but sometimes a policy module does a different
decision (for example module-stream-restore).

Related: https://gitlab.freedesktop.org/pulseaudio/pulseaudio/issues/767

src/pulse/stream.h

index 7913f7f..f9b52d4 100644 (file)
@@ -414,7 +414,7 @@ int pa_stream_is_corked(const pa_stream *s);
  * Returns zero on success. */
 int pa_stream_connect_playback(
         pa_stream *s                  /**< The stream to connect to a sink */,
-        const char *dev               /**< Name of the sink to connect to, or NULL for default */ ,
+        const char *dev               /**< Name of the sink to connect to, or NULL to let the server decide */ ,
         const pa_buffer_attr *attr    /**< Buffering attributes, or NULL for default */,
         pa_stream_flags_t flags       /**< Additional flags, or 0 for default */,
         const pa_cvolume *volume      /**< Initial volume, or NULL for default */,
@@ -423,7 +423,7 @@ int pa_stream_connect_playback(
 /** Connect the stream to a source. Returns zero on success. */
 int pa_stream_connect_record(
         pa_stream *s                  /**< The stream to connect to a source */ ,
-        const char *dev               /**< Name of the source to connect to, or NULL for default */,
+        const char *dev               /**< Name of the source to connect to, or NULL to let the server decide */,
         const pa_buffer_attr *attr    /**< Buffer attributes, or NULL for default */,
         pa_stream_flags_t flags       /**< Additional flags, or 0 for default */);