Pinqponq.LiveKit.Server 1.0.2

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Pinqponq.LiveKit.Server --version 1.0.2
                    


                    

                
NuGet\Install-Package Pinqponq.LiveKit.Server -Version 1.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Pinqponq.LiveKit.Server" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Pinqponq.LiveKit.Server" Version="1.0.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Pinqponq.LiveKit.Server" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Pinqponq.LiveKit.Server --version 1.0.2
                    


                    

                
#r "nuget: Pinqponq.LiveKit.Server, 1.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Pinqponq.LiveKit.Server@1.0.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Pinqponq.LiveKit.Server&version=1.0.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Pinqponq.LiveKit.Server&version=1.0.2
                    


                            Install as a Cake Tool

Pinqponq.LiveKit.Server

A LiveKit server API client for .NET: it issues the access tokens your clients join rooms with, calls LiveKit's RoomService over its Twirp JSON API, and verifies the webhooks LiveKit sends back. Requests are plain HttpClient calls with System.Text.Json — no generated Protobuf/gRPC client and no Protobuf toolchain.

Install

dotnet add package Pinqponq.LiveKit.Server

Requirements

  • .NET 8.0, 9.0, or 10.0
  • A LiveKit server — self-hosted or LiveKit Cloud — and its API key/secret pair

Quick start

using Pinqponq.LiveKit.Server;
using Pinqponq.LiveKit.Server.Auth;
using Pinqponq.LiveKit.Server.DependencyInjection;

var builder = WebApplication.CreateBuilder(args);

builder.Services
    .AddPinqponqLiveKitServer(options => options.Url = "wss://my-project.livekit.cloud")
    .AddStaticCredentials(
        builder.Configuration["LiveKit:ApiKey"]!,
        builder.Configuration["LiveKit:ApiSecret"]!);

var app = builder.Build();

app.MapPost("/livekit/token", async (AccessTokenIssuer issuer, CancellationToken cancellationToken) =>
{
    var token = await issuer.CreateToken(
        new AccessTokenOptions
        {
            Identity = "user-123",
            Name = "Jane Doe",
            VideoGrant = new VideoGrant { RoomJoin = true, Room = "my-room" },
        },
        cancellationToken);

    return Results.Ok(new { token = token.Value, expiresAt = token.ExpiresAt });
});

app.Run();

Managing rooms and receiving webhooks from injected services:

using Pinqponq.LiveKit.Server.Models;
using Pinqponq.LiveKit.Server.Rooms;
using Pinqponq.LiveKit.Server.Webhooks;

public sealed class MeetingService(RoomServiceClient roomServiceClient, WebhookReceiver webhookReceiver)
{
    public Task<IReadOnlyList<ParticipantInfo>> ListParticipantsAsync(string roomName, CancellationToken cancellationToken) =>
        roomServiceClient.ListParticipants(roomName, cancellationToken);

    public async Task HandleWebhookAsync(string rawBody, string? authorizationHeader, CancellationToken cancellationToken)
    {
        // Throws LiveKitWebhookValidationException unless LiveKit signed exactly this body.
        var webhookEvent = await webhookReceiver.Receive(rawBody, authorizationHeader, cancellationToken);

        if (webhookEvent.EventType == WebhookEventType.ParticipantJoined)
        {
            // webhookEvent.Room, webhookEvent.Participant, ...
        }
    }
}

Configuration

AddPinqponqLiveKitServer(Action<LiveKitServerOptions> configureOptions) registers RoomServiceClient (as a typed HttpClient), AccessTokenIssuer and WebhookReceiver, and returns a LiveKitServerBuilder for the credentials:

Option Default Notes
Url "" (required) LiveKit server address. Accepts http, https, ws and wss, with an optional sub path; ws/wss are sent as http/https.

Options are validated on startup via ValidateOnStart(), so a missing or non-absolute Url fails fast instead of at the first RoomService call.

Credentials are registered on the returned builder — exactly one of:

  • AddStaticCredentials(apiKey, apiSecret) — a fixed key/secret pair.
  • AddCredentialsProvider<TCredentialsProvider>(lifetime) — your own ILiveKitCredentialsProvider, e.g. one that reads a secret store (default lifetime: Singleton).

Main types

Type Kind Purpose
AddPinqponqLiveKitServer(Action<LiveKitServerOptions>) DI extension (IServiceCollection) Registers the three services below and returns a LiveKitServerBuilder.
LiveKitServerBuilder Builder AddStaticCredentials(...) / AddCredentialsProvider<T>(...) register the ILiveKitCredentialsProvider.
AccessTokenIssuer Service CreateToken(AccessTokenOptions, cancellationToken) → LiveKitAccessToken (Value, ExpiresAt).
AccessTokenOptions Options Identity, Name, Metadata, Attributes, VideoGrant, Ttl (default AccessTokenOptions.DefaultTtl, 6 hours).
VideoGrant Model The token's video claim: room join/create/list/admin, publish/subscribe permissions, CanPublishSources, and the rest of LiveKit's grant fields.
RoomServiceClient Service ListRooms, GetRoom, ListParticipants, RemoveParticipant, DeleteRoom against LiveKit's RoomService.
WebhookReceiver Service Receive(rawBody, authorizationHeader, cancellationToken) → WebhookEvent, after verifying LiveKit's signature.
WebhookEvent Model Id, Event / EventType, CreatedAt, Room, Participant, Track.
ILiveKitCredentialsProvider Interface GetCredentials(cancellationToken) → LiveKitCredentials. Implement it to source the key/secret yourself.
LiveKitApiException Exception A RoomService call returned a non-success status: StatusCode, ErrorCode (Twirp code), IsNotFound.
LiveKitWebhookValidationException Exception A webhook is not authentic — see Notes / behavior.

Notes / behavior

  • Each RoomService call carries its own least-privilege token. RoomServiceClient signs a 10-minute token per call holding only the grant that call needs — roomList for ListRooms / GetRoom, roomAdmin limited to the target room for ListParticipants / RemoveParticipant, and roomCreate for DeleteRoom.
  • Token options are checked before signing. CreateToken throws ArgumentOutOfRangeException for a non-positive Ttl, and ArgumentException when a RoomJoin grant has no Identity, or a RoomJoin / RoomAdmin grant has no Room. Tokens are HS256-signed with the API secret.
  • Unset publish/subscribe permissions mean "granted". On VideoGrant, CanPublish, CanSubscribe and CanPublishData are nullable on purpose: LiveKit treats an unset permission as granted and only an explicit false denies it. Do not default them to false when building a grant.
  • Webhook verification fails closed. Receive throws LiveKitWebhookValidationException when the Authorization header is missing, the token's signature, issuer (your API key) or lifetime is invalid, or the body's SHA-256 does not match the checksum in the token. Pass the request body exactly as received — the checksum covers those bytes, so a re-serialized body will not verify.
  • Webhooks can arrive more than once. LiveKit retries failed deliveries; use WebhookEvent.Id to discard duplicates. Egress, ingress and agent job payloads are not modeled — read them from the raw body if you need them.
  • API errors keep LiveKit's code. LiveKitApiException.ErrorCode holds the Twirp error code (not_found, permission_denied, …) and is null when the response was not a Twirp error at all, e.g. an HTML page from a proxy. GetRoom returns null for a room that isn't open rather than throwing.
  • Credentials are read on every call. The ILiveKitCredentialsProvider is called each time a token is signed or a webhook is verified, so a provider backed by a remote secret store should cache internally. LiveKitCredentials.ToString() omits the secret, so it is safe to log.
  • Pinqponq.Identity — authenticates your own users; issue a LiveKit access token only after that check passes.
  • Pinqponq.ErrorHandling — map LiveKitWebhookValidationException and LiveKitApiException to standard error responses through its StatusMappingResolver.

Samples

Try this package in the browser via Pinqponq.Playground — see samples/README.md.

Repository

https://github.com/pinqponq/pinqnuqets

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.2 107 10/6/2026
1.0.1 139 9/23/2026

https://github.com/pinqponq/pinqnuqets/blob/master/CHANGELOG.md