Web Egress

Web Egress allows you to stream or record any website, with a lifecycle detached from LiveKit rooms.

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 = new EncodedFileOutput({
  fileType: EncodedFileType.MP4,
  filepath: 'livekit-demo/web-test.mp4',
  output: {
    case: 's3',
    value: new S3Upload({
      accessKey: 'aws-access-key',
      secret: 'aws-access-secret',
      bucket: 'my-bucket',
    }),
  },
});


const info = await egressClient.startWebEgress('https://docs.livekit.io/', { file: output });
const egressID = info.egressId;

Supported Outputs

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

GitHubSlack
Sign in