From 945058848632ef6b7cd133c53f7f512c1945c832 Mon Sep 17 00:00:00 2001 From: Penwywern Date: Thu, 10 Aug 2023 23:13:46 +0200 Subject: [PATCH] docs: Add source-specific signals --- docs/sphinx/reference-sources.rst | 50 +++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/reference-sources.rst b/docs/sphinx/reference-sources.rst index 89baeb067..dbc7ebbd1 100644 --- a/docs/sphinx/reference-sources.rst +++ b/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 ------------------------