summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/libcamera/stream.cpp29
1 files changed, 29 insertions, 0 deletions
diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
index 3398c597..d60f8324 100644
--- a/src/libcamera/stream.cpp
+++ b/src/libcamera/stream.cpp
@@ -271,6 +271,23 @@ SizeRange StreamFormats::range(unsigned int pixelformat) const
*/
/**
+ * \todo This method is deprecated and should be removed once all pipeline
+ * handlers provied StreamFormats.
+ */
+StreamConfiguration::StreamConfiguration()
+ : stream_(nullptr)
+{
+}
+
+/**
+ * \brief Construct a configuration with stream formats
+ */
+StreamConfiguration::StreamConfiguration(const StreamFormats &formats)
+ : stream_(nullptr), formats_(formats)
+{
+}
+
+/**
* \var StreamConfiguration::size
* \brief Stream size in pixels
*/
@@ -311,6 +328,18 @@ SizeRange StreamFormats::range(unsigned int pixelformat) const
*/
/**
+ * \fn StreamConfiguration::formats()
+ * \brief Retrieve advisory stream format information
+ *
+ * This method retrieves information about the pixel formats and sizes supported
+ * by the stream configuration. The sizes are advisory and not all of them are
+ * guaranteed to be supported by the stream. Users shall always inspect the size
+ * in the stream configuration after calling CameraConfiguration::validate().
+ *
+ * \return Stream formats information
+ */
+
+/**
* \brief Assemble and return a string describing the configuration
*
* \return A string describing the StreamConfiguration