Class IngressClient

Client to access Ingress APIs

Hierarchy

ServiceBase
- IngressClient

Index

Constructors

Methods

authHeader createIngress deleteIngress listIngress updateIngress

Constructors

constructor

new IngressClient(
    host: string,
    apiKey?: string,
    secret?: string,
    options?: ClientOptions,
): IngressClient
Parameters
- host: string
  hostname including protocol. i.e. 'https://.livekit.cloud'
- OptionalapiKey: string
  API Key, can be set in env var LIVEKIT_API_KEY
- Optionalsecret: string
  API Secret, can be set in env var LIVEKIT_API_SECRET
- Optionaloptions: ClientOptions
  client options
Returns IngressClient
Overrides ServiceBase.constructor
- Defined in packages/livekit-server-sdk/src/IngressClient.ts:140

Methods

authHeader

authHeader(grant: VideoGrant, sip?: SIPGrant): Promise<Record<string, string>>
Parameters
- grant: VideoGrant
- Optionalsip: SIPGrant
Returns Promise<Record<string, string>>
Inherited from ServiceBase.authHeader
- Defined in packages/livekit-server-sdk/src/ServiceBase.ts:55

createIngress

createIngress(
inputType: IngressInput,
opts: CreateIngressOptions,
): Promise<IngressInfo>
Parameters
- inputType: IngressInput
  protocol for the ingress
- opts: CreateIngressOptions
  CreateIngressOptions
Returns Promise<IngressInfo>
- Defined in packages/livekit-server-sdk/src/IngressClient.ts:152

deleteIngress

deleteIngress(ingressId: string): Promise<IngressInfo>
Parameters
- ingressId: string
  ingress to delete
Returns Promise<IngressInfo>
- Defined in packages/livekit-server-sdk/src/IngressClient.ts:274

listIngress

listIngress(roomName?: string): Promise<IngressInfo[]>
Parameters
- OptionalroomName: string
  list ingress for one room only
Returns Promise<IngressInfo[]>

Deprecated
use listIngress(opts) or listIngress(arg) instead
- Defined in packages/livekit-server-sdk/src/IngressClient.ts:247
listIngress(opts?: ListIngressOptions): Promise<IngressInfo[]>
Parameters
- Optionalopts: ListIngressOptions
  list options
Returns Promise<IngressInfo[]>
- Defined in packages/livekit-server-sdk/src/IngressClient.ts:251

updateIngress

updateIngress(
ingressId: string,
opts: UpdateIngressOptions,
): Promise<IngressInfo>
Parameters
- ingressId: string
  ID of the ingress to update
- opts: UpdateIngressOptions
  UpdateIngressOptions
Returns Promise<IngressInfo>
- Defined in packages/livekit-server-sdk/src/IngressClient.ts:212