nodecg-obs-control.json

Schema

• audioMonitorPanel Object Audio Monitor panel Settings:

  • disableInputVolumeMetersEvent Boolean Whether the meters showing the current volume level are disabled.

  • filterPollingTime Integer How often in milliseconds the panel updates.

  • displayTerm String Only audio sources with the declared string included in the name will be shown on the Audio Monitor Panel. This is preset in both NodeCG and the Stream Portable OBS to ♪

• mediaSourceURLPanel Object Runner Stream Source panel Settings:

  • localDelay Boolean Determines whether the panel should include a control to add delay to the local OBS sync timer and Discord input. This is useful if you're intending to have commentary captured through Discord, as you can add delay to that input to match the runner's stream delay. If you're planning on having all comms captured through the runner's stream, leave this as false.

  • mediaSources Array of strings The names of the browser/media sources in the Stream Portable OBS that the Media Source URL Panel will be managing. The panel will produce a set of controls for each string declared here. These should always be named "Player #" and the package supports up to four runners. If you know you won't need all four sources, you can remove additional players.

  • urls Array of objects The common portion of the URLs for your runner streaming servers. You can declare as many as you'd like. Declaring one will produce a static text label on the panel, whilst declaring multiple will produce a drop down list. Some common examples include: 

- if all your runners are streaming to their own Twitch channels, use just the default URL and remove {TWITCH_STREAM_NAME_HERE}. This isn't advised to do as this could force ads to play and you'll need to interact with the sources in OBS if a content warning needs to be confirmed.
- if you're using a set of dummy Twitch accounts, all named the same expect for the final character(s), use just the default URL and change {TWITCH_STREAM_NAME_HERE} to the common name the accounts share; you'll then add the final unique characters to the keys section below.
- if you're using custom RTMP servers, set a url for each of your servers; you'll then add the slugs you provide to runners to the keys section below. Note that there currently isn't any automation for managing multiple URLs, only multiple keys.

• url String The common portion of the URL.

• name String The name this URL will appear as in the Media Source Panel.

• keys Array of objects The unique portions at the end of the URLs you've declared in urls above.

  • key String The unique portion of the URL. You'll be able to automate the browser source updating the key by declaring the key each runner will use in speedcontrol. 

  • name String The name this key will appear as in the Media Source Panel.

• outputStatusPanel Object Output Status Panel Settings:

  • streamPollingTime Integer How often in milliseconds the panel updates the streaming data.

  • recordPollingTime Integer How often in milliseconds the panel updates the recording data.

  • streamServiceSettingsPollingTime Integer How often in milliseconds the panel updates the stream service settings data.

  • enableServerChange Boolean Determines whether a button for changing the streaming server is enabled. It is recommended this is left as false as you likely won't want users changing where you're streaming to.

  • enableProfileChange Boolean Determines whether a button for changing the OBS profile is enabled. It is recommended this is left as false though this can be useful if you've got different encoding settings on different profiles as you're unsure of your venue's internet speed.

• statsPanel Object Stats Panel Settings:

  • statsPollingTime Integer How often in milliseconds the stats panel updates.