Liking cljdoc? Tell your friends :D

hive-kdenlive.kdenlive.client

HTTP transport to the Kdenlive scripting fork — the JVM boundary.

Strata: Pure routes/request (kdenlive.routes, portable) Port IKdenlive — call a catalog route, get data back Boundary HttpKdenlive — java.net.http, JSON wire Seam kdenlive — read at call time; rebind in tests

The wire encoding is JSON; requests carry the route's :body as the JSON object and responses are decoded to Clojure data with keyword keys.

HTTP transport to the Kdenlive scripting fork — the JVM boundary.

Strata:
  Pure      routes/request        (kdenlive.routes, portable)
  Port      IKdenlive             — call a catalog route, get data back
  Boundary  HttpKdenlive          — java.net.http, JSON wire
  Seam      *kdenlive*            — read at call time; rebind in tests

The wire encoding is JSON; requests carry the route's :body as the JSON
object and responses are decoded to Clojure data with keyword keys.
raw docstring

*kdenlive*clj

The IKdenlive call dispatches through. Rebind with a recording stub in tests; the delay keeps the default lazy so importing this ns never opens a connection.

The IKdenlive `call` dispatches through. Rebind with a recording stub in
tests; the delay keeps the default lazy so importing this ns never opens a
connection.
sourceraw docstring

->jsonclj

(->json m)

Encode a flat map as a JSON object string. Values: string/number/boolean.

Encode a flat map as a JSON object string. Values: string/number/boolean.
sourceraw docstring

callclj

(call route-id & {:as params})

Invoke catalog route route-id with params through *kdenlive*.

Invoke catalog route `route-id` with `params` through `*kdenlive*`.
sourceraw docstring

endpointclj

(endpoint env)

Where the scripting fork listens, from an environment map, read with the fork's OWN variable names (kdenlive/src/scripting/scriptingserver.cpp), so one environment configures both sides:

KDENLIVE_SCRIPTING_ADDRESS default 127.0.0.1 KDENLIVE_SCRIPTING_PORT default 9876 KDENLIVE_SCRIPTING_SECRET default none; sent as X-Kdenlive-Secret

The base URL carries /api/v1. The fork also accepts paths without it, but /api/v1 is the documented prefix and survives a stricter server.

Where the scripting fork listens, from an environment map, read with the
fork's OWN variable names (kdenlive/src/scripting/scriptingserver.cpp), so
one environment configures both sides:

  KDENLIVE_SCRIPTING_ADDRESS  default 127.0.0.1
  KDENLIVE_SCRIPTING_PORT     default 9876
  KDENLIVE_SCRIPTING_SECRET   default none; sent as X-Kdenlive-Secret

The base URL carries /api/v1. The fork also accepts paths without it, but
/api/v1 is the documented prefix and survives a stricter server.
sourceraw docstring

http-kdenliveclj

(http-kdenlive)
(http-kdenlive base-url)
(http-kdenlive base-url secret)

An IKdenlive against the scripting fork. With no argument, where the fork's own environment variables say it listens (see endpoint); with a base URL and optional secret, exactly there.

An IKdenlive against the scripting fork. With no argument, where the fork's
own environment variables say it listens (see `endpoint`); with a base URL
and optional secret, exactly there.
sourceraw docstring

IKdenlivecljprotocol

-callclj

(-call client route-id params)

Invoke catalog route route-id with params. {:ok data} | {:error :kdenlive/... :status int}

Invoke catalog route `route-id` with `params`.
{:ok data} | {:error :kdenlive/... :status int}
source

pingclj

(ping)

True when the scripting fork answers. GET /project is the cheapest read the route table registers, so it doubles as the health probe.

True when the scripting fork answers. GET /project is the cheapest read
the route table registers, so it doubles as the health probe.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close