openrv-web / ViewerProvider

Interface: ViewerProvider

Defined in: api/types.ts:29

Minimal viewer interface required by the API layer.

Provides zoom, pan, channel mode, texture filter, and background pattern control.

Methods

addViewChangeListener()?

optional addViewChangeListener(callback): () => void

Defined in: api/types.ts:52

Subscribe to view changes (pan/zoom). Returns an unsubscribe function.

Parameters

callback

(panX, panY, zoom) => void

Returns

(): void

Returns

void

---

fitToHeight()

fitToHeight(): void

Defined in: api/types.ts:34

Returns

void

---

fitToWidth()

fitToWidth(): void

Defined in: api/types.ts:33

Returns

void

---

fitToWindow()

fitToWindow(): void

Defined in: api/types.ts:32

Returns

void

---

getBackgroundPatternState()

getBackgroundPatternState(): BackgroundPatternState

Defined in: api/types.ts:43

Returns

BackgroundPatternState

---

getChannelMode()

getChannelMode(): ChannelMode

Defined in: api/types.ts:39

Returns

ChannelMode

---

getFilterMode()

getFilterMode(): TextureFilterMode

Defined in: api/types.ts:41

Returns

TextureFilterMode

---

getFitMode()

getFitMode(): string | null

Defined in: api/types.ts:35

Returns

string | null

---

getMatteSettings()

getMatteSettings(): MatteSettings

Defined in: api/types.ts:47

Get the current matte overlay settings.

Returns

MatteSettings

---

getPan()

getPan(): object

Defined in: api/types.ts:37

Returns

object

x

x: number

y

y: number

---

getSourceDimensions()?

optional getSourceDimensions(): object

Defined in: api/types.ts:54

Get the native source image dimensions.

Returns

object

height

height: number

pixelAspect?

optional pixelAspect: number

width

width: number

---

getViewportSize()

getViewportSize(): object

Defined in: api/types.ts:44

Returns

object

height

height: number

width

width: number

---

getZoom()

getZoom(): number

Defined in: api/types.ts:31

Returns

number

---

setBackgroundPatternState()

setBackgroundPatternState(state): void

Defined in: api/types.ts:42

Parameters

state

BackgroundPatternState

Returns

void

---

setChannelMode()

setChannelMode(mode): void

Defined in: api/types.ts:38

Parameters

mode

ChannelMode

Returns

void

---

setFilterMode()

setFilterMode(mode): void

Defined in: api/types.ts:40

Parameters

mode

TextureFilterMode

Returns

void

---

setMatteSettings()

setMatteSettings(settings): void

Defined in: api/types.ts:49

Update matte overlay settings (partial merge).

Parameters

settings

Partial<MatteSettings>

Returns

void

---

setPan()

setPan(x, y): void

Defined in: api/types.ts:36

Parameters

x

number

y

number

Returns

void

---

setZoom()

setZoom(level): void

Defined in: api/types.ts:30

Parameters

level

number

Returns

void