Go Realtime SDK 和 LiveKit 服务器 API
Use this SDK to interact with LiveKit server APIs and create access tokens from your Go backend.
[!NOTE]
Version 2 of the SDK contains a small set of breaking changes. Read the migration guide for a detailed overview of what has changed.
go get github.com/livekit/server-sdk-go/v2Note: since v1.0 release, this package requires Go 1.18+ in order to build.
import (
"time"
lksdk "github.com/livekit/server-sdk-go/v2"
"github.com/livekit/protocol/auth"
)
func getJoinToken(apiKey, apiSecret, room, identity string) (string, error) {
at := auth.NewAccessToken(apiKey, apiSecret)
grant := &auth.VideoGrant{
RoomJoin: true,
Room: room,
}
at.SetVideoGrant(grant).
SetIdentity(identity).
SetValidFor(time.Hour)
return at.ToJWT()
}Every request to the server APIs is authenticated. LiveKitAPI (and each service client) supports two modes:
// Backend (API key & secret): set LIVEKIT_URL, LIVEKIT_API_KEY, and
// LIVEKIT_API_SECRET, then construct with no options...
api, _ := lksdk.NewLiveKitAPI()
// ...or pass any of them explicitly to override the corresponding env var:
api, _ := lksdk.NewLiveKitAPI(lksdk.WithURL(hostURL), lksdk.WithAPIKey("api-key", "api-secret"))
// Frontend (pre-signed access token): with LIVEKIT_URL set, pass just the token:
api, _ := lksdk.NewLiveKitAPI(lksdk.WithToken("token"))LiveKitAPI is a single entry point to every server API, exposing each service through an accessor: Room(), Egress(), Ingress(), SIP(), AgentDispatch(), and Connector(). Construct it with your credentials (see Authentication); the url and credentials fall back to the LIVEKIT_URL, LIVEKIT_API_KEY, LIVEKIT_API_SECRET, and LIVEKIT_TOKEN environment variables. Values you pass explicitly take precedence; the environment variables are used only as a fallback for arguments you omit — an ambient LIVEKIT_TOKEN, for example, won't override an explicitly-provided API key and secret.
RoomService, reached via api.Room(), gives you complete control over rooms and participants within them, including selective track subscriptions and moderation capabilities.
…Agent dispatch assigns an agent to a room. Explicit dispatch, via api.AgentDispatch(), gives you full control over when and how agents join and lets you pass job-specific metadata. The target agent is selected by its agent_name, and the room is created if it doesn't exist.
// dispatch an agent into a room
dispatch, _ := api.AgentDispatch().CreateDispatch(context.Background(), &livekit.CreateAgentDispatchRequest{
Room: "myroom",
AgentName: "my-agent",
Metadata: "{}",
})
// list dispatches in a room
dispatches, _ := api.AgentDispatch().ListDispatch(context.Background(), &livekit.ListAgentDispatchRequest{
Room: "myroom",
})
// delete a dispatch
api.AgentDispatch().DeleteDispatch(context.Background(), &livekit.DeleteAgentDispatchRequest{
DispatchId: dispatch.Id,
Room: "myroom",
})
_ = dispatchesA failed server API call returns a lksdk.ServerError, which exposes the error code, message, and any server-provided metadata. Use errors.As to extract it. SIP dialing calls can fail with a SIP response status; lksdk.SIPStatusFrom extracts it from the returned error:
_, err := api.SIP().CreateSIPParticipant(context.Background(), &livekit.CreateSIPParticipantRequest{
SipTrunkId: "trunk-id",
SipCallTo: "+15105550100",
RoomName: "my-room",
WaitUntilAnswered: true,
})
if err != nil {
if status := lksdk.SIPStatusFrom(err); status != nil {
fmt.Println(status.Code, status.Status) // e.g. 486 "Busy Here"
}
var se lksdk.ServerError
if errors.As(err, &se) {
fmt.Println(se.Code(), se.Msg())
}
}The Real-time SDK gives you access programmatic access as a client enabling you to publish and record audio/video/data to the room.
…For more advanced usage, see the examples directory.
With the Go SDK, you can publish existing files encoded in H.264, VP8, and Opus to the room.
First, you will need to encode media into the right format.
ffmpeg -i \
-c:v libvpx -keyint_min 120 -qmax 50 -maxrate 2M -b:v 1M \
-c:a libopus -page_duration 20000 -vn The above encodes VP8 at average 1Mbps / max 2Mbps with a minimum keyframe interval of 120.
ffmpeg -i \
-c:v libx264 -bsf:v h264_mp4toannexb -b:v 2M -profile baseline -pix_fmt yuv420p \
-x264-params keyint=120 -max_delay 0 -bf 0 \
-c:a libopus -page_duration 20000 -vn The above encodes H264 with CBS of 2Mbps with a minimum keyframe interval of 120.
file := "video.ivf"
videoWidth := 1920
videoHeight := 1080
track, err := lksdk.NewLocalFileTrack(file,
// control FPS to ensure synchronization
lksdk.ReaderTrackWithFrameDuration(33 * time.Millisecond),
lksdk.ReaderTrackWithOnWriteComplete(func() { fmt.Println("track finished") }),
)
if err != nil {
return err
}
if _, err = room.LocalParticipant.PublishTrack(track, &lksdk.TrackPublicationOptions{
Name: file,
VideoWidth: videoWidth,
VideoHeight: videoHeight,
}); err != nil {
return err
}// - `in` implements io.ReadCloser, such as buffer or file
// - `mime` has to be one of webrtc.MimeType...
track, err := lksdk.NewLocalReaderTrack(in, mime,
lksdk.ReaderTrackWithFrameDuration(33 * time.Millisecond),
lksdk.ReaderTrackWithOnWriteComplete(func() { fmt.Println("track finished") }),
)
if err != nil {
return err
}
if _, err = room.LocalParticipant.PublishTrack(track, &lksdk.TrackPublicationOptions{}); err != nil {
return err
}For a full working example, refer to filesender. This example sends all audio/video files in the current directory.
In order to publish audio from PCM16 Samples, you can use the NewPCMLocalTrack API as follows:
import (
...
lkmedia "github.com/livekit/server-sdk-go/v2/pkg/media"
)
...
publishTrack, err := lkmedia.NewPCMLocalTrack(sourceSampleRate, sourceChannels, logger.GetLogger())
if err != nil {
return err
}
if _, err = room.LocalParticipant.PublishTrack(publishTrack, &lksdk.TrackPublicationOptions{
Name: "test",
}); err != nil {
return err
}You can then write PCM16 samples to the publishTrack like:
err = publishTrack.WriteSample(sample)
if err != nil {
logger.Errorw("error writing sample", err)
}The SDK will encode the sample to Opus and write it to the track. If the sourceSampleRate is not 48000, resampling is also handled internally.
To close the track, you can call Close() on the publishTrack, this will stop accepting samples, write the existing buffer and then close the track. If you wish to clear the buffer manually, use the ClearQeuue() on the track. There's also a WaitForPlayout() API if you want to wait for existing buffer to be written before writing something to the track.
Note: Stereo audio is currently not supported, it may result in unpleasant audio.
In order to publish from non-file sources, you will have to implement your own SampleProvider, that could provide frames of data with a NextSample method.
The SDK takes care of sending the samples to the room.
With video publishing, keyframes can be an order of magnitude larger than delta frames. This size difference can cause a significant increase in bitrate when a keyframe is transmitted, leading to a surge in packet flow. Such spikes might result in packet loss at the forwarding layer. To maintain a consistent packet flow, you can enable the use of a pacer.
…With the Go SDK, you can accept media from the room.
For a full working example, refer to filesaver. This example saves the audio/video in the LiveKit room to the local disk.
To get PCM audio out of a remote Opus audio track, you can use the following API:
import (
...
media "github.com/livekit/media-sdk"
lkmedia "github.com/livekit/server-sdk-go/v2/pkg/media"
)
type PCM16Writer struct {
closed atomic.Bool
}
func (w *PCM16Writer) WriteSample(sample media.PCM16Sample) error {
if !w.closed.Load() {
// Use the sample however you want
}
}
func (w *PCM16Writer) Close() error {
w.closed.Store(true)
// close the writer
}
...
writer := &PCM16Writer{}
pcmTrack, err := lkmedia.NewPCMRemoteTrack(remoteTrack, writer)
if err != nil {
return err
}The SDK will then read the provided remote track, decode the audio and write the PCM16 samples to the provided writer. By defeault, it pushes out 48kHz mono audio. The output sample rate and channels can also be configured by passsing as an option:
pcmTrack, err := lkmedia.NewPCMRemoteTrack(remoteTrack, writer, lkmedia.WithTargetSampleRate(24000), lkmedia.WithTargetChannels(2))Resampling to the target sample rate is handled internally, and so is upmixing/downmixing to the target channel count.
The API also provides an option to handle jitter, this is enabled by default but you can disable it using:
pcmTrack, err := lkmedia.NewPCMRemoteTrack(remoteTrack, writer, lkmedia.WithHandleJitter(false))The Go SDK helps you to verify and decode webhook callbacks to ensure their authenticity. See webhooks guide for configuration.
import (
"github.com/livekit/protocol/auth"
"github.com/livekit/protocol/livekit"
"github.com/livekit/protocol/webhook"
)
var authProvider = auth.NewSimpleKeyProvider(
apiKey, apiSecret,
)
func ServeHTTP(w http.ResponseWriter, r *http.Request) {
// event is a livekit.WebhookEvent{} object
event, err := webhook.ReceiveWebhookEvent(r, authProvider)
if err != nil {
// could not validate, handle error
return
}
// consume WebhookEvent
}LiveKit Ecosystem
LiveKit SDKsBrowser · iOS/macOS/visionOS · Android · Flutter · React Native · Rust · Node.js · Python · Unity · Unity (WebGL) · ESP32
Server APIsNode.js · Golang · Ruby · Java/Kotlin · Python · Rust · PHP (community) · .NET (community)
UI ComponentsReact · Android Compose · SwiftUI · Flutter
Agents FrameworksPython · Node.js · Playground
ServicesLiveKit server · Egress · Ingress · SIP
ResourcesDocs · Example apps · Cloud · Self-hosting · CLI
暂无开放 Issues,或尚未同步最近议题。