Skip to content

A library to normalize and extend the OBS Studio BrowserSource JS interface

License

Notifications You must be signed in to change notification settings

SReject/obsstudio.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 

Repository files navigation

obsstudio.js

Normalizes and extends OBS Browser's JS interface.

Requirements

OBS Browser 1.31 or later.
This comes packaged with OBS Studio Full install.

Deviations

obsstudio.js alters behaviors of the OBS interface in the following ways:

  • obsstudio.pluginVersion is made read only.
  • obsstudio.getCurrentScene() is made read only and now returns a promise
  • obsstudio.getStatus() is made read only and now returns a promise
  • OBS related events are emitted against window.obsstudio instead of window

Using

Include obsstudio.js in your html file prior to scripts that make use of it:

<html>
    <head>
        <!-- Other head stuff -->

        <script src="./obsstudio.js"></script>
        <!-- Other scripts that make use of the modified obsstudio object -->
    </head>
    <body>
        ...
    </body>
</html>

Documentation

For API documentation and examples refer to the wiki

About

A library to normalize and extend the OBS Studio BrowserSource JS interface

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published