summaryrefslogtreecommitdiff
path: root/include/asterisk/stream.h
diff options
context:
space:
mode:
authorRichard Mudgett <rmudgett@digium.com>2017-06-14 13:07:17 -0500
committerRichard Mudgett <rmudgett@digium.com>2017-06-15 09:42:15 -0500
commit4797a8bb810c7b7c5445f49f367e3f054797fd7c (patch)
tree08fc0b4e726e74ed43f238fcb127f2b0f181783a /include/asterisk/stream.h
parent06265b8c8a7e38707c76b5ca257882223797e612 (diff)
stream: Ignore declined streams for some topology calls.
* Made ast_format_cap_from_stream_topology() not include any formats from declined streams. * Made ast_stream_topology_get_first_stream_by_type() ignore declined streams to return the first active stream of the type. * Updated unit tests to check these changes have the expected effect. Change-Id: Iabbc6a3e8edf263a25fd3056c3c614407c7897df
Diffstat (limited to 'include/asterisk/stream.h')
-rw-r--r--include/asterisk/stream.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/include/asterisk/stream.h b/include/asterisk/stream.h
index 14d624fb2..00169a3f1 100644
--- a/include/asterisk/stream.h
+++ b/include/asterisk/stream.h
@@ -401,8 +401,11 @@ struct ast_stream_topology *ast_stream_topology_create_from_format_cap(
struct ast_format_cap *cap);
/*!
- * \brief A helper function that, given a stream topology, creates a format
- * capabilities structure containing all formats from all streams.
+ * \brief Create a format capabilities structure representing the topology.
+ *
+ * \details
+ * A helper function that, given a stream topology, creates a format
+ * capabilities structure containing all formats from all active streams.
*
* \param topology The topology of streams
*
@@ -417,7 +420,7 @@ struct ast_format_cap *ast_format_cap_from_stream_topology(
struct ast_stream_topology *topology);
/*!
- * \brief Gets the first stream of a specific type from the topology
+ * \brief Gets the first active stream of a specific type from the topology
*
* \param topology The topology of streams
* \param type The media type