Skip to content

docs: Add precision on editable string lists #9501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Penwy wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Add precision on editable string lists #9501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/sphinx/reference-properties.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -664,6 +664,8 @@ 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``.
Comment thread
Penwy marked this conversation as resolved.

---------------------

.. function:: size_t obs_property_list_add_int(obs_property_t *p, const char *name, long long val)
Expand Down Expand Up @@ -694,6 +696,8 @@ 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)
Expand Down
2 changes: 2 additions & 0 deletions docs/sphinx/reference-settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,8 @@ 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)
Expand Down