Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EgressClient

Client to access Egress APIs

Hierarchy

  • EgressClient

Index

Constructors

Methods

Constructors

constructor

  • new EgressClient(host: string, apiKey?: string, secret?: string): EgressClient

  • 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 EgressClient

Methods

listEgress

  • listEgress(roomName?: string): Promise<EgressInfo>

  • Parameters

    • Optional roomName: string

      list egress for one room only

    Returns Promise<EgressInfo>

startWebCompositeEgress

  • startWebCompositeEgress(roomName: string, layout: string, output: EncodedFileOutput | StreamOutput, options?: EncodingOptionsPreset | EncodingOptions, audioOnly?: boolean, videoOnly?: boolean, customBaseUrl?: string): Promise<EgressInfo>

  • Parameters

    • roomName: string

      room name

    • layout: string

      egress layout

    • output: EncodedFileOutput | StreamOutput

      output filepath or RtmpOutput

    • Optional options: EncodingOptionsPreset | EncodingOptions

      egress options or preset

    • Optional audioOnly: boolean

      record audio only

    • Optional videoOnly: boolean

      record video only

    • Optional customBaseUrl: string

      custom template url

    Returns Promise<EgressInfo>

stopEgress

  • stopEgress(egressId: string): Promise<EgressInfo>

updateLayout

  • updateLayout(egressId: string, layout: string): Promise<EgressInfo>

  • Parameters

    • egressId: string
    • layout: string

    Returns Promise<EgressInfo>

updateStream

  • updateStream(egressId: string, addOutputUrls?: string[], removeOutputUrls?: string[]): Promise<EgressInfo>

  • Parameters

    • egressId: string
    • Optional addOutputUrls: string[]
    • Optional removeOutputUrls: string[]

    Returns Promise<EgressInfo>

Generated using TypeDoc