Class LiveKitIngressService

Namespace

LiveKit.Services

Assembly

LiveKit.AspNetCore.ServerSdk.dll

Service for managing media ingress (RTMP, WHIP, URL pull).

Provides methods for creating and managing ingress endpoints for bringing external media into LiveKit rooms. See LiveKit Ingress API Documentation for more information.

public sealed class LiveKitIngressService : TwirpClient, ILiveKitIngressService

Inheritance

object

TwirpClient

LiveKitIngressService

Implements

ILiveKitIngressService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LiveKitIngressService(HttpClient, ILogger<LiveKitIngressService>, ILiveKitTokenService)

Initializes a new instance of the LiveKitIngressService class.

public LiveKitIngressService(HttpClient httpClient, ILogger<LiveKitIngressService> logger, ILiveKitTokenService _tokenService)

Parameters

httpClient HttpClient

logger ILogger<LiveKitIngressService>

_tokenService ILiveKitTokenService

Methods

CreateIngressAsync(CreateIngressRequest, CancellationToken)

Creates a new ingress endpoint.

public Task<IngressInfo> CreateIngressAsync(CreateIngressRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateIngressRequest

cancellationToken CancellationToken

Returns

Task<IngressInfo>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

DeleteIngressAsync(DeleteIngressRequest, CancellationToken)

Deletes an ingress endpoint.

public Task<IngressInfo> DeleteIngressAsync(DeleteIngressRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteIngressRequest

cancellationToken CancellationToken

Returns

Task<IngressInfo>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

ListIngressAsync(ListIngressRequest, CancellationToken)

Lists ingress endpoints.

public Task<ListIngressResponse> ListIngressAsync(ListIngressRequest request, CancellationToken cancellationToken = default)

Parameters

request ListIngressRequest

cancellationToken CancellationToken

Returns

Task<ListIngressResponse>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.

UpdateIngressAsync(UpdateIngressRequest, CancellationToken)

Updates an existing ingress. Ingress can only be updated when in ENDPOINT_WAITING state.

public Task<IngressInfo> UpdateIngressAsync(UpdateIngressRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateIngressRequest

cancellationToken CancellationToken

Returns

Task<IngressInfo>

Exceptions

LiveKitApiException

Thrown when the server returns a non-success HTTP status code.