OBS WebSocket icon

OBS WebSocket

Control OBS Studio via WebSocket

Text Source → Get Text

AI-generated

Summary

Retrieve the current text content from a specified text source in OBS Studio via WebSocket.

Inputs

  • Text Source Name (required) — The name of the text source (GDI+ or FreeType2) whose text you want to retrieve.

Output shape

a single JSON object containing the source name and its current text content.

The output JSON includes the properties sourceName (string) and text (string). The text is the current content of the specified source. Errors during retrieval produce error messages in the output if 'Continue On Fail' is enabled.

Examples

Example 1: Get text content from a text source named 'Chat Overlay'

Set 'Text Source Name' to 'Chat Overlay' and choose the 'Get Text' operation under resource 'Text Source'.

Discussion