SpoutReceiver

Read with AI
All docs in one file (llms-full.txt)
SpoutReceiver #Source #Node
SpoutReceiver

A node that receives video from other apps running on the same PC. It works as Spout on Windows and Syphon on macOS, and the node’s display name also switches between SpoutReceiver / SyphonReceiver according to the platform it is running on (the node ID used as the save key stays SpoutReceiver on both). The source list updates every frame, and SynapseRackMain is excluded from the candidates.

  • The selection is sticky. When nothing is selected (None), it does not auto-connect to the first source
  • Choosing None stops receiving and clears the output to black
  • On Windows the received texture is output as-is; on macOS it is received into a RenderTexture rebuilt to match the source resolution

Right after selecting, it waits 5 frames and then waits for video to arrive (up to 300 frames for Spout, up to 500 frames for Syphon). On timeout, the output stays un-updated.

Input ports

None

Output ports

Port IDType
RenderTexture OutputRenderTexture

Scriptable members

PathType
currentSourceNamestring

Synapse Apps (scripting)

await synapse.modules.create({ type: "SpoutReceiver" })

Pages linking here