OBS Trigger: Vendor Request Event

⏵ Home ⏵ Join The Aitum Discord ⏵ Getting Started ⏵ FAQ

← Previous

OBS Trigger: Source Visibility Changed

OBS Trigger: Vertical: Scene Changed

OBS Trigger: Vendor Request Event

🚨

This is an Advanced Feature that most Aitum users will not need to use.

The Vendor Request Event trigger allows you to intercept OBS vendor requests that are sent by 3rd-party OBS plugins, allowing you to trigger rules based off those vendor events. This can help with interacting with 3rd-party OBS plugins that Aitum does not directly support or integrate with.

Vendor Requests are fairly new to OBS Studio, being introduced with Websocket Version 5, so not all plugins feature Vendor Request data. If the plugin has vendor requests setup, they will likely have documentation available.

** Add Example From Downstream Keyer Here **

Any successful Vendor Request Event trigger will have the request data provided as a local variable if any data exists. Otherwise you will receive {} as the default fallback.

Trigger Inputs

Vendor Name

The vendorName provided by the OBS Vendor Event.

Type	Text (String)
Default Fallback	Unknown Vendor
Min - Max Characters	(No Min - Max)
Required	No
Local Variable	Yes

Event Type

The requestType of the OBS Vendor Event.

Type	Text (String)
Default Fallback	Unknown Event
Min - Max Characters	(No Min - Max)
Required	No
Local Variable	Yes

Hidden Variables

Hidden Variables are available as Local Variables within the actions of a rule, but you will not see these fields visually on the Trigger. These can also be used with a New Rule Check, more info here on Checks.