mirror/obs-studio
0
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2024-09-19 20:32:15 +02:00
Code

docs: Add property functions

Browse Source
This commit is contained in:
CodeYan01 2022-09-22 19:02:15 +08:00 committed by Ryan Foster
parent 67c1202849
commit 937986452b
1 changed files with 55 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
docs/sphinx/reference-properties.rst
View File

@ -75,6 +75,18 @@ General Functions
---------------------
.. function:: void obs_properties_remove_by_name(obs_properties_t *props, const char *property)
Removes a property from a properties list. Only valid in ``get_properties``,
``script_properties`` for scripts, ``modified_callback``, and ``modified_callback2``.
``modified_callback`` and ``modified_callback2`` *must* return true so that
all UI properties are rebuilt. Returning false is undefined behavior.
:param props: Properties to remove from.
:param property: Name of the property to remove.
---------------------
Property Object Functions
-------------------------
@ -249,6 +261,9 @@ Property Object Functions
settings; it's used to implement a button in user interface if the
properties are used to generate user interface.
If the properties need to be refreshed due to changes to the property layout,
the callback should return true, otherwise return false.
:param name: Setting identifier string
:param text: Localized name shown to user
:param callback: Callback to be executed when the button is pressed
@ -436,6 +451,10 @@ Property Enumeration Functions
---------------------
.. function:: const char * obs_property_int_suffix(obs_property_t *p)
---------------------
.. function:: double obs_property_float_min(obs_property_t *p)
---------------------
@ -452,10 +471,22 @@ Property Enumeration Functions
---------------------
.. function:: const char * obs_property_float_suffix(obs_property_t *p)
---------------------
.. function:: enum obs_text_type obs_property_text_type(obs_property_t *p)
---------------------
.. function:: bool obs_property_text_monospace(obs_property_t *p)
Returns whether the input of the text property should be rendered
with a monospace font or not. Only has an effect if the text type
of the property is ``OBS_TEXT_MULTILINE``, even if this returns *true*.
---------------------
.. function:: enum obs_text_info_type obs_property_text_info_type(obs_property_t *p)
:return: One of the following values:
@ -638,6 +669,30 @@ Property Modification Functions
---------------------
.. function:: void obs_property_int_set_suffix(obs_property_t *p, const char *suffix)
Adds a suffix to the int property, such that 100 will show up
as "100ms" if the suffix is "ms". The user will only be able
to edit the number, not the suffix.
---------------------
.. function:: void obs_property_float_set_suffix(obs_property_t *p, const char *suffix)
Adds a suffix to the float property, such that 1.5 will show up
as "1.5s" if the suffix is "s". The user will only be able
to edit the number, not the suffix.
---------------------
.. function:: void obs_property_text_set_monospace(obs_property_t *p, bool monospace)
Sets whether the input of text property should be rendered with
a monospace font or not. Only has an effect if the text type of
the property is ``OBS_TEXT_MULTILINE``.
---------------------
.. function:: void obs_property_text_set_info_type(obs_property_t *p, enum obs_text_info_type type)
:param type: Can be one of the following values: