Skip to content

@jdultra/ultra-globe


@jdultra/ultra-globe / TelemetryProvider

Class: TelemetryProvider

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:125

Base contract for time-addressable telemetry providers.

Providers are expected to normalize raw telemetry into TelemetrySample records and expose lookup helpers that projected media layers can query by playback time.

Extended by

Constructors

Constructor

new TelemetryProvider(options?): TelemetryProvider

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:142

Parameters

options?

Object

Returns

TelemetryProvider

Methods

getDuration()

getDuration(): number

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:187

Returns

number


getFirstSample()

getFirstSample(): TelemetrySample | null

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:171

Returns

TelemetrySample | null


getLastSample()

getLastSample(): TelemetrySample | null

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:175

Returns

TelemetrySample | null


getSampleAtTime()

getSampleAtTime(timeSeconds, options?): TelemetrySample | null

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:202

Queries telemetry by playback time in seconds.

Parameters

timeSeconds

number

options?

Object

Returns

TelemetrySample | null


getSampleAtTimeMilliseconds()

getSampleAtTimeMilliseconds(timeMilliseconds, options?): TelemetrySample | null

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:213

Queries telemetry by playback time in milliseconds.

Parameters

timeMilliseconds

number

options?

Object

Returns

TelemetrySample | null


getSampleCount()

getSampleCount(): number

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:163

Returns

number


getSamples()

getSamples(): TelemetrySample[]

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:167

Returns

TelemetrySample[]


getTimeRange()

getTimeRange(): { startTime: number; endTime: number; duration: number; } | null

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:179

Returns

{ startTime: number; endTime: number; duration: number; } | null


isLoaded()

isLoaded(): boolean

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:159

Returns

boolean


load()

load(): Promise<TelemetryProvider>

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:155

Loads telemetry data into the provider.

Subclasses should override this method and finish by calling setSamples(normalizedSamples).

Returns

Promise<TelemetryProvider>


setSamples()

setSamples(samples): TelemetryProvider

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:194

Replaces the normalized sample set.

Parameters

samples

Partial<TelemetrySample>[]

Returns

TelemetryProvider


interpolateSamples()

static interpolateSamples(previous, next, targetTimeMilliseconds): TelemetrySample

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:138

Parameters

previous

TelemetrySample

next

TelemetrySample

targetTimeMilliseconds

number

Returns

TelemetrySample


normalizeSample()

static normalizeSample(sample, index?): TelemetrySample | null

Defined in: layers/projections/telemetry/TelemetryProvider.d.ts:131

Parameters

sample

Partial<TelemetrySample>

index?

number

Returns

TelemetrySample | null