obs-websocket/docs/partials/eventsHeader.md
2021-03-08 03:56:43 -08:00

614 B

Events

Events are broadcast by the server to each connected client when a recognized action occurs within OBS.

An event message will contain at least the following base fields:

  • update-type String: the type of event.
  • stream-timecode String (optional): time elapsed between now and stream start (only present if OBS Studio is streaming).
  • rec-timecode String (optional): time elapsed between now and recording start (only present if OBS Studio is recording).

Timecodes are sent using the format: HH:MM:SS.mmm

Additional fields may be present in the event message depending on the event type.