livekit/egress

LiveKit Egress 镜像文档

镜像概述

LiveKit Egress是LiveKit实时音视频平台的核心组件，专注于媒体流输出处理。它接收来自LiveKit SFU的实时音视频流，通过配置将流录制为文件、推送到CDN或生成可分发的媒体格式，为实时音视频应用提供完整的内容留存与分发能力。

核心功能与特性

多类型输出支持

• 文件录制：将音视频流编码为MP4、WebM等文件格式，支持单轨道（音频/视频分离）或多轨道合成
• 实时流推送：支持RTMP、RTMPS、HLS、WebRTC等协议，可直接推送到CDN或第三方直播平台
• 合成流处理：支持多参与者视频画面合成（如网格布局）、音频混合，生成单一输出流

可靠性与灵活性

• 自动恢复：网络中断或服务重启后支持断点续传，确保录制完整性
• 动态配置：通过LiveKit API动态发起录制/推流任务，无需重启服务
• 多存储集成：支持本地文件系统、S3、GCS、Azure Blob等存储服务

性能优化

• 硬件加速：支持GPU加速编码（需宿主机配置NVIDIA Docker运行时）
• 自适应码率：根据输入流质量动态调整输出码率，平衡存储占用与画质

使用场景与适用范围

• 直播内容存档：将直播流实时录制为文件，用于后期回放或剪辑
• 在线会议/ webinar 录制：存档会议内容，支持会后分享或合规审计
• 教育场景：录制在线课程、培训内容，生成点播资源
• 内容分发：将实时流推送到多CDN，扩展内容覆盖范围

使用方法与配置说明

镜像获取

从LiveKit官方仓库拉取最新镜像：

bash
docker pull livekit/egress:latest

基本使用（Docker Run）

bash
docker run -d \
  --name livekit-egress \
  -e LIVEKIT_URL="wss://your-livekit-server:7880" \
  -e LIVEKIT_API_KEY="your-api-key" \
  -e LIVEKIT_API_SECRET="your-api-secret" \
  -e EGRESS_CONFIG_PATH="/etc/egress/config.yaml" \
  -v ./config.yaml:/etc/egress/config.yaml \
  livekit/egress:latest

核心环境变量配置

Docker Compose示例

yaml
version: '3.8'
services:
  egress:
    image: livekit/egress:latest
    container_name: livekit-egress
    environment:
      - LIVEKIT_URL=wss://livekit-sfu:7880
      - LIVEKIT_API_KEY=${LIVEKIT_API_KEY}
      - LIVEKIT_API_SECRET=${LIVEKIT_API_SECRET}
      - STORAGE_TYPE=s3
      - S3_BUCKET=livekit-recordings
      - AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}
      - AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}
      - AWS_REGION=us-west-2
    volumes:
      - ./config:/etc/egress/config
    restart: unless-stopped
    depends_on:
      - livekit-sfu

任务配置示例（通过API发起）

通过LiveKit Server API发起录制任务（以Go SDK为例）：

go
import (
  "github.com/livekit/protocol/livekit"
  "github.com/livekit/server-sdk-go"
)

func startRecording() error {
  client := lksdk.NewRoomServiceClient("https://livekit.example.com", "API_KEY", "API_SECRET")
  
  req := &livekit.RecordingRequest{
    RoomName: "my-room",
    Output: &livekit.RecordingOutput{
      FileType: livekit.RecordingFileType_MP4,
      Filepath: "recordings/meeting-123.mp4",
    },
    // 可选：配置合成布局
    Layout: &livekit.VideoLayout{
      Type: livekit.VideoLayout_GRID,
    },
  }
  
  _, err := client.StartRecording(context.Background(), req)
  return err
}

注意事项

• 需确保与LiveKit SFU版本兼容（参考官方版本矩阵）
• 高并发场景建议通过Kubernetes部署，配置资源限制与自动扩缩容
• 存储服务需配置适当权限，确保Egress可读写目标存储路径
• 网络带宽需满足输出流码率要求，避免卡顿或丢包