kiteffmpeg/io.github.yuroyami.kiteffmpeg/KiteFFmpegWeb

KiteFFmpegWeb

Loads the codec, which on the web is a separate wasm module fetched over the network.

Every other target links FFmpeg into the same binary and can answer FFmpeg.identity the instant the process starts. A browser cannot, and cannot block waiting either, so the web needs one explicit step that the common API has nowhere to put. Call this once, await it, and the rest of kiteffmpeg behaves normally:

KiteFFmpegWeb.load("/kite.mjs")
check(FFmpeg.identity.isAcceptable)

Web only. It exists in no common source set, so no other platform's API changes to accommodate it.

Types

IncompleteModule

class IncompleteModule : IllegalArgumentException

Thrown when the module was built without the runtime pieces this backend reads.

NotLoaded

class NotLoaded : IllegalStateException

Thrown when the codec is used before load has completed. Names the fix, not the symptom.

Properties

DEFAULT_URL

const val DEFAULT_URL: String

The conventional name emscripten writes beside the wasm, resolved against the page.

isLoaded

val isLoaded: Boolean

True once load has completed. Every codec call before that throws NotLoaded.

Functions

attach

fun attach(codecModule: JsAny)

Adopts a codec module the page has already instantiated.

attachAsyncRuntime

fun attachAsyncRuntime(codecModule: JsAny): AsyncMediaRuntime

Creates a runtime that owns codecModule, an asynchronous codec module the page has already instantiated. Use it under a bundler, for the reason attach gives.

load

suspend fun load(url: String = DEFAULT_URL)

Fetches and instantiates the codec module at url itself.

loadAsyncRuntime

suspend fun loadAsyncRuntime(artifacts: WebAsyncCodecArtifacts): AsyncMediaRuntime

Fetches one asynchronous codec module and creates a runtime that owns it. Every call creates a new runtime with a module of its own, also for the same addresses. The page's module of load and attach is not used and not replaced.