Skip to main content

Events

obs-load#

Fires when obs is loaded

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadnullData of the event

obs-unload#

Fires when obs is unloaded

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadnullData of the event

obs-open#

Fires when obs is connected

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadnullData of the event

obs-close#

Fires when obs is disconnected

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadnullData of the event

obs-error#

Fires when obs is connected

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.errorErrorError throw

obs-switch-scene#

Fires when obs current scene change.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSwitchScenesData of the event

obs-stream-starting#

Fires when obs stream starting

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadStreamStartingData of the event

obs-stream-started#

Fires when obs stream started

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadStreamStartedData of the event

obs-stream-stopping#

Fires when obs stream stopping

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadStreamStoppingData of the event

obs-stream-stopped#

Fires when obs stream stopped

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadStreamStoppedData of the event

obs-stream-status#

Fires every second when obs stream i started

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadStreamStatusData of the event

obs-recording-starting#

Fires when obs recording starting

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadRecordingStartingData of the event

obs-recording-started#

Fires when obs recording started

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadRecordingStartedData of the event

obs-recording-stopping#

Fires when obs recording stopping

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadRecordingStoppingData of the event

obs-recording-stopped#

Fires when obs recording stopped

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadRecordingStoppedData of the event

obs-recording-paused#

Fires when obs recording paused

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadRecordingPausedData of the event

obs-recording-resumed#

Fires when obs recording resumed

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadRecordingResumedData of the event

obs-source-created#

Fires when obs source created

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSourceCreatedData of the event

obs-source-destroyed#

Fires when obs source destroyed

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSourceDestroyedData of the event

obs-source-renamed#

Fires when obs source renamed

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSourceCreatedData of the event

obs-source-volume-changed#

Fires when obs source volume changed

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSourceVolumeChangedData of the event

obs-source-mute-changed#

Fires when obs source mute changed

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSourceMuteStateChangedData of the event

obs-filter-added#

Fires when obs filter added

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSourceFilterVisibilityChangedData of the event

obs-filter-removed#

Fires when obs filter removed

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSourceFilterVisibilityChangedData of the event

obs-filter-visibility-changed#

Fires when obs filter visibility changed

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSourceFilterVisibilityChangedData of the event

obs-sceneitem-added#

Fires when obs scene item is added

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSceneItemVisibilityChangedData of the event

obs-sceneitem-removed#

Fires when obs scene item is removed

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSceneItemVisibilityChangedData of the event

obs-sceneitem-visibility-changed#

Fires when obs scene item visibility changed

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSceneItemVisibilityChangedData of the event

obs-sceneitem-transform-changed#

Fires when obs scene item transform changed

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadSceneItemVisibilityChangedData of the event