Browse Source

docs: Add obs_view_enum_video_info and deprecate obs_view_get_video_info

derrod 1 year ago
parent
commit
3f7133b2c7
1 changed files with 9 additions and 1 deletions
  1. 9 1
      docs/sphinx/reference-core.rst

+ 9 - 1
docs/sphinx/reference-core.rst

@@ -895,6 +895,14 @@ Views
 
 .. function:: bool obs_view_get_video_info(obs_view_t *view, struct obs_video_info *ovi)
 
-   Gets the video settings currently in use for this view context.
+   Gets the video settings of the first matching mix currently in use for this view context.
 
    :return: *false* if no video
+
+   .. deprecated:: 3X.X
+
+---------------------
+
+.. function:: void obs_view_enum_video_info(obs_view_t *view, bool (*enum_proc)(void *, struct obs_video_info *), void *param)
+
+   Enumerates all the video info of all mixes that use the specified mix.