Skip to content

Commit

Permalink
docs: Document newer JSON serialization functions
Browse files Browse the repository at this point in the history
  • Loading branch information
derrod authored and Lain-B committed May 26, 2024
1 parent 94d158c commit e54af0d
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/sphinx/reference-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,30 @@ General Functions

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

.. function:: const char *obs_data_get_json_with_defaults(obs_data_t *data)

Same as :c:func:`obs_data_get_json()` but default values are also serialized.

:return: Json string for this object

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

.. function:: const char *obs_data_get_json_pretty(obs_data_t *data)

Same as :c:func:`obs_data_get_json()` but the JSON data is pretty-printed.

:return: Json string for this object

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

.. function:: const char *obs_data_get_json_pretty_with_defaults(obs_data_t *data)

Same as :c:func:`obs_data_get_json_pretty()` but default values are also serialized.

:return: Json string for this object

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

.. function:: const char *obs_data_get_last_json(obs_data_t *data)

Returns the last json string generated for this data object. Does not
Expand Down

0 comments on commit e54af0d

Please sign in to comment.