4aiman/obs-studio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
obs-studio/docs/sphinx
History
tt2468 d314d4725d libobs, plugins: Deprecate obs_output_t functions with flag parameters 
This deprecates the following functions, replacing them with new
versions:
- `obs_output_can_begin_data_capture()` - now `*capture2()`
- `obs_output_initialize_encoders()` - now `*encoders2()`
- `obs_output_begin_data_capture()` - now `*capture2()`

The flags parameter was initially designed to support audio-only or
video-only operation of an output which had the `OBS_OUTPUT_AV` flag,
however, full support for that was never implemented, and there are
likely fundamental issues with an implementation, mainly that most
outputs are programmed assuming that there will always be at least one
audio and one video track. This requires new flags specifying support
for optional audio/video, among other things.

An implementation to allow audio/video to be optional is best done
using the flag technique above, with audio/video enablement specified
by whether media (raw, `video_t/audio_t`) or encoder (`obs_encoder_t`)
objects are specified.

Since every implementation I could find always specifies `flags` as 0,
I was able to safely conclude that immediately removing the parameter's
functionality is safe to do.
2023-05-20 16:41:55 -07: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: Add callback for main texture rendered 2023-03-24 15:18:45 -07:00
reference-encoders.rst docs: Clarify that data for source/encoder properties can be null 2023-04-22 16:34:56 -07:00
reference-frontend-api.rst docs: Fix obs_frontend_get_scene_collections() description 2023-04-22 16:43:07 -07: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/graphics: Enable DMABUF on FreeBSD and DragonFly 2023-01-24 11:50:13 -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 CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10: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_FORMAT_V210 2023-03-26 01:52:44 -07: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 CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10: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/sphinx: Add undocumented macros for darray 2023-01-28 19:03:55 -08:00
reference-libobs-util-dstr.rst CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10:00
reference-libobs-util-platform.rst docs: Clarify a dot is included in the extension 2023-03-18 15:36:41 -07: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 CI: Update docs to Sphinx v3, fix warnings 2022-07-30 11:09:01 +10: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/sphinx: Add sphinx documentation 2017-11-27 03:02:04 -08:00
reference-modules.rst docs: Fix layout and typos 2023-02-26 10:31:02 +11:00
reference-outputs.rst libobs, plugins: Deprecate obs_output_t functions with flag parameters 2023-05-20 16:41:55 -07:00
reference-properties.rst docs: Fix layout and typos 2023-02-26 10:31:02 +11:00
reference-scenes.rst docs: Remove obs_sceneitem_group_from_scene/source 2023-04-22 16:44:28 -07:00
reference-services.rst docs: Add missing elements in Services API 2023-05-06 16:24:52 -07:00
reference-settings.rst docs: Add clarifications 2022-11-05 16:12:13 -07:00
reference-sources.rst docs: Clarify that data for source/encoder properties can be null 2023-04-22 16:34:56 -07: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