# LiveKit v0.1.0 - Table of Contents

> Elixir server SDK for LiveKit. Mint access tokens, call Room/Egress/Ingress
Twirp APIs, and verify webhook callbacks.

## Pages

- [LiveKit Server SDK for Elixir](readme.md)
- [Changelog](changelog.md)

## Modules

- Getting started
  - [LiveKit](LiveKit.md): Elixir server SDK for [LiveKit](https://livekit.io).
  - [LiveKit.Client](LiveKit.Client.md): Immutable handle carrying the configuration used by every LiveKit call.
  - [LiveKit.Config](LiveKit.Config.md): Validated connection settings for a LiveKit deployment.
  - [LiveKit.Error](LiveKit.Error.md): The single error type returned by every public LiveKit SDK function.

- Auth
  - [LiveKit.AccessToken](LiveKit.AccessToken.md): Builds and signs LiveKit access tokens.
  - [LiveKit.Auth](LiveKit.Auth.md): Creates the short-lived administrative tokens used by LiveKit service calls.
  - [LiveKit.Grants](LiveKit.Grants.md): Encoding of LiveKit JWT grants.
  - [LiveKit.TokenVerifier](LiveKit.TokenVerifier.md): Verifies LiveKit HS256 JWTs against an API key and secret.

- Grants
  - [LiveKit.Grants.Agent](LiveKit.Grants.Agent.md): Cloud agent permissions, encoded as the `agent` claim of a LiveKit JWT.
  - [LiveKit.Grants.Claims](LiveKit.Grants.Claims.md): The complete set of LiveKit-specific claims carried by an access token.
  - [LiveKit.Grants.SIP](LiveKit.Grants.SIP.md): SIP permissions, encoded as the `sip` claim of a LiveKit JWT.
  - [LiveKit.Grants.Video](LiveKit.Grants.Video.md): Room and media permissions, encoded as the `video` claim of a LiveKit JWT.

- Services
  - [LiveKit.EgressService](LiveKit.EgressService.md): LiveKit Egress API — start and manage recordings and streams.
  - [LiveKit.IngressService](LiveKit.IngressService.md): LiveKit Ingress API — create and manage RTMP, WHIP, and URL ingress endpoints.
  - [LiveKit.RoomService](LiveKit.RoomService.md): LiveKit RoomService API — create and administer rooms and participants.
  - [LiveKit.Twirp](LiveKit.Twirp.md): Shared HTTP transport for LiveKit's Twirp service APIs.
  - [LiveKit.WebhookReceiver](LiveKit.WebhookReceiver.md): Validates LiveKit webhook callbacks and decodes them into
`LiveKit.Proto.WebhookEvent`.

## Mix Tasks

- [mix livekit.proto.fetch](Mix.Tasks.Livekit.Proto.Fetch.md): Downloads the LiveKit protocol definitions into `priv/proto`.
- [mix livekit.proto.generate](Mix.Tasks.Livekit.Proto.Generate.md): Regenerates the protobuf modules in `lib/livekit/proto` from `priv/proto`.

