docs: Add precision on editable string lists

This commit is contained in:
Penwywern
2026-09-01 17:55:58 -04:00
committed by Ryan Foster
parent e8c4e7181c
commit 7525aa1c5c
2 changed files with 9 additions and 0 deletions
+6
View File
@@ -741,6 +741,9 @@ Property Modification Functions
:param val: The actual string value stored and will be returned by :c:func:`obs_data_get_string`
:returns: The index of the list item.
Note: If ``p`` is of type OBS_COMBO_TYPE_EDITABLE, :c:func:`obs_data_get_string` will return ``name`` instead of
``val``.
---------------------
.. function:: size_t obs_property_list_add_int(obs_property_t *p, const char *name, long long val)
@@ -771,6 +774,9 @@ Property Modification Functions
:param name: Localized name shown to user
:param val: The actual string value stored and will be returned by :c:func:`obs_data_get_string`
Note: If ``p`` is of type OBS_COMBO_TYPE_EDITABLE, :c:func:`obs_data_get_string` will return ``name`` instead of
``val``.
---------------------
.. function:: void obs_property_list_insert_int(obs_property_t *p, size_t idx, const char *name, long long val)
+3
View File
@@ -188,6 +188,9 @@ Get Functions
.. function:: const char *obs_data_get_string(obs_data_t *data, const char *name)
Note: If the data object was generated from a OBS_COMBO_TYPE_EDITABLE property, the property's ``name`` will be
returned instead of its ``val``.
---------------------
.. function:: long long obs_data_get_int(obs_data_t *data, const char *name)