Skip to content

Commit

Permalink
docs: Document new Custom Browser Dock APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
Elgato-AStory committed Dec 21, 2021
1 parent aea8c51 commit 6713469
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/sphinx/reference-frontend-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,37 @@ Functions

:param dock: QDockWidget to add/create
:return: A pointer to the added QAction

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

.. function:: void obs_frontend_add_extra_browser_dock(const char *title, const char *url, const char *uuid)

Adds a Custom Browser Dock to the UI.

:param title: Name of the dock to create
:param url: URL of page to show in the new dock
:param uuid: Optional UUID string to identify the new dock, pass an empty string to have one generated automatically

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

.. function:: char **obs_frontend_get_extra_browser_docks(void)

Gets a list of all custom browser docks.

:return: A list of strings, ending with NULL. Each group of 3 strings
contains the data for one custom browser dock, in the order:
title[0], url[0], uuid[0], title[1], url[1], uuid[1], ...
The list is stored within one contiguous segment of memory,
so freeing the returned pointer with :c:func:`bfree()` will free
the entire list.

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

.. function:: void obs_frontend_remove_extra_browser_dock(const char *uuid)

Removes all custom browser docks with a given UUID.

:param uuid: UUID string to identify the dock(s) to remove

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

Expand Down

0 comments on commit 6713469

Please sign in to comment.