Class EgressClient

Client to access Egress APIs

Hierarchy

  • default
    • EgressClient

Constructors

constructor

Methods

authHeader listEgress startParticipantEgress startRoomCompositeEgress startTrackCompositeEgress startTrackEgress startWebEgress stopEgress updateLayout updateStream

Constructors

constructor

  • new EgressClient(host, apiKey?, secret?): 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

authHeader

listEgress

  • listEgress(options?): Promise<EgressInfo[]>

  • Parameters

    • Optional options: ListEgressOptions

      options to filter listed Egresses, by default returns all Egress instances

    Returns Promise<EgressInfo[]>

  • listEgress(roomName?): Promise<EgressInfo[]>

  • Parameters

    • Optional roomName: string

      list egress for one room only

    Returns Promise<EgressInfo[]>

    Deprecated

startParticipantEgress

  • startParticipantEgress(roomName, identity, output, opts?): Promise<EgressInfo>

  • Export a participant's audio and video tracks,

    Parameters

    Returns Promise<EgressInfo>

startRoomCompositeEgress

  • startRoomCompositeEgress(roomName, output, opts?): Promise<EgressInfo>

  • Parameters

    • roomName: string

      room name

    • output: EncodedOutputs | EncodedFileOutput | StreamOutput | SegmentedFileOutput

      file or stream output

    • Optional opts: RoomCompositeOptions

      RoomCompositeOptions

    Returns Promise<EgressInfo>

  • startRoomCompositeEgress(roomName, output, layout?, options?, audioOnly?, videoOnly?, customBaseUrl?): Promise<EgressInfo>

  • Parameters

    • roomName: string
    • output: EncodedOutputs | EncodedFileOutput | StreamOutput | SegmentedFileOutput
    • Optional layout: string
    • Optional options: EncodingOptionsPreset | EncodingOptions
    • Optional audioOnly: boolean
    • Optional videoOnly: boolean
    • Optional customBaseUrl: string

    Returns Promise<EgressInfo>

    Deprecated

    use RoomCompositeOptions instead

startTrackCompositeEgress

  • startTrackCompositeEgress(roomName, output, opts?): Promise<EgressInfo>

  • Parameters

    • roomName: string

      room name

    • output: EncodedOutputs | EncodedFileOutput | StreamOutput | SegmentedFileOutput

      file or stream output

    • Optional opts: TrackCompositeOptions

      TrackCompositeOptions

    Returns Promise<EgressInfo>

  • startTrackCompositeEgress(roomName, output, audioTrackId?, videoTrackId?, options?): Promise<EgressInfo>

  • Parameters

    • roomName: string
    • output: EncodedOutputs | EncodedFileOutput | StreamOutput | SegmentedFileOutput
    • Optional audioTrackId: string
    • Optional videoTrackId: string
    • Optional options: EncodingOptionsPreset | EncodingOptions

    Returns Promise<EgressInfo>

    Deprecated

    use TrackCompositeOptions instead

startTrackEgress

  • startTrackEgress(roomName, output, trackId): Promise<EgressInfo>

  • Parameters

    • roomName: string

      room name

    • output: string | DirectFileOutput

      file or websocket output

    • trackId: string

      track Id

    Returns Promise<EgressInfo>

startWebEgress

  • startWebEgress(url, output, opts?): Promise<EgressInfo>

  • Parameters

    • url: string

      url

    • output: EncodedOutputs | EncodedFileOutput | StreamOutput | SegmentedFileOutput

      file or stream output

    • Optional opts: WebOptions

      WebOptions

    Returns Promise<EgressInfo>

stopEgress

  • stopEgress(egressId): Promise<EgressInfo>

  • Parameters

    • egressId: string

    Returns Promise<EgressInfo>

updateLayout

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

  • Parameters

    • egressId: string
    • layout: string

    Returns Promise<EgressInfo>

updateStream

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

  • Parameters

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

    Returns Promise<EgressInfo>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc