Documentation ¶
Index ¶
- Constants
- Variables
- func AppendLogFields(ctx context.Context, fields ...interface{})
- func EnsureAdminPermission(ctx context.Context, room livekit.RoomName) error
- func EnsureCreatePermission(ctx context.Context) error
- func EnsureIngressAdminPermission(ctx context.Context) error
- func EnsureJoinPermission(ctx context.Context) (name livekit.RoomName, err error)
- func EnsureListPermission(ctx context.Context) error
- func EnsureRecordPermission(ctx context.Context) error
- func GetClientIP(r *http.Request) string
- func GetGrants(ctx context.Context) *auth.ClaimGrants
- func InitializeRouter(conf *config.Config, currentNode routing.LocalNode) (routing.Router, error)
- func IsValidDomain(domain string) bool
- func NewEgressLauncher(client rpc.EgressClient, es EgressStore, ts telemetry.TelemetryService) rtc.EgressLauncher
- func NewTurnServer(conf *config.Config, authHandler turn.AuthHandler, standalone bool) (*turn.Server, error)
- func SetAuthorizationToken(r *http.Request, token string)
- func TwirpLogger(logger logger.Logger) *twirp.ServerHooks
- func TwirpRequestStatusReporter() *twirp.ServerHooks
- func WithGrants(ctx context.Context, grants *auth.ClaimGrants) context.Context
- type APIKeyAuthMiddleware
- type EgressService
- func (s *EgressService) ListEgress(ctx context.Context, req *livekit.ListEgressRequest) (*livekit.ListEgressResponse, error)
- func (s *EgressService) StartRoomCompositeEgress(ctx context.Context, req *livekit.RoomCompositeEgressRequest) (*livekit.EgressInfo, error)
- func (s *EgressService) StartTrackCompositeEgress(ctx context.Context, req *livekit.TrackCompositeEgressRequest) (*livekit.EgressInfo, error)
- func (s *EgressService) StartTrackEgress(ctx context.Context, req *livekit.TrackEgressRequest) (*livekit.EgressInfo, error)
- func (s *EgressService) StartWebEgress(ctx context.Context, req *livekit.WebEgressRequest) (*livekit.EgressInfo, error)
- func (s *EgressService) StopEgress(ctx context.Context, req *livekit.StopEgressRequest) (*livekit.EgressInfo, error)
- func (s *EgressService) UpdateLayout(ctx context.Context, req *livekit.UpdateLayoutRequest) (*livekit.EgressInfo, error)
- func (s *EgressService) UpdateStream(ctx context.Context, req *livekit.UpdateStreamRequest) (*livekit.EgressInfo, error)
- type EgressStore
- type IOInfoService
- func (s *IOInfoService) GetIngressInfo(ctx context.Context, req *rpc.GetIngressInfoRequest) (*rpc.GetIngressInfoResponse, error)
- func (s *IOInfoService) Start() error
- func (s *IOInfoService) Stop()
- func (s *IOInfoService) UpdateEgressInfo(ctx context.Context, info *livekit.EgressInfo) (*emptypb.Empty, error)
- func (s *IOInfoService) UpdateIngressState(ctx context.Context, req *rpc.UpdateIngressStateRequest) (*emptypb.Empty, error)
- type IngressService
- func (s *IngressService) CreateIngress(ctx context.Context, req *livekit.CreateIngressRequest) (*livekit.IngressInfo, error)
- func (s *IngressService) CreateIngressWithUrlPrefix(ctx context.Context, urlPrefix string, req *livekit.CreateIngressRequest) (*livekit.IngressInfo, error)
- func (s *IngressService) DeleteIngress(ctx context.Context, req *livekit.DeleteIngressRequest) (*livekit.IngressInfo, error)
- func (s *IngressService) ListIngress(ctx context.Context, req *livekit.ListIngressRequest) (*livekit.ListIngressResponse, error)
- func (s *IngressService) UpdateIngress(ctx context.Context, req *livekit.UpdateIngressRequest) (*livekit.IngressInfo, error)
- type IngressStore
- type LayoutMetadata
- type LivekitServer
- type LocalStore
- func (s *LocalStore) DeleteParticipant(_ context.Context, roomName livekit.RoomName, ...) error
- func (s *LocalStore) DeleteRoom(ctx context.Context, roomName livekit.RoomName) error
- func (s *LocalStore) ListParticipants(_ context.Context, roomName livekit.RoomName) ([]*livekit.ParticipantInfo, error)
- func (s *LocalStore) ListRooms(_ context.Context, roomNames []livekit.RoomName) ([]*livekit.Room, error)
- func (s *LocalStore) LoadParticipant(_ context.Context, roomName livekit.RoomName, ...) (*livekit.ParticipantInfo, error)
- func (s *LocalStore) LoadRoom(_ context.Context, roomName livekit.RoomName, includeInternal bool) (*livekit.Room, *livekit.RoomInternal, error)
- func (s *LocalStore) LockRoom(_ context.Context, _ livekit.RoomName, _ time.Duration) (string, error)
- func (s *LocalStore) StoreParticipant(_ context.Context, roomName livekit.RoomName, ...) error
- func (s *LocalStore) StoreRoom(_ context.Context, room *livekit.Room, internal *livekit.RoomInternal) error
- func (s *LocalStore) UnlockRoom(_ context.Context, _ livekit.RoomName, _ string) error
- type ObjectStore
- type RTCService
- type RedisStore
- func (s *RedisStore) CleanEndedEgress() error
- func (s *RedisStore) DeleteIngress(_ context.Context, info *livekit.IngressInfo) error
- func (s *RedisStore) DeleteParticipant(_ context.Context, roomName livekit.RoomName, ...) error
- func (s *RedisStore) DeleteRoom(ctx context.Context, roomName livekit.RoomName) error
- func (s *RedisStore) ListEgress(_ context.Context, roomName livekit.RoomName, active bool) ([]*livekit.EgressInfo, error)
- func (s *RedisStore) ListIngress(ctx context.Context, roomName livekit.RoomName) ([]*livekit.IngressInfo, error)
- func (s *RedisStore) ListParticipants(_ context.Context, roomName livekit.RoomName) ([]*livekit.ParticipantInfo, error)
- func (s *RedisStore) ListRooms(_ context.Context, roomNames []livekit.RoomName) ([]*livekit.Room, error)
- func (s *RedisStore) LoadEgress(_ context.Context, egressID string) (*livekit.EgressInfo, error)
- func (s *RedisStore) LoadIngress(_ context.Context, ingressId string) (*livekit.IngressInfo, error)
- func (s *RedisStore) LoadIngressFromStreamKey(_ context.Context, streamKey string) (*livekit.IngressInfo, error)
- func (s *RedisStore) LoadParticipant(_ context.Context, roomName livekit.RoomName, ...) (*livekit.ParticipantInfo, error)
- func (s *RedisStore) LoadRoom(_ context.Context, roomName livekit.RoomName, includeInternal bool) (*livekit.Room, *livekit.RoomInternal, error)
- func (s *RedisStore) LockRoom(_ context.Context, roomName livekit.RoomName, duration time.Duration) (string, error)
- func (s *RedisStore) Start() error
- func (s *RedisStore) Stop()
- func (s *RedisStore) StoreEgress(_ context.Context, info *livekit.EgressInfo) error
- func (s *RedisStore) StoreIngress(ctx context.Context, info *livekit.IngressInfo) error
- func (s *RedisStore) StoreParticipant(_ context.Context, roomName livekit.RoomName, ...) error
- func (s *RedisStore) StoreRoom(_ context.Context, room *livekit.Room, internal *livekit.RoomInternal) error
- func (s *RedisStore) UnlockRoom(ctx context.Context, roomName livekit.RoomName, uid string) error
- func (s *RedisStore) UpdateEgress(_ context.Context, info *livekit.EgressInfo) error
- func (s *RedisStore) UpdateIngress(ctx context.Context, info *livekit.IngressInfo) error
- func (s *RedisStore) UpdateIngressState(ctx context.Context, ingressId string, state *livekit.IngressState) error
- type RoomAllocator
- type RoomManager
- func (r *RoomManager) CleanupRooms() error
- func (r *RoomManager) CloseIdleRooms()
- func (r *RoomManager) DeleteRoom(ctx context.Context, roomName livekit.RoomName) error
- func (r *RoomManager) GetRoom(_ context.Context, roomName livekit.RoomName) *rtc.Room
- func (r *RoomManager) HasParticipants() bool
- func (r *RoomManager) StartSession(ctx context.Context, roomName livekit.RoomName, pi routing.ParticipantInit, ...) error
- func (r *RoomManager) Stop()
- type RoomService
- func (s *RoomService) CreateRoom(ctx context.Context, req *livekit.CreateRoomRequest) (*livekit.Room, error)
- func (s *RoomService) DeleteRoom(ctx context.Context, req *livekit.DeleteRoomRequest) (*livekit.DeleteRoomResponse, error)
- func (s *RoomService) GetParticipant(ctx context.Context, req *livekit.RoomParticipantIdentity) (*livekit.ParticipantInfo, error)
- func (s *RoomService) ListParticipants(ctx context.Context, req *livekit.ListParticipantsRequest) (*livekit.ListParticipantsResponse, error)
- func (s *RoomService) ListRooms(ctx context.Context, req *livekit.ListRoomsRequest) (*livekit.ListRoomsResponse, error)
- func (s *RoomService) MutePublishedTrack(ctx context.Context, req *livekit.MuteRoomTrackRequest) (*livekit.MuteRoomTrackResponse, error)
- func (s *RoomService) RemoveParticipant(ctx context.Context, req *livekit.RoomParticipantIdentity) (*livekit.RemoveParticipantResponse, error)
- func (s *RoomService) SendData(ctx context.Context, req *livekit.SendDataRequest) (*livekit.SendDataResponse, error)
- func (s *RoomService) UpdateParticipant(ctx context.Context, req *livekit.UpdateParticipantRequest) (*livekit.ParticipantInfo, error)
- func (s *RoomService) UpdateRoomMetadata(ctx context.Context, req *livekit.UpdateRoomMetadataRequest) (*livekit.Room, error)
- func (s *RoomService) UpdateSubscriptions(ctx context.Context, req *livekit.UpdateSubscriptionsRequest) (*livekit.UpdateSubscriptionsResponse, error)
- type ServiceStore
- type SessionHandler
- type SignalServer
- type StandardRoomAllocator
- type WSSignalConnection
Constants ¶
const ( VersionKey = "livekit_version" // RoomsKey is hash of room_name => Room proto RoomsKey = "rooms" RoomInternalKey = "room_internal" // EgressKey is a hash of egressID => egress info EgressKey = "egress" EndedEgressKey = "ended_egress" RoomEgressPrefix = "egress:room:" // IngressKey is a hash of ingressID => ingress info IngressKey = "ingress" StreamKeyKey = "{ingress}_stream_key" IngressStatePrefix = "{ingress}_state:" RoomIngressPrefix = "room_{ingress}:" // RoomParticipantsPrefix is hash of participant_name => ParticipantInfo RoomParticipantsPrefix = "room_participants:" // RoomLockPrefix is a simple key containing a provided lock uid RoomLockPrefix = "room_lock:" )
const (
LivekitRealm = "livekit"
)
Variables ¶
var ( ErrPermissionDenied = errors.New("permissions denied") ErrMissingAuthorization = errors.New("invalid authorization header. Must start with " + bearerPrefix) ErrInvalidAuthorizationToken = errors.New("invalid authorization token") )
var ( ErrEgressNotFound = psrpc.NewErrorf(psrpc.NotFound, "egress does not exist") ErrEgressNotConnected = psrpc.NewErrorf(psrpc.Internal, "egress not connected (redis required)") ErrIdentityEmpty = psrpc.NewErrorf(psrpc.InvalidArgument, "identity cannot be empty") ErrIngressNotConnected = psrpc.NewErrorf(psrpc.Internal, "ingress not connected (redis required)") ErrIngressNotFound = psrpc.NewErrorf(psrpc.NotFound, "ingress does not exist") ErrMetadataExceedsLimits = psrpc.NewErrorf(psrpc.InvalidArgument, "metadata size exceeds limits") ErrOperationFailed = psrpc.NewErrorf(psrpc.Internal, "operation cannot be completed") ErrParticipantNotFound = psrpc.NewErrorf(psrpc.NotFound, "participant does not exist") ErrRoomNotFound = psrpc.NewErrorf(psrpc.NotFound, "requested room does not exist") ErrRoomLockFailed = psrpc.NewErrorf(psrpc.Internal, "could not lock room") ErrRoomUnlockFailed = psrpc.NewErrorf(psrpc.Internal, "could not unlock room, lock token does not match") ErrTrackNotFound = psrpc.NewErrorf(psrpc.NotFound, "track is not found") ErrWebHookMissingAPIKey = psrpc.NewErrorf(psrpc.InvalidArgument, "api_key is required to use webhooks") )
Functions ¶
func AppendLogFields ¶ added in v1.3.2
func EnsureAdminPermission ¶
func EnsureCreatePermission ¶
func EnsureIngressAdminPermission ¶ added in v1.3.0
func EnsureJoinPermission ¶
func EnsureListPermission ¶
func EnsureRecordPermission ¶ added in v0.12.1
func GetClientIP ¶ added in v1.4.1
func InitializeRouter ¶ added in v0.12.2
func IsValidDomain ¶ added in v0.12.2
func NewEgressLauncher ¶ added in v1.2.2
func NewEgressLauncher( client rpc.EgressClient, es EgressStore, ts telemetry.TelemetryService) rtc.EgressLauncher
func NewTurnServer ¶
func SetAuthorizationToken ¶
func TwirpLogger ¶ added in v1.2.5
func TwirpLogger(logger logger.Logger) *twirp.ServerHooks
logging handling inspired by https://github.com/bakins/twirpzap License: Apache-2.0
func TwirpRequestStatusReporter ¶ added in v1.3.4
func TwirpRequestStatusReporter() *twirp.ServerHooks
func WithGrants ¶ added in v0.15.5
Types ¶
type APIKeyAuthMiddleware ¶
type APIKeyAuthMiddleware struct {
// contains filtered or unexported fields
}
authentication middleware
func NewAPIKeyAuthMiddleware ¶
func NewAPIKeyAuthMiddleware(provider auth.KeyProvider) *APIKeyAuthMiddleware
func (*APIKeyAuthMiddleware) ServeHTTP ¶
func (m *APIKeyAuthMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)
type EgressService ¶ added in v0.15.5
type EgressService struct {
// contains filtered or unexported fields
}
func NewEgressService ¶ added in v0.15.5
func NewEgressService( client rpc.EgressClient, store ServiceStore, es EgressStore, rs livekit.RoomService, ts telemetry.TelemetryService, launcher rtc.EgressLauncher, ) *EgressService
func (*EgressService) ListEgress ¶ added in v0.15.5
func (s *EgressService) ListEgress(ctx context.Context, req *livekit.ListEgressRequest) (*livekit.ListEgressResponse, error)
func (*EgressService) StartRoomCompositeEgress ¶ added in v0.15.7
func (s *EgressService) StartRoomCompositeEgress(ctx context.Context, req *livekit.RoomCompositeEgressRequest) (*livekit.EgressInfo, error)
func (*EgressService) StartTrackCompositeEgress ¶ added in v0.15.5
func (s *EgressService) StartTrackCompositeEgress(ctx context.Context, req *livekit.TrackCompositeEgressRequest) (*livekit.EgressInfo, error)
func (*EgressService) StartTrackEgress ¶ added in v0.15.5
func (s *EgressService) StartTrackEgress(ctx context.Context, req *livekit.TrackEgressRequest) (*livekit.EgressInfo, error)
func (*EgressService) StartWebEgress ¶ added in v1.3.0
func (s *EgressService) StartWebEgress(ctx context.Context, req *livekit.WebEgressRequest) (*livekit.EgressInfo, error)
func (*EgressService) StopEgress ¶ added in v0.15.5
func (s *EgressService) StopEgress(ctx context.Context, req *livekit.StopEgressRequest) (*livekit.EgressInfo, error)
func (*EgressService) UpdateLayout ¶ added in v0.15.5
func (s *EgressService) UpdateLayout(ctx context.Context, req *livekit.UpdateLayoutRequest) (*livekit.EgressInfo, error)
func (*EgressService) UpdateStream ¶ added in v0.15.5
func (s *EgressService) UpdateStream(ctx context.Context, req *livekit.UpdateStreamRequest) (*livekit.EgressInfo, error)
type EgressStore ¶ added in v0.15.5
type EgressStore interface { StoreEgress(ctx context.Context, info *livekit.EgressInfo) error LoadEgress(ctx context.Context, egressID string) (*livekit.EgressInfo, error) ListEgress(ctx context.Context, roomName livekit.RoomName, active bool) ([]*livekit.EgressInfo, error) UpdateEgress(ctx context.Context, info *livekit.EgressInfo) error }
type IOInfoService ¶ added in v1.3.4
type IOInfoService struct {
// contains filtered or unexported fields
}
func NewIOInfoService ¶ added in v1.3.4
func NewIOInfoService( nodeID livekit.NodeID, bus psrpc.MessageBus, es EgressStore, is IngressStore, ts telemetry.TelemetryService, ) (*IOInfoService, error)
func (*IOInfoService) GetIngressInfo ¶ added in v1.3.4
func (s *IOInfoService) GetIngressInfo(ctx context.Context, req *rpc.GetIngressInfoRequest) (*rpc.GetIngressInfoResponse, error)
func (*IOInfoService) Start ¶ added in v1.3.4
func (s *IOInfoService) Start() error
func (*IOInfoService) Stop ¶ added in v1.3.4
func (s *IOInfoService) Stop()
func (*IOInfoService) UpdateEgressInfo ¶ added in v1.3.4
func (s *IOInfoService) UpdateEgressInfo(ctx context.Context, info *livekit.EgressInfo) (*emptypb.Empty, error)
func (*IOInfoService) UpdateIngressState ¶ added in v1.3.4
func (s *IOInfoService) UpdateIngressState(ctx context.Context, req *rpc.UpdateIngressStateRequest) (*emptypb.Empty, error)
type IngressService ¶ added in v1.2.0
type IngressService struct {
// contains filtered or unexported fields
}
func NewIngressService ¶ added in v1.2.0
func NewIngressService( conf *config.IngressConfig, nodeID livekit.NodeID, bus psrpc.MessageBus, psrpcClient rpc.IngressClient, store IngressStore, rs livekit.RoomService, ts telemetry.TelemetryService, ) *IngressService
func (*IngressService) CreateIngress ¶ added in v1.2.0
func (s *IngressService) CreateIngress(ctx context.Context, req *livekit.CreateIngressRequest) (*livekit.IngressInfo, error)
func (*IngressService) CreateIngressWithUrlPrefix ¶ added in v1.2.1
func (s *IngressService) CreateIngressWithUrlPrefix(ctx context.Context, urlPrefix string, req *livekit.CreateIngressRequest) (*livekit.IngressInfo, error)
func (*IngressService) DeleteIngress ¶ added in v1.2.0
func (s *IngressService) DeleteIngress(ctx context.Context, req *livekit.DeleteIngressRequest) (*livekit.IngressInfo, error)
func (*IngressService) ListIngress ¶ added in v1.2.0
func (s *IngressService) ListIngress(ctx context.Context, req *livekit.ListIngressRequest) (*livekit.ListIngressResponse, error)
func (*IngressService) UpdateIngress ¶ added in v1.2.0
func (s *IngressService) UpdateIngress(ctx context.Context, req *livekit.UpdateIngressRequest) (*livekit.IngressInfo, error)
type IngressStore ¶ added in v1.2.0
type IngressStore interface { StoreIngress(ctx context.Context, info *livekit.IngressInfo) error LoadIngress(ctx context.Context, ingressID string) (*livekit.IngressInfo, error) LoadIngressFromStreamKey(ctx context.Context, streamKey string) (*livekit.IngressInfo, error) ListIngress(ctx context.Context, roomName livekit.RoomName) ([]*livekit.IngressInfo, error) UpdateIngress(ctx context.Context, info *livekit.IngressInfo) error UpdateIngressState(ctx context.Context, ingressId string, state *livekit.IngressState) error DeleteIngress(ctx context.Context, info *livekit.IngressInfo) error }
type LayoutMetadata ¶ added in v0.15.5
type LayoutMetadata struct {
Layout string `json:"layout"`
}
type LivekitServer ¶
type LivekitServer struct {
// contains filtered or unexported fields
}
func InitializeServer ¶
func NewLivekitServer ¶
func NewLivekitServer(conf *config.Config, roomService livekit.RoomService, egressService *EgressService, ingressService *IngressService, ioService *IOInfoService, rtcService *RTCService, keyProvider auth.KeyProvider, router routing.Router, roomManager *RoomManager, signalServer *SignalServer, turnServer *turn.Server, currentNode routing.LocalNode, ) (s *LivekitServer, err error)
func (*LivekitServer) HTTPPort ¶ added in v0.15.3
func (s *LivekitServer) HTTPPort() int
func (*LivekitServer) IsRunning ¶
func (s *LivekitServer) IsRunning() bool
func (*LivekitServer) Node ¶
func (s *LivekitServer) Node() *livekit.Node
func (*LivekitServer) RoomManager ¶ added in v0.9.2
func (s *LivekitServer) RoomManager() *RoomManager
func (*LivekitServer) Start ¶
func (s *LivekitServer) Start() error
func (*LivekitServer) Stop ¶
func (s *LivekitServer) Stop(force bool)
type LocalStore ¶ added in v0.15.5
type LocalStore struct {
// contains filtered or unexported fields
}
encapsulates CRUD operations for room settings
func NewLocalStore ¶ added in v0.15.5
func NewLocalStore() *LocalStore
func (*LocalStore) DeleteParticipant ¶ added in v0.15.5
func (s *LocalStore) DeleteParticipant(_ context.Context, roomName livekit.RoomName, identity livekit.ParticipantIdentity) error
func (*LocalStore) DeleteRoom ¶ added in v0.15.5
func (*LocalStore) ListParticipants ¶ added in v0.15.5
func (s *LocalStore) ListParticipants(_ context.Context, roomName livekit.RoomName) ([]*livekit.ParticipantInfo, error)
func (*LocalStore) LoadParticipant ¶ added in v0.15.5
func (s *LocalStore) LoadParticipant(_ context.Context, roomName livekit.RoomName, identity livekit.ParticipantIdentity) (*livekit.ParticipantInfo, error)
func (*LocalStore) StoreParticipant ¶ added in v0.15.5
func (s *LocalStore) StoreParticipant(_ context.Context, roomName livekit.RoomName, participant *livekit.ParticipantInfo) error
func (*LocalStore) StoreRoom ¶ added in v0.15.5
func (s *LocalStore) StoreRoom(_ context.Context, room *livekit.Room, internal *livekit.RoomInternal) error
func (*LocalStore) UnlockRoom ¶ added in v0.15.5
type ObjectStore ¶ added in v0.15.5
type ObjectStore interface { ServiceStore // enable locking on a specific room to prevent race // returns a (lock uuid, error) LockRoom(ctx context.Context, roomName livekit.RoomName, duration time.Duration) (string, error) UnlockRoom(ctx context.Context, roomName livekit.RoomName, uid string) error StoreRoom(ctx context.Context, room *livekit.Room, internal *livekit.RoomInternal) error DeleteRoom(ctx context.Context, roomName livekit.RoomName) error StoreParticipant(ctx context.Context, roomName livekit.RoomName, participant *livekit.ParticipantInfo) error DeleteParticipant(ctx context.Context, roomName livekit.RoomName, identity livekit.ParticipantIdentity) error }
encapsulates CRUD operations for room settings
type RTCService ¶
type RTCService struct {
// contains filtered or unexported fields
}
func NewRTCService ¶
func NewRTCService( conf *config.Config, ra RoomAllocator, store ServiceStore, router routing.MessageRouter, currentNode routing.LocalNode, telemetry telemetry.TelemetryService, ) *RTCService
func (*RTCService) ParseClientInfo ¶ added in v0.15.4
func (s *RTCService) ParseClientInfo(r *http.Request) *livekit.ClientInfo
func (*RTCService) ServeHTTP ¶
func (s *RTCService) ServeHTTP(w http.ResponseWriter, r *http.Request)
func (*RTCService) Validate ¶ added in v0.11.0
func (s *RTCService) Validate(w http.ResponseWriter, r *http.Request)
type RedisStore ¶ added in v0.15.5
type RedisStore struct {
// contains filtered or unexported fields
}
func NewRedisStore ¶ added in v0.15.5
func NewRedisStore(rc redis.UniversalClient) *RedisStore
func (*RedisStore) CleanEndedEgress ¶ added in v1.2.0
func (s *RedisStore) CleanEndedEgress() error
func (*RedisStore) DeleteIngress ¶ added in v1.2.0
func (s *RedisStore) DeleteIngress(_ context.Context, info *livekit.IngressInfo) error
func (*RedisStore) DeleteParticipant ¶ added in v0.15.5
func (s *RedisStore) DeleteParticipant(_ context.Context, roomName livekit.RoomName, identity livekit.ParticipantIdentity) error
func (*RedisStore) DeleteRoom ¶ added in v0.15.5
func (*RedisStore) ListEgress ¶ added in v0.15.5
func (s *RedisStore) ListEgress(_ context.Context, roomName livekit.RoomName, active bool) ([]*livekit.EgressInfo, error)
func (*RedisStore) ListIngress ¶ added in v1.2.0
func (s *RedisStore) ListIngress(ctx context.Context, roomName livekit.RoomName) ([]*livekit.IngressInfo, error)
func (*RedisStore) ListParticipants ¶ added in v0.15.5
func (s *RedisStore) ListParticipants(_ context.Context, roomName livekit.RoomName) ([]*livekit.ParticipantInfo, error)
func (*RedisStore) LoadEgress ¶ added in v0.15.5
func (s *RedisStore) LoadEgress(_ context.Context, egressID string) (*livekit.EgressInfo, error)
func (*RedisStore) LoadIngress ¶ added in v1.2.0
func (s *RedisStore) LoadIngress(_ context.Context, ingressId string) (*livekit.IngressInfo, error)
func (*RedisStore) LoadIngressFromStreamKey ¶ added in v1.2.0
func (s *RedisStore) LoadIngressFromStreamKey(_ context.Context, streamKey string) (*livekit.IngressInfo, error)
func (*RedisStore) LoadParticipant ¶ added in v0.15.5
func (s *RedisStore) LoadParticipant(_ context.Context, roomName livekit.RoomName, identity livekit.ParticipantIdentity) (*livekit.ParticipantInfo, error)
func (*RedisStore) Start ¶ added in v1.2.0
func (s *RedisStore) Start() error
func (*RedisStore) Stop ¶ added in v1.2.0
func (s *RedisStore) Stop()
func (*RedisStore) StoreEgress ¶ added in v0.15.5
func (s *RedisStore) StoreEgress(_ context.Context, info *livekit.EgressInfo) error
func (*RedisStore) StoreIngress ¶ added in v1.2.0
func (s *RedisStore) StoreIngress(ctx context.Context, info *livekit.IngressInfo) error
func (*RedisStore) StoreParticipant ¶ added in v0.15.5
func (s *RedisStore) StoreParticipant(_ context.Context, roomName livekit.RoomName, participant *livekit.ParticipantInfo) error
func (*RedisStore) StoreRoom ¶ added in v0.15.5
func (s *RedisStore) StoreRoom(_ context.Context, room *livekit.Room, internal *livekit.RoomInternal) error
func (*RedisStore) UnlockRoom ¶ added in v0.15.5
func (*RedisStore) UpdateEgress ¶ added in v0.15.5
func (s *RedisStore) UpdateEgress(_ context.Context, info *livekit.EgressInfo) error
func (*RedisStore) UpdateIngress ¶ added in v1.2.0
func (s *RedisStore) UpdateIngress(ctx context.Context, info *livekit.IngressInfo) error
func (*RedisStore) UpdateIngressState ¶ added in v1.2.4
func (s *RedisStore) UpdateIngressState(ctx context.Context, ingressId string, state *livekit.IngressState) error
type RoomAllocator ¶ added in v0.13.0
type RoomAllocator interface { CreateRoom(ctx context.Context, req *livekit.CreateRoomRequest) (*livekit.Room, error) ValidateCreateRoom(ctx context.Context, roomName livekit.RoomName) error }
func NewRoomAllocator ¶ added in v0.13.0
func NewRoomAllocator(conf *config.Config, router routing.Router, rs ObjectStore) (RoomAllocator, error)
type RoomManager ¶
type RoomManager struct {
// contains filtered or unexported fields
}
RoomManager manages rooms and its interaction with participants. It's responsible for creating, deleting rooms, as well as running sessions for participants
func NewLocalRoomManager ¶ added in v0.12.4
func NewLocalRoomManager( conf *config.Config, roomStore ObjectStore, currentNode routing.LocalNode, router routing.Router, telemetry telemetry.TelemetryService, clientConfManager clientconfiguration.ClientConfigurationManager, egressLauncher rtc.EgressLauncher, versionGenerator utils.TimedVersionGenerator, ) (*RoomManager, error)
func (*RoomManager) CleanupRooms ¶
func (r *RoomManager) CleanupRooms() error
CleanupRooms cleans up after old rooms that have been around for a while
func (*RoomManager) CloseIdleRooms ¶
func (r *RoomManager) CloseIdleRooms()
func (*RoomManager) DeleteRoom ¶
DeleteRoom completely deletes all room information, including active sessions, room store, and routing info
func (*RoomManager) HasParticipants ¶ added in v0.13.0
func (r *RoomManager) HasParticipants() bool
func (*RoomManager) StartSession ¶
func (r *RoomManager) StartSession( ctx context.Context, roomName livekit.RoomName, pi routing.ParticipantInit, requestSource routing.MessageSource, responseSink routing.MessageSink, ) error
StartSession starts WebRTC session when a new participant is connected, takes place on RTC node
func (*RoomManager) Stop ¶
func (r *RoomManager) Stop()
type RoomService ¶
type RoomService struct {
// contains filtered or unexported fields
}
A rooms service that supports a single node
func NewRoomService ¶
func NewRoomService( roomConf config.RoomConfig, apiConf config.APIConfig, router routing.MessageRouter, roomAllocator RoomAllocator, serviceStore ServiceStore, egressLauncher rtc.EgressLauncher, ) (svc *RoomService, err error)
func (*RoomService) CreateRoom ¶
func (s *RoomService) CreateRoom(ctx context.Context, req *livekit.CreateRoomRequest) (*livekit.Room, error)
func (*RoomService) DeleteRoom ¶
func (s *RoomService) DeleteRoom(ctx context.Context, req *livekit.DeleteRoomRequest) (*livekit.DeleteRoomResponse, error)
func (*RoomService) GetParticipant ¶
func (s *RoomService) GetParticipant(ctx context.Context, req *livekit.RoomParticipantIdentity) (*livekit.ParticipantInfo, error)
func (*RoomService) ListParticipants ¶
func (s *RoomService) ListParticipants(ctx context.Context, req *livekit.ListParticipantsRequest) (*livekit.ListParticipantsResponse, error)
func (*RoomService) ListRooms ¶
func (s *RoomService) ListRooms(ctx context.Context, req *livekit.ListRoomsRequest) (*livekit.ListRoomsResponse, error)
func (*RoomService) MutePublishedTrack ¶
func (s *RoomService) MutePublishedTrack(ctx context.Context, req *livekit.MuteRoomTrackRequest) (*livekit.MuteRoomTrackResponse, error)
func (*RoomService) RemoveParticipant ¶
func (s *RoomService) RemoveParticipant(ctx context.Context, req *livekit.RoomParticipantIdentity) (*livekit.RemoveParticipantResponse, error)
func (*RoomService) SendData ¶ added in v0.12.2
func (s *RoomService) SendData(ctx context.Context, req *livekit.SendDataRequest) (*livekit.SendDataResponse, error)
func (*RoomService) UpdateParticipant ¶
func (s *RoomService) UpdateParticipant(ctx context.Context, req *livekit.UpdateParticipantRequest) (*livekit.ParticipantInfo, error)
func (*RoomService) UpdateRoomMetadata ¶ added in v0.13.1
func (s *RoomService) UpdateRoomMetadata(ctx context.Context, req *livekit.UpdateRoomMetadataRequest) (*livekit.Room, error)
func (*RoomService) UpdateSubscriptions ¶ added in v0.9.14
func (s *RoomService) UpdateSubscriptions(ctx context.Context, req *livekit.UpdateSubscriptionsRequest) (*livekit.UpdateSubscriptionsResponse, error)
type ServiceStore ¶ added in v0.15.5
type ServiceStore interface { LoadRoom(ctx context.Context, roomName livekit.RoomName, includeInternal bool) (*livekit.Room, *livekit.RoomInternal, error) // ListRooms returns currently active rooms. if names is not nil, it'll filter and return // only rooms that match ListRooms(ctx context.Context, roomNames []livekit.RoomName) ([]*livekit.Room, error) LoadParticipant(ctx context.Context, roomName livekit.RoomName, identity livekit.ParticipantIdentity) (*livekit.ParticipantInfo, error) ListParticipants(ctx context.Context, roomName livekit.RoomName) ([]*livekit.ParticipantInfo, error) }
type SessionHandler ¶ added in v1.4.0
type SessionHandler func( ctx context.Context, roomName livekit.RoomName, pi routing.ParticipantInit, connectionID livekit.ConnectionID, requestSource routing.MessageSource, responseSink routing.MessageSink, ) error
type SignalServer ¶ added in v1.4.0
type SignalServer struct {
// contains filtered or unexported fields
}
func NewDefaultSignalServer ¶ added in v1.4.0
func NewDefaultSignalServer( currentNode routing.LocalNode, bus psrpc.MessageBus, config config.SignalRelayConfig, router routing.Router, roomManager *RoomManager, ) (r *SignalServer, err error)
func NewSignalServer ¶ added in v1.4.0
func NewSignalServer( nodeID livekit.NodeID, region string, bus psrpc.MessageBus, config config.SignalRelayConfig, sessionHandler SessionHandler, ) (*SignalServer, error)
func (*SignalServer) Stop ¶ added in v1.4.0
func (r *SignalServer) Stop()
type StandardRoomAllocator ¶ added in v0.13.7
type StandardRoomAllocator struct {
// contains filtered or unexported fields
}
func (*StandardRoomAllocator) CreateRoom ¶ added in v0.13.7
func (r *StandardRoomAllocator) CreateRoom(ctx context.Context, req *livekit.CreateRoomRequest) (*livekit.Room, error)
CreateRoom creates a new room from a request and allocates it to a node to handle it'll also monitor its state, and cleans it up when appropriate
func (*StandardRoomAllocator) ValidateCreateRoom ¶ added in v1.3.4
type WSSignalConnection ¶
type WSSignalConnection struct {
// contains filtered or unexported fields
}
func NewWSSignalConnection ¶
func NewWSSignalConnection(conn types.WebsocketClient) *WSSignalConnection
func (*WSSignalConnection) ReadRequest ¶
func (c *WSSignalConnection) ReadRequest() (*livekit.SignalRequest, int, error)
func (*WSSignalConnection) WriteResponse ¶
func (c *WSSignalConnection) WriteResponse(msg *livekit.SignalResponse) (int, error)