nodecg-streamlabs

KO | EN

gitlite — search

#hacktoberfest #react #typescript #go #android #linux #docker #macos #nodejs #awesome #cli #pytorch #security #openai

nodecg-streamlabs

(★ 9)

NodeCG bundle that exposes the StreamLabs streaming API to other NodeCG bundles.

nodecg-streamlabs Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# nodecg-streamlabs

nodecg-streamlabs is a bundle designed to wrap around StreamLabs' API and expose events to other bundles. All that's required to use nodecg-streamlabs is your socket token.

## Using in your bundle
### In a graphic or dashboard panel
```js
nodecg.listenFor("twitch-event", "nodecg-streamlabs", event => {
    // do work
});

nodecg.listenFor("youtube-event", "nodecg-streamlabs", event => {
    // do work
});

nodecg.listenFor("streamlabs-event", "nodecg-streamlabs", event => {
    // do work
});
```
### In an extension
```js
module.exports = nodecg => {
    const streamlabs = nodecg.extensions['nodecg-streamlabs'];

streamlabs.on("twitch-event", event => {
        // do work
    });

streamlabs.on("youtube-event", event => {
        // do work
    });

streamlabs.on("streamlabs-event", event => {
        // do work
    });
};
```

## Events
Each platform has a platform specific event that bundles can listen for: `twitch-event`, `youtube-event`, and `streamlabs-event`. Events from these are structured as such:
```js
{
    type: "...",
    message: {
        ...
    }
}
```

For those who want more fine-tuned control over what events they're listening to, there are also event-specific streams for each platform and event:
```
twitch-follow
twitch-subscription
twitch-host
twitch-bits
youtube-subscription
youtube-sponsor
youtube-superchat
donation
```

And lastly, for those who want to handle everything themselves, the `rawEvent` stream emits every event directly.

nodecg-streamlabs

nodecg-streamlabs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

nodecg-streamlabs

nodecg-streamlabs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README