Options
All
  • Public
  • Public/Protected
  • All
Menu

@eyevinn/player-analytics-specification

Index

Interfaces

Type aliases

Type aliases

Domain

Domain: string

Milliseconds

Milliseconds: number

ShardId

ShardId: string

TBaseEvent

TBaseEvent: { domain?: Domain; duration: Milliseconds; playhead: Milliseconds; sdk?: { name: string; version: string }; sessionId: UUID; shardId?: ShardId; timestamp: UTCTimestamp }

Type declaration

  • Optional domain?: Domain

    OPTIONAL. Populated by the ingest server, NOT by the client.

    The server SHOULD derive this from the request's HTTP Origin header (the scheme + host + optional port of the page that produced the event, e.g. "https://example.com"). It MUST NOT be trusted as a client-supplied value. When the Origin header is absent, the field is omitted entirely (it is never set to an empty string or a placeholder).

  • duration: Milliseconds

    The duration of the content as an integer number of milliseconds. VOD = length of stream; Live = live edge in UTC (milliseconds). -1 if unknown.

  • playhead: Milliseconds

    The current playhead position as an integer number of milliseconds. If the content is Live this SHOULD be the UTC time in milliseconds. -1 if unknown.

  • Optional sdk?: { name: string; version: string }

    OPTIONAL. Identifies the client SDK that produced the event.

    A client that sends sdk declares that it emits playhead and duration as integer milliseconds, so the server trusts those values and does not convert them. name is free text; the Eyevinn SDKs use web, swift, and android. Both name and version are required and no other keys are allowed.

    • name: string
    • version: string
  • sessionId: UUID
  • Optional shardId?: ShardId
  • timestamp: UTCTimestamp

TBitrateChangedEvent

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

TBitrateChangedEventPayload

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

Type declaration

  • Optional audioBitrate?: number
  • bitrate: number
  • Optional height?: number
  • Optional videoBitrate?: number
  • Optional width?: number

TBufferedEvent

TBufferedEvent: TBaseEvent & { event: "buffered" }

TBufferingEvent

TBufferingEvent: TBaseEvent & { event: "buffering" }

TErrorEvent

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

TErrorEventPayload

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

Type declaration

  • Optional category?: string
  • code: string
  • Optional data?: Record<string, any>
  • Optional message?: string

TEventType

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

THeartbeatEvent

THeartbeatEvent: TBaseEvent & { event: "heartbeat" }

TInitEvent

TInitEvent: TBaseEvent & { event: "init" }

TLoadedEvent

TLoadedEvent: TBaseEvent & { event: "loaded" }

TLoadingEvent

TLoadingEvent: TBaseEvent & { event: "loading" }

TMetadataEvent

TMetadataEvent: TBaseEvent & { city?: string; country?: string; event: "metadata"; payload: TMetadataEventPayload }

TMetadataEventPayload

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

Type declaration

  • [key: string]: string | number | boolean
  • Optional contentId?: string
  • Optional contentTitle?: string
  • Optional contentUrl?: string
  • Optional customMetadataId?: number

    OPTIONAL. A client-defined grouping key for related metadata events.

    Opaque to the server: the client assigns it however it likes and the server MUST NOT interpret or validate its value. Being optional, it is fully back-compatible — omitting it leaves existing behaviour unchanged.

  • Optional deviceId?: string
  • Optional deviceModel?: string
  • Optional deviceType?: string
  • Optional drmType?: string
  • Optional live?: boolean
  • Optional userId?: string

TPausedEvent

TPausedEvent: TBaseEvent & { event: "paused" }

TPlayerAnalyticsEvent

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

TPlayingEvent

TPlayingEvent: TBaseEvent & { event: "playing" }

TSeekedEvent

TSeekedEvent: TBaseEvent & { event: "seeked" }

TSeekingEvent

TSeekingEvent: TBaseEvent & { event: "seeking" }

TStoppedEvent

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

TStoppedEventPayload

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

Type declaration

  • reason: "error" | "ended" | "aborted" | "unknown" | string

TWarningEvent

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

TWarningEventPayload

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

Type declaration

  • Optional category?: string
  • code: string
  • Optional data?: Record<string, any>
  • Optional message?: string

UTCTimestamp

UTCTimestamp: number

UUID

UUID: string

Generated using TypeDoc