API Reference LiveKit v#0.1.0

Copy Markdown View Source

Modules

Elixir server SDK for LiveKit.

Builds and signs LiveKit access tokens.

Creates the short-lived administrative tokens used by LiveKit service calls.

Immutable handle carrying the configuration used by every LiveKit call.

Validated connection settings for a LiveKit deployment.

LiveKit Egress API — start and manage recordings and streams.

The single error type returned by every public LiveKit SDK function.

Encoding of LiveKit JWT grants.

Cloud agent permissions, encoded as the agent claim of a LiveKit JWT.

The complete set of LiveKit-specific claims carried by an access token.

SIP permissions, encoded as the sip claim of a LiveKit JWT.

Room and media permissions, encoded as the video claim of a LiveKit JWT.

LiveKit Ingress API — create and manage RTMP, WHIP, and URL ingress endpoints.

LiveKit RoomService API — create and administer rooms and participants.

Verifies LiveKit HS256 JWTs against an API key and secret.

Shared HTTP transport for LiveKit's Twirp service APIs.

Validates LiveKit webhook callbacks and decodes them into LiveKit.Proto.WebhookEvent.

Mix Tasks

Downloads the LiveKit protocol definitions into priv/proto.

Regenerates the protobuf modules in lib/livekit/proto from priv/proto.