浏览代码

docs: Clarify that data for source/encoder properties can be null

gxalpha 2 年之前
父节点
当前提交
f05b719950
共有 2 个文件被更改,包括 10 次插入0 次删除
  1. 5 0
      docs/sphinx/reference-encoders.rst
  2. 5 0
      docs/sphinx/reference-sources.rst

+ 5 - 0
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

+ 5 - 0
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)