@eyevinn/player-analytics-specification

Seconds: number

ShardId: string

TBaseEvent: { duration: Seconds; playhead: Seconds; sessionId: UUID; shardId?: ShardId; timestamp: UTCTimestamp }

TBitrateChangedEvent: TBaseEvent & { event: "bitrate_changed"; payload: TBitrateChangedEventPayload }

TBitrateChangedEventPayload: { audioBitrate?: number; bitrate: number; height?: number; videoBitrate?: number; width?: number }

TBufferedEvent: TBaseEvent & { event: "buffered" }

TBufferingEvent: TBaseEvent & { event: "buffering" }

TErrorEvent: TBaseEvent & { event: "error"; payload: TErrorEventPayload }

TErrorEventPayload: { category?: string; code: string; data?: Record<string, any>; message?: string }

TEventType: "init" | "heartbeat" | "loading" | "loaded" | "playing" | "paused" | "resume" | "buffering" | "buffered" | "seeking" | "seeked" | "stopped" | "bitrate_changed" | "error" | "warning"

THeartbeatEvent: TBaseEvent & { event: "heartbeat" }

TInitEvent: TBaseEvent & { event: "init" }

TLoadedEvent: TBaseEvent & { event: "loaded" }

TLoadingEvent: TBaseEvent & { event: "loading" }

TMetadataEvent: TBaseEvent & { event: "metadata"; payload: TMetadataEventPayload }

TMetadataEventPayload: { contentId?: string; contentTitle?: string; contentUrl?: string; deviceId?: string; deviceModel?: string; deviceType?: string; drmType?: string; live?: boolean; userId?: string }

TPausedEvent: TBaseEvent & { event: "paused" }

TPlayerAnalyticsEvent: TInitEvent | THeartbeatEvent | TLoadingEvent | TLoadedEvent | TPlayingEvent | TPausedEvent | TBufferingEvent | TBufferedEvent | TSeekingEvent | TSeekedEvent | TBitrateChangedEvent | TErrorEvent | TWarningEvent | TStoppedEvent | TMetadataEvent

TPlayingEvent: TBaseEvent & { event: "playing" }

TSeekedEvent: TBaseEvent & { event: "seeked" }

TSeekingEvent: TBaseEvent & { event: "seeking" }

TStoppedEvent: TBaseEvent & { event: "stopped"; payload: TStoppedEventPayload }

TStoppedEventPayload: { reason: "error" | "ended" | "aborted" | "unknown" | string }

TWarningEvent: TBaseEvent & { event: "warning"; payload: TWarningEventPayload }

TWarningEventPayload: { category?: string; code: string; data?: Record<string, any>; message?: string }

UTCTimestamp: number

UUID: string