Skip to main content
Version: v2.9.1

Player Events: SponsorBlock Events

warning

⚠️ These events are only emitted by the sponsor block plugin.

These events are fired by the player when interacting with SponsorBlock data – like segments or chapters loaded and skipped.
These interfaces extend BaseEvent.

SegmentSkipped

Emitted when a segment is skipped.
Extends: BaseEvent.

Property Type Description Optional
typestring = "SegmentSkipped"Event type identifier
segment{ category: string, start: number, end: number }Segment that was skipped

SegmentsLoaded

Emitted when segments are loaded.
Extends: BaseEvent.

Property Type Description Optional
typestring = "SegmentsLoaded"Event type identifier.
segments{ category: string, start: number, end: number }Segments that were loaded.

ChaptersLoaded

Emitted when chapters are loaded.
Extends: BaseEvent.

Property Type Description Optional
typestring = "ChaptersLoaded"Event type identifier.
chapters{ name: string, start: number, end: number, duration: number }[]Chapters that were loaded.

ChapterStarted

Emitted when a chapter is started.
Extends: BaseEvent.

Property Type Description Optional
typestring = "ChapterStarted"Event type identifier.
chapter{ name: string, start: number, end: number, duration: number }Chapter that started.