LiveKit LogoDocs
Real-timeEgress/IngressCloudReference

Web Egress

On this page

OverviewUsageSupported Outputs

Overview

Web egress allows you to record or stream any website. Similar to room composite egress, it uses headless Chromium to render output. Unlike room composite egress, you can supply any url, and the lifecycle of web egress is not attached to a LiveKit room.

Usage

const output = {
fileType: EncodedFileType.MP4,
filepath: 'livekit-demo/web-test.mp4',
s3: {
accessKey: 'aws-access-key',
secret: 'aws-access-secret',
region: 'aws-region',
bucket: 'my-bucket'
}
};
const info = await egressClient.startWebEgress('https://docs.livekit.io/server/egress', output);
const egressID = info.egressId;

Supported Outputs

Web egress supports the same output methods as RoomComposite: RTMP, MP4, and HLS. Refer to RoomComposite examples for additional details.

Previous

Chevron IconRoom Composite Egress
LiveKit logo

Product

SFU

SDKs

Performance

Deployment

GitHub Logo