Erster Commit

2026-08-22 08:40:29 +02:00
commit 875477d425
1961 changed files with 930336 additions and 0 deletions
@@ -0,0 +1,138 @@
+import { IngressAudioOptions, IngressVideoOptions, IngressInput, IngressInfo } from '@livekit/protocol';
+import { ClientOptions } from './ClientOptions.js';
+import { ServiceBase } from './ServiceBase.js';
+import './grants.js';
+import 'jose';
+
+interface CreateIngressOptions {
+    /**
+     * ingress name. optional
+     */
+    name?: string;
+    /**
+     * name of the room to send media to. required
+     */
+    roomName?: string;
+    /**
+     * unique identity of the participant. required
+     */
+    participantIdentity: string;
+    /**
+     * participant display name
+     */
+    participantName?: string;
+    /**
+     * metadata to attach to the participant
+     */
+    participantMetadata?: string;
+    /**
+     * @deprecated use `enableTranscoding` instead.
+     * whether to skip transcoding and forward the input media directly. Only supported by WHIP
+     */
+    bypassTranscoding?: boolean;
+    /**
+     * whether to enable transcoding or forward the input media directly.
+     * Transcoding is required for all input types except WHIP. For WHIP, the default is to not transcode.
+     */
+    enableTranscoding?: boolean | undefined;
+    /**
+     * url of the media to pull for ingresses of type URL
+     */
+    url?: string;
+    /**
+     * custom audio encoding parameters. optional
+     */
+    audio?: IngressAudioOptions;
+    /**
+     * custom video encoding parameters. optional
+     */
+    video?: IngressVideoOptions;
+}
+interface UpdateIngressOptions {
+    /**
+     * ingress name. optional
+     */
+    name: string;
+    /**
+     * name of the room to send media to.
+     */
+    roomName?: string;
+    /**
+     * unique identity of the participant.
+     */
+    participantIdentity?: string;
+    /**
+     * participant display name
+     */
+    participantName?: string;
+    /**
+     * metadata to attach to the participant
+     */
+    participantMetadata?: string;
+    /**
+     * @deprecated use `enableTranscoding` instead
+     * whether to skip transcoding and forward the input media directly. Only supported by WHIP
+     */
+    bypassTranscoding?: boolean | undefined;
+    /**
+     * whether to enable transcoding or forward the input media directly.
+     * Transcoding is required for all input types except WHIP. For WHIP, the default is to not transcode.
+     */
+    enableTranscoding?: boolean | undefined;
+    /**
+     * custom audio encoding parameters. optional
+     */
+    audio?: IngressAudioOptions;
+    /**
+     * custom video encoding parameters. optional
+     */
+    video?: IngressVideoOptions;
+}
+interface ListIngressOptions {
+    /**
+     * list ingress for one room only
+     */
+    roomName?: string;
+    /**
+     * list ingress by ID
+     */
+    ingressId?: string;
+}
+/**
+ * Client to access Ingress APIs
+ */
+declare class IngressClient extends ServiceBase {
+    private readonly rpc;
+    /**
+     * @param host - hostname including protocol. i.e. 'https://<project>.livekit.cloud'
+     * @param apiKey - API Key, can be set in env var LIVEKIT_API_KEY
+     * @param secret - API Secret, can be set in env var LIVEKIT_API_SECRET
+     * @param options - client options
+     */
+    constructor(host: string, apiKey?: string, secret?: string, options?: ClientOptions);
+    /**
+     * @param inputType - protocol for the ingress
+     * @param opts - CreateIngressOptions
+     */
+    createIngress(inputType: IngressInput, opts: CreateIngressOptions): Promise<IngressInfo>;
+    /**
+     * @param ingressId - ID of the ingress to update
+     * @param opts - UpdateIngressOptions
+     */
+    updateIngress(ingressId: string, opts: UpdateIngressOptions): Promise<IngressInfo>;
+    /**
+     * @deprecated use `listIngress(opts)` or `listIngress(arg)` instead
+     * @param roomName - list ingress for one room only
+     */
+    listIngress(roomName?: string): Promise<Array<IngressInfo>>;
+    /**
+     * @param opts - list options
+     */
+    listIngress(opts?: ListIngressOptions): Promise<Array<IngressInfo>>;
+    /**
+     * @param ingressId - ingress to delete
+     */
+    deleteIngress(ingressId: string): Promise<IngressInfo>;
+}
+
+export { type CreateIngressOptions, IngressClient, type ListIngressOptions, type UpdateIngressOptions };