Required Permissions: slobs.notifications

This module can be used to push notifications to the Streamlabs OBS native UI, mark your notifications as read and bind a callback action for when your notification has been read. We will add more functionality to this module as requested.

Minimum Version

This was module was added in Build 7 of the Streamlabs OBS App Developer build.

NotificationOptions object

The NotificationOptions object represents the data structure of a new notification to be pushed.

Notification object

The Notification object represents the data structure of the response of the push method. It contains all attributes of the NotificationOptions object, with an addition of the id parameter.

notificationRead event

This event is emitted whenever a notification is read. Your callback will be called with an array of notification_ids read.

notificationRead((ids: number[]) => {})

Example

streamlabsOBS.v1.Notifications.notificationRead(ids => {
  console.log('Notifications Read', ids);
});

push method

push(NotificationOptions): Notification

This function is used to push a new notification.

Arguments

1. NotificationsOptions object

Returns

Full Notification object returned.

Example

streamlabsOBS.v1.Notifications.push({
  message: "New Notification!"
}).then((notification: Notification) => {
	console.log("New notification", notification);
});

markAsRead method

markAsRead(id): void

This function is used to mark a notification as read.

Arguments

1. id attribute of the Notifications object to be marked as read.

Returns

This method does not return anything.

Example

streamlabsOBS.v1.Notifications.markAsRead(1).then(() => {
	console.log("Marked as read");
});