From 5681080e2dd29e10bdd45de9e488e19c0c5815ed Mon Sep 17 00:00:00 2001
From: Roland Kakonyi <roland.kakonyi@bitmovin.com>
Date: Wed, 11 Oct 2023 22:11:36 +0200
Subject: [PATCH] feat(apidocs): improve documentation of seek and timeshift
 events

---
 src/events.ts | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/src/events.ts b/src/events.ts
index c5c5e242..7cb2540a 100644
--- a/src/events.ts
+++ b/src/events.ts
@@ -157,7 +157,8 @@ export interface SeekPosition {
 
 /**
  * Emitted when the player is about to seek to a new position.
- * Only applies to VoD streams.
+ * This event only applies to VoD streams.
+ * When looking for an equivalent for live streams, the {@link TimeShiftEvent} is relevant.
  */
 export interface SeekEvent extends Event {
   /**
@@ -172,13 +173,15 @@ export interface SeekEvent extends Event {
 
 /**
  * Emitted when seeking has finished and data to continue playback is available.
- * Only applies to VoD streams.
+ * This event only applies to VoD streams.
+ * When looking for an equivalent for live streams, the {@link TimeShiftedEvent} is relevant.
  */
 export interface SeekedEvent extends Event {}
 
 /**
  * Emitted when the player starts time shifting.
- * Only applies to live streams.
+ * This event only applies to live streams.
+ * When looking for an equivalent for VoD streams, the {@link SeekEvent} is relevant.
  */
 export interface TimeShiftEvent extends Event {
   /**
@@ -193,7 +196,8 @@ export interface TimeShiftEvent extends Event {
 
 /**
  * Emitted when time shifting has finished and data is available to continue playback.
- * Only applies to live streams.
+ * This event only applies to live streams.
+ * When looking for an equivalent for VoD streams, the {@link SeekedEvent} is relevant.
  */
 export interface TimeShiftedEvent extends Event {}