Interface ILiveKitIngressService

Namespace

LiveKit.Services

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.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 interface ILiveKitIngressService

Methods

CreateIngressAsync(CreateIngressRequest, CancellationToken)

Creates a new ingress endpoint.

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.

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.

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.

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.