Class EgressClient

Client to access Egress APIs

Hierarchy

ServiceBase
- EgressClient

Index

Constructors

Methods

authHeader listEgress startEgress startParticipantEgress startRoomCompositeEgress startTrackCompositeEgress startTrackEgress startWebEgress stopEgress updateLayout updateStream

Constructors

constructor

new EgressClient(
    host: string,
    apiKey?: string,
    secret?: string,
    options?: ClientOptions,
): 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
- Optionaloptions: ClientOptions
  client options
Returns EgressClient
Overrides ServiceBase.constructor
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:144

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

listEgress

listEgress(options?: ListEgressOptions): 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:639
listEgress(roomName?: string): 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:644

startEgress

startEgress(request: StartEgressRequest): Promise<EgressInfo>
Starts an egress using the unified v2 request.
Parameters
- request: StartEgressRequest
  the egress request
Returns Promise<EgressInfo>
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:589

startParticipantEgress

startParticipantEgress(
    roomName: string,
    identity: string,
    output: EncodedOutputs,
    opts?: ParticipantEgressOptions,
): 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:295

startRoomCompositeEgress

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

Deprecated
use RoomCompositeOptions instead
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:165

startTrackCompositeEgress

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

Deprecated
use TrackCompositeOptions instead
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:338

startTrackEgress

startTrackEgress(
    roomName: string,
    output: string | DirectFileOutput,
    trackId: string,
    webhooks?: WebhookConfig[],
): Promise<EgressInfo>
Parameters
- roomName: string
  room name
- output: string | DirectFileOutput
  file or websocket output
- trackId: string
  track Id
- Optionalwebhooks: WebhookConfig[]
Returns Promise<EgressInfo>
- Defined in packages/livekit-server-sdk/src/EgressClient.ts:539

startWebEgress

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

stopEgress

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

updateLayout

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

updateStream

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

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

startEgress

Parameters

Returns Promise<EgressInfo>

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