Track Egress

Overview

TrackEgress is the simplest way to export individual tracks to cloud storage or a server via WebSocket.

Tracks are exported as is, without transcoding. The following containers will be used depending on track codec:

H.264: MP4
VP8: WebM
Opus: Ogg

Export to cloud storage

const output = {
    fileType:  EncodedFileType.MP4,
    filepath: 'livekit-demo/track-test.mp4',
    s3: {
        accessKey: 'aws-access-key',
        secret:    'aws-access-secret',
        region:    'aws-region',
        bucket:    'my-bucket'
    }
};

const info = await egressClient.startTrackEgress('my-room', output, trackID);
const egressID = info.egressId;

trackRequest := &livekit.TrackEgressRequest{
    RoomName:  "my-room",
    TrackId:   "speaker-dark",
    Output: &livekit.TrackEgressRequest_File{
        File: &livekit.DirectFileOutput{
            Filepath: "livekit-demo/track-test",
            Output: &livekit.DirectFileOutput_S3{
                S3: &livekit.S3Upload{
                    AccessKey: "aws-access-key",
                    Secret:    "aws-access-secret",
                    Region:    "aws-region",
                    Bucket:    "my-bucket",
                },
            },
        },
    },
}

info, err := egressClient.StartTrackEgress(ctx, trackRequest)
egressID := info.EgressId

info = egressClient.start_track_egress(
    'room-name',
    LiveKit::Proto::DirectFileOutput.new(
        filepath: 'myfile.mp4',
        gcp: LiveKit::Proto::GCPUpload.new(
            credentials: '',
            bucket: 'my-bucket'
        )
    ),
    'TR_XXXXXXXXXXXX',
)
puts info

LivekitEgress.DirectFileOutput output = LivekitEgress.DirectFileOutput.newBuilder()
        .setFilepath("livekit-demo/track-test")
        .setS3(LivekitEgress.S3Upload.newBuilder()
                .setAccessKey("access-key")
                .setSecret("secret")
                .setBucket("bucket")
                .setRegion("region")
                .build())
        .build();

Call<LivekitEgress.EgressInfo> call = client.startTrackEgress(
        "roomName",
        output,
        "trackId");
try {
    LivekitEgress.EgressInfo egressInfo = call.execute().body();
    // handle engress info
} catch (IOException e) {
    // handle error
}

{
    "room_name": "my-room",
    "track_id": "TR_XXXXXXXXXXXX",
    "file": {
        "filepath": "livekit-demo/track-test.mp4",
        "s3": {
            "access_key": "aws-access-key",
            "secret": "aws-access-secret",
            "region": "aws-region",
            "bucket": "my-bucket"
        }
    }
}

% livekit-cli start-track-egress --request request.json
Egress started. Egress ID: EG_XXXXXXXXXXXX

You can add custom stream processing by starting a TrackEgress to your WebSocket server. This will give you a real-time streaming export of your audio tracks. (WebSocket streaming is only available for audio tracks).

The tracks will be exported as raw PCM data. This format is compatible with most transcription services.

Format: pcm_s16le
Content-Type: audio/x-raw
Sample rate: matches incoming, typically 48kHz

When a TrackEgressRequest is started with a WebSocket URL, we'll initiate a WebSocket session to the desired URL.

We'll send a combination of binary and text frames. Binary frames would contain audio data. Text frames will contain end user events on the tracks. For example: if the track was muted, you will receive the following:

{ "muted": true }

And when unmuted:

{ "muted": false }

The WebSocket connection will terminate when the track is unpublished (or if the participant leaves the room).

const info = await egressClient.startTrackEgress(
  'my-room',
  'wss://my-websocket-server.com',
  trackID,
);
const egressID = info.egressId;

trackRequest := &livekit.TrackEgressRequest{
  RoomName:  "my-room",
  TrackId:   "speaker-dark",
  Output: &livekit.TrackEgressRequest_WebsocketUrl{
    WebsocketUrl: "wss://my-websocket-server.com",
  },
}

info, err := egressClient.StartTrackEgress(ctx, trackRequest)
egressID := info.EgressId

info = egressClient.start_track_egress(
    'room-name',
    'wss://my-websocket-server.com',
    'TR_XXXXXXXXXXXX',
)
puts info

{
    "room_name": "my-room",
    "track_id": "TR_XXXXXXXXXXXX",
    "websocket_url": "wss://my-websocket-server.com"
}

% livekit-cli start-track-egress --request request.json
Egress started. Egress ID: EG_XXXXXXXXXXXX

Overview

Export to cloud storage

Stream audio to WebSocket