Browse Source

docs: Add source-specific signals

Penwywern 2 years ago
parent
commit
9450588486
1 changed files with 48 additions and 2 deletions
  1. 48 2
      docs/sphinx/reference-sources.rst

+ 48 - 2
docs/sphinx/reference-sources.rst

@@ -544,8 +544,10 @@ Source Definition Structure (obs_source_info)
 
 .. _source_signal_handler_reference:
 
-Source Signals
---------------
+Common Source Signals
+---------------------
+
+The following signals are defined for every source type:
 
 **destroy** (ptr *source*)
 
@@ -703,6 +705,50 @@ Source Signals
 
    Called when the media source switches to the previous media.
 
+
+Source-specific Signals
+-----------------------
+
+The following signals are defined for specific sources only:
+
+**slide_changed** (int index, string path)
+
+   Called when the source's currently displayed image changes.
+
+   :Defined by: - Image Slide Show
+
+-----------------------
+
+**hooked** (ptr source, string title, string class, string executable)
+
+   Called when the source successfully captures an existing window.
+
+   :Defined by: - Window Capture (Windows)
+                - Game Capture (Windows)
+                - Application Audio Output Capture (Windows)
+
+-----------------------
+
+**hooked** (ptr source, string name, string class)
+
+   Called when the source successfully captures an existing window.
+
+   :Defined by: - Window Capture (Xcomposite)
+
+-----------------------
+
+**unhooked** (ptr source)
+
+   Called when the source stops capturing.
+
+   :Defined by: - Window Capture (Windows)
+                - Game Capture (Windows)
+                - Application Audio Output Capture (Windows)
+                - Window Capture (Xcomposite)
+
+-----------------------
+
+
 General Source Functions
 ------------------------