Class IngressClient

Client to access Ingress APIs

Hierarchy

default
- IngressClient

Index

Constructors

Methods

authHeader createIngress deleteIngress listIngress updateIngress

Constructors

constructor

new IngressClient(host, apiKey?, secret?): IngressClient
Parameters
- host: string
  hostname including protocol. i.e. 'https://cluster.livekit.io'
- Optional apiKey: string
  API Key, can be set in env var LIVEKIT_API_KEY
- Optional secret: string
  API Secret, can be set in env var LIVEKIT_API_SECRET
Returns IngressClient
Overrides ServiceBase.constructor
- Defined in src/IngressClient.ts:106

Methods

authHeader

authHeader(grant): Promise<any>
Parameters
- grant: VideoGrant
Returns Promise<any>
Inherited from ServiceBase.authHeader
- Defined in src/ServiceBase.ts:25

createIngress

createIngress(inputType, opts?): Promise<IngressInfo>
Parameters
- inputType: IngressInput
  protocol for the ingress
- Optional opts: CreateIngressOptions
  CreateIngressOptions
Returns Promise<IngressInfo>
- Defined in src/IngressClient.ts:115

deleteIngress

deleteIngress(ingressId): Promise<IngressInfo>
Parameters
- ingressId: string
  ingress to delete
Returns Promise<IngressInfo>
- Defined in src/IngressClient.ts:216

listIngress

listIngress(roomName?): Promise<IngressInfo[]>
Parameters
- Optional roomName: string
  list ingress for one room only
Returns Promise<IngressInfo[]>
Deprecated
use listIngress(opts) instead
- Defined in src/IngressClient.ts:192
listIngress(opts?): Promise<IngressInfo[]>
Parameters
- Optional opts: ListIngressOptions
  list options
Returns Promise<IngressInfo[]>
- Defined in src/IngressClient.ts:196

updateIngress

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

Generated using TypeDoc