53 Commits
Author SHA1 Message Date
ExeldroandRyan Foster 854948b8df frontend: Add copy paste functions 2026-05-22 17:25:23 -04:00
Sebastian BeckmannandRyan Foster 5730f86050 frontend/api: Remove obs_frontend_add_dock
Deprecated since cde5545f8f (30.0).
2025-08-20 18:05:15 -04:00
ExeldroandRyan Foster a289581579 docs: Add obs_frontend_get_user_config 2024-09-17 12:10:22 -04:00
tytan652andMatt Gajownik 3b266fec22 UI,docs: Send a custom event to the dock widget when closing 2024-08-04 10:18:59 +10:00
CodeYan01andRyan Foster 9c427c5f93 docs: Add versionadded for 30.x functions 2024-06-03 13:52:34 -04:00
derrodandRyan Foster cf4681a9c3 docs: Document obs_frontend_recording_add_chapter() 2024-05-29 12:29:45 -04:00
CodeYan01andLain f5fe9999b4 docs: Add info on obs_frontend_source_list 2023-12-02 18:01:55 -06:00
Susko3andLain f173650103 docs: Fix missing accessor in example
Tested this in code, and it makes sense from the way
`scenes.sources.array[i]` is accessed.
2023-11-25 17:29:21 -06:00
tytan652andLain 595306cd54 docs: Fix obs_frontend_add_dock deprecation version 2023-08-17 04:54:01 -07:00
Richard StanwayandLain f7eb634788 docs: Clarify OBS_FRONTEND_EVENT_EXIT intent 2023-07-15 16:54:51 -07:00
CodeYan01andMatt Gajownik c3dafe0703 docs: Add versionadded directives for 29.1 2023-06-25 09:29:25 +10:00
SuslikVandLain 90affc03fb docs: Fix param name
Copy-paste mistake
2023-06-17 16:30:07 -07:00
tytan652andLain 90d96e92c2 obs-frontend-api,UI,docs: Add API to add custom docks with no toggle
Some plugin does that by deleting the QAction returned by
obs_frontend_add_dock().

Now that obs_frontend_add_dock() is deprecated,
obs_frontend_add_custom_qdock() replace this usage.
2023-06-03 16:47:01 -07:00
tytan652andLain cde5545f8f obs-frontend-api,UI,docs: Add dock API that ask for unique object name
obs_frontend_add_dock() is deprecated in favor of
obs_frontend_add_dock_by_id()
2023-06-03 16:47:01 -07:00
WarmUpTillandJim 0d6588fa8c docs: Fix obs_frontend_get_scene_collections() description 2023-04-22 16:43:07 -07:00
CodeYan01andRyan Foster b4fdf2a329 docs: Clarify enum_scenes order 2023-03-01 09:44:35 -05:00
ExeldroandJim 2d3013ccdc UI: Add obs_frontend_add_undo_redo_action 2023-02-04 15:30:07 -08:00
ExeldroandJim 46da073aa5 UI: Add obs_frontend_open_sceneitem_edit_transform() 2023-02-04 15:23:26 -08:00
gxalphaandJim 563cf6544d docs: Fix reference count info of obs_frontend_get_streaming_service 2022-12-03 15:36:49 -08:00
CodeYan01andJim 862ed14fd9 docs: Add versionadded for 29.0.0 functions 2022-12-03 15:33:59 -08:00
CodeYan01andJim bdf6809f45 docs: Add clarifications
Adds links to release functions for "new/incremented reference".
Extra info on signal handler.
Parameter description on `obs_property_list_add_*` functions, since
their parameter `name` can be confusing and it is unclear which value
is stored in obs_data_t.
Adds clarifications on calldata_ptr.
2022-11-05 16:12:13 -07:00
Jim 1fc6c50b62 UI/obs-frontend-api: Return allocated strings for new funcs
8dda8d3500 added a few functions to get the last
recording/replay/screenshot path, but it should return allocations
because it's possible for the data to be modified at a later point.
2022-10-30 20:35:36 -07:00
cg2121andJim 8dda8d3500 obs-frontend-api: Add functions to get last saved files
Adds functions to the frontend api to get the last recording,
screenshot and replay buffer saved.
2022-10-30 19:53:11 -07:00
cg2121andMatt Gajownik 42ecdef938 obs-frontend-api: Add screenshot event
This adds a frontend event for when a screenshot is taken.
2022-10-23 11:06:30 +11:00
cg2121andJim 3c7b1c8297 obs-frontend-api: Add theme functions
This adds a frontend function to check if a theme is dark and also
adds an event for when the theme is changed.
2022-10-15 16:21:34 -07:00
gxalphaandMatt Gajownik 467f73d4c9 obs-frontend-api: Add function for manual file splitting 2022-07-30 18:50:13 +10:00
Matt GajownikandMatt Gajownik ff555dd2b0 CI: Update docs to Sphinx v3, fix warnings
Sphinx 3 adds a number of C and C++ friendly directives, making
documenting our code much easier.
2022-07-30 11:09:01 +10:00
cg2121andJim 65a360fa41 obs-frontend-api: Add function to get frontend translated string
Developers now can easily get a translated string from the frontend
instead of using their own translations.
2022-03-10 06:27:18 -08:00
cg2121andJim 748cf32a43 UI: Add events for renaming profiles/collections
The events make it more clear when profiles or scene
collections are renamed.
2022-03-08 11:17:59 -08:00
gxalphaandJim 3fb2e27825 docs: Fix frontend API docs for preview_scene functions 2022-01-04 01:53:42 -08:00
tt2468andJim 47397ce527 UI: Add obs_frontend_open_source_interaction()
Adds a frontend api call to open the interact dialog of a source,
just like the `_properties` and `_filters` functions.
2021-12-28 21:44:35 -08:00
tt2468andJim 466ba5ae29 docs: Fix names of filter/properties functions 2021-12-28 16:49:00 -08:00
tt2468andJim 9147ce3287 docs: Add missing frontend-api calls + organize
Add all missing obs_frontend_*() functions, plus organize the
`obs_frontend_event` enum. It wasn't ordered the same as the header
file, so we might as well take the opportunity to make it clearer.
2021-11-23 21:52:30 -08:00
Clayton GroeneveldandJim 8d349ea4aa obs-frontend-api: Add scripting shutdown event
This event is for when scripts need to know when OBS is exiting.
Currently scripts are destroyed before the current exit event.
2021-11-15 10:20:55 -08:00
tt2468andJim a65287d615 docs: Add obs_frontend_get_current_record_output_path() 2021-11-13 16:05:52 -08:00
tt2468andJim 10b3a9a84a docs: Add _CHANGING frontend events
Also improves a few related event descriptions.
2021-11-10 06:36:23 -08:00
Ben AlmanandJim f48259f2b3 docs: Add transition duration changed event 2021-09-20 18:54:11 -07:00
ExeldroandJim 5b18faeb49 UI: Add functions to open properties and filters 2021-08-12 04:31:40 -07:00
SCG82andDillon Pentz 88cc691afa UI: Add obs-frontend-api functions to create/delete profiles 2021-07-09 19:32:18 +12:00
tt2468andDillon Pentz 9ca70f4470 UI: Add obs_frontend_get_current_profile_path()
Returns the path of the current profile's location on the filesystem.
2021-07-09 17:39:40 +12:00
jp9000 2a63d60d23 docs: Fix erroneous code example 2021-04-24 23:17:58 -07:00
Christopher P. YargerandJim dcf3e6cd06 docs: Add entries for Frontend API T-bar control 2021-03-10 20:18:36 -08:00
tt2468andJim 1ea8183737 Docs: Add obs_frontend_reset_video() 2021-02-03 08:53:42 -08:00
Clayton GroeneveldandJim 3bc4e8ecba obs-frontend-api: Add frontend api functions for the virtual camera
This adds functions to the frontend api to start/stop the virtual
camera, to check if it is active and adds function to get the output
reference. It also adds api events for when the virtual camera is
started or stopped.
2021-01-13 09:46:04 -08:00
Andrew WoodwardandJim ae9b7eaa9a docs/sphinx: Add missing obs_frontend_open_projector 2021-01-02 04:34:59 -08:00
hgonomegandGitHub d3ec3e99d5 UI: Add replay buffer saved event to the frontend api (#3592)
* obs-frontend-api: add the event of saving replay buffer

Add OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED as given by RFC 33

* UI: Emit the replay buffer saved event to the api

Send the OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED to api (as in rfc33)

* docs/sphinx: Add replay buffer saved event

Documentation provided for OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED (RFC33)
2020-10-10 17:53:13 -07:00
Scratch 8dde1fc874 Docs: Fix Frontend Finish Loading event 2020-10-10 13:50:08 +11:00
Clayton Groeneveldandjp9000 a70014d7b2 UI: Add ability to make screenshots
Co-authored-by: Jim <obs.jim@gmail.com>
2020-07-30 17:41:43 -07:00
jp9000 eab10d48b2 UI: Add pause support
Adds support for pausing recordings.  When settings are eligible for
recordings, a pause button will appear next to the recording button.  If
the settings are not eligible, it will warn the user in the output
settings that they cannot pause recordings if those settings are used.
2019-07-08 08:11:56 -07:00
JimandGitHub 3a3cfce29d Merge pull request #1873 from Palakis/feature/frontend-api-studio-mode-transition
obs-frontend-api: Add method to trigger a Studio Mode transition
2019-05-09 19:24:59 -07:00