Class EgressClient

Client to access Egress APIs

Hierarchy

default
- EgressClient

Index

Constructors

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://.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
Returns EgressClient
Overrides ServiceBase.constructor
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:128

Methods

authHeader

authHeader(grant, sip?): 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:28

listEgress

listEgress(options?): Promise<EgressInfo[]>
Parameters
- Optionaloptions: ListEgressOptions
  options to filter listed Egresses, by default returns all Egress instances
Returns Promise<EgressInfo[]>
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:587
listEgress(roomName?): Promise<EgressInfo[]>
Parameters
- OptionalroomName: string
  list egress for one room only
Returns Promise<EgressInfo[]>
Deprecated
use listEgress(options?: ListEgressOptions) instead
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:592

startParticipantEgress

startParticipantEgress(roomName, identity, output, opts?): Promise<EgressInfo>
Export a participant's audio and video tracks,
Parameters
- roomName: string
  room name
- identity: string
- output: EncodedOutputs
  one or more outputs
- Optionalopts: ParticipantEgressOptions
  ParticipantEgressOptions
Returns Promise<EgressInfo>
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:266

startRoomCompositeEgress

startRoomCompositeEgress(roomName, output, opts?): Promise<EgressInfo>
Parameters
- roomName: string
  room name
- output:
      | EncodedOutputs
      | EncodedFileOutput
      | StreamOutput
      | SegmentedFileOutput
  file or stream output
- Optionalopts: RoomCompositeOptions
  RoomCompositeOptions
Returns Promise<EgressInfo>
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:138
startRoomCompositeEgress(roomName, output, layout?, options?, audioOnly?, videoOnly?, customBaseUrl?): Promise<EgressInfo>
Parameters
- roomName: string
- output:
      | EncodedOutputs
      | EncodedFileOutput
      | StreamOutput
      | SegmentedFileOutput
- Optionallayout: string
- Optionaloptions: EncodingOptionsPreset | EncodingOptions
- OptionalaudioOnly: boolean
- OptionalvideoOnly: boolean
- OptionalcustomBaseUrl: string
Returns Promise<EgressInfo>
Deprecated
use RoomCompositeOptions instead
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:146

startTrackCompositeEgress

startTrackCompositeEgress(roomName, output, opts?): Promise<EgressInfo>
Parameters
- roomName: string
  room name
- output:
      | EncodedOutputs
      | EncodedFileOutput
      | StreamOutput
      | SegmentedFileOutput
  file or stream output
- Optionalopts: TrackCompositeOptions
  TrackCompositeOptions
Returns Promise<EgressInfo>
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:298
startTrackCompositeEgress(roomName, output, audioTrackId?, videoTrackId?, options?): Promise<EgressInfo>
Parameters
- roomName: string
- output:
      | EncodedOutputs
      | EncodedFileOutput
      | StreamOutput
      | SegmentedFileOutput
- OptionalaudioTrackId: string
- OptionalvideoTrackId: string
- Optionaloptions: EncodingOptionsPreset | EncodingOptions
Returns Promise<EgressInfo>
Deprecated
use TrackCompositeOptions instead
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:306

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>
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:504

startWebEgress

startWebEgress(url, output, opts?): Promise<EgressInfo>
Parameters
- url: string
  url
- output:
      | EncodedOutputs
      | EncodedFileOutput
      | StreamOutput
      | SegmentedFileOutput
  file or stream output
- Optionalopts: WebOptions
  WebOptions
Returns Promise<EgressInfo>
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:220

stopEgress

stopEgress(egressId): Promise<EgressInfo>
Parameters
- egressId: string
Returns Promise<EgressInfo>
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:616

updateLayout

updateLayout(egressId, layout): Promise<EgressInfo>
Parameters
- egressId: string
- layout: string
Returns Promise<EgressInfo>
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:551

updateStream

updateStream(egressId, addOutputUrls?, removeOutputUrls?): Promise<EgressInfo>
Parameters
- egressId: string
- OptionaladdOutputUrls: string[]
- OptionalremoveOutputUrls: string[]
Returns Promise<EgressInfo>
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:566

Class EgressClient

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EgressClient

Methods

authHeader

Parameters

Returns Promise<Record<string, string>>

listEgress

Parameters

Returns Promise<EgressInfo[]>

Parameters

Returns Promise<EgressInfo[]>

Deprecated

startParticipantEgress

Parameters

Returns Promise<EgressInfo>

startRoomCompositeEgress

Parameters

Returns Promise<EgressInfo>

Parameters

Returns Promise<EgressInfo>

Deprecated

startTrackCompositeEgress

Parameters

Returns Promise<EgressInfo>

Parameters

Returns Promise<EgressInfo>

Deprecated

startTrackEgress

Parameters

Returns Promise<EgressInfo>

startWebEgress

Parameters

Returns Promise<EgressInfo>

stopEgress

Parameters

Returns Promise<EgressInfo>

updateLayout

Parameters

Returns Promise<EgressInfo>

updateStream

Parameters

Returns Promise<EgressInfo>

Settings

On This Page