4aiman/obs-studio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
obs-studio/docs/sphinx
History
gxalpha 62ef7e0fee libobs: Deprecate obs_get_transition_by_[name|uuid] 
obs_get_transition_by_name is very problematic because transitions are
always private and their names aren't unique. This means that the method
iterates over all private sources and then takes the first that both is
a transition and matches the name we're looking for. However, this could
be from anywhere - it could be a frontend transition, but also a source
transition, quick transition, or even one from third-party plugins. This
is always never what is intended.

As such, this method (which should never have been added in the first
place) needs to go. In its place, obs_frontend_get_transitions returns a
list of all frontend transitions (which is usually what people are
looking for), and alternatively obs_get_source_by_uuid also provides
access to private sources.

While we're at it, obs_get_transition_by_uuid is basically a wrapper for
obs_get_source_by_uuid and not really necessary. UUID's are unique and
a source doesn't suddenly change its type, so if you have a transition's
UUID you can be pretty sure that when you do obs_get_source_by_uuid, it
will still be a transition.
2025-04-01 17:07:24 -04:00
..
_build docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
_static docs/sphinx: Override RTD style 2022-07-30 11:09:01 +10:00
_templates docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
backend-design.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
conf.py Update copyrights/names 2023-05-20 01:31:18 -07:00
favicon.ico CI: Use ReadTheDocs theme for Sphinx docs 2022-07-30 11:09:01 +10:00
frontends.rst docs/sphinx: Minor formatting corrections 2022-06-05 12:14:05 +10:00
graphics.rst docs/sphinx: Document SRGB changes 2021-01-21 07:42:56 -08:00
index.rst docs/sphinx: RTD-friendly documentation changes 2022-07-30 11:09:01 +10:00
logo.svg docs/sphinx: RTD-friendly documentation changes 2022-07-30 11:09:01 +10:00
make.bat docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
Makefile docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
plugins.rst docs/sphinx: RTD-friendly documentation changes 2022-07-30 11:09:01 +10:00
reference-core-objects.rst docs/sphinx: RTD-friendly documentation changes 2022-07-30 11:09:01 +10:00
reference-core.rst libobs: Deprecate obs_get_transition_by_[name|uuid] 2025-04-01 17:07:24 -04:00
reference-encoders.rst libobs: Add obs_encoder_get_mixer_index 2024-09-12 18:07:19 -04:00
reference-frontend-api.rst docs: Add obs_frontend_get_user_config 2024-09-17 12:10:22 -04:00
reference-libobs-callback.rst docs: Clarify signal_handler_connect() 2022-12-03 15:19:06 -08:00
reference-libobs-graphics-axisang.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics-effects.rst docs: Fix layout and typos 2023-02-26 10:31:02 +11:00
reference-libobs-graphics-graphics.rst libobs,libobs-opengl: Add gs_sync_t 2025-02-05 16:20:15 -05:00
reference-libobs-graphics-image-file.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics-math.rst docs: Fix macro definitions 2023-07-08 16:09:09 -07:00
reference-libobs-graphics-matrix4.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics-quat.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics-vec2.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics-vec3.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics-vec4.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-graphics.rst docs/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-libobs-media-io.rst libobs: Add video_output_disconnect2() 2025-01-28 17:36:51 -05:00
reference-libobs-util-base.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-util-bmem.rst docs/sphinx: Fix statement typo for bfree() 2022-05-30 20:57:39 -07:00
reference-libobs-util-circlebuf.rst docs: Fix circlebuf deprecation note 2024-02-08 18:21:37 -05:00
reference-libobs-util-config-file.rst docs: Add missing config_t get/set functions 2021-11-23 21:52:30 -08:00
reference-libobs-util-darray.rst docs: Add example for DARRAY as function parameter 2023-07-06 01:47:24 -07:00
reference-libobs-util-deque.rst docs: Add versionadded for 30.x functions 2024-06-03 13:52:34 -04:00
reference-libobs-util-dstr.rst docs: Clarify strlist_split 2023-08-27 09:55:36 +10:00
reference-libobs-util-platform.rst docs: Add versionadded directives for 29.1 2023-06-25 09:29:25 +10:00
reference-libobs-util-profiler.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-util-serializers.rst libobs/util: Add buffered file serializer 2024-05-18 16:15:41 -07:00
reference-libobs-util-source-profiler.rst docs: Add source profiler functions 2024-08-10 23:51:39 -07:00
reference-libobs-util-text-lookup.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-util-threading.rst docs/sphinx: Minor formatting corrections 2022-06-05 12:14:05 +10:00
reference-libobs-util.rst docs: Add source profiler functions 2024-08-10 23:51:39 -07:00
reference-modules.rst docs: Add versionadded for 30.x functions 2024-06-03 13:52:34 -04:00
reference-outputs.rst libobs: Add optional reconnect callback to outputs 2025-03-17 13:30:58 -04:00
reference-properties.rst docs: Add versionadded for 30.x functions 2024-06-03 13:52:34 -04:00
reference-scenes.rst libobs: Remove relative positioning functions 2024-12-04 14:41:03 -05:00
reference-services.rst docs,libobs: Remove deprecated service APIs 2024-08-28 19:10:27 -04:00
reference-settings.rst docs: Add versionadded for 30.x functions 2024-06-03 13:52:34 -04:00
reference-sources.rst docs,libobs: Remove/internalize deprecated addref functions 2024-08-28 19:10:27 -04:00
requirements.txt docs: Fix sphinx import error on Python 3.10+ 2022-10-20 21:26:52 +11:00
scripting.rst docs: Add note about instance methods as callbacks in scripting 2023-04-15 16:36:32 -07:00