[go: up one dir, main page]

lksdk

package module
v2.9.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 4, 2025 License: Apache-2.0 Imports: 61 Imported by: 40

README

The LiveKit icon, the name of the repository and some sample code in the background.

LiveKit Go SDK

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.

Installation

go get github.com/livekit/server-sdk-go/v2

Note: since v1.0 release, this package requires Go 1.18+ in order to build.

Token creation

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()
}

RoomService API

RoomService gives you complete control over rooms and participants within them. It includes selective track subscriptions as well as moderation capabilities.

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

func main() {
	hostURL := "host-url"  // ex: https://project-123456.livekit.cloud
	apiKey := "api-key"
	apiSecret := "api-secret"

	roomName := "myroom"
	identity := "participantIdentity"

    roomClient := lksdk.NewRoomServiceClient(hostURL, apiKey, apiSecret)

    // create a new room
    room, _ := roomClient.CreateRoom(context.Background(), &livekit.CreateRoomRequest{
		Name: roomName,
	})

    // list rooms
    res, _ := roomClient.ListRooms(context.Background(), &livekit.ListRoomsRequest{})

    // terminate a room and cause participants to leave
    roomClient.DeleteRoom(context.Background(), &livekit.DeleteRoomRequest{
		Room: roomId,
	})

    // list participants in a room
    res, _ := roomClient.ListParticipants(context.Background(), &livekit.ListParticipantsRequest{
		Room: roomName,
	})

    // disconnect a participant from room
    roomClient.RemoveParticipant(context.Background(), &livekit.RoomParticipantIdentity{
		Room:     roomName,
		Identity: identity,
	})

    // mute/unmute participant's tracks
    roomClient.MutePublishedTrack(context.Background(), &livekit.MuteRoomTrackRequest{
		Room:     roomName,
		Identity: identity,
		TrackSid: "track_sid",
		Muted:    true,
	})
}

Interacting as a participant

The Real-time SDK gives you access programmatic access as a client enabling you to publish and record audio/video/data to the room.

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

func main() {
  hostURL := "host-url"  // ex: https://project-123456.livekit.cloud
  apiKey := "api-key"
  apiSecret := "api-secret"
  roomName := "myroom"
  identity := "botuser"
  roomCB := &lksdk.RoomCallback{
	ParticipantCallback: lksdk.ParticipantCallback{
	  OnTrackSubscribed: trackSubscribed,
  	},
  }
  room, err := lksdk.ConnectToRoom(hostURL, lksdk.ConnectInfo{
  	APIKey:              apiKey,
  	APISecret:           apiSecret,
  	RoomName:            roomName,
  	ParticipantIdentity: identity,
  }, roomCB)
  if err != nil {
  	panic(err)
  }

  ...
  room.Disconnect()
}

func trackSubscribed(track *webrtc.TrackRemote, publication *lksdk.RemoteTrackPublication, rp *lksdk.RemoteParticipant) {

}

For more advanced usage, see the examples directory.

Publishing tracks to Room

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.

VP8 / Opus
ffmpeg -i <input.mp4> \
  -c:v libvpx -keyint_min 120 -qmax 50 -maxrate 2M -b:v 1M <output.ivf> \
  -c:a libopus -page_duration 20000 -vn <output.ogg>

The above encodes VP8 at average 1Mbps / max 2Mbps with a minimum keyframe interval of 120.

H.264 / Opus
ffmpeg -i <input.mp4> \
  -c:v libx264 -bsf:v h264_mp4toannexb -b:v 2M -profile baseline -pix_fmt yuv420p \
    -x264-params keyint=120 -max_delay 0 -bf 0 <output.h264> \
  -c:a libopus -page_duration 20000 -vn <output.ogg>

The above encodes H264 with CBS of 2Mbps with a minimum keyframe interval of 120.

Publish from file
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
}
Publish from io.ReadCloser implementation
// - `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.

Publishing audio from PCM16 Samples

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.

Publish from other sources

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.

Using a pacer

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.

import "github.com/livekit/mediatransportutil/pkg/pacer"

// Control total output bitrate to 10Mbps with 1s max latency
pf := pacer.NewPacerFactory(
	pacer.LeakyBucketPacer,
	pacer.WithBitrate(10000000),
	pacer.WithMaxLatency(time.Second),
)

room, err := lksdk.ConnectToRoom(hostURL, lksdk.ConnectInfo{
    APIKey:              apiKey,
    APISecret:           apiSecret,
    RoomName:            roomName,
    ParticipantIdentity: identity,
}, &lksdk.RoomCallback{
    ParticipantCallback: lksdk.ParticipantCallback{
        OnTrackSubscribed: onTrackSubscribed,
    },
}, lksdk.WithPacer(pf))

Receiving tracks from Room

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.

Decoding an Opus track to PCM16

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))

Receiving webhooks

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)
Server APIsNode.js · Golang · Ruby · Java/Kotlin · Python · Rust · PHP (community) · .NET (community)
UI ComponentsReact · Android Compose · SwiftUI
Agents FrameworksPython · Node.js · Playground
ServicesLiveKit server · Egress · Ingress · SIP
ResourcesDocs · Example apps · Cloud · Self-hosting · CLI

Documentation

Index

Examples

Constants

View Source 
const (
	LIVEKIT_SDK_SALT         = "LKFrameEncryptionKey"
	LIVEKIT_IV_LENGTH        = 12
	LIVEKIT_PBKDF_ITERATIONS = 100000
	LIVEKIT_KEY_SIZE_BYTES   = 16
	LIVEKIT_HKDF_INFO_BYTES  = 128
)
View Source 
const (
	ParticipantStandard = ParticipantKind(livekit.ParticipantInfo_STANDARD)
	ParticipantIngress  = ParticipantKind(livekit.ParticipantInfo_INGRESS)
	ParticipantEgress   = ParticipantKind(livekit.ParticipantInfo_EGRESS)
	ParticipantSIP      = ParticipantKind(livekit.ParticipantInfo_SIP)
	ParticipantAgent    = ParticipantKind(livekit.ParticipantInfo_AGENT)
)
View Source 
const (
	MaxMessageBytes = 256
	MaxDataBytes    = 15360 // 15KiB

	// Maximum payload size for RPC requests and responses. If a payload exceeds this size,
	// the RPC call will fail with a RpcRequestPayloadTooLarge(1402) or RpcResponsePayloadTooLarge(1504) error.
	MaxPayloadBytes = 15360 // 15KiB
)
View Source 
const PROTOCOL = 16
View Source 
const (
	// default max chunk size for streams
	STREAM_CHUNK_SIZE = 15_000
)
View Source 
const (
	SimulateSpeakerUpdateInterval = 5
)
View Source 
const Version = "2.9.1"

Variables

View Source 
var (
	ErrIncorrectKeyLength    = errors.New("incorrect key length for encryption/decryption")
	ErrUnableGenerateIV      = errors.New("unable to generate iv for encryption")
	ErrIncorrectIVLength     = errors.New("incorrect iv length")
	ErrIncorrectSecretLength = errors.New("input secret provided to derivation function cannot be empty or nil")
	ErrIncorrectSaltLength   = errors.New("input salt provided to derivation function cannot be empty or nil")
	ErrBlockCipherRequired   = errors.New("input block cipher cannot be nil")
)
View Source 
var (
	ErrURLNotProvided           = errors.New("URL was not provided")
	ErrConnectionTimeout        = errors.New("could not connect after timeout")
	ErrTrackPublishTimeout      = errors.New("timed out publishing track")
	ErrCannotDetermineMime      = errors.New("cannot determine mimetype from file extension")
	ErrUnsupportedFileType      = errors.New("ReaderSampleProvider does not support this mime type")
	ErrUnsupportedSimulcastKind = errors.New("simulcast is only supported for video")
	ErrInvalidSimulcastTrack    = errors.New("simulcast track was not initiated correctly")
	ErrCannotFindTrack          = errors.New("could not find the track")
	ErrInvalidParameter         = errors.New("invalid parameter")
	ErrCannotConnectSignal      = errors.New("could not establish signal connection")
	ErrCannotDialSignal         = errors.New("could not dial signal connection")
	ErrNoPeerConnection         = errors.New("peer connection not established")
	ErrAborted                  = errors.New("operation was aborted")
)

Functions

func DecryptGCMAudioSample added in v2.4.1 

func DecryptGCMAudioSample(sample, key, sifTrailer []byte) ([]byte, error)

Take audio sample (body of RTP) encrypted by LiveKit client SDK, extract IV and decrypt using provided key If sample matches sifTrailer, it's considered to be a non-encrypted Server Injected Frame and nil is returned Use DecryptGCMAudioSampleCustomCipher with cached aes cipher block for better (30%) performance

func DecryptGCMAudioSampleCustomCipher added in v2.4.1 

func DecryptGCMAudioSampleCustomCipher(sample, sifTrailer []byte, cipherBlock cipher.Block) ([]byte, error)

Take audio sample (body of RTP) encrypted by LiveKit client SDK, extract IV and decrypt using provided cipherBlock If sample matches sifTrailer, it's considered to be a non-encrypted Server Injected Frame and nil is returned Encrypted sample format based on livekit client sdk ---------+-------------------------+---------+---- payload |IV...(length = IV_LENGTH)|IV_LENGTH|KID| ---------+-------------------------+---------+---- First byte of audio frame is not encrypted and only authenticated payload - variable bytes IV - variable bytes (equal to IV_LENGTH bytes) IV_LENGTH - 1 byte KID (Key ID) - 1 byte - ignored here, key is provided as parameter to function

func DeriveKeyFromBytes added in v2.4.1 

func DeriveKeyFromBytes(secret []byte) ([]byte, error)

func DeriveKeyFromBytesCustomSalt added in v2.4.1 

func DeriveKeyFromBytesCustomSalt(secret []byte, salt string) ([]byte, error)

func DeriveKeyFromString added in v2.4.1 

func DeriveKeyFromString(password string) ([]byte, error)

func DeriveKeyFromStringCustomSalt added in v2.4.1 

func DeriveKeyFromStringCustomSalt(password, salt string) ([]byte, error)

func EncryptGCMAudioSample added in v2.4.1 

func EncryptGCMAudioSample(sample, key []byte, kid uint8) ([]byte, error)

Take audio sample (body of RTP) and encrypts it using AES-GCM 128bit with provided key Use EncryptGCMAudioSampleCustomCipher with cached aes cipher block for better (20%) performance

func EncryptGCMAudioSampleCustomCipher added in v2.4.1 

func EncryptGCMAudioSampleCustomCipher(sample []byte, kid uint8, cipherBlock cipher.Block) ([]byte, error)

Take audio sample (body of RTP) and encrypts it using AES-GCM 128bit with provided cipher block Encrypted sample format based on livekit client sdk ---------+-------------------------+---------+---- payload |IV...(length = IV_LENGTH)|IV_LENGTH|KID| ---------+-------------------------+---------+---- First byte of audio frame is not encrypted and only authenticated payload - variable bytes IV - variable bytes (equal to IV_LENGTH bytes) - 12 random bytes IV_LENGTH - 1 byte - 12 bytes fixed KID (Key ID) - 1 byte - taken from "kid" parameter

func FromProtoIceServers 

func FromProtoIceServers(iceservers []*livekit.ICEServer) []webrtc.ICEServer

func FromProtoSessionDescription 

func FromProtoSessionDescription(sd *livekit.SessionDescription) webrtc.SessionDescription

func FromProtoTrickle 

func FromProtoTrickle(trickle *livekit.TrickleRequest) webrtc.ICECandidateInit

func ReaderTrackWithFrameDuration 

func ReaderTrackWithFrameDuration(duration time.Duration) func(provider *ReaderSampleProvider)

func ReaderTrackWithMime 

func ReaderTrackWithMime(mime string) func(provider *ReaderSampleProvider)

func ReaderTrackWithOnWriteComplete 

func ReaderTrackWithOnWriteComplete(f func()) func(provider *ReaderSampleProvider)

func ReaderTrackWithRTCPHandler 

func ReaderTrackWithRTCPHandler(f func(rtcp.Packet)) func(provider *ReaderSampleProvider)

func ReaderTrackWithSampleOptions 

func ReaderTrackWithSampleOptions(opts ...LocalTrackOptions) func(provider *ReaderSampleProvider)

func SIPStatusFrom added in v2.5.0 

func SIPStatusFrom(err error) *livekit.SIPStatus

SIPStatusFrom unwraps an error and returns associated SIP call status, if any.

func SetLogger 

func SetLogger(l protoLogger.Logger)

SetLogger overrides default logger. To use a [logr](https://github.com/go-logr/logr) compatible logger, pass in SetLogger(logger.LogRLogger(logRLogger))

func ToHttpURL 

func ToHttpURL(url string) string

func ToProtoSessionDescription 

func ToProtoSessionDescription(sd webrtc.SessionDescription) *livekit.SessionDescription

func ToProtoTrickle 

func ToProtoTrickle(candidateInit webrtc.ICECandidateInit, target livekit.SignalTarget) *livekit.TrickleRequest

func ToWebsocketURL 

func ToWebsocketURL(url string) string

Types

type AgentClient added in v2.6.0 

type AgentClient struct {
	// contains filtered or unexported fields
}

func NewAgentClient added in v2.6.0 

func NewAgentClient(url string, apiKey string, apiSecret string, opts ...twirp.ClientOption) (*AgentClient, error)

func (*AgentClient) CreateAgent added in v2.6.0 

func (c *AgentClient) CreateAgent(ctx context.Context, req *livekit.CreateAgentRequest) (*livekit.CreateAgentResponse, error)

func (*AgentClient) DeleteAgent added in v2.6.0 

func (c *AgentClient) DeleteAgent(ctx context.Context, req *livekit.DeleteAgentRequest) (*livekit.DeleteAgentResponse, error)

func (*AgentClient) DeployAgent added in v2.6.0 

func (c *AgentClient) DeployAgent(ctx context.Context, req *livekit.DeployAgentRequest) (*livekit.DeployAgentResponse, error)

func (*AgentClient) GetClientSettings added in v2.6.0 

func (c *AgentClient) GetClientSettings(ctx context.Context, req *livekit.ClientSettingsRequest) (*livekit.ClientSettingsResponse, error)

func (*AgentClient) ListAgentSecrets added in v2.6.0 

func (c *AgentClient) ListAgentSecrets(ctx context.Context, req *livekit.ListAgentSecretsRequest) (*livekit.ListAgentSecretsResponse, error)

func (*AgentClient) ListAgentVersions added in v2.6.0 

func (c *AgentClient) ListAgentVersions(ctx context.Context, req *livekit.ListAgentVersionsRequest) (*livekit.ListAgentVersionsResponse, error)

func (*AgentClient) ListAgents added in v2.6.0 

func (c *AgentClient) ListAgents(ctx context.Context, req *livekit.ListAgentsRequest) (*livekit.ListAgentsResponse, error)

func (*AgentClient) RollbackAgent added in v2.6.0 

func (c *AgentClient) RollbackAgent(ctx context.Context, req *livekit.RollbackAgentRequest) (*livekit.RollbackAgentResponse, error)

func (*AgentClient) UpdateAgent added in v2.6.0 

func (c *AgentClient) UpdateAgent(ctx context.Context, req *livekit.UpdateAgentRequest) (*livekit.UpdateAgentResponse, error)

func (*AgentClient) UpdateAgentSecrets added in v2.6.0 

func (c *AgentClient) UpdateAgentSecrets(ctx context.Context, req *livekit.UpdateAgentSecretsRequest) (*livekit.UpdateAgentSecretsResponse, error)

type AgentDispatchClient added in v2.2.1 

type AgentDispatchClient struct {
	// contains filtered or unexported fields
}

func NewAgentDispatchServiceClient added in v2.2.1 

func NewAgentDispatchServiceClient(url string, apiKey string, secretKey string, opts ...twirp.ClientOption) *AgentDispatchClient

func (*AgentDispatchClient) CreateDispatch added in v2.2.1 

func (c *AgentDispatchClient) CreateDispatch(ctx context.Context, req *livekit.CreateAgentDispatchRequest) (*livekit.AgentDispatch, error)

func (*AgentDispatchClient) DeleteDispatch added in v2.2.1 

func (c *AgentDispatchClient) DeleteDispatch(ctx context.Context, req *livekit.DeleteAgentDispatchRequest) (*livekit.AgentDispatch, error)

func (*AgentDispatchClient) ListDispatch added in v2.2.1 

func (c *AgentDispatchClient) ListDispatch(ctx context.Context, req *livekit.ListAgentDispatchRequest) (*livekit.ListAgentDispatchResponse, error)

type AudioSampleProvider 

type AudioSampleProvider interface {
	SampleProvider
	CurrentAudioLevel() uint8
}

type BaseSampleProvider 

type BaseSampleProvider struct {
}

BaseSampleProvider provides empty implementations for OnBind and OnUnbind

func (*BaseSampleProvider) Close 

func (p *BaseSampleProvider) Close() error

func (*BaseSampleProvider) OnBind 

func (p *BaseSampleProvider) OnBind() error

func (*BaseSampleProvider) OnUnbind 

func (p *BaseSampleProvider) OnUnbind() error

type ByteStreamHandler added in v2.6.0 

type ByteStreamHandler func(reader *ByteStreamReader, participantIdentity string)

ByteStreamHandler is a function that will be called when a byte stream is received. It will be called with the stream reader and the participant identity that sent the stream.

type ByteStreamInfo added in v2.6.0 

type ByteStreamInfo struct {
	Name *string
	// contains filtered or unexported fields
}

Info for byte streams

  • Id is the id of the stream
  • MimeType is the mime type of the stream, determined for SendFile if not provided
  • Topic is the topic of the stream
  • Timestamp is the timestamp of sending the stream
  • Size is the total size of the stream, if provided
  • Attributes are any additional attributes of the stream
  • Name is the name of the file or stream, if provided

type ByteStreamReader added in v2.6.0 

type ByteStreamReader struct {
	Info ByteStreamInfo
	// contains filtered or unexported fields
}

func NewByteStreamReader added in v2.6.0 

func NewByteStreamReader(info ByteStreamInfo, totalChunkCount *uint64) *ByteStreamReader

func (ByteStreamReader) OnProgress added in v2.6.0 

func (r ByteStreamReader) OnProgress(onProgress *func(progress float64))

OnProgress sets the callback function that will be called when the stream is being read only called if TotalSize of the stream is set

func (ByteStreamReader) Read added in v2.6.0 

func (r ByteStreamReader) Read(bytes []byte) (int, error)

Read reads the next len(p) bytes from the stream or until the stream buffer is drained. The return value is the number of bytes read. If the buffer has no data to return, it will wait for a write to the stream or return io.EOF if the stream is closed.

func (*ByteStreamReader) ReadAll added in v2.6.0 

func (r *ByteStreamReader) ReadAll() []byte

ReadAll reads all the data from the stream and returns it as a byte slice. This will block until the stream is closed.

func (ByteStreamReader) ReadByte added in v2.6.0 

func (r ByteStreamReader) ReadByte() (byte, error)

ReadByte reads and returns the next byte from the buffer. If no byte is available, it will wait for a write to the stream or return io.EOF if the stream is closed.

func (ByteStreamReader) ReadBytes added in v2.6.0 

func (r ByteStreamReader) ReadBytes(delim byte) ([]byte, error)

ReadBytes reads until the first occurrence of delim in the input, returning a slice containing the data up to and including the delimiter. If ReadBytes encounters an error before finding a delimiter, it returns the data read before EOF, but does not return EOF until the stream is closed. ReadBytes returns err != nil if and only if the returned data does not end in delim.

type ByteStreamWriter added in v2.6.0 

type ByteStreamWriter struct {
	Info ByteStreamInfo
	// contains filtered or unexported fields
}

ByteStreamWriter is a writer type for byte streams

func (ByteStreamWriter) Close added in v2.6.0 

func (w ByteStreamWriter) Close()

Close the stream, this will send a stream trailer to notify the receiver that the stream is closed

func (ByteStreamWriter) Write added in v2.6.0 

func (w ByteStreamWriter) Write(data T, onDone *func())

Write data to the stream, data can be a byte slice or a string depending on the type of the stream writer onDone is a callback function that will be called when the data provided is written to the stream

type ConnectInfo 

type ConnectInfo struct {
	APIKey                string
	APISecret             string
	RoomName              string
	ParticipantName       string
	ParticipantIdentity   string
	ParticipantKind       ParticipantKind
	ParticipantMetadata   string
	ParticipantAttributes map[string]string
}

type ConnectOption 

type ConnectOption func(*SignalClientConnectParams)

func WithAutoSubscribe 

func WithAutoSubscribe(val bool) ConnectOption

func WithDisableRegionDiscovery added in v2.2.1 

func WithDisableRegionDiscovery() ConnectOption

func WithICETransportPolicy added in v2.1.1 

func WithICETransportPolicy(iceTransportPolicy webrtc.ICETransportPolicy) ConnectOption

func WithInterceptors added in v2.1.1 

func WithInterceptors(interceptors []interceptor.Factory) ConnectOption

func WithPacer 

func WithPacer(pacer pacer.Factory) ConnectOption

WithPacer enables the use of a pacer on this connection A pacer helps to smooth out video packet rate to avoid overwhelming downstream. Learn more at: https://chromium.googlesource.com/external/webrtc/+/master/modules/pacing/g3doc/index.md

func WithRetransmitBufferSize 

func WithRetransmitBufferSize(val uint16) ConnectOption

Retransmit buffer size to reponse to nack request, must be one of: 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768

type ConnectionState added in v2.2.0 

type ConnectionState string
const (
	ConnectionStateConnected    ConnectionState = "connected"
	ConnectionStateReconnecting ConnectionState = "reconnecting"
	ConnectionStateDisconnected ConnectionState = "disconnected"
)

type DataPacket added in v2.0.5 

type DataPacket interface {
	ToProto() *livekit.DataPacket
}

type DataPublishOption 

type DataPublishOption func(*dataPublishOptions)

func WithDataPublishDestination 

func WithDataPublishDestination(identities []string) DataPublishOption

func WithDataPublishReliable 

func WithDataPublishReliable(reliable bool) DataPublishOption

func WithDataPublishTopic 

func WithDataPublishTopic(topic string) DataPublishOption

type DataReceiveParams 

type DataReceiveParams struct {
	Sender         *RemoteParticipant
	SenderIdentity string
	Topic          string // Deprecated: Use UserDataPacket.Topic
}

type DisconnectionReason added in v2.1.0 

type DisconnectionReason string
const (
	LeaveRequested     DisconnectionReason = "leave requested by user"
	UserUnavailable    DisconnectionReason = "remote user unavailable"
	RejectedByUser     DisconnectionReason = "rejected by remote user"
	Failed             DisconnectionReason = "connection to room failed"
	RoomClosed         DisconnectionReason = "room closed"
	ParticipantRemoved DisconnectionReason = "removed by server"
	DuplicateIdentity  DisconnectionReason = "duplicate identity"
	OtherReason        DisconnectionReason = "other reasons"
)

func GetDisconnectionReason added in v2.3.0 

func GetDisconnectionReason(reason livekit.DisconnectReason) DisconnectionReason

type EgressClient 

type EgressClient struct {
	// contains filtered or unexported fields
}

func NewEgressClient 

func NewEgressClient(url string, apiKey string, secretKey string, opts ...twirp.ClientOption) *EgressClient

func (*EgressClient) ListEgress 

func (c *EgressClient) ListEgress(ctx context.Context, req *livekit.ListEgressRequest) (*livekit.ListEgressResponse, error)

func (*EgressClient) StartParticipantEgress 

func (c *EgressClient) StartParticipantEgress(ctx context.Context, req *livekit.ParticipantEgressRequest) (*livekit.EgressInfo, error)

func (*EgressClient) StartRoomCompositeEgress 

func (c *EgressClient) StartRoomCompositeEgress(ctx context.Context, req *livekit.RoomCompositeEgressRequest) (*livekit.EgressInfo, error)

func (*EgressClient) StartTrackCompositeEgress 

func (c *EgressClient) StartTrackCompositeEgress(ctx context.Context, req *livekit.TrackCompositeEgressRequest) (*livekit.EgressInfo, error)

func (*EgressClient) StartTrackEgress 

func (c *EgressClient) StartTrackEgress(ctx context.Context, req *livekit.TrackEgressRequest) (*livekit.EgressInfo, error)

func (*EgressClient) StartWebEgress 

func (c *EgressClient) StartWebEgress(ctx context.Context, req *livekit.WebEgressRequest) (*livekit.EgressInfo, error)

func (*EgressClient) StopEgress 

func (c *EgressClient) StopEgress(ctx context.Context, req *livekit.StopEgressRequest) (*livekit.EgressInfo, error)

func (*EgressClient) UpdateLayout 

func (c *EgressClient) UpdateLayout(ctx context.Context, req *livekit.UpdateLayoutRequest) (*livekit.EgressInfo, error)

func (*EgressClient) UpdateStream 

func (c *EgressClient) UpdateStream(ctx context.Context, req *livekit.UpdateStreamRequest) (*livekit.EgressInfo, error)

type IngressClient 

type IngressClient struct {
	// contains filtered or unexported fields
}

func NewIngressClient 

func NewIngressClient(url string, apiKey string, secretKey string, opts ...twirp.ClientOption) *IngressClient

func (*IngressClient) CreateIngress 

func (c *IngressClient) CreateIngress(ctx context.Context, in *livekit.CreateIngressRequest) (*livekit.IngressInfo, error)

func (*IngressClient) DeleteIngress 

func (c *IngressClient) DeleteIngress(ctx context.Context, in *livekit.DeleteIngressRequest) (*livekit.IngressInfo, error)

func (*IngressClient) ListIngress 

func (c *IngressClient) ListIngress(ctx context.Context, in *livekit.ListIngressRequest) (*livekit.ListIngressResponse, error)

func (*IngressClient) UpdateIngress 

func (c *IngressClient) UpdateIngress(ctx context.Context, in *livekit.UpdateIngressRequest) (*livekit.IngressInfo, error)

type LocalParticipant 

type LocalParticipant struct {
	// contains filtered or unexported fields
}

func (*LocalParticipant) Attributes added in v2.2.1 

func (p *LocalParticipant) Attributes() map[string]string

func (*LocalParticipant) AudioLevel 

func (p *LocalParticipant) AudioLevel() float32

func (*LocalParticipant) GetPublisherPeerConnection 

func (p *LocalParticipant) GetPublisherPeerConnection() *webrtc.PeerConnection

GetPublisherPeerConnection is a power-user API that gives access to the underlying publisher peer connection local tracks are published to server via this PeerConnection

func (*LocalParticipant) GetSubscriberPeerConnection 

func (p *LocalParticipant) GetSubscriberPeerConnection() *webrtc.PeerConnection

GetSubscriberPeerConnection is a power-user API that gives access to the underlying subscriber peer connection subscribed tracks are received using this PeerConnection

func (*LocalParticipant) GetTrackPublication 

func (p *LocalParticipant) GetTrackPublication(source livekit.TrackSource) TrackPublication

func (*LocalParticipant) Identity 

func (p *LocalParticipant) Identity() string

func (*LocalParticipant) IsCameraEnabled 

func (p *LocalParticipant) IsCameraEnabled() bool

func (*LocalParticipant) IsMicrophoneEnabled 

func (p *LocalParticipant) IsMicrophoneEnabled() bool

func (*LocalParticipant) IsScreenShareAudioEnabled 

func (p *LocalParticipant) IsScreenShareAudioEnabled() bool

func (*LocalParticipant) IsScreenShareEnabled 

func (p *LocalParticipant) IsScreenShareEnabled() bool

func (*LocalParticipant) IsSpeaking 

func (p *LocalParticipant) IsSpeaking() bool

func (*LocalParticipant) Kind 

func (p *LocalParticipant) Kind() ParticipantKind

func (*LocalParticipant) Metadata 

func (p *LocalParticipant) Metadata() string

func (*LocalParticipant) Name 

func (p *LocalParticipant) Name() string

func (*LocalParticipant) PerformRpc added in v2.6.0 

func (p *LocalParticipant) PerformRpc(params PerformRpcParams) (*string, error)

Initiate an RPC call to a remote participant

  • @param params - For parameters for initiating the RPC call, see PerformRpcParams
  • @returns A string payload or an error

func (*LocalParticipant) Permissions 

func (p *LocalParticipant) Permissions() *livekit.ParticipantPermission

func (*LocalParticipant) PublishData deprecated 

func (p *LocalParticipant) PublishData(payload []byte, opts ...DataPublishOption) error

PublishData sends custom user data via WebRTC data channel.

By default, the message can be received by all participants in a room, see WithDataPublishDestination for choosing specific participants.

Messages are sent via a LOSSY channel by default, see WithDataPublishReliable for sending reliable data.

Deprecated: Use PublishDataPacket with UserData instead.

func (*LocalParticipant) PublishDataPacket added in v2.0.5 

func (p *LocalParticipant) PublishDataPacket(pck DataPacket, opts ...DataPublishOption) error

PublishDataPacket sends a packet via a WebRTC data channel. UserData can be used for sending custom user data.

By default, the message can be received by all participants in a room, see WithDataPublishDestination for choosing specific participants.

Messages are sent via UDP and offer no delivery guarantees, see WithDataPublishReliable for sending data reliably (with retries).

func (*LocalParticipant) PublishSimulcastTrack 

func (p *LocalParticipant) PublishSimulcastTrack(tracks []*LocalTrack, opts *TrackPublicationOptions) (*LocalTrackPublication, error)

PublishSimulcastTrack publishes up to three layers to the server

func (*LocalParticipant) PublishTrack 

func (p *LocalParticipant) PublishTrack(track webrtc.TrackLocal, opts *TrackPublicationOptions) (*LocalTrackPublication, error)

func (*LocalParticipant) SID 

func (p *LocalParticipant) SID() string

func (*LocalParticipant) SendFile added in v2.6.0 

func (p *LocalParticipant) SendFile(filePath string, options StreamBytesOptions) (*ByteStreamInfo, error)

SendFile sends a file to the remote participant as a byte stream with the provided options. It will return a ByteStreamInfo that can be used to get metadata about the stream. Error is returned if the file cannot be read.

func (*LocalParticipant) SendText added in v2.6.0 

func (p *LocalParticipant) SendText(text string, options StreamTextOptions) *TextStreamInfo

SendText creates a new text stream writer with the provided options. It will return a TextStreamInfo that can be used to get metadata about the stream.

func (*LocalParticipant) SetAttributes added in v2.2.1 

func (p *LocalParticipant) SetAttributes(attrs map[string]string)

SetAttributes sets the KV attributes of the current participant. To remove an attribute, set it to empty value. Updates will be performed only if the participant has canUpdateOwnMetadata grant.

func (*LocalParticipant) SetMetadata 

func (p *LocalParticipant) SetMetadata(metadata string)

SetMetadata sets the metadata of the current participant. Updates will be performed only if the participant has canUpdateOwnMetadata grant.

func (*LocalParticipant) SetName 

func (p *LocalParticipant) SetName(name string)

SetName sets the name of the current participant. updates will be performed only if the participant has canUpdateOwnMetadata grant

func (*LocalParticipant) SetSubscriptionPermission added in v2.3.0 

func (p *LocalParticipant) SetSubscriptionPermission(sp *livekit.SubscriptionPermission)

Control who can subscribe to LocalParticipant's published tracks.

By default, all participants can subscribe. This allows fine-grained control over who is able to subscribe at a participant and track level.

Note: if access is given at a track-level (i.e. both `AllParticipants` and `TrackPermission.AllTracks` are false), any newer published tracks will not grant permissions to any participants and will require a subsequent permissions update to allow subscription.

func (*LocalParticipant) StreamBytes added in v2.6.0 

func (p *LocalParticipant) StreamBytes(options StreamBytesOptions) *ByteStreamWriter

StreamBytes creates a new byte stream writer with the provided options.

func (*LocalParticipant) StreamText added in v2.6.0 

func (p *LocalParticipant) StreamText(options StreamTextOptions) *TextStreamWriter

StreamText creates a new text stream writer with the provided options.

func (*LocalParticipant) TrackPublications 

func (p *LocalParticipant) TrackPublications() []TrackPublication

func (*LocalParticipant) UnpublishTrack 

func (p *LocalParticipant) UnpublishTrack(sid string) error

type LocalSampleTrack 

type LocalSampleTrack = LocalTrack

type LocalSampleTrackOptions 

type LocalSampleTrackOptions = LocalTrackOptions

type LocalTrack 

type LocalTrack struct {
	// contains filtered or unexported fields
}

LocalTrack is a local track that simplifies writing samples. It handles timing and publishing of things, so as long as a SampleProvider is provided, the class takes care of publishing tracks at the right frequency This extends webrtc.TrackLocalStaticSample, and adds the ability to write RTP extensions

func NewLocalFileTrack 

func NewLocalFileTrack(file string, options ...ReaderSampleProviderOption) (*LocalTrack, error)

NewLocalFileTrack creates an *os.File reader for NewLocalReaderTrack

func NewLocalReaderTrack 

func NewLocalReaderTrack(in io.ReadCloser, mime string, options ...ReaderSampleProviderOption) (*LocalTrack, error)

NewLocalReaderTrack uses io.ReadCloser interface to adapt to various ingress types - mime: has to be one of webrtc.MimeType... (e.g. webrtc.MimeTypeOpus)

func NewLocalSampleTrack 

func NewLocalSampleTrack(c webrtc.RTPCodecCapability, opts ...LocalTrackOptions) (*LocalTrack, error)

func NewLocalTrack 

func NewLocalTrack(c webrtc.RTPCodecCapability, opts ...LocalTrackOptions) (*LocalTrack, error)

func (*LocalTrack) Bind 

func (s *LocalTrack) Bind(t webrtc.TrackLocalContext) (webrtc.RTPCodecParameters, error)

Bind is an interface for TrackLocal, not for external consumption

func (*LocalTrack) Close 

func (s *LocalTrack) Close() error

func (*LocalTrack) Codec 

func (s *LocalTrack) Codec() webrtc.RTPCodecCapability

Codec gets the Codec of the track

func (*LocalTrack) ID 

func (s *LocalTrack) ID() string

ID is the unique identifier for this Track. This should be unique for the stream, but doesn't have to globally unique. A common example would be 'audio' or 'video' and StreamID would be 'desktop' or 'webcam'

func (*LocalTrack) IsBound 

func (s *LocalTrack) IsBound() bool

func (*LocalTrack) Kind 

func (s *LocalTrack) Kind() webrtc.RTPCodecType

Kind controls if this TrackLocal is audio or video

func (*LocalTrack) OnBind 

func (s *LocalTrack) OnBind(f func())

OnBind sets a callback to be called when the track has been negotiated for publishing and bound to a peer connection

func (*LocalTrack) OnUnbind 

func (s *LocalTrack) OnUnbind(f func())

OnUnbind sets a callback to be called after the track is removed from a peer connection

func (*LocalTrack) RID 

func (s *LocalTrack) RID() string

RID is the RTP stream identifier.

func (*LocalTrack) SSRC added in v2.1.1 

func (s *LocalTrack) SSRC() webrtc.SSRC

func (*LocalTrack) SetLogger added in v2.2.1 

func (s *LocalTrack) SetLogger(l protoLogger.Logger)

SetLogger overrides default logger.

func (*LocalTrack) SetTransceiver 

func (s *LocalTrack) SetTransceiver(transceiver *webrtc.RTPTransceiver)

func (*LocalTrack) StartWrite 

func (s *LocalTrack) StartWrite(provider SampleProvider, onComplete func()) error

func (*LocalTrack) StreamID 

func (s *LocalTrack) StreamID() string

StreamID is the group this track belongs too. This must be unique

func (*LocalTrack) Unbind 

func (s *LocalTrack) Unbind(t webrtc.TrackLocalContext) error

Unbind is an interface for TrackLocal, not for external consumption

func (*LocalTrack) WriteRTP 

func (s *LocalTrack) WriteRTP(p *rtp.Packet, opts *SampleWriteOptions) error

func (*LocalTrack) WriteSample 

func (s *LocalTrack) WriteSample(sample media.Sample, opts *SampleWriteOptions) error

type LocalTrackOptions 

type LocalTrackOptions func(s *LocalTrack)

func WithRTCPHandler 

func WithRTCPHandler(cb func(rtcp.Packet)) LocalTrackOptions

func WithSimulcast 

func WithSimulcast(simulcastID string, layer *livekit.VideoLayer) LocalTrackOptions

WithSimulcast marks the current track for simulcasting. In order to use simulcast, simulcastID must be identical across all layers

type LocalTrackPublication 

type LocalTrackPublication struct {
	// contains filtered or unexported fields
}

func NewLocalTrackPublication 

func NewLocalTrackPublication(kind TrackKind, track Track, opts TrackPublicationOptions, client *SignalClient) *LocalTrackPublication

func (*LocalTrackPublication) CloseTrack 

func (p *LocalTrackPublication) CloseTrack()

func (*LocalTrackPublication) GetSimulcastTrack 

func (p *LocalTrackPublication) GetSimulcastTrack(quality livekit.VideoQuality) *LocalTrack

func (*LocalTrackPublication) IsMuted 

func (p *LocalTrackPublication) IsMuted() bool

func (*LocalTrackPublication) IsSubscribed 

func (p *LocalTrackPublication) IsSubscribed() bool

func (*LocalTrackPublication) Kind 

func (p *LocalTrackPublication) Kind() TrackKind

func (*LocalTrackPublication) MimeType 

func (p *LocalTrackPublication) MimeType() string

func (*LocalTrackPublication) Name 

func (p *LocalTrackPublication) Name() string

func (*LocalTrackPublication) PublicationOptions 

func (p *LocalTrackPublication) PublicationOptions() TrackPublicationOptions

func (*LocalTrackPublication) SID 

func (p *LocalTrackPublication) SID() string

func (*LocalTrackPublication) SetMuted 

func (p *LocalTrackPublication) SetMuted(muted bool)

func (*LocalTrackPublication) SimulateDisconnection added in v2.2.1 

func (p *LocalTrackPublication) SimulateDisconnection(duration time.Duration)

func (*LocalTrackPublication) Source 

func (p *LocalTrackPublication) Source() livekit.TrackSource

func (*LocalTrackPublication) Track 

func (p *LocalTrackPublication) Track() Track

func (*LocalTrackPublication) TrackInfo 

func (p *LocalTrackPublication) TrackInfo() *livekit.TrackInfo

func (*LocalTrackPublication) TrackLocal 

func (p *LocalTrackPublication) TrackLocal() webrtc.TrackLocal

type LocalTrackWithClose 

type LocalTrackWithClose interface {
	webrtc.TrackLocal
	Close() error
}

type MuteFunc added in v2.9.1 

type MuteFunc func(muted bool) error

type NullSampleProvider 

type NullSampleProvider struct {
	BaseSampleProvider
	BytesPerSample uint32
	SampleDuration time.Duration
}

NullSampleProvider is a media provider that provides null packets, it could meet a certain bitrate, if desired

func NewNullSampleProvider 

func NewNullSampleProvider(bitrate uint32) *NullSampleProvider

func (*NullSampleProvider) NextSample 

func (p *NullSampleProvider) NextSample(ctx context.Context) (media.Sample, error)

type PCTransport 

type PCTransport struct {
	OnOffer func(description webrtc.SessionDescription)
	// contains filtered or unexported fields
}

PCTransport is a wrapper around PeerConnection, with some helper methods

func NewPCTransport 

func NewPCTransport(params PCTransportParams) (*PCTransport, error)

func (*PCTransport) AddICECandidate 

func (t *PCTransport) AddICECandidate(candidate webrtc.ICECandidateInit) error

func (*PCTransport) Close 

func (t *PCTransport) Close() error

func (*PCTransport) GetSelectedCandidatePair 

func (t *PCTransport) GetSelectedCandidatePair() (*webrtc.ICECandidatePair, error)

func (*PCTransport) IsConnected 

func (t *PCTransport) IsConnected() bool

func (*PCTransport) Negotiate 

func (t *PCTransport) Negotiate()

func (*PCTransport) OnRemoteDescriptionSettled 

func (t *PCTransport) OnRemoteDescriptionSettled(f func() error)

func (*PCTransport) PeerConnection 

func (t *PCTransport) PeerConnection() *webrtc.PeerConnection

func (*PCTransport) SetConfiguration added in v2.2.1 

func (t *PCTransport) SetConfiguration(config webrtc.Configuration) error

func (*PCTransport) SetLogger added in v2.2.1 

func (t *PCTransport) SetLogger(l protoLogger.Logger)

SetLogger overrides default logger.

func (*PCTransport) SetRTT 

func (t *PCTransport) SetRTT(rtt uint32)

func (*PCTransport) SetRemoteDescription 

func (t *PCTransport) SetRemoteDescription(sd webrtc.SessionDescription) error

type PCTransportParams 

type PCTransportParams struct {
	Configuration webrtc.Configuration

	RetransmitBufferSize uint16
	Pacer                pacer.Factory
	Interceptors         []interceptor.Factory
	OnRTTUpdate          func(rtt uint32)
	IsSender             bool
}

type PLIWriter 

type PLIWriter func(webrtc.SSRC)

type Participant 

type Participant interface {
	SID() string
	Identity() string
	Name() string
	Kind() ParticipantKind
	IsSpeaking() bool
	AudioLevel() float32
	TrackPublications() []TrackPublication
	IsCameraEnabled() bool
	IsMicrophoneEnabled() bool
	IsScreenShareEnabled() bool
	IsScreenShareAudioEnabled() bool
	Metadata() string
	Attributes() map[string]string
	GetTrackPublication(source livekit.TrackSource) TrackPublication
	Permissions() *livekit.ParticipantPermission
	// contains filtered or unexported methods
}

type ParticipantAttributesChangedFunc added in v2.2.1 

type ParticipantAttributesChangedFunc func(changed map[string]string, p Participant)

ParticipantAttributesChangedFunc is callback for Participant attribute change event. The function is called with an already updated participant state and the map of changes attributes. Deleted attributes will have empty string value in the changed map.

type ParticipantCallback 

type ParticipantCallback struct {
	// for local participant
	OnLocalTrackPublished   func(publication *LocalTrackPublication, lp *LocalParticipant)
	OnLocalTrackUnpublished func(publication *LocalTrackPublication, lp *LocalParticipant)

	// for all participants
	OnTrackMuted               func(pub TrackPublication, p Participant)
	OnTrackUnmuted             func(pub TrackPublication, p Participant)
	OnMetadataChanged          func(oldMetadata string, p Participant)
	OnAttributesChanged        ParticipantAttributesChangedFunc
	OnIsSpeakingChanged        func(p Participant)
	OnConnectionQualityChanged func(update *livekit.ConnectionQualityInfo, p Participant)

	// for remote participants
	OnTrackSubscribed         func(track *webrtc.TrackRemote, publication *RemoteTrackPublication, rp *RemoteParticipant)
	OnTrackUnsubscribed       func(track *webrtc.TrackRemote, publication *RemoteTrackPublication, rp *RemoteParticipant)
	OnTrackSubscriptionFailed func(sid string, rp *RemoteParticipant)
	OnTrackPublished          func(publication *RemoteTrackPublication, rp *RemoteParticipant)
	OnTrackUnpublished        func(publication *RemoteTrackPublication, rp *RemoteParticipant)
	OnDataReceived            func(data []byte, params DataReceiveParams) // Deprecated: Use OnDataPacket instead
	OnDataPacket              func(data DataPacket, params DataReceiveParams)
	OnTranscriptionReceived   func(transcriptionSegments []*TranscriptionSegment, p Participant, publication TrackPublication)
}

func NewParticipantCallback 

func NewParticipantCallback() *ParticipantCallback

func (*ParticipantCallback) Merge 

func (cb *ParticipantCallback) Merge(other *ParticipantCallback)

type ParticipantKind 

type ParticipantKind int

type PerformRpcParams added in v2.6.0 

type PerformRpcParams struct {
	// The identity of the destination participant
	DestinationIdentity string
	// The name of the method to call
	Method string
	// The method payload
	Payload string
	// Timeout for receiving a response after initial connection. Default: 10000ms
	ResponseTimeout *time.Duration
}

Parameters for initiating an RPC call

type Private added in v2.9.1 

type Private[T any] struct {
	// contains filtered or unexported fields
}

func MakePrivate added in v2.9.1 

func MakePrivate[T any](v T) Private[T]

type PubCallback 

type PubCallback func(pub TrackPublication, participant *RemoteParticipant)

type RTCEngine 

type RTCEngine struct {
	JoinTimeout time.Duration

	// callbacks
	OnLocalTrackUnpublished func(response *livekit.TrackUnpublishedResponse)
	OnTrackRemoteMuted      func(request *livekit.MuteTrackRequest)
	OnDisconnected          func(reason DisconnectionReason)
	OnMediaTrack            func(track *webrtc.TrackRemote, receiver *webrtc.RTPReceiver)
	OnParticipantUpdate     func([]*livekit.ParticipantInfo)
	OnSpeakersChanged       func([]*livekit.SpeakerInfo)
	OnDataReceived          func(userPacket *livekit.UserPacket) // Deprecated: Use OnDataPacket instead
	OnDataPacket            func(identity string, dataPacket DataPacket)
	OnConnectionQuality     func([]*livekit.ConnectionQualityInfo)
	OnRoomUpdate            func(room *livekit.Room)
	OnRoomMoved             func(moved *livekit.RoomMovedResponse)
	OnRestarting            func()
	OnRestarted             func(*livekit.JoinResponse)
	OnResuming              func()
	OnResumed               func()
	OnTranscription         func(*livekit.Transcription)
	OnSignalClientConnected func(*livekit.JoinResponse)
	OnRpcRequest            func(callerIdentity, requestId, method, payload string, responseTimeout time.Duration, version uint32)
	OnRpcAck                func(requestId string)
	OnRpcResponse           func(requestId string, payload *string, error *RpcError)
	OnStreamHeader          func(*livekit.DataStream_Header, string)
	OnStreamChunk           func(*livekit.DataStream_Chunk)
	OnStreamTrailer         func(*livekit.DataStream_Trailer)
	OnLocalTrackSubscribed  func(trackSubscribed *livekit.TrackSubscribed)

	// callbacks to get data
	CbGetLocalParticipantSID func() string
	// contains filtered or unexported fields
}

func NewRTCEngine 

func NewRTCEngine() *RTCEngine

func (*RTCEngine) Close 

func (e *RTCEngine) Close()

func (*RTCEngine) GetDataChannel 

func (e *RTCEngine) GetDataChannel(kind livekit.DataPacket_Kind) *webrtc.DataChannel

func (*RTCEngine) GetDataChannelSub 

func (e *RTCEngine) GetDataChannelSub(kind livekit.DataPacket_Kind) *webrtc.DataChannel

func (*RTCEngine) IsConnected 

func (e *RTCEngine) IsConnected() bool

func (*RTCEngine) Join 

func (e *RTCEngine) Join(url string, token string, params *SignalClientConnectParams) (*livekit.JoinResponse, error)

Deprecated, use JoinContext.

func (*RTCEngine) JoinContext added in v2.4.2 

func (e *RTCEngine) JoinContext(ctx context.Context, url string, token string, params *SignalClientConnectParams) (*livekit.JoinResponse, error)

func (*RTCEngine) OnClose added in v2.6.0 

func (e *RTCEngine) OnClose(onClose func())

func (*RTCEngine) Publisher added in v2.0.4 

func (e *RTCEngine) Publisher() (*PCTransport, bool)

func (*RTCEngine) RegisterTrackPublishedListener added in v2.3.1 

func (e *RTCEngine) RegisterTrackPublishedListener(cid string, c chan *livekit.TrackPublishedResponse)

func (*RTCEngine) SetLogger added in v2.2.1 

func (e *RTCEngine) SetLogger(l protoLogger.Logger)

SetLogger overrides default logger.

func (*RTCEngine) Subscriber added in v2.0.4 

func (e *RTCEngine) Subscriber() (*PCTransport, bool)

func (*RTCEngine) UnregisterTrackPublishedListener added in v2.3.1 

func (e *RTCEngine) UnregisterTrackPublishedListener(cid string)

type ReaderSampleProvider 

type ReaderSampleProvider struct {
	// Configuration
	Mime            string
	FrameDuration   time.Duration
	OnWriteComplete func()
	AudioLevel      uint8
	// contains filtered or unexported fields
}

ReaderSampleProvider provides samples by reading from an io.ReadCloser implementation

func (*ReaderSampleProvider) Close 

func (p *ReaderSampleProvider) Close() error

func (*ReaderSampleProvider) CurrentAudioLevel 

func (p *ReaderSampleProvider) CurrentAudioLevel() uint8

func (*ReaderSampleProvider) NextSample 

func (p *ReaderSampleProvider) NextSample(ctx context.Context) (media.Sample, error)

func (*ReaderSampleProvider) OnBind 

func (p *ReaderSampleProvider) OnBind() error

func (*ReaderSampleProvider) OnUnbind 

func (p *ReaderSampleProvider) OnUnbind() error

type ReaderSampleProviderOption 

type ReaderSampleProviderOption func(*ReaderSampleProvider)

type RemoteParticipant 

type RemoteParticipant struct {
	// contains filtered or unexported fields
}

func (*RemoteParticipant) Attributes added in v2.2.1 

func (p *RemoteParticipant) Attributes() map[string]string

func (*RemoteParticipant) AudioLevel 

func (p *RemoteParticipant) AudioLevel() float32

func (*RemoteParticipant) GetTrackPublication 

func (p *RemoteParticipant) GetTrackPublication(source livekit.TrackSource) TrackPublication

func (*RemoteParticipant) Identity 

func (p *RemoteParticipant) Identity() string

func (*RemoteParticipant) IsCameraEnabled 

func (p *RemoteParticipant) IsCameraEnabled() bool

func (*RemoteParticipant) IsMicrophoneEnabled 

func (p *RemoteParticipant) IsMicrophoneEnabled() bool

func (*RemoteParticipant) IsScreenShareAudioEnabled 

func (p *RemoteParticipant) IsScreenShareAudioEnabled() bool

func (*RemoteParticipant) IsScreenShareEnabled 

func (p *RemoteParticipant) IsScreenShareEnabled() bool

func (*RemoteParticipant) IsSpeaking 

func (p *RemoteParticipant) IsSpeaking() bool

func (*RemoteParticipant) Kind 

func (p *RemoteParticipant) Kind() ParticipantKind

func (*RemoteParticipant) Metadata 

func (p *RemoteParticipant) Metadata() string

func (*RemoteParticipant) Name 

func (p *RemoteParticipant) Name() string

func (*RemoteParticipant) Permissions 

func (p *RemoteParticipant) Permissions() *livekit.ParticipantPermission

func (*RemoteParticipant) SID 

func (p *RemoteParticipant) SID() string

func (*RemoteParticipant) TrackPublications 

func (p *RemoteParticipant) TrackPublications() []TrackPublication

func (*RemoteParticipant) WritePLI 

func (p *RemoteParticipant) WritePLI(ssrc webrtc.SSRC)

type RemoteTrackPublication 

type RemoteTrackPublication struct {
	// contains filtered or unexported fields
}

func (*RemoteTrackPublication) IsEnabled 

func (p *RemoteTrackPublication) IsEnabled() bool

func (*RemoteTrackPublication) IsMuted 

func (p *RemoteTrackPublication) IsMuted() bool

func (*RemoteTrackPublication) IsSubscribed 

func (p *RemoteTrackPublication) IsSubscribed() bool

func (*RemoteTrackPublication) Kind 

func (p *RemoteTrackPublication) Kind() TrackKind

func (*RemoteTrackPublication) MimeType 

func (p *RemoteTrackPublication) MimeType() string

func (*RemoteTrackPublication) Name 

func (p *RemoteTrackPublication) Name() string

func (*RemoteTrackPublication) OnRTCP 

func (p *RemoteTrackPublication) OnRTCP(cb func(rtcp.Packet))

func (*RemoteTrackPublication) Receiver 

func (p *RemoteTrackPublication) Receiver() *webrtc.RTPReceiver

func (*RemoteTrackPublication) SID 

func (p *RemoteTrackPublication) SID() string

func (*RemoteTrackPublication) SetEnabled 

func (p *RemoteTrackPublication) SetEnabled(enabled bool)

func (*RemoteTrackPublication) SetSubscribed 

func (p *RemoteTrackPublication) SetSubscribed(subscribed bool) error

func (*RemoteTrackPublication) SetVideoDimensions 

func (p *RemoteTrackPublication) SetVideoDimensions(width uint32, height uint32)

func (*RemoteTrackPublication) SetVideoQuality 

func (p *RemoteTrackPublication) SetVideoQuality(quality livekit.VideoQuality) error

func (*RemoteTrackPublication) Source 

func (p *RemoteTrackPublication) Source() livekit.TrackSource

func (*RemoteTrackPublication) Track 

func (p *RemoteTrackPublication) Track() Track

func (*RemoteTrackPublication) TrackInfo 

func (p *RemoteTrackPublication) TrackInfo() *livekit.TrackInfo

func (*RemoteTrackPublication) TrackRemote 

func (p *RemoteTrackPublication) TrackRemote() *webrtc.TrackRemote

type Room 

type Room struct {
	LocalParticipant *LocalParticipant
	// contains filtered or unexported fields
}

func ConnectToRoom 

func ConnectToRoom(url string, info ConnectInfo, callback *RoomCallback, opts ...ConnectOption) (*Room, error)

ConnectToRoom creates and joins the room

func ConnectToRoomWithToken 

func ConnectToRoomWithToken(url, token string, callback *RoomCallback, opts ...ConnectOption) (*Room, error)

ConnectToRoomWithToken creates and joins the room

func NewRoom 

func NewRoom(callback *RoomCallback) *Room

NewRoom can be used to update callbacks before calling Join

func (*Room) ActiveSpeakers 

func (r *Room) ActiveSpeakers() []Participant

func (*Room) ConnectionState added in v2.2.0 

func (r *Room) ConnectionState() ConnectionState

func (*Room) Disconnect 

func (r *Room) Disconnect()

func (*Room) DisconnectWithReason added in v2.3.0 

func (r *Room) DisconnectWithReason(reason livekit.DisconnectReason)

func (*Room) GetParticipantByIdentity 

func (r *Room) GetParticipantByIdentity(identity string) *RemoteParticipant

func (*Room) GetParticipantBySID 

func (r *Room) GetParticipantBySID(sid string) *RemoteParticipant

func (*Room) GetRemoteParticipants 

func (r *Room) GetRemoteParticipants() []*RemoteParticipant

func (*Room) Join 

func (r *Room) Join(url string, info ConnectInfo, opts ...ConnectOption) error

Join - joins the room as with default permissions

func (*Room) JoinWithToken 

func (r *Room) JoinWithToken(url, token string, opts ...ConnectOption) error

JoinWithToken - customize participant options by generating your own token

func (*Room) Metadata 

func (r *Room) Metadata() string

func (*Room) Name 

func (r *Room) Name() string

func (*Room) PrepareConnection added in v2.2.1 

func (r *Room) PrepareConnection(url, token string) error

PrepareConnection - with LiveKit Cloud, determine the best edge data center for the current client to connect to

func (*Room) RegisterByteStreamHandler added in v2.6.0 

func (r *Room) RegisterByteStreamHandler(topic string, handler ByteStreamHandler) error

Registers a handler for a byte stream. It will be called when a byte stream is received for the given topic. The handler will be called with the stream reader and the participant identity that sent the stream.

func (*Room) RegisterRpcMethod added in v2.6.0 

func (r *Room) RegisterRpcMethod(method string, handler RpcHandlerFunc) error

Establishes the participant as a receiver for calls of the specified RPC method. Will overwrite any existing callback for the same method.

  • @param method - The name of the indicated RPC method
  • @param handler - Will be invoked when an RPC request for this method is received
  • @returns A promise that resolves when the method is successfully registered

Example: 

room.LocalParticipant?.registerRpcMethod(
	"greet",
	func (data: RpcInvocationData) => {
		fmt.Println("Received greeting from ", data.callerIdentity, "with payload ", data.payload)
		return "Hello, " + data.callerIdentity + "!";
	}
);

The handler should return either a string or an error. If unable to respond within `responseTimeout`, the request will result in an error on the caller's side.

You may throw errors of type `RpcError` with a string `message` in the handler, and they will be received on the caller's side with the message intact. Other errors thrown in your handler will not be transmitted as-is, and will instead arrive to the caller as `1500` ("Application Error").

func (*Room) RegisterTextStreamHandler added in v2.6.0 

func (r *Room) RegisterTextStreamHandler(topic string, handler TextStreamHandler) error

Registers a handler for a text stream. It will be called when a text stream is received for the given topic. The handler will be called with the stream reader and the participant identity that sent the stream.

func (*Room) SID 

func (r *Room) SID() string

func (*Room) ServerInfo 

func (r *Room) ServerInfo() *livekit.ServerInfo

func (*Room) SetLogger added in v2.2.1 

func (r *Room) SetLogger(l protoLogger.Logger)

SetLogger overrides default logger.

func (*Room) SifTrailer added in v2.4.1 

func (r *Room) SifTrailer() []byte

func (*Room) Simulate 

func (r *Room) Simulate(scenario SimulateScenario)

func (*Room) UnregisterByteStreamHandler added in v2.6.0 

func (r *Room) UnregisterByteStreamHandler(topic string)

Unregisters a handler for a byte stream.

func (*Room) UnregisterRpcMethod added in v2.6.0 

func (r *Room) UnregisterRpcMethod(method string)

Unregisters a previously registered RPC method.

  • @param method - The name of the RPC method to unregister

func (*Room) UnregisterTextStreamHandler added in v2.6.0 

func (r *Room) UnregisterTextStreamHandler(topic string)

Unregisters a handler for a text stream.

type RoomCallback 

type RoomCallback struct {
	OnDisconnected            func()
	OnDisconnectedWithReason  func(reason DisconnectionReason)
	OnParticipantConnected    func(*RemoteParticipant)
	OnParticipantDisconnected func(*RemoteParticipant)
	OnActiveSpeakersChanged   func([]Participant)
	OnRoomMetadataChanged     func(metadata string)
	OnRoomMoved               func(roomName string, token string)
	OnReconnecting            func()
	OnReconnected             func()
	OnLocalTrackSubscribed    func(publication *LocalTrackPublication, lp *LocalParticipant)

	// participant events are sent to the room as well
	ParticipantCallback
}
Example

ExampleRoomCallback demonstrates usage of RoomCallback to handle various room events 

package main

import (
	"fmt"

	"github.com/livekit/protocol/livekit"
	lksdk "github.com/livekit/server-sdk-go/v2"
)

func main() {
	// Create a new callback handler
	cb := lksdk.NewRoomCallback()

	// Handle data packets received from other participants
	cb.OnDataPacket = func(data lksdk.DataPacket, params lksdk.DataReceiveParams) {
		// handle DTMF
		switch val := data.(type) {
		case *livekit.SipDTMF:
			fmt.Printf("Received DTMF from %s: %s (%d)\n", params.SenderIdentity, val.Digit, val.Code)
		case *lksdk.UserDataPacket:
			fmt.Printf("Received user data from %s: %s\n", params.SenderIdentity, string(val.Payload))
		}
	}

	// Handle participant metadata changes
	cb.OnAttributesChanged = func(changed map[string]string, p lksdk.Participant) {
		fmt.Printf("Participant %s attributes changed: %v\n", p.Identity(), changed)
	}

	// Handle when current participant becomes disconnected
	cb.OnDisconnectedWithReason = func(reason lksdk.DisconnectionReason) {
		fmt.Printf("Disconnected from room: %s\n", reason)
	}

	// Create a new room with the callback
	room := lksdk.NewRoom(cb)
	room.JoinWithToken("wss://myproject.livekit.cloud", "my-token")
}

func NewRoomCallback 

func NewRoomCallback() *RoomCallback

func (*RoomCallback) Merge 

func (cb *RoomCallback) Merge(other *RoomCallback)

type RoomServiceClient 

type RoomServiceClient struct {
	// contains filtered or unexported fields
}

func NewRoomServiceClient 

func NewRoomServiceClient(url string, apiKey string, secretKey string, opts ...twirp.ClientOption) *RoomServiceClient

func (*RoomServiceClient) CreateRoom 

func (c *RoomServiceClient) CreateRoom(ctx context.Context, req *livekit.CreateRoomRequest) (*livekit.Room, error)

func (*RoomServiceClient) CreateToken 

func (c *RoomServiceClient) CreateToken() *auth.AccessToken

func (*RoomServiceClient) DeleteRoom 

func (c *RoomServiceClient) DeleteRoom(ctx context.Context, req *livekit.DeleteRoomRequest) (*livekit.DeleteRoomResponse, error)

func (*RoomServiceClient) ForwardParticipant added in v2.6.0 

func (c *RoomServiceClient) ForwardParticipant(ctx context.Context, req *livekit.ForwardParticipantRequest) (*livekit.ForwardParticipantResponse, error)

Forward a participant's track(s) to another room. Requires `roomAdmin` and `destinationRoom`. The forwarding will stop when the participant leaves the room or `RemoveParticipant` has been called in the destination room. A participant can be forwarded to multiple rooms. The destination room will be created if it does not exist.

func (*RoomServiceClient) GetParticipant 

func (c *RoomServiceClient) GetParticipant(ctx context.Context, req *livekit.RoomParticipantIdentity) (*livekit.ParticipantInfo, error)

func (*RoomServiceClient) ListParticipants 

func (c *RoomServiceClient) ListParticipants(ctx context.Context, req *livekit.ListParticipantsRequest) (*livekit.ListParticipantsResponse, error)

func (*RoomServiceClient) ListRooms 

func (c *RoomServiceClient) ListRooms(ctx context.Context, req *livekit.ListRoomsRequest) (*livekit.ListRoomsResponse, error)

func (*RoomServiceClient) MoveParticipant added in v2.7.1 

func (c *RoomServiceClient) MoveParticipant(ctx context.Context, req *livekit.MoveParticipantRequest) (*livekit.MoveParticipantResponse, error)

Move a connected participant to a different room. Requires `roomAdmin` and `destinationRoom`. The participant will be removed from the current room and added to the destination room. From other observers' perspective, the participant would've disconnected from the previous room and joined the new one.

func (*RoomServiceClient) MutePublishedTrack 

func (c *RoomServiceClient) MutePublishedTrack(ctx context.Context, req *livekit.MuteRoomTrackRequest) (*livekit.MuteRoomTrackResponse, error)

func (*RoomServiceClient) RemoveParticipant 

func (c *RoomServiceClient) RemoveParticipant(ctx context.Context, req *livekit.RoomParticipantIdentity) (*livekit.RemoveParticipantResponse, error)

func (*RoomServiceClient) SendData 

func (c *RoomServiceClient) SendData(ctx context.Context, req *livekit.SendDataRequest) (*livekit.SendDataResponse, error)

func (*RoomServiceClient) UpdateParticipant 

func (c *RoomServiceClient) UpdateParticipant(ctx context.Context, req *livekit.UpdateParticipantRequest) (*livekit.ParticipantInfo, error)

func (*RoomServiceClient) UpdateRoomMetadata 

func (c *RoomServiceClient) UpdateRoomMetadata(ctx context.Context, req *livekit.UpdateRoomMetadataRequest) (*livekit.Room, error)

func (*RoomServiceClient) UpdateSubscriptions 

func (c *RoomServiceClient) UpdateSubscriptions(ctx context.Context, req *livekit.UpdateSubscriptionsRequest) (*livekit.UpdateSubscriptionsResponse, error)

type RpcError added in v2.6.0 

type RpcError struct {
	Code    RpcErrorCode
	Message string
	Data    *string
}

Specialized error handling for RPC methods.

Instances of this type, when thrown in a method handler, will have their `message` serialized and sent across the wire. The sender will receive an equivalent error on the other side.

Built-in types are included but developers may use any string, with a max length of 256 bytes.

func NewRpcError added in v2.6.0 

func NewRpcError(code RpcErrorCode, message string, data *string) *RpcError

Creates an error object with the given code and message, plus an optional data payload.

If thrown in an RPC method handler, the error will be sent back to the caller.

Error codes 1001-1999 are reserved for built-in errors.

Maximum message length is 256 bytes, and maximum data payload length is 15KiB. If a payload exceeds these limits, it will be truncated.

func (*RpcError) Error added in v2.6.0 

func (e *RpcError) Error() string

type RpcErrorCode added in v2.6.0 

type RpcErrorCode uint32
const (
	RpcApplicationError RpcErrorCode = 1500 + iota
	RpcConnectionTimeout
	RpcResponseTimeout
	RpcRecipientDisconnected
	RpcResponsePayloadTooLarge
	RpcSendFailed
)
const (
	RpcUnsupportedMethod RpcErrorCode = 1400 + iota
	RpcRecipientNotFound
	RpcRequestPayloadTooLarge
	RpcUnsupportedServer
	RpcUnsupportedVersion
)

type RpcHandlerFunc added in v2.6.0 

type RpcHandlerFunc func(data RpcInvocationData) (string, error)

type RpcInvocationData added in v2.6.0 

type RpcInvocationData struct {
	// The unique request ID. Will match at both sides of the call, useful for debugging or logging.
	RequestID string
	// The unique participant identity of the caller.
	CallerIdentity string
	// The payload of the request. User-definable format, could be JSON for example.
	Payload string
	// The maximum time the caller will wait for a response.
	ResponseTimeout time.Duration
}

Data passed to method handler for incoming RPC invocations

type SIPClient 

type SIPClient struct {
	// contains filtered or unexported fields
}

func NewSIPClient 

func NewSIPClient(url string, apiKey string, secretKey string, opts ...twirp.ClientOption) *SIPClient

NewSIPClient creates a LiveKit SIP client.

func (*SIPClient) CreateSIPDispatchRule 

func (s *SIPClient) CreateSIPDispatchRule(ctx context.Context, in *livekit.CreateSIPDispatchRuleRequest) (*livekit.SIPDispatchRuleInfo, error)

CreateSIPDispatchRule creates SIP Dispatch Rules.

func (*SIPClient) CreateSIPInboundTrunk added in v2.2.0 

func (s *SIPClient) CreateSIPInboundTrunk(ctx context.Context, in *livekit.CreateSIPInboundTrunkRequest) (*livekit.SIPInboundTrunkInfo, error)

CreateSIPInboundTrunk creates a new SIP Trunk for accepting inbound calls to LiveKit.

func (*SIPClient) CreateSIPOutboundTrunk added in v2.2.0 

func (s *SIPClient) CreateSIPOutboundTrunk(ctx context.Context, in *livekit.CreateSIPOutboundTrunkRequest) (*livekit.SIPOutboundTrunkInfo, error)

CreateSIPOutboundTrunk creates a new SIP Trunk for making outbound calls from LiveKit.

func (*SIPClient) CreateSIPParticipant 

func (s *SIPClient) CreateSIPParticipant(ctx context.Context, in *livekit.CreateSIPParticipantRequest) (*livekit.SIPParticipantInfo, error)

CreateSIPParticipant creates SIP Participant by making an outbound call.

func (*SIPClient) DeleteSIPDispatchRule 

func (s *SIPClient) DeleteSIPDispatchRule(ctx context.Context, in *livekit.DeleteSIPDispatchRuleRequest) (*livekit.SIPDispatchRuleInfo, error)

DeleteSIPDispatchRule deletes SIP Dispatch Rule given an ID.

func (*SIPClient) DeleteSIPTrunk 

func (s *SIPClient) DeleteSIPTrunk(ctx context.Context, in *livekit.DeleteSIPTrunkRequest) (*livekit.SIPTrunkInfo, error)

DeleteSIPTrunk deletes SIP Trunk given an ID.

func (*SIPClient) GetSIPDispatchRulesByIDs added in v2.4.1 

func (s *SIPClient) GetSIPDispatchRulesByIDs(ctx context.Context, ids []string) ([]*livekit.SIPDispatchRuleInfo, error)

GetSIPDispatchRulesByIDs gets SIP Dispatch Rules by ID. Returned slice is in the same order as the IDs. Missing IDs will have nil in the corresponding position.

func (*SIPClient) GetSIPInboundTrunksByIDs added in v2.4.1 

func (s *SIPClient) GetSIPInboundTrunksByIDs(ctx context.Context, ids []string) ([]*livekit.SIPInboundTrunkInfo, error)

GetSIPInboundTrunksByIDs gets SIP Inbound Trunks by ID. Returned slice is in the same order as the IDs. Missing IDs will have nil in the corresponding position.

func (*SIPClient) GetSIPOutboundTrunksByIDs added in v2.4.1 

func (s *SIPClient) GetSIPOutboundTrunksByIDs(ctx context.Context, ids []string) ([]*livekit.SIPOutboundTrunkInfo, error)

GetSIPOutboundTrunksByIDs gets SIP Outbound Trunks by ID. Returned slice is in the same order as the IDs. Missing IDs will have nil in the corresponding position.

func (*SIPClient) ListSIPDispatchRule 

func (s *SIPClient) ListSIPDispatchRule(ctx context.Context, in *livekit.ListSIPDispatchRuleRequest) (*livekit.ListSIPDispatchRuleResponse, error)

ListSIPDispatchRule lists SIP Dispatch Rules.

func (*SIPClient) ListSIPInboundTrunk added in v2.2.0 

func (s *SIPClient) ListSIPInboundTrunk(ctx context.Context, in *livekit.ListSIPInboundTrunkRequest) (*livekit.ListSIPInboundTrunkResponse, error)

ListSIPInboundTrunk lists SIP Trunks accepting inbound calls.

func (*SIPClient) ListSIPOutboundTrunk added in v2.2.0 

func (s *SIPClient) ListSIPOutboundTrunk(ctx context.Context, in *livekit.ListSIPOutboundTrunkRequest) (*livekit.ListSIPOutboundTrunkResponse, error)

ListSIPOutboundTrunk lists SIP Trunks for making outbound calls.

func (*SIPClient) ListSIPTrunk deprecated 

func (s *SIPClient) ListSIPTrunk(ctx context.Context, in *livekit.ListSIPTrunkRequest) (*livekit.ListSIPTrunkResponse, error)

ListSIPTrunk lists SIP Trunks.

Deprecated: Use ListSIPInboundTrunk or ListSIPOutboundTrunk

func (*SIPClient) TransferSIPParticipant added in v2.3.0 

func (s *SIPClient) TransferSIPParticipant(ctx context.Context, in *livekit.TransferSIPParticipantRequest) (*emptypb.Empty, error)

TransferSIPParticipant transfer an existing SIP participant to an outside SIP endpoint.

func (*SIPClient) UpdateSIPDispatchRule added in v2.6.0 

func (s *SIPClient) UpdateSIPDispatchRule(ctx context.Context, in *livekit.UpdateSIPDispatchRuleRequest) (*livekit.SIPDispatchRuleInfo, error)

UpdateSIPDispatchRule updates an existing SIP Dispatch Rule.

func (*SIPClient) UpdateSIPInboundTrunk added in v2.6.0 

func (s *SIPClient) UpdateSIPInboundTrunk(ctx context.Context, in *livekit.UpdateSIPInboundTrunkRequest) (*livekit.SIPInboundTrunkInfo, error)

UpdateSIPInboundTrunk updates an existing SIP Inbound Trunk.

func (*SIPClient) UpdateSIPOutboundTrunk added in v2.6.0 

func (s *SIPClient) UpdateSIPOutboundTrunk(ctx context.Context, in *livekit.UpdateSIPOutboundTrunkRequest) (*livekit.SIPOutboundTrunkInfo, error)

UpdateSIPOutboundTrunk updates an existing SIP Outbound Trunk.

type SampleProvider 

type SampleProvider interface {
	NextSample(context.Context) (media.Sample, error)
	OnBind() error
	OnUnbind() error
	Close() error
}

type SampleWriteOptions 

type SampleWriteOptions struct {
	AudioLevel *uint8
}

type SignalClient 

type SignalClient struct {
	OnClose                 func()
	OnAnswer                func(sd webrtc.SessionDescription)
	OnOffer                 func(sd webrtc.SessionDescription)
	OnTrickle               func(init webrtc.ICECandidateInit, target livekit.SignalTarget)
	OnParticipantUpdate     func([]*livekit.ParticipantInfo)
	OnLocalTrackPublished   func(response *livekit.TrackPublishedResponse)
	OnSpeakersChanged       func([]*livekit.SpeakerInfo)
	OnConnectionQuality     func([]*livekit.ConnectionQualityInfo)
	OnRoomUpdate            func(room *livekit.Room)
	OnRoomMoved             func(moved *livekit.RoomMovedResponse)
	OnTrackRemoteMuted      func(request *livekit.MuteTrackRequest)
	OnLocalTrackUnpublished func(response *livekit.TrackUnpublishedResponse)
	OnTokenRefresh          func(refreshToken string)
	OnLeave                 func(*livekit.LeaveRequest)
	OnLocalTrackSubscribed  func(trackSubscribed *livekit.TrackSubscribed)
	// contains filtered or unexported fields
}

func NewSignalClient 

func NewSignalClient() *SignalClient

func (*SignalClient) Close 

func (c *SignalClient) Close()

func (*SignalClient) IsStarted 

func (c *SignalClient) IsStarted() bool

func (*SignalClient) Join 

func (c *SignalClient) Join(urlPrefix string, token string, params SignalClientConnectParams) (*livekit.JoinResponse, error)

Deprecated, use JoinContext

func (*SignalClient) JoinContext added in v2.4.2 

func (c *SignalClient) JoinContext(ctx context.Context, urlPrefix string, token string, params SignalClientConnectParams) (*livekit.JoinResponse, error)

func (*SignalClient) Reconnect 

func (c *SignalClient) Reconnect(urlPrefix string, token string, params SignalClientConnectParams, participantSID string) (*livekit.ReconnectResponse, error)

Reconnect starts a new WebSocket connection to the server, passing in reconnect=1 when successful, it'll return a ReconnectResponse; older versions of the server will not send back a ReconnectResponse

func (*SignalClient) SendAnswer 

func (c *SignalClient) SendAnswer(sd webrtc.SessionDescription) error

func (*SignalClient) SendICECandidate 

func (c *SignalClient) SendICECandidate(candidate webrtc.ICECandidateInit, target livekit.SignalTarget) error

func (*SignalClient) SendLeave 

func (c *SignalClient) SendLeave() error

func (*SignalClient) SendLeaveWithReason added in v2.3.0 

func (c *SignalClient) SendLeaveWithReason(reason livekit.DisconnectReason) error

func (*SignalClient) SendMuteTrack 

func (c *SignalClient) SendMuteTrack(sid string, muted bool) error

func (*SignalClient) SendOffer 

func (c *SignalClient) SendOffer(sd webrtc.SessionDescription) error

func (*SignalClient) SendRequest 

func (c *SignalClient) SendRequest(req *livekit.SignalRequest) error

func (*SignalClient) SendSyncState 

func (c *SignalClient) SendSyncState(state *livekit.SyncState) error

func (*SignalClient) SendUpdateParticipantMetadata 

func (c *SignalClient) SendUpdateParticipantMetadata(metadata *livekit.UpdateParticipantMetadata) error

func (*SignalClient) SendUpdateTrackSettings 

func (c *SignalClient) SendUpdateTrackSettings(settings *livekit.UpdateTrackSettings) error

func (*SignalClient) SetLogger added in v2.2.1 

func (c *SignalClient) SetLogger(l protoLogger.Logger)

SetLogger overrides default logger.

func (*SignalClient) Start 

func (c *SignalClient) Start()

type SignalClientConnectParams added in v2.3.1 

type SignalClientConnectParams struct {
	AutoSubscribe          bool
	Reconnect              bool
	DisableRegionDiscovery bool

	RetransmitBufferSize uint16

	Pacer pacer.Factory

	Interceptors []interceptor.Factory

	ICETransportPolicy webrtc.ICETransportPolicy
}

not exposed to users. clients should use ConnectOption

type SimulateScenario 

type SimulateScenario int
const (
	SimulateSignalReconnect SimulateScenario = iota
	SimulateForceTCP
	SimulateForceTLS
	SimulateSpeakerUpdate
	SimulateMigration
	SimulateServerLeave
	SimulateNodeFailure
)

type SimulcastTrack 

type SimulcastTrack struct {
	// contains filtered or unexported fields
}

func NewSimulcastTrack 

func NewSimulcastTrack(trackLocal webrtc.TrackLocal, videoLayer *livekit.VideoLayer) *SimulcastTrack

func (*SimulcastTrack) Quality 

func (t *SimulcastTrack) Quality() livekit.VideoQuality

func (*SimulcastTrack) TrackLocal 

func (t *SimulcastTrack) TrackLocal() webrtc.TrackLocal

func (*SimulcastTrack) VideoLayer 

func (t *SimulcastTrack) VideoLayer() *livekit.VideoLayer

type StreamBytesOptions added in v2.6.0 

type StreamBytesOptions struct {
	Topic                 string
	MimeType              string
	DestinationIdentities []string
	StreamId              *string
	TotalSize             uint64
	Attributes            map[string]string
	OnProgress            func(progress float64)
	FileName              *string
}

Options for publishing a byte stream

  • Topic is the topic of the stream
  • MimeType is the mime type of the stream, determined for SendFile if not provided
  • DestinationIdentities is the list of identities that will receive the stream, empty for all participants
  • StreamId is the id of the stream, generated if not provided
  • TotalSize is the total size of the stream, optional but calculated internally for SendFile
  • Attributes are any additional attributes of the stream
  • OnProgress is a callback function that will be called when the stream is being written
  • FileName is the name of the file, optional

type StreamTextOptions added in v2.6.0 

type StreamTextOptions struct {
	Topic                 string
	DestinationIdentities []string
	StreamId              *string
	ReplyToStreamId       *string
	TotalSize             uint64
	Attributes            map[string]string
	OnProgress            func(progress float64)
	Attachments           []string
	AttachedStreamIds     []string
}

Options for publishing a text stream with mime type "text/plain"

  • Topic is the topic of the stream
  • DestinationIdentities is the list of identities that will receive the stream, empty for all participants
  • StreamId is the id of the stream, generated if not provided
  • ReplyToStreamId is the id of the stream to reply to, optional
  • TotalSize is the total size of the stream, optional but calculated internally for SendText if not provided
  • Attributes are any additional attributes of the stream
  • OnProgress is a callback function that will be called when the stream is being written
  • Attachments is the list of file paths to attach to the stream, optional
  • AttachedStreamIds is the list of stream ids that are attached to this stream, mapped by index to attachments, optional, generated if not provided

type TextStreamHandler added in v2.6.0 

type TextStreamHandler func(reader *TextStreamReader, participantIdentity string)

TextStreamHandler is a function that will be called when a text stream is received. It will be called with the stream reader and the participant identity that sent the stream.

type TextStreamInfo added in v2.6.0 

type TextStreamInfo struct {
	// contains filtered or unexported fields
}

Info for text streams

  • Id is the id of the stream
  • MimeType is the mime type of the stream, always "text/plain" for text streams
  • Topic is the topic of the stream
  • Timestamp is the timestamp of sending the stream
  • Size is the total size of the stream, if provided
  • Attributes are any additional attributes of the stream

type TextStreamReader added in v2.6.0 

type TextStreamReader struct {
	Info TextStreamInfo
	// contains filtered or unexported fields
}

func NewTextStreamReader added in v2.6.0 

func NewTextStreamReader(info TextStreamInfo, totalChunkCount *uint64) *TextStreamReader

func (TextStreamReader) OnProgress added in v2.6.0 

func (r TextStreamReader) OnProgress(onProgress *func(progress float64))

OnProgress sets the callback function that will be called when the stream is being read only called if TotalSize of the stream is set

func (TextStreamReader) Read added in v2.6.0 

func (r TextStreamReader) Read(bytes []byte) (int, error)

Read reads the next len(p) bytes from the stream or until the stream buffer is drained. The return value is the number of bytes read. If the buffer has no data to return, it will wait for a write to the stream or return io.EOF if the stream is closed.

func (*TextStreamReader) ReadAll added in v2.6.0 

func (r *TextStreamReader) ReadAll() string

ReadAll reads all the data from the stream and returns it as a string. This will block until the stream is closed.

func (TextStreamReader) ReadByte added in v2.6.0 

func (r TextStreamReader) ReadByte() (byte, error)

ReadByte reads and returns the next byte from the buffer. If no byte is available, it will wait for a write to the stream or return io.EOF if the stream is closed.

func (TextStreamReader) ReadBytes added in v2.6.0 

func (r TextStreamReader) ReadBytes(delim byte) ([]byte, error)

ReadBytes reads until the first occurrence of delim in the input, returning a slice containing the data up to and including the delimiter. If ReadBytes encounters an error before finding a delimiter, it returns the data read before EOF, but does not return EOF until the stream is closed. ReadBytes returns err != nil if and only if the returned data does not end in delim.

func (*TextStreamReader) ReadRune added in v2.6.0 

func (r *TextStreamReader) ReadRune() (rune, int, error)

ReadRune reads and returns the next UTF-8-encoded Unicode code point from the buffer. If no bytes are available, it will wait for a write to the stream or return io.EOF if the stream is closed. If the bytes are an erroneous UTF-8 encoding, it consumes one byte and returns U+FFFD, 1.

func (*TextStreamReader) ReadString added in v2.6.0 

func (r *TextStreamReader) ReadString(delim byte) (string, error)

ReadString reads until the first occurrence of delim in the input, returning a string containing the data up to and including the delimiter. If ReadString encounters an error before finding a delimiter, it returns the data read before EOF, but does not return EOF until the stream is closed. ReadString returns err != nil if and only if the returned data does not end in delim.

type TextStreamWriter added in v2.6.0 

type TextStreamWriter struct {
	Info TextStreamInfo
	// contains filtered or unexported fields
}

TextStreamWriter is a writer type for text streams

func (TextStreamWriter) Close added in v2.6.0 

func (w TextStreamWriter) Close()

Close the stream, this will send a stream trailer to notify the receiver that the stream is closed

func (TextStreamWriter) Write added in v2.6.0 

func (w TextStreamWriter) Write(data T, onDone *func())

Write data to the stream, data can be a byte slice or a string depending on the type of the stream writer onDone is a callback function that will be called when the data provided is written to the stream

type Track 

type Track interface {
	ID() string
}

type TrackKind 

type TrackKind string
const (
	TrackKindVideo TrackKind = "video"
	TrackKindAudio TrackKind = "audio"
)

func KindFromRTPType 

func KindFromRTPType(rt webrtc.RTPCodecType) TrackKind

func (TrackKind) ProtoType 

func (k TrackKind) ProtoType() livekit.TrackType

func (TrackKind) RTPType 

func (k TrackKind) RTPType() webrtc.RTPCodecType

func (TrackKind) String 

func (k TrackKind) String() string

type TrackPubCallback 

type TrackPubCallback func(track Track, pub TrackPublication, participant *RemoteParticipant)

type TrackPublication 

type TrackPublication interface {
	Name() string
	SID() string
	Source() livekit.TrackSource
	Kind() TrackKind
	MimeType() string
	IsMuted() bool
	IsSubscribed() bool
	TrackInfo() *livekit.TrackInfo
	// Track is either a webrtc.TrackLocal or webrtc.TrackRemote
	Track() Track
	// contains filtered or unexported methods
}

type TrackPublicationOptions 

type TrackPublicationOptions struct {
	Name   string
	Source livekit.TrackSource
	// Set dimensions for video
	VideoWidth  int
	VideoHeight int
	// Opus only
	DisableDTX bool
	Stereo     bool
	// which stream the track belongs to, used to group tracks together.
	// if not specified, server will infer it from track source to bundle camera/microphone, screenshare/audio together
	Stream string
	// encryption type
	Encryption livekit.Encryption_Type
}

type TranscriptionSegment added in v2.4.1 

type TranscriptionSegment struct {
	ID        string
	Text      string
	Language  string
	StartTime uint64
	EndTime   uint64
	Final     bool
}

func ExtractTranscriptionSegments added in v2.4.1 

func ExtractTranscriptionSegments(transcription *livekit.Transcription) []*TranscriptionSegment

type UserDataPacket added in v2.0.5 

type UserDataPacket struct {
	Payload []byte
	Topic   string // optional
}

UserDataPacket is a custom user data that can be sent via WebRTC on a custom topic.

func UserData added in v2.0.5 

func UserData(data []byte) *UserDataPacket

UserData is a custom user data that can be sent via WebRTC.

func (*UserDataPacket) ToProto added in v2.0.5 

func (p *UserDataPacket) ToProto() *livekit.DataPacket

ToProto implements DataPacket.

Source Files

View all Source files

Directories

Path Synopsis
examples
audiotrack
audiotracke2ee
datastreams
echo
echoe2ee
filesaver
filesender
openai_realtime_voice
rpc
pkg
interceptor
media
oggreader
samplebuilder
Package samplebuilder builds media frames from RTP packets.
 Package samplebuilder builds media frames from RTP packets.
synchronizer

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.