OBS

Index

Constructors

• constructor

Properties

• inputs
• scenes
• socket
• streaming

Methods

• call
• clean
• connect
• off
• on
• startStreaming
• stopStreaming
• toggleStreaming

Constructors

constructor

• new OBS(): OBS

• Returns OBS

Properties

inputs

inputs: Map<string, Input<{}, {}>> = ...

All of the sources that this OBS instance has access to, excluding scenes

scenes

scenes: Map<string, Scene<{}, {}>> = ...

All of the scenes that this OBS instance has access to

socket

socket: default = ...

The OBS websocket connection used internally

streaming

streaming: boolean = false

Streaming state

Methods

call

• call<T>(requestType: T, requestData?: Omit<OBSRequestTypes, keyof OBSRequestTypesOverrides> & OBSRequestTypesOverrides[T]): Promise<Omit<OBSResponseTypes, keyof OBSResponseTypesOverrides> & OBSResponseTypesOverrides[T]>

• Type parameters

  • T: keyof OBSRequestTypesOverrides | GetPersistentData | SetPersistentData | GetSceneCollectionList | SetCurrentSceneCollection | CreateSceneCollection | GetProfileList | SetCurrentProfile | CreateProfile | RemoveProfile | GetProfileParameter | SetProfileParameter | GetVideoSettings | SetVideoSettings | GetStreamServiceSettings | SetStreamServiceSettings | GetVersion | GetStats | BroadcastCustomEvent | CallVendorRequest | GetHotkeyList | TriggerHotkeyByName | TriggerHotkeyByKeySequence | Sleep | GetInputList | GetInputKindList | CreateInput | RemoveInput | SetInputName | GetInputDefaultSettings | GetInputSettings | SetInputSettings | GetInputMute | SetInputMute | ToggleInputMute | GetInputVolume | SetInputVolume | GetInputAudioSyncOffset | SetInputAudioSyncOffset | GetInputAudioMonitorType | GetInputPropertiesListPropertyItems | PressInputPropertiesButton | GetMediaInputStatus | SetMediaInputCursor | OffsetMediaInputCursor | TriggerMediaInputAction | GetRecordStatus | ToggleRecord | StartRecord | StopRecord | ToggleRecordPause | PauseRecord | ResumeRecord | GetRecordDirectory | GetSceneItemList | GetGroupItemList | GetSceneItemId | CreateSceneItem | RemoveSceneItem | DuplicateSceneItem | GetSceneItemTransform | GetSceneItemEnabled | SetSceneItemEnabled | GetSceneItemLocked | SetSceneItemLocked | GetSceneItemIndex | SetSceneItemIndex | GetSceneList | GetCurrentProgramScene | SetCurrentProgramScene | GetCurrentPreviewScene | SetCurrentPreviewScene | CreateScene | RemoveScene | SetSceneName | GetSourceActive | GetSourceScreenshot | SaveSourceScreenshot | GetStreamStatus | ToggleStream | StartStream | StopStream | GetTransitionKindList | GetSceneTransitionList | GetCurrentSceneTransition | SetCurrentSceneTransition | SetCurrentSceneTransitionDuration | SetCurrentSceneTransitionSettings | TriggerStudioModeTransition | GetStudioModeEnabled | SetStudioModeEnabled

  Parameters

  • requestType: T

  • optionalrequestData: Omit<OBSRequestTypes, keyof OBSRequestTypesOverrides> & OBSRequestTypesOverrides[T]

  Returns Promise<Omit<OBSResponseTypes, keyof OBSResponseTypesOverrides> & OBSResponseTypesOverrides[T]>

clean

• clean(): Promise<void>

• Goes though each source in OBS and removes it if Sceneify owns it, and there are no references to the source in code.

  ---

  Returns Promise<void>

connect

• connect(url: string, password?: string): Promise<void>

• Connect this OBS instance to a websocket

  ---

  Parameters

  • url: string

  • optionalpassword: string

  Returns Promise<void>

off

• off<T>(event: T, callback: (data: Omit<OBSEventTypes, never> & OBSEventTypesOverrides[T]) => void): void

• Type parameters

  • T: keyof OBSEventTypes

  Parameters

  • event: T

  • callback: (data: Omit<OBSEventTypes, never> & OBSEventTypesOverrides[T]) => void

  Returns void

on

• on<T>(event: T, callback: (data: Omit<OBSEventTypes, never> & OBSEventTypesOverrides[T]) => void): OBS

• Type parameters

  • T: keyof OBSEventTypes

  Parameters

  • event: T

  • callback: (data: Omit<OBSEventTypes, never> & OBSEventTypesOverrides[T]) => void

  Returns OBS

startStreaming

• startStreaming(): Promise<void>

• Returns Promise<void>

stopStreaming

• stopStreaming(): Promise<void>

• Returns Promise<void>

toggleStreaming

• toggleStreaming(): Promise<void>

• Returns Promise<void>