API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceAssetDefinitions

@codexo/exojs / assets / stable

Every built-in asset type, keyed by its id, plus whatever extension packages declaration-merge into it. An entry declares the runtime `resource` it produces and the `config` it accepts; it may also carry `isValue: true` to mirror a type whose leaf is a deferred AssetRef rather than a heal-in-place handle - required for every type that ships no seamless adapter (see ValueAssetKind).

15
props
0
methods
0
events
Import
import { AssetDefinitions } from '@codexo/exojs'

Every built-in asset type, keyed by its id, plus whatever extension packages declaration-merge into it.

An entry declares the runtime `resource` it produces and the `config` it accepts; it may also carry `isValue: true` to mirror a type whose leaf is a deferred AssetRef rather than a heal-in-place handle - required for every type that ships no seamless adapter (see ValueAssetKind).

Properties15
binary: { config: { source: string }; resource: ArrayBuffer }
bmFont: { config: { source: string }; resource: BmFontA loaded BMFont asset: the parsed descriptor plus all page textures. Loaded by the built-in BMFont factory - no extra setup required. Pass directly to BitmapTe… }
csv: { config: { delimiter?: string; source: string }; resource: string[][] }
font: { config: { addToDocument?: boolean; descriptors?: FontFaceDescriptors; family: string; source: string }; resource: FontFace }
image: { config: { mimeType?: string; source: string }; resource: HTMLImageElement }
json: { config: { source: string }; resource: unknown }
music: { config: { crossOrigin?: MediaCrossOriginValue for a media element's `crossorigin` attribute. `'anonymous'` is the default for URL-backed media: without it a cross-origin video is playable but unusabl…; loadEvent?: StreamingLoadEvent`HTMLMediaElement` ready-state events the streaming asset factories (MusicFactory, VideoFactory) accept as the load-completion signal. Pick the earliest event…; mimeType?: string; playbackOptions?: Partial<PlaybackOptionsCommon playback configuration for Sound and AudioStream.>; source: string; stallTimeout?: number }; resource: AudioStreamStreaming long-form audio backed by an `HTMLAudioElement` - background tracks, voice-over, **and internet radio** (same mechanism, low CPU/RAM). Decoded lazily… }
sound: { config: { playbackOptions?: Partial<PlaybackOptionsCommon playback configuration for Sound and AudioStream.>; poolSize?: number; source: string; sprites?: Readonly<Record<string, AudioSpriteClipNamed sub-region of an AudioBuffer used as an audio sprite sheet. `start` / `end` are seconds into the buffer; `loop` makes the clip loop indefinitely when pla…>> | string }; resource: SoundPre-decoded short audio clip backed by an `AudioBuffer`. Sound is a **data descriptor** - it holds the decoded audio buffer, sprite definitions, and default pl… }
subtitle: { config: { source: string }; resource: VTTCue[] }
svg: { config: { height?: number; source: string; width?: number }; resource: HTMLImageElement }
text: { config: { source: string }; resource: string }
texture: { config: { mimeType?: string; source: string; textureOptions?: Partial<TextureOptionsFull construction options of a texture: sampling state plus upload state.> }; resource: TextureA static GPU texture sourced from an image, canvas, or video element. Holds the pixel source, its sampling state (ScaleModes, WrapModes) and its upload state (… }
video: { config: { crossOrigin?: MediaCrossOriginValue for a media element's `crossorigin` attribute. `'anonymous'` is the default for URL-backed media: without it a cross-origin video is playable but unusabl…; loadEvent?: StreamingLoadEvent`HTMLMediaElement` ready-state events the streaming asset factories (MusicFactory, VideoFactory) accept as the load-completion signal. Pick the earliest event…; mimeType?: string; playbackOptions?: Partial<PlaybackOptionsCommon playback configuration for Sound and AudioStream.>; source: string; stallTimeout?: number; textureOptions?: Partial<TextureOptionsFull construction options of a texture: sampling state plus upload state.> }; resource: VideoRenders an `HTMLVideoElement` as a live texture on a Sprite. `Video` wraps a video element, manages playback (play/pause/stop/seek, volume, loop, playback rate… }
wasm: { config: { source: string }; resource: Module }
xml: { config: { source: string }; resource: Document }
Source
src/assets/AssetDefinitions.ts