From f05b719950f51a606cd55ebbfc18858cfdc0f3a2 Mon Sep 17 00:00:00 2001 From: gxalpha Date: Fri, 21 Apr 2023 19:33:22 +0200 Subject: [PATCH] docs: Clarify that data for source/encoder properties can be null --- docs/sphinx/reference-encoders.rst | 5 +++++ docs/sphinx/reference-sources.rst | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/docs/sphinx/reference-encoders.rst b/docs/sphinx/reference-encoders.rst index 7ff45a561..75e96ae08 100644 --- a/docs/sphinx/reference-encoders.rst +++ b/docs/sphinx/reference-encoders.rst @@ -90,6 +90,11 @@ Encoder Definition Structure (obs_encoder_info) Gets the property information of this encoder. + :param data: The implementation data associated with this encoder. + This value can be null (e.g., when + :c:func:`obs_get_encoder_properties()` is called on the + encoder type), make sure to handle this gracefully. + (Optional) :return: The properties of the encoder diff --git a/docs/sphinx/reference-sources.rst b/docs/sphinx/reference-sources.rst index caab1163c..5cfe65e8b 100644 --- a/docs/sphinx/reference-sources.rst +++ b/docs/sphinx/reference-sources.rst @@ -222,6 +222,11 @@ Source Definition Structure (obs_source_info) obs_properties_t *(*obs_source_info.get_properties2)(void *data, void *type_data) Gets the property information of this source. + + :param data: The implementation data associated with this source. + This value can be null (e.g., when + :c:func:`obs_get_source_properties()` is called on the + source type), make sure to handle this gracefully. (Optional)