rtc

Jan 3, 2025

Changes in this version

+ var ErrNoICETransport = errors.New("no ICE transport")

+ var ErrNoRemoteDescription = errors.New("no remote description")

+ var ErrNotSynchronousPeerConnectionMode = errors.New("not using synchronous peer connection mode")

+ var ErrParticipantSessionClosed = errors.New("participant session is already closed")

+ func MaybeTruncateIP(addr string) string

type ClientInfo

+ func (c ClientInfo) SupportSctpZeroChecksum() bool

type PCTransport

+ func (t *PCTransport) GetAnswer() (webrtc.SessionDescription, error)

+ func (t *PCTransport) GetRTT() (float64, bool)

type ParticipantImpl

+ func (p *ParticipantImpl) GetAnswer() (webrtc.SessionDescription, error)

+ func (p *ParticipantImpl) MetricsCollectorBatchReady(mb *livekit.MetricsBatch)

+ func (p *ParticipantImpl) MetricsCollectorTimeToCollectMetrics()

+ func (p *ParticipantImpl) MetricsReporterBatchReady(mb *livekit.MetricsBatch)

+ func (p *ParticipantImpl) Verify() bool

type ParticipantParams

+ DatachannelSlowThreshold int

+ EnableMetrics bool

+ FireOnTrackBySdp bool

+ UseOneShotSignallingMode bool

type SubscriptionManager

+ func (m *SubscriptionManager) IsTrackNameSubscribed(publisherIdentity livekit.ParticipantIdentity, trackName string) bool

type SubscriptionManagerParams

+ UseOneShotSignallingMode bool

type TransportManager

+ func (t *TransportManager) AddTrackLocal(trackLocal webrtc.TrackLocal, params types.AddTrackParams) (*webrtc.RTPSender, *webrtc.RTPTransceiver, error)

+ func (t *TransportManager) AddTransceiverFromTrackLocal(trackLocal webrtc.TrackLocal, params types.AddTrackParams) (*webrtc.RTPSender, *webrtc.RTPTransceiver, error)

+ func (t *TransportManager) GetAnswer() (webrtc.SessionDescription, error)

+ func (t *TransportManager) GetPublisherRTT() (float64, bool)

+ func (t *TransportManager) GetSubscriberRTT() (float64, bool)

+ func (t *TransportManager) RemoveTrackLocal(sender *webrtc.RTPSender) error

type TransportManagerParams

+ DatachannelSlowThreshold int

+ FireOnTrackBySdp bool

+ UseOneShotSignallingMode bool

type TransportParams

+ DatachannelMaxReceiverBufferSize int

+ DatachannelSlowThreshold int

+ FireOnTrackBySdp bool

+ UseOneShotSignallingMode bool

type WebRTCConfig

+ func (c *WebRTCConfig) UpdateCongestionControl(ccConf config.CongestionControlConfig)

Oct 19, 2024

Changes in this version

+ var ErrNoSubscribeMetricsPermission = errors.New("participant is not given permission to subscribe to metrics")

+ var OpusCodecCapability = webrtc.RTPCodecCapability

+ var RedCodecCapability = webrtc.RTPCodecCapability

+ func BroadcastMetricsForRoom(r types.Room, source types.Participant, dp *livekit.DataPacket, ...)

type DummyReceiver

+ func (d *DummyReceiver) AddOnReady(f func())

+ func (d *DummyReceiver) IsReady() bool

+ type DummyRedReceiver struct

+ func NewDummyRedReceiver(d *DummyReceiver, isRedEncoding bool) *DummyRedReceiver

+ func (d *DummyRedReceiver) AddDownTrack(track sfu.TrackSender) error

+ func (d *DummyRedReceiver) DeleteDownTrack(subscriberID livekit.ParticipantID)

+ func (d *DummyRedReceiver) ReadRTP(buf []byte, layer uint8, esn uint64) (int, error)

type PCTransport

+ func (t *PCTransport) GetICEConnectionInfo() *types.ICEConnectionInfo

type ParticipantImpl

+ func (p *ParticipantImpl) CanSubscribeMetrics() bool

+ func (p *ParticipantImpl) GetEnabledPublishCodecs() []*livekit.Codec

+ func (p *ParticipantImpl) HandleMetrics(senderParticipantID livekit.ParticipantID, metrics *livekit.MetricsBatch) error

+ func (p *ParticipantImpl) IsReconnect() bool

+ func (p *ParticipantImpl) OnMetrics(callback func(types.LocalParticipant, *livekit.DataPacket))

+ func (p *ParticipantImpl) SendRequestResponse(requestResponse *livekit.RequestResponse) error

+ func (p *ParticipantImpl) Version() utils.TimedVersion

type ParticipantParams

+ DropRemoteICECandidates bool

+ MetricConfig metric.MetricConfig

+ Reconnect bool

type SubscriberTransportHandler

+ func (h SubscriberTransportHandler) OnDataSendError(err error)

type TransportManager

+ func (t *TransportManager) GetICEConfig() *livekit.ICEConfig

+ func (t *TransportManager) GetICEConnectionInfo() []*types.ICEConnectionInfo

type TransportManagerParams

+ DataChannelStats *telemetry.BytesTrackStats

+ DropRemoteICECandidates bool

type TransportParams

+ DropRemoteICECandidates bool

type WrappedReceiver

+ func (r *WrappedReceiver) AddOnReady(f func())

Aug 11, 2024

Changes in this version

+ var ErrAttributesExceedsLimits = errors.New("attributes size exceeds limits")

+ var ErrJobShutdownTimeout = psrpc.NewErrorf(psrpc.DeadlineExceeded, "timed out waiting for agent job to shutdown")

+ var ErrMetadataExceedsLimits = errors.New("metadata size exceeds limits")

+ var ErrNameExceedsLimits = errors.New("name length exceeds limits")

+ type AgentStore interface

+ DeleteAgentDispatch func(ctx context.Context, dispatch *livekit.AgentDispatch) error

+ DeleteAgentJob func(ctx context.Context, job *livekit.Job) error

+ ListAgentDispatches func(ctx context.Context, roomName livekit.RoomName) ([]*livekit.AgentDispatch, error)

+ StoreAgentDispatch func(ctx context.Context, dispatch *livekit.AgentDispatch) error

+ StoreAgentJob func(ctx context.Context, job *livekit.Job) error

type ClientInfo

+ func (c ClientInfo) SupportErrorResponse() bool

+ func (c ClientInfo) SupportTrackSubscribedEvent() bool

type MediaTrack

+ func (t *MediaTrack) OnTrackSubscribed()

type MediaTrackParams

+ OnTrackEverSubscribed func(livekit.TrackID)

type ParticipantImpl

+ func (p *ParticipantImpl) CheckMetadataLimits(name string, metadata string, attributes map[string]string) error

+ func (p *ParticipantImpl) GetDisableSenderReportPassThrough() bool

+ func (p *ParticipantImpl) SendErrorResponse(errorResponse *livekit.ErrorResponse) error

+ func (p *ParticipantImpl) UpdateAudioTrack(update *livekit.UpdateLocalAudioTrack) error

+ func (p *ParticipantImpl) UpdateVideoTrack(update *livekit.UpdateLocalVideoTrack) error

type ParticipantParams

+ DisableSenderReportPassThrough bool

+ GetSubscriberForwarderState func(p types.LocalParticipant) (map[livekit.TrackID]*livekit.RTPForwarderState, error)

+ LimitConfig config.LimitConfig

type Room

+ func (r *Room) AddAgentDispatch(agentName string, metadata string) (*livekit.AgentDispatch, error)

+ func (r *Room) DeleteAgentDispatch(dispatchID string) (*livekit.AgentDispatch, error)

+ func (r *Room) GetAgentDispatches(dispatchID string) ([]*livekit.AgentDispatch, error)

type SubscriptionManager

+ func (m *SubscriptionManager) StopAndGetSubscribedTracksForwarderState() map[livekit.TrackID]*livekit.RTPForwarderState

type UpTrackManager

+ func (u *UpTrackManager) UpdatePublishedAudioTrack(update *livekit.UpdateLocalAudioTrack) types.MediaTrack

+ func (u *UpTrackManager) UpdatePublishedVideoTrack(update *livekit.UpdateLocalVideoTrack) types.MediaTrack

Jun 23, 2024

Changes in this version

+ var ErrAttributeExceedsLimits = errors.New("attribute size exceeds limits")

type ParticipantImpl

+ func (p *ParticipantImpl) SetAttributes(attrs map[string]string) error

type ParticipantParams

+ MaxAttributesSize uint32

Jun 16, 2024

Changes in this version

type MediaTrackParams

+ ForwardStats *sfu.ForwardStats

type ParticipantParams

+ ForwardStats *sfu.ForwardStats

Apr 26, 2024

Changes in this version

type MediaTrackReceiver

+ func (t *MediaTrackReceiver) UpdateAudioTrack(update *livekit.UpdateLocalAudioTrack)

+ func (t *MediaTrackReceiver) UpdateVideoTrack(update *livekit.UpdateLocalVideoTrack)

type ParticipantImpl

+ func (p *ParticipantImpl) Disconnected() <-chan struct{}

type UpTrackManager

+ func (u *UpTrackManager) UpdateAudioTrack(update *livekit.UpdateLocalAudioTrack) error

+ func (u *UpTrackManager) UpdateVideoTrack(update *livekit.UpdateLocalVideoTrack) error

Apr 11, 2024

Changes in this version

type ParticipantImpl

+ func (p *ParticipantImpl) IsDependent() bool

+ func (p *ParticipantImpl) Kind() livekit.ParticipantInfo_Kind

+ func (p *ParticipantImpl) NotifyMigration()

type ReceiverConfig

+ PacketBufferSizeAudio int

+ PacketBufferSizeVideo int

type SubscriptionManager

+ func (m *SubscriptionManager) ReconcileAll()

Feb 17, 2024

Changes in this version

+ func IsCloseNotifySkippable(closeReason types.ParticipantCloseReason) bool

+ type AnyTransportHandler struct

+ func (h AnyTransportHandler) OnFailed(isShortLived bool)

+ func (h AnyTransportHandler) OnICECandidate(c *webrtc.ICECandidate, target livekit.SignalTarget) error

+ func (h AnyTransportHandler) OnNegotiationFailed()

type MediaTrackParams

+ OnRTCP func([]rtcp.Packet)

type ParticipantImpl

+ func (p *ParticipantImpl) CloseReason() types.ParticipantCloseReason

type ParticipantParams

+ GetRegionSettings func(ip string) *livekit.RegionSettings

+ SessionStartTime time.Time

+ type PrimaryTransportHandler struct

+ func (h PrimaryTransportHandler) OnFullyEstablished()

+ func (h PrimaryTransportHandler) OnInitialConnected()

+ type PublisherTransportHandler struct

+ func (h PublisherTransportHandler) OnAnswer(sd webrtc.SessionDescription) error

+ func (h PublisherTransportHandler) OnDataPacket(kind livekit.DataPacket_Kind, data []byte)

+ func (h PublisherTransportHandler) OnInitialConnected()

+ func (h PublisherTransportHandler) OnTrack(track *webrtc.TrackRemote, rtpReceiver *webrtc.RTPReceiver)

+ type SubscriberTransportHandler struct

+ func (h SubscriberTransportHandler) OnInitialConnected()

+ func (h SubscriberTransportHandler) OnOffer(sd webrtc.SessionDescription) error

+ func (h SubscriberTransportHandler) OnStreamStateChange(update *streamallocator.StreamStateUpdate) error

type TransportManager

+ func (t *TransportManager) HandleReceiverReport(dt *sfu.DownTrack, report *rtcp.ReceiverReport)

type TransportManagerParams

+ PublisherHandler transport.Handler

+ SubscriberHandler transport.Handler

+ Twcc *twcc.Responder

+ type TransportManagerPublisherTransportHandler struct

+ func (h TransportManagerPublisherTransportHandler) OnAnswer(sd webrtc.SessionDescription) error

+ type TransportManagerTransportHandler struct

+ func (h TransportManagerTransportHandler) OnFailed(isShortLived bool)

type TransportParams

+ Handler transport.Handler

+ Twcc *lktwcc.Responder

Dec 22, 2023

Changes in this version

type DummyReceiver

+ func (d *DummyReceiver) GetTrackStats() *livekit.RTPStats

+ func (d *DummyReceiver) UpdateTrackInfo(ti *livekit.TrackInfo)

type MediaTrack

+ func (t *MediaTrack) UpdateCodecCid(codecs []*livekit.SimulcastCodec)

type MediaTrackReceiver

+ func (t *MediaTrackReceiver) GetTrackStats() *livekit.RTPStats

+ func (t *MediaTrackReceiver) NotifyMaxLayerChange(maxLayer int32)

+ func (t *MediaTrackReceiver) TrackInfoClone() *livekit.TrackInfo

+ func (t *MediaTrackReceiver) UpdateCodecCid(codecs []*livekit.SimulcastCodec)

type PCTransport

+ func (t *PCTransport) GetICEConnectionDetails() *types.ICEConnectionDetails

type ParticipantImpl

+ func (p *ParticipantImpl) HasConnected() bool

type ParticipantParams

+ DisableSupervisor bool

+ type ParticipantTrafficLoad struct

+ func NewParticipantTrafficLoad(params ParticipantTrafficLoadParams) *ParticipantTrafficLoad

+ func (p *ParticipantTrafficLoad) Close()

+ func (p *ParticipantTrafficLoad) GetTrafficLoad() *types.TrafficLoad

+ func (p *ParticipantTrafficLoad) OnTrafficLoad(f func(trafficLoad *types.TrafficLoad))

+ type ParticipantTrafficLoadParams struct

+ DataChannelStats *telemetry.BytesTrackStats

+ Logger logger.Logger

+ Participant *ParticipantImpl

type Room

+ func (r *Room) GetParticipantCount() int

type TransportManager

+ func (t *TransportManager) GetICEConnectionDetails() []*types.ICEConnectionDetails

type TransportParams

+ Transport livekit.SignalTarget

Nov 9, 2023

Changes in this version

+ const PublisherAgentTopic

+ const RoomAgentTopic

+ var ErrDataChannelBufferFull = errors.New("data channel buffer is full")

+ var ErrInternalError = errors.New("internal error")

+ func NewMockParticipant(identity livekit.ParticipantIdentity, protocol types.ProtocolVersion, ...) *typesfakes.FakeLocalParticipant

+ func NewMockTrack(kind livekit.TrackType, name string) *typesfakes.FakeMediaTrack

+ type AgentClient interface

+ CheckEnabled func(ctx context.Context, req *rpc.CheckEnabledRequest) *rpc.CheckEnabledResponse

+ JobRequest func(ctx context.Context, job *livekit.Job)

+ func NewAgentClient(bus psrpc.MessageBus) (AgentClient, error)

type ClientInfo

+ func (c ClientInfo) ComplyWithCodecOrderInSDPAnswer() bool

type ParticipantImpl

+ func (p *ParticipantImpl) IsAgent() bool

type ParticipantParams

+ DataChannelMaxBufferedAmount uint64

+ PublishEnabledCodecs []*livekit.Codec

+ SubscribeEnabledCodecs []*livekit.Codec

type TransportManagerParams

+ DataChannelMaxBufferedAmount uint64

+ EnabledPublishCodecs []*livekit.Codec

+ EnabledSubscribeCodecs []*livekit.Codec

type TransportParams

+ DataChannelMaxBufferedAmount uint64

Oct 16, 2023

Changes in this version

+ const PingIntervalSeconds

+ const PingTimeoutSeconds

+ var ErrTransportFailure = errors.New("transport failure")

+ func StartParticipantEgress(ctx context.Context, launcher EgressLauncher, ts telemetry.TelemetryService, ...) error

type ParticipantImpl

+ func (p *ParticipantImpl) GetPendingTrack(trackID livekit.TrackID) *livekit.TrackInfo

+ func (p *ParticipantImpl) SupportsSyncStreamID() bool

+ func (p *ParticipantImpl) SupportsTransceiverReuse() bool

type ParticipantParams

+ ReconnectOnDataChannelError bool

+ SyncStreams bool

type UpTrackManager

+ func (u *UpTrackManager) GetAudioLevel() (level float64, active bool)

Aug 23, 2023

Changes in this version

+ var ErrIceRestartOnClosedPeerConnection = errors.New("ICE restart on closed peer connection")

+ func PackSyncStreamID(participantID livekit.ParticipantID, stream string) string

+ func StreamFromTrackSource(source livekit.TrackSource) string

type DummyReceiver

+ func (d *DummyReceiver) GetCalculatedClockRate(layer int32) uint32

type MediaTrackReceiver

+ func (t *MediaTrackReceiver) IsEncrypted() bool

+ func (t *MediaTrackReceiver) Stream() string

type ParticipantImpl

+ func (p *ParticipantImpl) GetPlayoutDelayConfig() *livekit.PlayoutDelay

+ func (p *ParticipantImpl) GetTrailer() []byte

+ func (p *ParticipantImpl) HandleSignalSourceClose()

+ func (p *ParticipantImpl) SupportSyncStreamID() bool

type ParticipantParams

+ PlayoutDelay *livekit.PlayoutDelay

+ Trailer []byte

type Room

+ func (r *Room) Trailer() []byte

type TransportManagerParams

+ AllowPlayoutDelay bool

type TransportParams

+ AllowPlayoutDelay bool

Jul 9, 2023

Changes in this version

type PCTransport

+ func (t *PCTransport) GetPacer() pacer.Pacer

type ParticipantImpl

+ func (p *ParticipantImpl) GetClientInfo() *livekit.ClientInfo

+ func (p *ParticipantImpl) GetPacer() pacer.Pacer

type TransportManager

+ func (t *TransportManager) GetSubscriberPacer() pacer.Pacer

type WrappedReceiver

+ func (r *WrappedReceiver) DeleteDownTrack(participantID livekit.ParticipantID)

May 10, 2023

Changes in this version

+ var ErrSubscriptionLimitExceeded = errors.New("participant has exceeded its subscription limit")

+ func IsCodecEnabled(codecs []*livekit.Codec, cap webrtc.RTPCodecCapability) bool

type PCTransport

+ func (t *PCTransport) SetAllowPauseOfStreamAllocator(allowPause bool)

+ func (t *PCTransport) SetChannelCapacityOfStreamAllocator(channelCapacity int64)

type ParticipantImpl

+ func (p *ParticipantImpl) CanPublishSource(source livekit.TrackSource) bool

+ func (p *ParticipantImpl) CanSkipBroadcast() bool

+ func (p *ParticipantImpl) GetAllowTimestampAdjustment() bool

+ func (p *ParticipantImpl) HandleReconnectAndSendResponse(reconnectReason livekit.ReconnectReason, ...) error

+ func (p *ParticipantImpl) ToProtoWithVersion() (*livekit.ParticipantInfo, utils.TimedVersion)

type ParticipantParams

+ AllowTimestampAdjustment bool

+ AllowUDPUnstableFallback bool

+ SubscriberAllowPause bool

+ SubscriptionLimitAudio int32

+ SubscriptionLimitVideo int32

type Room

+ func (r *Room) OnRoomUpdated(f func())

+ func (r *Room) UpdateParticipantMetadata(participant types.LocalParticipant, name string, metadata string)

type SubscriptionManagerParams

+ SubscriptionLimitAudio int32

+ SubscriptionLimitVideo int32

type TransportManager

+ func (t *TransportManager) HandleClientReconnect(reason livekit.ReconnectReason)

+ func (t *TransportManager) HasPublisherEverConnected() bool

+ func (t *TransportManager) SetSubscriberAllowPause(allowPause bool)

+ func (t *TransportManager) SetSubscriberChannelCapacity(channelCapacity int64)

type TransportManagerParams

+ AllowUDPUnstableFallback bool

Mar 31, 2023

Changes in this version

+ var RoomDepartureGrace uint32 = 20

type MediaTrack

+ func (t *MediaTrack) GetConnectionScoreAndQuality() (float32, livekit.ConnectionQuality)

type MediaTrackReceiverParams

+ AudioConfig config.AudioConfig

type PCTransport

+ func (t *PCTransport) IsShortConnection(at time.Time) (bool, time.Duration)

type ParticipantParams

+ TCPFallbackRTTThreshold int

type Room

+ func (r *Room) GetParticipantRequestSource(identity livekit.ParticipantIdentity) routing.MessageSource

+ func (r *Room) ReplaceParticipantRequestSource(identity livekit.ParticipantIdentity, reqSource routing.MessageSource)

type SubscriptionManagerParams

+ OnSubscriptionError func(trackID livekit.TrackID)

type TransportManager

+ func (t *TransportManager) LastSeenSignalAt() time.Time

+ func (t *TransportManager) SetSignalSourceValid(valid bool)

type TransportManagerParams

+ TCPFallbackRTTThreshold int

Feb 26, 2023

Changes in this version

+ func BroadcastDataPacketForRoom(r types.Room, source types.LocalParticipant, dp *livekit.DataPacket, ...)

type DirectionConfig

+ StrictACKs bool

type DummyReceiver

+ func (d *DummyReceiver) IsClosed() bool

type MediaTrackReceiver

+ func (t *MediaTrackReceiver) IsOpen() bool

+ func (t *MediaTrackReceiver) SetClosing()

type PCTransport

+ func (t *PCTransport) SetSignalingRTT(rtt uint32)

type ParticipantImpl

+ func (p *ParticipantImpl) OnMigrateStateChange(callback func(p types.LocalParticipant, state types.MigrateState))

type Room

+ func (r *Room) GetLocalParticipants() []types.LocalParticipant

type TransportManager

+ func (t *TransportManager) SinceLastSignal() time.Duration

Feb 10, 2023

Changes in this version

+ var ErrNoSubscribePermission = errors.New("participant is not given permission to subscribe to tracks")

+ var ErrNoTrackPermission = errors.New("participant is not allowed to subscribe to this track")

+ var ErrTrackNotAttached = errors.New("track is not yet attached")

+ var ErrTrackNotBound = errors.New("track not bound")

+ var ErrTrackNotFound = errors.New("track cannot be found")

type ClientInfo

+ func (c ClientInfo) CanHandleReconnectResponse() bool

+ func (c ClientInfo) SupportsChangeRTPSenderEncodingActive() bool

type DummyReceiver

+ func (d *DummyReceiver) GetRTCPSenderReportDataExt(layer int32) *buffer.RTCPSenderReportDataExt

type EgressLauncher

+ StartEgressWithClusterId func(ctx context.Context, clusterId string, req *livekit.StartEgressRequest) (*livekit.EgressInfo, error)

type PCTransport

+ func (t *PCTransport) ResetShortConnOnICERestart()

type ParticipantImpl

+ func (p *ParticipantImpl) IsClosed() bool

+ func (p *ParticipantImpl) IsIdle() bool

+ func (p *ParticipantImpl) IssueFullReconnect(reason types.ParticipantCloseReason)

+ func (p *ParticipantImpl) OnTrackUnpublished(callback func(types.LocalParticipant, types.MediaTrack))

+ func (p *ParticipantImpl) SendReconnectResponse(reconnectResponse *livekit.ReconnectResponse) error

+ func (p *ParticipantImpl) UpdateMediaRTT(rtt uint32)

type ParticipantParams

+ DisableDynacast bool

+ TrackResolver types.MediaTrackResolver

+ VersionGenerator utils2.TimedVersionGenerator

type Room

+ func (r *Room) GetParticipantByID(participantID livekit.ParticipantID) types.LocalParticipant

+ func (r *Room) ResolveMediaTrackForSubscriber(subIdentity livekit.ParticipantIdentity, trackID livekit.TrackID) types.MediaResolverResult

+ type RoomTrackManager struct

+ func NewRoomTrackManager() *RoomTrackManager

+ func (r *RoomTrackManager) AddTrack(track types.MediaTrack, publisherIdentity livekit.ParticipantIdentity, ...)

+ func (r *RoomTrackManager) GetOrCreateTrackChangeNotifier(trackID livekit.TrackID) *utils.ChangeNotifier

+ func (r *RoomTrackManager) GetOrCreateTrackRemoveNotifier(trackID livekit.TrackID) *utils.ChangeNotifier

+ func (r *RoomTrackManager) GetTrackInfo(trackID livekit.TrackID) *TrackInfo

+ func (r *RoomTrackManager) HasObservers(track types.MediaTrack) bool

+ func (r *RoomTrackManager) NotifyTrackChanged(trackID livekit.TrackID)

+ func (r *RoomTrackManager) RemoveTrack(track types.MediaTrack)

type SubscribedTrack

+ func (t *SubscribedTrack) AddOnBind(f func())

+ func (t *SubscribedTrack) Close(willBeResumed bool)

+ func (t *SubscribedTrack) IsBound() bool

+ func (t *SubscribedTrack) NeedsNegotiation() bool

+ func (t *SubscribedTrack) OnClose(f func(bool))

+ func (t *SubscribedTrack) RTPSender() *webrtc.RTPSender

+ func (t *SubscribedTrack) SetNeedsNegotiation(needs bool)

+ func (t *SubscribedTrack) SetRTPSender(sender *webrtc.RTPSender)

+ type SubscriptionManager struct

+ func NewSubscriptionManager(params SubscriptionManagerParams) *SubscriptionManager

+ func (m *SubscriptionManager) Close(willBeResumed bool)

+ func (m *SubscriptionManager) GetSubscribedParticipants() []livekit.ParticipantID

+ func (m *SubscriptionManager) GetSubscribedTracks() []types.SubscribedTrack

+ func (m *SubscriptionManager) HasSubscriptions() bool

+ func (m *SubscriptionManager) IsSubscribedTo(participantID livekit.ParticipantID) bool

+ func (m *SubscriptionManager) OnSubscribeStatusChanged(fn func(publisherID livekit.ParticipantID, subscribed bool))

+ func (m *SubscriptionManager) SubscribeToTrack(trackID livekit.TrackID)

+ func (m *SubscriptionManager) UnsubscribeFromTrack(trackID livekit.TrackID)

+ func (m *SubscriptionManager) UpdateSubscribedTrackSettings(trackID livekit.TrackID, settings *livekit.UpdateTrackSettings)

+ func (m *SubscriptionManager) WaitUntilSubscribed(timeout time.Duration) error

+ type SubscriptionManagerParams struct

+ Logger logger.Logger

+ OnSubcriptionError func(trackID livekit.TrackID)

+ OnTrackSubscribed func(subTrack types.SubscribedTrack)

+ OnTrackUnsubscribed func(subTrack types.SubscribedTrack)

+ Participant types.LocalParticipant

+ Telemetry telemetry.TelemetryService

+ TrackResolver types.MediaTrackResolver

+ type TrackInfo struct

+ PublisherID livekit.ParticipantID

+ PublisherIdentity livekit.ParticipantIdentity

+ Track types.MediaTrack

type TransportManager

+ func (t *TransportManager) UpdateLastSeenSignal()

+ func (t *TransportManager) UpdateMediaRTT(rtt uint32)

+ func (t *TransportManager) UpdateSignalingRTT(rtt uint32)

type UpTrackManager

+ func (u *UpTrackManager) HasPermission(trackID livekit.TrackID, subIdentity livekit.ParticipantIdentity) bool

type UpTrackManagerParams

+ VersionGenerator utils.TimedVersionGenerator

type WebRTCConfig

+ UseMDNS bool

Jan 8, 2023

Changes in this version

type ClientInfo

+ func (c ClientInfo) FireTrackByRTPPacket() bool

type DummyReceiver

+ func (d *DummyReceiver) GetRTCPSenderReportData(layer int32) *buffer.RTCPSenderReportData

+ func (d *DummyReceiver) GetReferenceLayerRTPTimestamp(ts uint32, layer int32, referenceLayer int32) (uint32, error)

type ParticipantImpl

+ func (p *ParticipantImpl) IsDisconnected() bool

type ParticipantParams

+ ReconnectOnSubscriptionError bool

type WebRTCConfig

+ NAT1To1IPs []string

Dec 16, 2022

Changes in this version

type ClientInfo

+ func (c ClientInfo) SupportPrflxOverRelay() bool

type ParticipantImpl

+ func (p *ParticipantImpl) GetBufferFactory() *buffer.Factory

+ func (p *ParticipantImpl) SetName(name string)

type ParticipantParams

+ ReconnectOnPublicationError bool

type WebRTCConfig

+ ExternalIP string

Nov 8, 2022

Changes in this version

+ func IPFilterFromConf(ips config.IPsConfig) (func(ip net.IP) bool, error)

+ func InterfaceFilterFromConf(ifs config.InterfacesConfig) func(string) bool

type DummyReceiver

+ func (d *DummyReceiver) GetRedReceiver() sfu.TrackReceiver

+ func (d *DummyReceiver) GetTemporalLayerFpsForSpatial(spatial int32) []float32

type MediaTrackReceiver

+ func (t *MediaTrackReceiver) GetTemporalLayerForSpatialFps(spatial int32, fps uint32, mime string) int32

type ParticipantImpl

+ func (p *ParticipantImpl) VerifySubscribeParticipantInfo(pID livekit.ParticipantID, version uint32)

type ParticipantParams

+ GetParticipantInfo func(pID livekit.ParticipantID) *livekit.ParticipantInfo

type TransportManager

+ func (t *TransportManager) GetUnmatchMediaForOffer(offer webrtc.SessionDescription, mediaType string) (parsed *sdp.SessionDescription, unmatched []*sdp.MediaDescription, err error)

+ func (t *TransportManager) OnReceiverReport(dt *sfu.DownTrack, report *rtcp.ReceiverReport)

+ func (t *TransportManager) UpdateRTT(rtt uint32, isUDP bool)

+ type WrappedReceiverParams struct

+ DisableRed bool

+ Logger logger.Logger

+ Receivers []*simulcastReceiver

+ StreamId string

+ TrackID livekit.TrackID

+ UpstreamCodecs []webrtc.RTPCodecParameters

Oct 20, 2022

Changes in this version

type TransportManager

+ func (t *TransportManager) LastPublisherOffer() webrtc.SessionDescription

Oct 13, 2022

Changes in this version

+ var ErrNotOpen = errors.New("track is not open")

type DummyReceiver

+ func (d *DummyReceiver) GetLayeredBitrate() sfu.Bitrates

type MediaTrackReceiverParams

+ IsRelayed bool

type MediaTrackSubscriptionsParams

+ IsRelayed bool

Sep 26, 2022

Changes in this version

+ func StartTrackEgress(ctx context.Context, launcher EgressLauncher, ts telemetry.TelemetryService, ...) error

+ type EgressLauncher interface

+ StartEgress func(context.Context, *livekit.StartEgressRequest) (*livekit.EgressInfo, error)

type Room

+ func (r *Room) Internal() *livekit.RoomInternal

Sep 13, 2022

Changes in this version

+ var ErrMidNotFound = errors.New("mid not found")

type ClientInfo

+ func (c ClientInfo) CompareVersion(version string) int

+ func (c ClientInfo) SupportsICETCP() bool

type PCTransport

+ func (t *PCTransport) GetICEConnectionType() types.ICEConnectionType

+ func (t *PCTransport) SetPreviousSdp(offer, answer *webrtc.SessionDescription)

type ParticipantImpl

+ func (p *ParticipantImpl) GetICEConnectionType() types.ICEConnectionType

+ func (p *ParticipantImpl) MaybeStartMigration(force bool, onStart func()) bool

type ParticipantParams

+ TURNSEnabled bool

type TransportManager

+ func (t *TransportManager) GetICEConnectionType() types.ICEConnectionType

+ func (t *TransportManager) HaveAllTransportEverConnected() bool

+ func (t *TransportManager) SubscriberClose()

type TransportManagerParams

+ TURNSEnabled bool

Aug 26, 2022

Changes in this version

+ var ErrClosingOrClosed = errors.New("track is closing or closed")

+ var ErrNoAnswerHandler = errors.New("no answer handler")

+ var ErrNoICECandidateHandler = errors.New("no ICE candidate handler")

+ var ErrNoOfferHandler = errors.New("no offer handler")

+ var ErrNoSender = errors.New("no sender")

+ var ErrNoTransceiver = errors.New("no transceiver")

+ type ClientInfo struct

+ func (c ClientInfo) SupportsAudioRED() bool

type DummyReceiver

+ func (d *DummyReceiver) GetPrimaryReceiverForRed() sfu.TrackReceiver

+ func (d *DummyReceiver) TrackInfo() *livekit.TrackInfo

+ type DynacastManager struct

+ func NewDynacastManager(params DynacastManagerParams) *DynacastManager

+ func (d *DynacastManager) AddCodec(mime string)

+ func (d *DynacastManager) Close()

+ func (d *DynacastManager) ForceQuality(quality livekit.VideoQuality)

+ func (d *DynacastManager) ForceUpdate()

+ func (d *DynacastManager) NotifySubscriberMaxQuality(subscriberID livekit.ParticipantID, mime string, quality livekit.VideoQuality)

+ func (d *DynacastManager) NotifySubscriberNodeMaxQuality(nodeID livekit.NodeID, qualities []types.SubscribedCodecQuality)

+ func (d *DynacastManager) OnSubscribedMaxQualityChange(f func(subscribedQualities []*livekit.SubscribedCodec, ...))

+ func (d *DynacastManager) Restart()

+ type DynacastManagerParams struct

+ DynacastPauseDelay time.Duration

+ Logger logger.Logger

+ type DynacastQuality struct

+ func NewDynacastQuality(params DynacastQualityParams) *DynacastQuality

+ func (d *DynacastQuality) NotifySubscriberMaxQuality(subscriberID livekit.ParticipantID, quality livekit.VideoQuality)

+ func (d *DynacastQuality) NotifySubscriberNodeMaxQuality(nodeID livekit.NodeID, quality livekit.VideoQuality)

+ func (d *DynacastQuality) OnSubscribedMaxQualityChange(f func(maxSubscribedQuality livekit.VideoQuality))

+ func (d *DynacastQuality) Restart()

+ func (d *DynacastQuality) Start()

+ func (d *DynacastQuality) Stop()

+ type DynacastQualityParams struct

+ DynacastPauseDelay time.Duration

+ Logger logger.Logger

+ MimeType string

+ type MediaLossProxy struct

+ func NewMediaLossProxy(params MediaLossProxyParams) *MediaLossProxy

+ func (m *MediaLossProxy) HandleMaxLossFeedback(_ *sfu.DownTrack, report *rtcp.ReceiverReport)

+ func (m *MediaLossProxy) NotifySubscriberNodeMediaLoss(_nodeID livekit.NodeID, fractionalLoss uint8)

+ func (m *MediaLossProxy) OnMediaLossUpdate(f func(fractionalLoss uint8))

+ type MediaLossProxyParams struct

+ Logger logger.Logger

type MediaTrack

+ func (t *MediaTrack) Close()

+ func (t *MediaTrack) NotifySubscriberNodeMaxQuality(nodeID livekit.NodeID, qualities []types.SubscribedCodecQuality)

+ func (t *MediaTrack) Restart()

type MediaTrackReceiver

+ func (t *MediaTrackReceiver) InitiateClose(willBeResumed bool)

+ func (t *MediaTrackReceiver) OnMediaLossFeedback(f func(dt *sfu.DownTrack, rr *rtcp.ReceiverReport))

+ func (t *MediaTrackReceiver) OnSetupReceiver(f func(mime string))

type MediaTrackSubscriptions

+ func (t *MediaTrackSubscriptions) GetAllSubscribersForMime(mime string) []livekit.ParticipantID

+ func (t *MediaTrackSubscriptions) OnSubscriberMaxQualityChange(...)

+ type NegotiationState int

+ const NegotiationStateNone

+ const NegotiationStateRemote

+ const NegotiationStateRetry

+ func (n NegotiationState) String() string

type PCTransport

+ func (t *PCTransport) AddNegotiationPending(publisherID livekit.ParticipantID)

+ func (t *PCTransport) AddTrackToStreamAllocator(subTrack types.SubscribedTrack)

+ func (t *PCTransport) AddTransceiverFromTrack(trackLocal webrtc.TrackLocal) (sender *webrtc.RTPSender, transceiver *webrtc.RTPTransceiver, err error)

+ func (t *PCTransport) CreateDataChannel(label string, dci *webrtc.DataChannelInit) error

+ func (t *PCTransport) CreateDataChannelIfEmpty(dcLabel string, dci *webrtc.DataChannelInit) (label string, id uint16, existing bool, err error)

+ func (t *PCTransport) GetMid(rtpReceiver *webrtc.RTPReceiver) string

+ func (t *PCTransport) GetRTPReceiver(mid string) *webrtc.RTPReceiver

+ func (t *PCTransport) HandleRemoteDescription(sd webrtc.SessionDescription)

+ func (t *PCTransport) HasEverConnected() bool

+ func (t *PCTransport) ICERestart()

+ func (t *PCTransport) IsNegotiationPending(publisherID livekit.ParticipantID) bool

+ func (t *PCTransport) OnAnswer(f func(sd webrtc.SessionDescription) error)

+ func (t *PCTransport) OnDataPacket(f func(kind livekit.DataPacket_Kind, data []byte))

+ func (t *PCTransport) OnFailed(f func(isShortLived bool))

+ func (t *PCTransport) OnFullyEstablished(f func())

+ func (t *PCTransport) OnGetDTX(f func() bool)

+ func (t *PCTransport) OnICECandidate(f func(c *webrtc.ICECandidate) error)

+ func (t *PCTransport) OnInitialConnected(f func())

+ func (t *PCTransport) OnNegotiationStateChanged(f func(state NegotiationState))

+ func (t *PCTransport) OnTrack(f func(track *webrtc.TrackRemote, rtpReceiver *webrtc.RTPReceiver))

+ func (t *PCTransport) RemoveTrackFromStreamAllocator(subTrack types.SubscribedTrack)

+ func (t *PCTransport) SendDataPacket(dp *livekit.DataPacket) error

+ func (t *PCTransport) SetPreferTCP(preferTCP bool)

+ func (t *PCTransport) WriteRTCP(pkts []rtcp.Packet) error

type ParticipantImpl

+ func (p *ParticipantImpl) CloseSignalConnection()

+ func (p *ParticipantImpl) GetClientConfiguration() *livekit.ClientConfiguration

+ func (p *ParticipantImpl) OnICEConfigChanged(f func(participant types.LocalParticipant, iceConfig types.IceConfig))

+ func (p *ParticipantImpl) UpdateMediaLoss(nodeID livekit.NodeID, trackID livekit.TrackID, fractionalLoss uint32) error

+ func (p *ParticipantImpl) UpdateSubscribedQuality(nodeID livekit.NodeID, trackID livekit.TrackID, ...) error

type ParticipantParams

+ AllowTCPFallback bool

+ ClientInfo ClientInfo

+ type TransportManager struct

+ func NewTransportManager(params TransportManagerParams) (*TransportManager, error)

+ func (t *TransportManager) AddICECandidate(candidate webrtc.ICECandidateInit, target livekit.SignalTarget)

+ func (t *TransportManager) AddNegotiationPending(publisherID livekit.ParticipantID)

+ func (t *TransportManager) AddSubscribedTrack(subTrack types.SubscribedTrack)

+ func (t *TransportManager) AddTrackToSubscriber(trackLocal webrtc.TrackLocal) (*webrtc.RTPSender, *webrtc.RTPTransceiver, error)

+ func (t *TransportManager) AddTransceiverFromTrackToSubscriber(trackLocal webrtc.TrackLocal) (*webrtc.RTPSender, *webrtc.RTPTransceiver, error)

+ func (t *TransportManager) Close()

+ func (t *TransportManager) GetLastUnmatchedMediaForOffer(offer webrtc.SessionDescription, mediaType string) (parsed *sdp.SessionDescription, unmatched *sdp.MediaDescription, err error)

+ func (t *TransportManager) GetPublisherMid(rtpReceiver *webrtc.RTPReceiver) string

+ func (t *TransportManager) GetPublisherRTPReceiver(mid string) *webrtc.RTPReceiver

+ func (t *TransportManager) HandleAnswer(answer webrtc.SessionDescription)

+ func (t *TransportManager) HandleOffer(offer webrtc.SessionDescription, shouldPend bool)

+ func (t *TransportManager) HasSubscriberEverConnected() bool

+ func (t *TransportManager) ICERestart(iceConfig *types.IceConfig)

+ func (t *TransportManager) IsNegotiationPending(publisherID livekit.ParticipantID) bool

+ func (t *TransportManager) IsPublisherEstablished() bool

+ func (t *TransportManager) NegotiateSubscriber(force bool)

+ func (t *TransportManager) OnAnyTransportFailed(f func())

+ func (t *TransportManager) OnAnyTransportNegotiationFailed(f func())

+ func (t *TransportManager) OnDataMessage(f func(kind livekit.DataPacket_Kind, data []byte))

+ func (t *TransportManager) OnICEConfigChanged(f func(iceConfig types.IceConfig))

+ func (t *TransportManager) OnPrimaryTransportFullyEstablished(f func())

+ func (t *TransportManager) OnPrimaryTransportInitialConnected(f func())

+ func (t *TransportManager) OnPublisherAnswer(f func(answer webrtc.SessionDescription) error)

+ func (t *TransportManager) OnPublisherGetDTX(f func() bool)

+ func (t *TransportManager) OnPublisherICECandidate(f func(c *webrtc.ICECandidate) error)

+ func (t *TransportManager) OnPublisherInitialConnected(f func())

+ func (t *TransportManager) OnPublisherTrack(f func(track *webrtc.TrackRemote, rtpReceiver *webrtc.RTPReceiver))

+ func (t *TransportManager) OnSubscriberICECandidate(f func(c *webrtc.ICECandidate) error)

+ func (t *TransportManager) OnSubscriberInitialConnected(f func())

+ func (t *TransportManager) OnSubscriberOffer(f func(offer webrtc.SessionDescription) error)

+ func (t *TransportManager) OnSubscriberStreamStateChange(f func(update *sfu.StreamStateUpdate) error)

+ func (t *TransportManager) ProcessPendingPublisherDataChannels()

+ func (t *TransportManager) ProcessPendingPublisherOffer()

+ func (t *TransportManager) RemoveSubscribedTrack(subTrack types.SubscribedTrack)

+ func (t *TransportManager) RemoveTrackFromSubscriber(sender *webrtc.RTPSender) error

+ func (t *TransportManager) SendDataPacket(dp *livekit.DataPacket) error

+ func (t *TransportManager) SetICEConfig(iceConfig types.IceConfig)

+ func (t *TransportManager) SetMigrateInfo(previousAnswer *webrtc.SessionDescription, ...)

+ func (t *TransportManager) SubscriberAsPrimary() bool

+ func (t *TransportManager) WritePublisherRTCP(pkts []rtcp.Packet) error

+ func (t *TransportManager) WriteSubscriberRTCP(pkts []rtcp.Packet) error

+ type TransportManagerParams struct

+ AllowTCPFallback bool

+ ClientConf *livekit.ClientConfiguration

+ ClientInfo ClientInfo

+ Config *WebRTCConfig

+ CongestionControlConfig config.CongestionControlConfig

+ EnabledCodecs []*livekit.Codec

+ Identity livekit.ParticipantIdentity

+ Logger logger.Logger

+ Migration bool

+ ProtocolVersion types.ProtocolVersion

+ SID livekit.ParticipantID

+ SimTracks map[uint32]SimulcastTrackInfo

+ SubscriberAsPrimary bool

+ Telemetry telemetry.TelemetryService

type TransportParams

+ ClientInfo ClientInfo

+ DirectionConfig DirectionConfig

+ IsOfferer bool

+ IsSendSide bool

Jul 8, 2022

Changes in this version

+ var ErrIceRestartWithoutLocalSDP = errors.New("ICE restart without local SDP settled")

+ var ErrNoReceiver = errors.New("cannot subscribe without a receiver in place")

+ type DummyReceiver struct

+ func NewDummyReceiver(trackID livekit.TrackID, streamId string, codec webrtc.RTPCodecParameters, ...) *DummyReceiver

+ func (d *DummyReceiver) AddDownTrack(track sfu.TrackSender) error

+ func (d *DummyReceiver) Codec() webrtc.RTPCodecParameters

+ func (d *DummyReceiver) DebugInfo() map[string]interface{}

+ func (d *DummyReceiver) DeleteDownTrack(participantID livekit.ParticipantID)

+ func (d *DummyReceiver) GetAudioLevel() (float64, bool)

+ func (d *DummyReceiver) GetBitrateTemporalCumulative() sfu.Bitrates

+ func (d *DummyReceiver) GetLayerDimension(quality int32) (uint32, uint32)

+ func (d *DummyReceiver) HeaderExtensions() []webrtc.RTPHeaderExtensionParameter

+ func (d *DummyReceiver) IsDtxDisabled() bool

+ func (d *DummyReceiver) ReadRTP(buf []byte, layer uint8, sn uint16) (int, error)

+ func (d *DummyReceiver) Receiver() sfu.TrackReceiver

+ func (d *DummyReceiver) SendPLI(layer int32, force bool)

+ func (d *DummyReceiver) SetMaxExpectedSpatialLayer(layer int32)

+ func (d *DummyReceiver) SetUpTrackPaused(paused bool)

+ func (d *DummyReceiver) StreamID() string

+ func (d *DummyReceiver) TrackID() livekit.TrackID

+ func (d *DummyReceiver) TrackSource() livekit.TrackSource

+ func (d *DummyReceiver) Upgrade(receiver sfu.TrackReceiver)

type MediaTrackParams

+ ParticipantVersion uint32

type MediaTrackReceiver

+ func (t *MediaTrackReceiver) IsSubscribed() bool

+ func (t *MediaTrackReceiver) PublisherVersion() uint32

+ func (t *MediaTrackReceiver) RemoveAllSubscribers(willBeResumed bool)

+ func (t *MediaTrackReceiver) RemoveSubscriber(subscriberID livekit.ParticipantID, willBeResumed bool)

+ func (t *MediaTrackReceiver) RevokeDisallowedSubscribers(allowedSubscriberIdentities []livekit.ParticipantIdentity) []livekit.ParticipantIdentity

type MediaTrackReceiverParams

+ ParticipantVersion uint32

type MediaTrackSubscriptions

+ func (t *MediaTrackSubscriptions) GetNumSubscribers() int

+ func (t *MediaTrackSubscriptions) OnDownTrackCreated(f func(downTrack *sfu.DownTrack))

+ func (t *MediaTrackSubscriptions) OnSubscriptionOperationComplete(f func(sub types.LocalParticipant))

+ func (t *MediaTrackSubscriptions) Stop()

type PCTransport

+ func (t *PCTransport) OnNegotiationFailed(f func())

type ParticipantImpl

+ func (p *ParticipantImpl) CacheDownTrack(trackID livekit.TrackID, rtpTransceiver *webrtc.RTPTransceiver, ...)

+ func (p *ParticipantImpl) ClearInProgressAndProcessSubscriptionRequestsQueue(trackID livekit.TrackID)

+ func (p *ParticipantImpl) EnqueueSubscribeTrack(trackID livekit.TrackID, f func(sub types.LocalParticipant) error)

+ func (p *ParticipantImpl) EnqueueUnsubscribeTrack(trackID livekit.TrackID, willBeResumed bool, ...)

+ func (p *ParticipantImpl) GetCachedDownTrack(trackID livekit.TrackID) (*webrtc.RTPTransceiver, sfu.ForwarderState)

+ func (p *ParticipantImpl) ProcessSubscriptionRequestsQueue(trackID livekit.TrackID)

+ func (p *ParticipantImpl) UncacheDownTrack(rtpTransceiver *webrtc.RTPTransceiver)

+ type SubscribeRequest struct

+ type SubscribeRequestType int

+ const SubscribeRequestTypeAdd

+ const SubscribeRequestTypeRemove

type SubscribedTrack

+ func (t *SubscribedTrack) PublisherVersion() uint32

+ func (t *SubscribedTrack) Subscriber() types.LocalParticipant

type SubscribedTrackParams

+ PublisherVersion uint32

+ Subscriber types.LocalParticipant

Jun 22, 2022

Changes in this version

+ type DumbReceiver struct

+ func NewDumbReceiver(trackID livekit.TrackID, streamId string, codec webrtc.RTPCodecParameters, ...) *DumbReceiver

+ func (d *DumbReceiver) AddDownTrack(track sfu.TrackSender) error

+ func (d *DumbReceiver) Codec() webrtc.RTPCodecParameters

+ func (d *DumbReceiver) DebugInfo() map[string]interface{}

+ func (d *DumbReceiver) DeleteDownTrack(participantID livekit.ParticipantID)

+ func (d *DumbReceiver) GetAudioLevel() (float64, bool)

+ func (d *DumbReceiver) GetBitrateTemporalCumulative() sfu.Bitrates

+ func (d *DumbReceiver) GetLayerDimension(quality int32) (uint32, uint32)

+ func (d *DumbReceiver) HeaderExtensions() []webrtc.RTPHeaderExtensionParameter

+ func (d *DumbReceiver) IsDtxDisabled() bool

+ func (d *DumbReceiver) ReadRTP(buf []byte, layer uint8, sn uint16) (int, error)

+ func (d *DumbReceiver) Receiver() sfu.TrackReceiver

+ func (d *DumbReceiver) SendPLI(layer int32, force bool)

+ func (d *DumbReceiver) SetMaxExpectedSpatialLayer(layer int32)

+ func (d *DumbReceiver) SetUpTrackPaused(paused bool)

+ func (d *DumbReceiver) StreamID() string

+ func (d *DumbReceiver) TrackID() livekit.TrackID

+ func (d *DumbReceiver) TrackSource() livekit.TrackSource

+ func (d *DumbReceiver) Upgrade(receiver sfu.TrackReceiver)

type MediaTrack

+ func (t *MediaTrack) HasPendingCodec() bool

+ func (t *MediaTrack) HasSdpCid(cid string) bool

+ func (t *MediaTrack) OnMaxLayerChange(maxLayer int32)

+ func (t *MediaTrack) SetPendingCodecSid(codecs []*livekit.SimulcastCodec)

type MediaTrackParams

+ SimTracks map[uint32]SimulcastTrackInfo

type MediaTrackReceiver

+ func (t *MediaTrackReceiver) ClearAllReceivers()

+ func (t *MediaTrackReceiver) PrimaryReceiver() sfu.TrackReceiver

+ func (t *MediaTrackReceiver) Receivers() []sfu.TrackReceiver

+ func (t *MediaTrackReceiver) SetLayerSsrc(mime string, rid string, ssrc uint32)

+ func (t *MediaTrackReceiver) SetPotentialCodecs(codecs []webrtc.RTPCodecParameters, ...)

+ func (t *MediaTrackReceiver) SetRTT(rtt uint32)

+ func (t *MediaTrackReceiver) TryClose() bool

type MediaTrackSubscriptions

+ func (t *MediaTrackSubscriptions) AddCodec(mime string)

type ParticipantImpl

+ func (p *ParticipantImpl) IsPublisher() bool

type WrappedReceiver

+ func (r *WrappedReceiver) Codecs() []webrtc.RTPCodecParameters

+ func (r *WrappedReceiver) DetermineReceiver(codec webrtc.RTPCodecCapability)

May 28, 2022

Changes in this version

type Room

+ func (r *Room) ToProto() *livekit.Room

May 18, 2022

Changes in this version

+ var ErrSubscriptionPermissionNeedsId = errors.New("either participant identity or SID needed")

+ func LoggerWithCodecMime(l logger.Logger, mime string) logger.Logger

type ParticipantImpl

+ func (p *ParticipantImpl) OnSubscribedTo(callback func(types.LocalParticipant, livekit.ParticipantID))

type SubscribedTrack

+ func (t *SubscribedTrack) SubscriberIdentity() livekit.ParticipantIdentity

type SubscribedTrackParams

+ SubscriberIdentity livekit.ParticipantIdentity

May 1, 2022

Changes in this version

type MediaTrackReceiver

+ func (t *MediaTrackReceiver) GetAudioLevel() (float64, bool)

+ func (t *MediaTrackReceiver) Restart()

type MediaTrackSubscriptions

+ func (t *MediaTrackSubscriptions) Restart()

type PCTransport

+ func (t *PCTransport) IsEstablished() bool

type ParticipantImpl

+ func (p *ParticipantImpl) GetAdaptiveStream() bool

type ParticipantParams

+ AdaptiveStream bool

+ Migration bool

+ Region string

type SubscribedTrackParams

+ AdaptiveStream bool

type UpTrackManager

+ func (u *UpTrackManager) Restart()

Mar 28, 2022

Changes in this version

+ const LossyDataChannel

+ const ReliableDataChannel

+ var ErrEmptyIdentity = errors.New("participant identity cannot be empty")

+ var ErrEmptyParticipantID = errors.New("participant ID cannot be empty")

+ var ErrMissingGrants = errors.New("VideoGrant is missing")

+ func LoggerWithPCTarget(l logger.Logger, target livekit.SignalTarget) logger.Logger

type MediaTrackParams

+ VideoConfig config.VideoConfig

type MediaTrackReceiverParams

+ VideoConfig config.VideoConfig

type MediaTrackSubscriptions

+ func (t *MediaTrackSubscriptions) GetAllSubscribers() []livekit.ParticipantID

type MediaTrackSubscriptionsParams

+ VideoConfig config.VideoConfig

type ParticipantImpl

+ func (p *ParticipantImpl) OnParticipantUpdate(callback func(types.LocalParticipant))

type ParticipantParams

+ ClientConf *livekit.ClientConfiguration

+ VideoConfig config.VideoConfig

Feb 28, 2022

Changes in this version

type ParticipantImpl

+ func (p *ParticipantImpl) SetMigrateInfo(mediaTracks []*livekit.TrackPublishedResponse, ...)

Feb 9, 2022

Changes in this version

+ func QualityForSpatialLayer(layer int32) livekit.VideoQuality

type MediaTrack

+ func (t *MediaTrack) SetRTT(rtt uint32)

type MediaTrackParams

+ PLIThrottleConfig config.PLIThrottleConfig

type MediaTrackSubscriptions

+ func (t *MediaTrackSubscriptions) ResyncAllSubscribers()

type ParticipantImpl

+ func (p *ParticipantImpl) GetLogger() logger.Logger

+ func (p *ParticipantImpl) UpdateRTT(rtt uint32)

type ParticipantParams

+ InitialVersion uint32

+ PLIThrottleConfig config.PLIThrottleConfig

type SubscribedTrack

+ func (t *SubscribedTrack) SubscriberID() livekit.ParticipantID

type TransportParams

+ ProtocolVersion types.ProtocolVersion

Jan 29, 2022

Changes in this version

+ const SilentAudioLevel

+ func LoggerWithTrack(l logger.Logger, trackID livekit.TrackID) logger.Logger

+ func VideoQualityToRID(q livekit.VideoQuality) string

type MediaTrack

+ func (t *MediaTrack) GetAudioLevel() (level uint8, active bool)

+ func (t *MediaTrack) TrySetSimulcastSSRC(layer uint8, ssrc uint32)

+ type MediaTrackReceiver struct

+ func NewMediaTrackReceiver(params MediaTrackReceiverParams) *MediaTrackReceiver

+ func (t *MediaTrackReceiver) AddOnClose(f func())

+ func (t *MediaTrackReceiver) AddSubscriber(sub types.LocalParticipant) error

+ func (t *MediaTrackReceiver) ClearReceiver()

+ func (t *MediaTrackReceiver) Close()

+ func (t *MediaTrackReceiver) DebugInfo() map[string]interface{}

+ func (t *MediaTrackReceiver) GetQualityForDimension(width, height uint32) livekit.VideoQuality

+ func (t *MediaTrackReceiver) GetVideoLayers() []*livekit.VideoLayer

+ func (t *MediaTrackReceiver) ID() livekit.TrackID

+ func (t *MediaTrackReceiver) IsMuted() bool

+ func (t *MediaTrackReceiver) IsSimulcast() bool

+ func (t *MediaTrackReceiver) Kind() livekit.TrackType

+ func (t *MediaTrackReceiver) Name() string

+ func (t *MediaTrackReceiver) NotifySubscriberNodeMediaLoss(_nodeID string, fractionalLoss uint8)

+ func (t *MediaTrackReceiver) OnMediaLossUpdate(f func(fractionalLoss uint8))

+ func (t *MediaTrackReceiver) OnSubscribedMaxQualityChange(...)

+ func (t *MediaTrackReceiver) OnVideoLayerUpdate(f func(layers []*livekit.VideoLayer))

+ func (t *MediaTrackReceiver) PublisherID() livekit.ParticipantID

+ func (t *MediaTrackReceiver) PublisherIdentity() livekit.ParticipantIdentity

+ func (t *MediaTrackReceiver) Receiver() sfu.TrackReceiver

+ func (t *MediaTrackReceiver) SetMuted(muted bool)

+ func (t *MediaTrackReceiver) SetSimulcast(simulcast bool)

+ func (t *MediaTrackReceiver) SetupReceiver(receiver sfu.TrackReceiver)

+ func (t *MediaTrackReceiver) Source() livekit.TrackSource

+ func (t *MediaTrackReceiver) TrackInfo() *livekit.TrackInfo

+ func (t *MediaTrackReceiver) UpdateTrackInfo(ti *livekit.TrackInfo)

+ func (t *MediaTrackReceiver) UpdateVideoLayers(layers []*livekit.VideoLayer)

+ type MediaTrackReceiverParams struct

+ BufferFactory *buffer.Factory

+ Logger logger.Logger

+ MediaTrack types.MediaTrack

+ ParticipantID livekit.ParticipantID

+ ParticipantIdentity livekit.ParticipantIdentity

+ ReceiverConfig ReceiverConfig

+ SubscriberConfig DirectionConfig

+ Telemetry telemetry.TelemetryService

+ TrackInfo *livekit.TrackInfo

+ type MediaTrackSubscriptions struct

+ func NewMediaTrackSubscriptions(params MediaTrackSubscriptionsParams) *MediaTrackSubscriptions

+ func (t *MediaTrackSubscriptions) AddSubscriber(sub types.LocalParticipant, codec webrtc.RTPCodecCapability, ...) (*sfu.DownTrack, error)

+ func (t *MediaTrackSubscriptions) Close()

+ func (t *MediaTrackSubscriptions) DebugInfo() []map[string]interface{}

+ func (t *MediaTrackSubscriptions) GetAllSubscriberIDs() []livekit.ParticipantID

+ func (t *MediaTrackSubscriptions) IsSubscriber(subID livekit.ParticipantID) bool

+ func (t *MediaTrackSubscriptions) NotifySubscriberMaxQuality(subscriberID livekit.ParticipantID, quality livekit.VideoQuality)

+ func (t *MediaTrackSubscriptions) NotifySubscriberNodeMaxQuality(nodeID string, quality livekit.VideoQuality)

+ func (t *MediaTrackSubscriptions) OnNoSubscribers(f func())

+ func (t *MediaTrackSubscriptions) OnSubscribedMaxQualityChange(f func(subscribedQualities []*livekit.SubscribedQuality, ...))

+ func (t *MediaTrackSubscriptions) RemoveAllSubscribers()

+ func (t *MediaTrackSubscriptions) RemoveSubscriber(participantID livekit.ParticipantID, resume bool)

+ func (t *MediaTrackSubscriptions) RevokeDisallowedSubscribers(allowedSubscriberIDs []livekit.ParticipantID) []livekit.ParticipantID

+ func (t *MediaTrackSubscriptions) SetMuted(muted bool)

+ func (t *MediaTrackSubscriptions) Start()

+ func (t *MediaTrackSubscriptions) UpdateQualityChange(force bool)

+ func (t *MediaTrackSubscriptions) UpdateVideoLayers()

+ type MediaTrackSubscriptionsParams struct

+ BufferFactory *buffer.Factory

+ Logger logger.Logger

+ MediaTrack types.MediaTrack

+ ReceiverConfig ReceiverConfig

+ SubscriberConfig DirectionConfig

+ Telemetry telemetry.TelemetryService

type PCTransport

+ func (t *PCTransport) SetPreviousAnswer(offer *webrtc.SessionDescription)

type ParticipantImpl

+ func (p *ParticipantImpl) AddMigratedTrack(cid string, ti *livekit.TrackInfo)

+ func (p *ParticipantImpl) ClaimGrants() *auth.ClaimGrants

+ func (p *ParticipantImpl) MigrateState() types.MigrateState

+ func (p *ParticipantImpl) OnClaimsChanged(callback func(types.LocalParticipant))

+ func (p *ParticipantImpl) SendRefreshToken(token string) error

+ func (p *ParticipantImpl) SetMigrateState(s types.MigrateState)

+ func (p *ParticipantImpl) SetPreviousAnswer(previous *webrtc.SessionDescription)

+ func (p *ParticipantImpl) UpdateSubscribedTrackSettings(trackID livekit.TrackID, settings *livekit.UpdateTrackSettings) error

type ParticipantParams

+ Grants *auth.ClaimGrants

+ SimTracks map[uint32]SimulcastTrackInfo

type Room

+ func (r *Room) Hold() bool

+ func (r *Room) ID() livekit.RoomID

+ func (r *Room) Release()

+ func (r *Room) SetParticipantPermission(participant types.LocalParticipant, permission *livekit.ParticipantPermission) error

+ func (r *Room) SimulateScenario(participant types.LocalParticipant, simulateScenario *livekit.SimulateScenario) error

+ func (r *Room) SyncState(participant types.LocalParticipant, state *livekit.SyncState) error

+ func (r *Room) UpdateSubscriptionPermission(participant types.LocalParticipant, ...) error

+ func (r *Room) UpdateVideoLayers(participant types.Participant, updateVideoLayers *livekit.UpdateVideoLayers) error

+ type SimulcastTrackInfo struct

+ Mid string

+ Rid string

type TransportParams

+ SimTracks map[uint32]SimulcastTrackInfo

+ type UnhandleSimulcastInterceptor struct

+ func (u *UnhandleSimulcastInterceptor) BindRemoteStream(info *interceptor.StreamInfo, reader interceptor.RTPReader) interceptor.RTPReader

+ type UnhandleSimulcastInterceptorFactory struct

+ func NewUnhandleSimulcastInterceptorFactory(opts ...UnhandleSimulcastOption) (*UnhandleSimulcastInterceptorFactory, error)

+ func (f *UnhandleSimulcastInterceptorFactory) NewInterceptor(id string) (interceptor.Interceptor, error)

+ type UnhandleSimulcastOption func(r *UnhandleSimulcastInterceptor) error

+ func UnhandleSimulcastTracks(tracks map[uint32]SimulcastTrackInfo) UnhandleSimulcastOption

+ type UpTrackManager struct

+ func NewUpTrackManager(params UpTrackManagerParams) *UpTrackManager

+ func (u *UpTrackManager) AddPublishedTrack(track types.MediaTrack)

+ func (u *UpTrackManager) AddSubscriber(sub types.LocalParticipant, params types.AddSubscriberParams) (int, error)

+ func (u *UpTrackManager) Close()

+ func (u *UpTrackManager) DebugInfo() map[string]interface{}

+ func (u *UpTrackManager) GetPublishedTrack(trackID livekit.TrackID) types.MediaTrack

+ func (u *UpTrackManager) GetPublishedTracks() []types.MediaTrack

+ func (u *UpTrackManager) OnPublishedTrackUpdated(f func(track types.MediaTrack, onlyIfReady bool))

+ func (u *UpTrackManager) OnUpTrackManagerClose(f func())

+ func (u *UpTrackManager) RemovePublishedTrack(track types.MediaTrack)

+ func (u *UpTrackManager) RemoveSubscriber(sub types.LocalParticipant, trackID livekit.TrackID, resume bool)

+ func (u *UpTrackManager) SetPublishedTrackMuted(trackID livekit.TrackID, muted bool) types.MediaTrack

+ func (u *UpTrackManager) Start()

+ func (u *UpTrackManager) SubscriptionPermission() *livekit.SubscriptionPermission

+ func (u *UpTrackManager) ToProto() []*livekit.TrackInfo

+ func (u *UpTrackManager) UpdateMediaLoss(nodeID string, trackID livekit.TrackID, fractionalLoss uint32) error

+ func (u *UpTrackManager) UpdateSubscribedQuality(nodeID string, trackID livekit.TrackID, maxQuality livekit.VideoQuality) error

+ func (u *UpTrackManager) UpdateSubscriptionPermission(subscriptionPermission *livekit.SubscriptionPermission, ...) error

+ func (u *UpTrackManager) UpdateVideoLayers(updateVideoLayers *livekit.UpdateVideoLayers) error

+ type UpTrackManagerParams struct

+ Logger logger.Logger

+ SID livekit.ParticipantID

Jan 6, 2022

Changes in this version

+ func SpatialLayerForQuality(quality livekit.VideoQuality) int32

+ type DirectionConfig struct

+ RTCPFeedback RTCPFeedbackConfig

+ RTPHeaderExtension RTPHeaderExtensionConfig

type MediaTrack

+ func (t *MediaTrack) RevokeDisallowedSubscribers(allowedSubscriberIDs []livekit.ParticipantID) []livekit.ParticipantID

type MediaTrackParams

+ SubscriberConfig DirectionConfig

type ParticipantImpl

+ func (p *ParticipantImpl) SubscriptionPermissionUpdate(publisherID livekit.ParticipantID, trackID livekit.TrackID, allowed bool)

+ func (p *ParticipantImpl) UpdateSubscriptionPermissions(permissions *livekit.UpdateSubscriptionPermissions, ...) error

type ParticipantParams

+ CongestionControlConfig config.CongestionControlConfig

+ Name livekit.ParticipantName

+ type RTCPFeedbackConfig struct

+ Audio []webrtc.RTCPFeedback

+ Video []webrtc.RTCPFeedback

+ type RTPHeaderExtensionConfig struct

+ Audio []string

+ Video []string

type Room

+ func (r *Room) GetBufferFactory() *buffer.Factory

+ func (r *Room) GetParticipantBySid(participantID livekit.ParticipantID) types.Participant

+ func (r *Room) RemoveDisallowedSubscriptions(sub types.Participant, ...)

+ func (r *Room) UpdateSubscriptionPermissions(participant types.Participant, ...) error

type SubscribedTrack

+ func (t *SubscribedTrack) PublisherID() livekit.ParticipantID

type SubscribedTrackParams

+ PublisherID livekit.ParticipantID

type TransportParams

+ CongestionControlConfig config.CongestionControlConfig

+ type UptrackManager struct

+ func NewUptrackManager(params UptrackManagerParams) *UptrackManager

+ func (u *UptrackManager) AddSubscriber(sub types.Participant, params types.AddSubscriberParams) (int, error)

+ func (u *UptrackManager) AddTrack(req *livekit.AddTrackRequest) *livekit.TrackInfo

+ func (u *UptrackManager) Close()

+ func (u *UptrackManager) DebugInfo() map[string]interface{}

+ func (u *UptrackManager) GetAudioLevel() (level uint8, active bool)

+ func (u *UptrackManager) GetConnectionQuality() (scores float64, numTracks int)

+ func (u *UptrackManager) GetDTX() bool

+ func (u *UptrackManager) GetPublishedTrack(sid livekit.TrackID) types.PublishedTrack

+ func (u *UptrackManager) GetPublishedTracks() []types.PublishedTrack

+ func (u *UptrackManager) MediaTrackReceived(track *webrtc.TrackRemote, rtpReceiver *webrtc.RTPReceiver)

+ func (u *UptrackManager) OnSubscribedMaxQualityChange(...)

+ func (u *UptrackManager) OnTrackPublished(f func(track types.PublishedTrack))

+ func (u *UptrackManager) OnTrackUpdated(f func(track types.PublishedTrack, onlyIfReady bool))

+ func (u *UptrackManager) OnWriteRTCP(f func(pkts []rtcp.Packet))

+ func (u *UptrackManager) RemoveSubscriber(sub types.Participant, trackID livekit.TrackID)

+ func (u *UptrackManager) SetTrackMuted(trackID livekit.TrackID, muted bool)

+ func (u *UptrackManager) Start()

+ func (u *UptrackManager) ToProto() []*livekit.TrackInfo

+ func (u *UptrackManager) UpdateSubscriptionPermissions(permissions *livekit.UpdateSubscriptionPermissions, ...) error

+ type UptrackManagerParams struct

+ AudioConfig config.AudioConfig

+ Config *WebRTCConfig

+ Identity livekit.ParticipantIdentity

+ Logger logger.Logger

+ SID livekit.ParticipantID

+ Telemetry telemetry.TelemetryService

+ ThrottleConfig config.PLIThrottleConfig

type WebRTCConfig

+ Publisher DirectionConfig

+ Subscriber DirectionConfig

Dec 22, 2021

Changes in this version

+ var ErrLimitExceeded = errors.New("node has exceeded its configured limit")

+ var FeedbackTypes = []webrtc.RTCPFeedback

+ func HandleParticipantSignal(room types.Room, participant types.Participant, req *livekit.SignalRequest, ...) error

+ func LoggerWithParticipant(l logger.Logger, identity, sid string) logger.Logger

+ func LoggerWithRoom(l logger.Logger, name string) logger.Logger

type MediaTrack

+ func (t *MediaTrack) AddOnClose(f func())

+ func (t *MediaTrack) GetConnectionScore() float64

+ func (t *MediaTrack) IsSimulcast() bool

+ func (t *MediaTrack) NotifySubscriberMaxQuality(subscriberID string, quality livekit.VideoQuality)

+ func (t *MediaTrack) NotifySubscriberMute(subscriberID string)

+ func (t *MediaTrack) OnSubscribedMaxQualityChange(...)

+ func (t *MediaTrack) Receiver() sfu.TrackReceiver

+ func (t *MediaTrack) Source() livekit.TrackSource

+ func (t *MediaTrack) UpdateVideoLayers(layers []*livekit.VideoLayer)

type PCTransport

+ func (t *PCTransport) AddTrack(subTrack types.SubscribedTrack)

+ func (t *PCTransport) OnStreamStateChange(f func(update *sfu.StreamStateUpdate) error)

+ func (t *PCTransport) RemoveTrack(subTrack types.SubscribedTrack)

type ParticipantImpl

+ func (p *ParticipantImpl) IsRecorder() bool

+ func (p *ParticipantImpl) SubscriberAsPrimary() bool

type ParticipantParams

+ Recorder bool

+ SID string

type Room

+ func (r *Room) Name() string

type SubscribedTrack

+ func (t *SubscribedTrack) Bound()

+ func (t *SubscribedTrack) MediaTrack() types.MediaTrack

+ func (t *SubscribedTrack) OnBind(f func())

+ func (t *SubscribedTrack) UpdateVideoLayer()

+ type SubscribedTrackParams struct

+ DownTrack *sfu.DownTrack

+ MediaTrack types.MediaTrack

+ PublisherIdentity string

+ SubscriberID string

Nov 19, 2021

Changes in this version

type ReceiverConfig

+ PacketBufferSize int

Nov 11, 2021

Changes in this version

type MediaTrackParams

+ Telemetry *telemetry.TelemetryService

type ParticipantParams

+ Telemetry *telemetry.TelemetryService

type TransportParams

+ ParticipantID string

+ ParticipantIdentity string

+ Telemetry *telemetry.TelemetryService

Nov 5, 2021

Changes in this version

+ func FixedPointToPercent(frac uint8) uint32

type MediaTrack

+ func (t *MediaTrack) PublishLossPercentage() uint32

type MediaTrackParams

+ Logger logger.Logger

type ParticipantImpl

+ func (p *ParticipantImpl) GetConnectionQuality() livekit.ConnectionQuality

+ func (p *ParticipantImpl) GetSubscribedParticipants() []string

+ func (p *ParticipantImpl) IsSubscribedTo(identity string) bool

+ func (p *ParticipantImpl) SendConnectionQualityUpdate(update *livekit.ConnectionQualityUpdate) error

type ParticipantParams

+ Logger logger.Logger

type Room

+ Logger logger.Logger

type SubscribedTrack

+ func (t *SubscribedTrack) SubscribeLossPercentage() uint32

type TransportParams

+ Logger logger.Logger

Nov 1, 2021

Changes in this version

+ func GetQualityForDimension(width, height uint32) livekit.VideoQuality

type MediaTrack

+ func (t *MediaTrack) GetQualityForDimension(width, height uint32) livekit.VideoQuality

type MediaTrackParams

+ ParticipantIdentity string

type ParticipantImpl

+ func (p *ParticipantImpl) GetPublishedTrack(sid string) types.PublishedTrack

+ func (p *ParticipantImpl) GetSubscribedTrack(sid string) types.SubscribedTrack

type Room

+ func (r *Room) IsClosed() bool

+ func (r *Room) ResumeParticipant(p types.Participant, responseSink routing.MessageSink) error

type SubscribedTrack

+ func (t *SubscribedTrack) PublisherIdentity() string

Oct 26, 2021

Changes in this version

type MediaTrack

+ func (t *MediaTrack) SdpCid() string

+ func (t *MediaTrack) SignalCid() string

type MediaTrackParams

+ SdpCid string

+ SignalCid string

Oct 20, 2021

Changes in this version

type MediaTrackParams

+ TrackInfo *livekit.TrackInfo

Oct 5, 2021

Changes in this version

type ParticipantImpl

+ func (p *ParticipantImpl) SendRoomUpdate(room *livekit.Room) error

type Room

+ func (r *Room) OnMetadataUpdate(f func(metadata string))

+ func (r *Room) SetMetadata(metadata string)

Sep 22, 2021

Changes in this version

type ParticipantImpl

+ func (p *ParticipantImpl) SendSpeakerUpdate(speakers []*livekit.SpeakerInfo) error

Aug 25, 2021

Changes in this version

type ParticipantImpl

+ func (p *ParticipantImpl) CanPublishData() bool

type Room

+ func (r *Room) SendDataPacket(up *livekit.UserPacket, kind livekit.DataPacket_Kind)

Aug 16, 2021

Changes in this version

type MediaTrack

+ func (t *MediaTrack) NumUpTracks() uint32

Jul 23, 2021

Changes in this version

type ParticipantImpl

+ func (p *ParticipantImpl) Hidden() bool

type ParticipantParams

+ Hidden bool

Jul 16, 2021

Changes in this version

type MediaTrack

+ func (t *MediaTrack) SetSimulcastLayers(layers []livekit.VideoQuality)

Jul 13, 2021

Changes in this version

type MediaTrack

+ func (t *MediaTrack) DebugInfo() map[string]interface{}

type ParticipantImpl

+ func (p *ParticipantImpl) DebugInfo() map[string]interface{}

type Room

+ func (r *Room) DebugInfo() map[string]interface{}

Jul 11, 2021

Changes in this version

+ const AudioLevelQuantization

Jul 5, 2021

Changes in this version

type ParticipantParams

+ EnabledCodecs []*livekit.Codec

type TransportParams

+ EnabledCodecs []*livekit.Codec

Jun 26, 2021

Changes in this version

+ var ErrCannotSubscribe = errors.New("participant does not have permission to subscribe")

+ func ConvertAudioLevel(level uint8) float32

type ParticipantParams

+ ThrottleConfig config.PLIThrottleConfig

type SubscribedTrack

+ func (t *SubscribedTrack) UpdateSubscriberSettings(enabled bool, quality livekit.VideoQuality)

Jun 21, 2021

Changes in this version

type MediaTrack

+ func (t *MediaTrack) ToProto() *livekit.TrackInfo

type MediaTrackParams

+ Height uint32

+ Width uint32

type ParticipantImpl

+ func (p *ParticipantImpl) UpdateAfterActive() bool

Jun 16, 2021

Changes in this version

type Room

+ func (r *Room) GetBufferFactor() *buffer.Factory

type WebRTCConfig

+ func (c *WebRTCConfig) SetBufferFactory(factory *buffer.Factory)

Jun 5, 2021

Changes in this version

type PacketStats

+ func (s PacketStats) Copy() *PacketStats

type Room

+ Room *livekit.Room

May 23, 2021

Changes in this version

+ type ParticipantOptions struct

+ AutoSubscribe bool

May 15, 2021

Changes in this version

type DataTrack

+ func (t *DataTrack) IsSubscriber(subId string) bool

type MediaTrack

+ func (t *MediaTrack) IsSubscriber(subId string) bool

May 12, 2021

Changes in this version

+ const DefaultEmptyTimeout

+ const DefaultRoomDepartureGrace

+ var ErrAlreadyJoined = errors.New("a participant with the same identity is already in the room")

+ var ErrDataChannelUnavailable = errors.New("data channel is not available")

+ var ErrMaxParticipantsExceeded = errors.New("room has exceeded its max participants")

+ var ErrPermissionDenied = errors.New("no permissions to access the room")

+ var ErrRoomClosed = errors.New("room has already closed")

+ var ErrUnexpectedOffer = errors.New("expected answer SDP, received offer")

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

+ func FromProtoTrickle(trickle *livekit.TrickleRequest) (webrtc.ICECandidateInit, error)

+ func IsEOF(err error) bool

+ func PackDataTrackLabel(participantId, trackId string, label string) string

+ func PackStreamID(participantId, trackId string) string

+ func Recover()

+ func RecoverSilent()

+ func ToProtoParticipants(participants []types.Participant) []*livekit.ParticipantInfo

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

+ func ToProtoTrack(t types.PublishedTrack) *livekit.TrackInfo

+ func ToProtoTrackKind(kind webrtc.RTPCodecType) livekit.TrackType

+ func ToProtoTrickle(candidateInit webrtc.ICECandidateInit) *livekit.TrickleRequest

+ func UnpackDataTrackLabel(packed string) (peerId string, trackId string, label string)

+ func UnpackStreamID(packed string) (participantId string, trackId string)

+ type AudioLevel struct

+ func NewAudioLevel(activeLevel uint8, minPercentile uint8) *AudioLevel

+ func (l *AudioLevel) GetLevel() (level uint8, noisy bool)

+ func (l *AudioLevel) Observe(level uint8)

+ type DataTrack struct

+ func NewDataTrack(trackId, participantId string, dc *webrtc.DataChannel) *DataTrack

+ func (t *DataTrack) AddSubscriber(participant types.Participant) error

+ func (t *DataTrack) ID() string

+ func (t *DataTrack) IsMuted() bool

+ func (t *DataTrack) Kind() livekit.TrackType

+ func (t *DataTrack) Name() string

+ func (t *DataTrack) OnClose(f func())

+ func (t *DataTrack) RemoveAllSubscribers()

+ func (t *DataTrack) RemoveSubscriber(participantId string)

+ func (t *DataTrack) SetMuted(muted bool)

+ func (t *DataTrack) Start()

+ type DownDataChannel struct

+ func (d *DownDataChannel) SendMessage(msg livekit.DataMessage) error

+ type MediaTrack struct

+ func NewMediaTrack(track *webrtc.TrackRemote, params MediaTrackParams) *MediaTrack

+ func (t *MediaTrack) AddReceiver(receiver *webrtc.RTPReceiver, track *webrtc.TrackRemote, twcc *twcc.Responder)

+ func (t *MediaTrack) AddSubscriber(sub types.Participant) error

+ func (t *MediaTrack) ID() string

+ func (t *MediaTrack) IsMuted() bool

+ func (t *MediaTrack) Kind() livekit.TrackType

+ func (t *MediaTrack) Name() string

+ func (t *MediaTrack) OnClose(f func())

+ func (t *MediaTrack) RemoveAllSubscribers()

+ func (t *MediaTrack) RemoveSubscriber(participantId string)

+ func (t *MediaTrack) SetMuted(muted bool)

+ func (t *MediaTrack) Start()

+ type MediaTrackParams struct

+ AudioConfig config.AudioConfig

+ BufferFactory *buffer.Factory

+ ParticipantID string

+ RTCPChan chan []rtcp.Packet

+ ReceiverConfig ReceiverConfig

+ Stats *RoomStatsReporter

+ TrackID string

+ type PCTransport struct

+ func NewPCTransport(params TransportParams) (*PCTransport, error)

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

+ func (t *PCTransport) Close()

+ func (t *PCTransport) CreateAndSendOffer(options *webrtc.OfferOptions) error

+ func (t *PCTransport) Negotiate()

+ func (t *PCTransport) OnOffer(f func(sd webrtc.SessionDescription))

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

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

+ type PacketStats struct

+ FIRTotal uint64

+ NackTotal uint64

+ PLITotal uint64

+ PacketBytes uint64

+ PacketTotal uint64

+ func (s *PacketStats) HandleRTCP(pkts []rtcp.Packet)

+ func (s *PacketStats) IncrementBytes(bytes uint64)

+ func (s *PacketStats) IncrementFIR(count uint64)

+ func (s *PacketStats) IncrementNack(count uint64)

+ func (s *PacketStats) IncrementPLI(count uint64)

+ func (s *PacketStats) IncrementPackets(count uint64)

+ type ParticipantImpl struct

+ func NewParticipant(params ParticipantParams) (*ParticipantImpl, error)

+ func (p *ParticipantImpl) AddICECandidate(candidate webrtc.ICECandidateInit, target livekit.SignalTarget) error

+ func (p *ParticipantImpl) AddSubscribedTrack(pubId string, subTrack types.SubscribedTrack)

+ func (p *ParticipantImpl) AddSubscriber(op types.Participant) (int, error)

+ func (p *ParticipantImpl) AddTrack(clientId, name string, trackType livekit.TrackType)

+ func (p *ParticipantImpl) CanPublish() bool

+ func (p *ParticipantImpl) CanSubscribe() bool

+ func (p *ParticipantImpl) Close() error

+ func (p *ParticipantImpl) ConnectedAt() time.Time

+ func (p *ParticipantImpl) GetAudioLevel() (level uint8, noisy bool)

+ func (p *ParticipantImpl) GetPublishedTracks() []types.PublishedTrack

+ func (p *ParticipantImpl) GetResponseSink() routing.MessageSink

+ func (p *ParticipantImpl) GetSubscribedTracks() []types.SubscribedTrack

+ func (p *ParticipantImpl) HandleAnswer(sdp webrtc.SessionDescription) error

+ func (p *ParticipantImpl) HandleOffer(sdp webrtc.SessionDescription) (answer webrtc.SessionDescription, err error)

+ func (p *ParticipantImpl) ICERestart() error

+ func (p *ParticipantImpl) ID() string

+ func (p *ParticipantImpl) Identity() string

+ func (p *ParticipantImpl) IsReady() bool

+ func (p *ParticipantImpl) Negotiate()

+ func (p *ParticipantImpl) OnClose(callback func(types.Participant))

+ func (p *ParticipantImpl) OnDataPacket(callback func(types.Participant, *livekit.DataPacket))

+ func (p *ParticipantImpl) OnMetadataUpdate(callback func(types.Participant))

+ func (p *ParticipantImpl) OnStateChange(callback func(p types.Participant, oldState livekit.ParticipantInfo_State))

+ func (p *ParticipantImpl) OnTrackPublished(callback func(types.Participant, types.PublishedTrack))

+ func (p *ParticipantImpl) OnTrackUpdated(callback func(types.Participant, types.PublishedTrack))

+ func (p *ParticipantImpl) ProtocolVersion() types.ProtocolVersion

+ func (p *ParticipantImpl) RTCPChan() chan []rtcp.Packet

+ func (p *ParticipantImpl) RemoveSubscribedTrack(pubId string, subTrack types.SubscribedTrack)

+ func (p *ParticipantImpl) RemoveSubscriber(participantId string)

+ func (p *ParticipantImpl) SendActiveSpeakers(speakers []*livekit.SpeakerInfo) error

+ func (p *ParticipantImpl) SendDataPacket(dp *livekit.DataPacket) error

+ func (p *ParticipantImpl) SendJoinResponse(roomInfo *livekit.Room, otherParticipants []types.Participant, ...) error

+ func (p *ParticipantImpl) SendParticipantUpdate(participants []*livekit.ParticipantInfo) error

+ func (p *ParticipantImpl) SetMetadata(metadata string)

+ func (p *ParticipantImpl) SetPermission(permission *livekit.ParticipantPermission)

+ func (p *ParticipantImpl) SetResponseSink(sink routing.MessageSink)

+ func (p *ParticipantImpl) SetTrackMuted(trackId string, muted bool)

+ func (p *ParticipantImpl) Start()

+ func (p *ParticipantImpl) State() livekit.ParticipantInfo_State

+ func (p *ParticipantImpl) SubscriberMediaEngine() *webrtc.MediaEngine

+ func (p *ParticipantImpl) SubscriberPC() *webrtc.PeerConnection

+ func (p *ParticipantImpl) ToProto() *livekit.ParticipantInfo

+ type ParticipantParams struct

+ AudioConfig config.AudioConfig

+ Config *WebRTCConfig

+ Identity string

+ ProtocolVersion types.ProtocolVersion

+ Sink routing.MessageSink

+ Stats *RoomStatsReporter

+ type ReceiverConfig struct

+ type Room struct

+ func NewRoom(room *livekit.Room, config WebRTCConfig, iceServers []*livekit.ICEServer, ...) *Room

+ func (r *Room) Close()

+ func (r *Room) CloseIfEmpty()

+ func (r *Room) FirstJoinedAt() int64

+ func (r *Room) GetActiveSpeakers() []*livekit.SpeakerInfo

+ func (r *Room) GetIncomingStats() PacketStats

+ func (r *Room) GetOutgoingStats() PacketStats

+ func (r *Room) GetParticipant(identity string) types.Participant

+ func (r *Room) GetParticipants() []types.Participant

+ func (r *Room) GetStatsReporter() *RoomStatsReporter

+ func (r *Room) Join(participant types.Participant) error

+ func (r *Room) LastLeftAt() int64

+ func (r *Room) OnClose(f func())

+ func (r *Room) OnParticipantChanged(f func(participant types.Participant))

+ func (r *Room) RemoveParticipant(identity string)

+ func (r *Room) UpdateSubscriptions(participant types.Participant, subscription *livekit.UpdateSubscription) error

+ type RoomStatsReporter struct

+ func NewRoomStatsReporter(roomName string) *RoomStatsReporter

+ func (r *RoomStatsReporter) AddParticipant()

+ func (r *RoomStatsReporter) AddPublishedTrack(kind string)

+ func (r *RoomStatsReporter) AddSubscribedTrack(kind string)

+ func (r *RoomStatsReporter) RoomEnded()

+ func (r *RoomStatsReporter) RoomStarted()

+ func (r *RoomStatsReporter) SubParticipant()

+ func (r *RoomStatsReporter) SubPublishedTrack(kind string)

+ func (r *RoomStatsReporter) SubSubscribedTrack(kind string)

+ type StatsBufferWrapper struct

+ func (w *StatsBufferWrapper) CreateBuffer(packetType packetio.BufferPacketType, ssrc uint32) io.ReadWriteCloser

+ type StatsInterceptor struct

+ func NewStatsInterceptor(reporter *RoomStatsReporter) *StatsInterceptor

+ func (s *StatsInterceptor) BindLocalStream(_ *interceptor.StreamInfo, writer interceptor.RTPWriter) interceptor.RTPWriter

+ func (s *StatsInterceptor) BindRTCPWriter(writer interceptor.RTCPWriter) interceptor.RTCPWriter

+ type SubscribedTrack struct

+ func NewSubscribedTrack(dt *sfu.DownTrack) *SubscribedTrack

+ func (t *SubscribedTrack) DownTrack() *sfu.DownTrack

+ func (t *SubscribedTrack) ID() string

+ func (t *SubscribedTrack) IsMuted() bool

+ func (t *SubscribedTrack) SetMuted(muted bool)

+ func (t *SubscribedTrack) SetPublisherMuted(muted bool)

+ func (t *SubscribedTrack) SetVideoQuality(quality livekit.VideoQuality)

+ type TransportParams struct

+ Config *WebRTCConfig

+ Stats *RoomStatsReporter

+ Target livekit.SignalTarget

+ type WebRTCConfig struct

+ BufferFactory *buffer.Factory

+ Configuration webrtc.Configuration

+ Receiver ReceiverConfig

+ SettingEngine webrtc.SettingEngine

+ TCPMuxListener *net.TCPListener

+ UDPMux ice.UDPMux

+ UDPMuxConn *net.UDPConn

+ func NewWebRTCConfig(conf *config.RTCConfig, externalIP string) (*WebRTCConfig, error)

+ type WrappedReceiver struct

+ func NewWrappedReceiver(receiver sfu.Receiver, trackId string, streamId string) WrappedReceiver

+ func (r WrappedReceiver) StreamID() string

+ func (r WrappedReceiver) TrackID() string