openrv-web / OpenRVAPIConfig

Interface: OpenRVAPIConfig

Defined in: api/OpenRVAPI.ts:51

Configuration passed to initialize the API.

Uses abstract provider interfaces so that any object implementing the required methods can be supplied — concrete UI classes (Viewer, ColorControls, CDLControl) satisfy these via structural typing.

Properties

cdlControl

cdlControl: CDLProvider

Defined in: api/OpenRVAPI.ts:55

---

colorControls

colorControls: ColorAdjustmentProvider

Defined in: api/OpenRVAPI.ts:54

---

curvesControl

curvesControl: CurvesProvider

Defined in: api/OpenRVAPI.ts:56

---

displayCapabilitiesProvider?

optional displayCapabilitiesProvider: DisplayCapabilitiesProvider

Defined in: api/OpenRVAPI.ts:72

Optional display capabilities provider for querying display features

---

displayProvider?

optional displayProvider: DisplayProvider

Defined in: api/OpenRVAPI.ts:70

Optional display profile provider for display color management

---

lutPipelineProvider?

optional lutPipelineProvider: LUTPipelineProvider

Defined in: api/OpenRVAPI.ts:66

Optional LUT pipeline provider for per-stage output color-space declarations (Pre-Cache / File / Look / Display).

Sibling of lutProvider: kept as a separate field so that hosts exposing only the simple single-LUT surface can omit it.

---

lutProvider?

optional lutProvider: LUTProvider

Defined in: api/OpenRVAPI.ts:58

Optional LUT provider for LUT load/clear/intensity control

---

ocioProvider?

optional ocioProvider: OCIOProvider

Defined in: api/OpenRVAPI.ts:74

Optional OCIO provider for OpenColorIO pipeline control

---

persistenceManager?

optional persistenceManager: AppPersistenceManager

Defined in: api/OpenRVAPI.ts:76

Optional persistence manager for auto-checkpoint creation before destructive API operations

---

pixelProbeProvider?

optional pixelProbeProvider: PixelProbeProvider

Defined in: api/OpenRVAPI.ts:80

Optional pixel probe provider for pixel-probe control through the view API

---

playlistManager?

optional playlistManager: PlaylistManager

Defined in: api/OpenRVAPI.ts:78

Optional playlist manager for playlist-aware frame/duration in the public API

---

session

session: Session

Defined in: api/OpenRVAPI.ts:52

---

toneMappingProvider?

optional toneMappingProvider: ToneMappingProvider

Defined in: api/OpenRVAPI.ts:68

Optional tone mapping provider for tone mapping state control

---

viewer

viewer: ViewerProvider

Defined in: api/OpenRVAPI.ts:53