rtc

package
v0.15.4 Latest Latest
Warning

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

 Go to latest Published: Feb 9, 2022 License: Apache-2.0 Imports: 44 Imported by: 3

Documentation

Index

Constants

View Source 
const (
	DefaultEmptyTimeout       = 5 * 60 // 5m
	DefaultRoomDepartureGrace = 20
	AudioLevelQuantization    = 8 // ideally power of 2 to minimize float decimal
)
View Source 
const (
	SilentAudioLevel = 127
)

Variables

View Source 
var (
	ErrRoomClosed              = errors.New("room has already closed")
	ErrPermissionDenied        = errors.New("no permissions to access the room")
	ErrMaxParticipantsExceeded = errors.New("room has exceeded its max participants")
	ErrLimitExceeded           = errors.New("node has exceeded its configured limit")
	ErrAlreadyJoined           = errors.New("a participant with the same identity is already in the room")
	ErrUnexpectedOffer         = errors.New("expected answer SDP, received offer")
	ErrDataChannelUnavailable  = errors.New("data channel is not available")
	ErrCannotSubscribe         = errors.New("participant does not have permission to subscribe")
)

Functions

func ConvertAudioLevel added in v0.9.14 

func ConvertAudioLevel(level uint8) float32

convert decibel back to linear

func FromProtoSessionDescription 

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

func FromProtoTrickle 

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

func HandleParticipantSignal added in v0.15.0 

func HandleParticipantSignal(room types.Room, participant types.LocalParticipant, req *livekit.SignalRequest, pLogger logger.Logger) error

func IsEOF 

func IsEOF(err error) bool

func LoggerWithParticipant added in v0.15.0 

func LoggerWithParticipant(l logger.Logger, identity livekit.ParticipantIdentity, sid livekit.ParticipantID) logger.Logger

logger helpers

func LoggerWithRoom added in v0.15.0 

func LoggerWithRoom(l logger.Logger, name livekit.RoomName, roomID livekit.RoomID) logger.Logger

func LoggerWithTrack added in v0.15.3 

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

func PackDataTrackLabel 

func PackDataTrackLabel(participantID livekit.ParticipantID, trackID livekit.TrackID, label string) string

func PackStreamID 

func PackStreamID(participantID livekit.ParticipantID, trackID livekit.TrackID) string

func QualityForSpatialLayer added in v0.15.4 

func QualityForSpatialLayer(layer int32) livekit.VideoQuality

func Recover 

func Recover()

func RecoverSilent 

func RecoverSilent()

func SpatialLayerForQuality added in v0.15.2 

func SpatialLayerForQuality(quality livekit.VideoQuality) int32

func ToProtoParticipants 

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

func ToProtoSessionDescription 

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

func ToProtoTrackKind 

func ToProtoTrackKind(kind webrtc.RTPCodecType) livekit.TrackType

func ToProtoTrickle 

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

func UnpackDataTrackLabel 

func UnpackDataTrackLabel(packed string) (peerID livekit.ParticipantID, trackID livekit.TrackID, label string)

func UnpackStreamID 

func UnpackStreamID(packed string) (participantID livekit.ParticipantID, trackID livekit.TrackID)

func VideoQualityToRID added in v0.15.3 

func VideoQualityToRID(q livekit.VideoQuality) string

Types

type AudioLevel 

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

keeps track of audio level for a participant

func NewAudioLevel 

func NewAudioLevel(activeLevel uint8, minPercentile uint8) *AudioLevel

func (*AudioLevel) GetLevel 

func (l *AudioLevel) GetLevel() (uint8, bool)

returns current audio level, 0 (loudest) to 127 (silent)

func (*AudioLevel) Observe 

func (l *AudioLevel) Observe(level uint8, durationMs uint32)

Observes a new frame, must be called from the same thread

type DirectionConfig added in v0.15.2 

type DirectionConfig struct {
	RTPHeaderExtension RTPHeaderExtensionConfig
	RTCPFeedback       RTCPFeedbackConfig
}

type MediaTrack 

type MediaTrack struct {
	*MediaTrackReceiver
	// contains filtered or unexported fields
}

MediaTrack represents a WebRTC track that needs to be forwarded Implements MediaTrack and PublishedTrack interface

func NewMediaTrack 

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

func (*MediaTrack) AddReceiver 

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

AddReceiver adds a new RTP receiver to the track

func (*MediaTrack) GetAudioLevel added in v0.15.3 

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

func (*MediaTrack) GetConnectionScore added in v0.15.0 

func (t *MediaTrack) GetConnectionScore() float32

func (*MediaTrack) SdpCid added in v0.13.6 

func (t *MediaTrack) SdpCid() string

func (*MediaTrack) SetRTT added in v0.15.4 

func (t *MediaTrack) SetRTT(rtt uint32)

func (*MediaTrack) SignalCid added in v0.13.6 

func (t *MediaTrack) SignalCid() string

func (*MediaTrack) ToProto added in v0.9.13 

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

func (*MediaTrack) TrySetSimulcastSSRC added in v0.15.3 

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

type MediaTrackParams 

type MediaTrackParams struct {
	TrackInfo           *livekit.TrackInfo
	SignalCid           string
	SdpCid              string
	ParticipantID       livekit.ParticipantID
	ParticipantIdentity livekit.ParticipantIdentity
	// channel to send RTCP packets to the source
	RTCPChan          chan []rtcp.Packet
	BufferFactory     *buffer.Factory
	ReceiverConfig    ReceiverConfig
	SubscriberConfig  DirectionConfig
	PLIThrottleConfig config.PLIThrottleConfig
	AudioConfig       config.AudioConfig
	Telemetry         telemetry.TelemetryService
	Logger            logger.Logger
}

type MediaTrackReceiver added in v0.15.3 

type MediaTrackReceiver struct {
	*MediaTrackSubscriptions
	// contains filtered or unexported fields
}

func NewMediaTrackReceiver added in v0.15.3 

func NewMediaTrackReceiver(params MediaTrackReceiverParams) *MediaTrackReceiver

func (*MediaTrackReceiver) AddOnClose added in v0.15.3 

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

func (*MediaTrackReceiver) AddSubscriber added in v0.15.3 

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

AddSubscriber subscribes sub to current mediaTrack

func (*MediaTrackReceiver) ClearReceiver added in v0.15.3 

func (t *MediaTrackReceiver) ClearReceiver()

func (*MediaTrackReceiver) Close added in v0.15.3 

func (t *MediaTrackReceiver) Close()

func (*MediaTrackReceiver) DebugInfo added in v0.15.3 

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

func (*MediaTrackReceiver) GetQualityForDimension added in v0.15.3 

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

GetQualityForDimension finds the closest quality to use for desired dimensions affords a 20% tolerance on dimension

func (*MediaTrackReceiver) GetVideoLayers added in v0.15.3 

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

func (*MediaTrackReceiver) ID added in v0.15.3 

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

func (*MediaTrackReceiver) IsMuted added in v0.15.3 

func (t *MediaTrackReceiver) IsMuted() bool

func (*MediaTrackReceiver) IsSimulcast added in v0.15.3 

func (t *MediaTrackReceiver) IsSimulcast() bool

func (*MediaTrackReceiver) Kind added in v0.15.3 

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

func (*MediaTrackReceiver) Name added in v0.15.3 

func (t *MediaTrackReceiver) Name() string

func (*MediaTrackReceiver) NotifySubscriberNodeMediaLoss added in v0.15.3 

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

func (*MediaTrackReceiver) OnMediaLossUpdate added in v0.15.3 

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

func (*MediaTrackReceiver) OnSubscribedMaxQualityChange added in v0.15.3 

func (t *MediaTrackReceiver) OnSubscribedMaxQualityChange(f func(trackID livekit.TrackID, subscribedQualities []*livekit.SubscribedQuality, maxSubscribedQuality livekit.VideoQuality) error)

func (*MediaTrackReceiver) OnVideoLayerUpdate added in v0.15.3 

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

func (*MediaTrackReceiver) PublisherID added in v0.15.3 

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

func (*MediaTrackReceiver) PublisherIdentity added in v0.15.3 

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

func (*MediaTrackReceiver) Receiver added in v0.15.3 

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

func (*MediaTrackReceiver) SetMuted added in v0.15.3 

func (t *MediaTrackReceiver) SetMuted(muted bool)

func (*MediaTrackReceiver) SetSimulcast added in v0.15.3 

func (t *MediaTrackReceiver) SetSimulcast(simulcast bool)

func (*MediaTrackReceiver) SetupReceiver added in v0.15.3 

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

func (*MediaTrackReceiver) Source added in v0.15.3 

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

func (*MediaTrackReceiver) TrackInfo added in v0.15.3 

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

func (*MediaTrackReceiver) UpdateTrackInfo added in v0.15.3 

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

func (*MediaTrackReceiver) UpdateVideoLayers added in v0.15.3 

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

type MediaTrackReceiverParams added in v0.15.3 

type MediaTrackReceiverParams struct {
	TrackInfo           *livekit.TrackInfo
	MediaTrack          types.MediaTrack
	ParticipantID       livekit.ParticipantID
	ParticipantIdentity livekit.ParticipantIdentity
	BufferFactory       *buffer.Factory
	ReceiverConfig      ReceiverConfig
	SubscriberConfig    DirectionConfig
	Telemetry           telemetry.TelemetryService
	Logger              logger.Logger
}

type MediaTrackSubscriptions added in v0.15.3 

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

MediaTrackSubscriptions manages subscriptions of a media track

func NewMediaTrackSubscriptions added in v0.15.3 

func NewMediaTrackSubscriptions(params MediaTrackSubscriptionsParams) *MediaTrackSubscriptions

func (*MediaTrackSubscriptions) AddSubscriber added in v0.15.3 

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

AddSubscriber subscribes sub to current mediaTrack

func (*MediaTrackSubscriptions) Close added in v0.15.3 

func (t *MediaTrackSubscriptions) Close()

func (*MediaTrackSubscriptions) DebugInfo added in v0.15.3 

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

func (*MediaTrackSubscriptions) IsSubscriber added in v0.15.3 

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

func (*MediaTrackSubscriptions) NotifySubscriberNodeMaxQuality added in v0.15.3 

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

func (*MediaTrackSubscriptions) OnNoSubscribers added in v0.15.3 

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

func (*MediaTrackSubscriptions) OnSubscribedMaxQualityChange added in v0.15.3 

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

func (*MediaTrackSubscriptions) RemoveAllSubscribers added in v0.15.3 

func (t *MediaTrackSubscriptions) RemoveAllSubscribers()

func (*MediaTrackSubscriptions) RemoveSubscriber added in v0.15.3 

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

RemoveSubscriber removes participant from subscription stop all forwarders to the client

func (*MediaTrackSubscriptions) ResyncAllSubscribers added in v0.15.4 

func (t *MediaTrackSubscriptions) ResyncAllSubscribers()

func (*MediaTrackSubscriptions) RevokeDisallowedSubscribers added in v0.15.3 

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

func (*MediaTrackSubscriptions) SetMuted added in v0.15.3 

func (t *MediaTrackSubscriptions) SetMuted(muted bool)

func (*MediaTrackSubscriptions) Start added in v0.15.3 

func (t *MediaTrackSubscriptions) Start()

func (*MediaTrackSubscriptions) UpdateQualityChange added in v0.15.3 

func (t *MediaTrackSubscriptions) UpdateQualityChange(force bool)

func (*MediaTrackSubscriptions) UpdateVideoLayers added in v0.15.3 

func (t *MediaTrackSubscriptions) UpdateVideoLayers()

type MediaTrackSubscriptionsParams added in v0.15.3 

type MediaTrackSubscriptionsParams struct {
	MediaTrack types.MediaTrack

	BufferFactory    *buffer.Factory
	ReceiverConfig   ReceiverConfig
	SubscriberConfig DirectionConfig

	Telemetry telemetry.TelemetryService

	Logger logger.Logger
}

type PCTransport 

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

PCTransport is a wrapper around PeerConnection, with some helper methods

func NewPCTransport 

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

func (*PCTransport) AddICECandidate 

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

func (*PCTransport) AddTrack added in v0.15.0 

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

func (*PCTransport) Close 

func (t *PCTransport) Close()

func (*PCTransport) CreateAndSendOffer 

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

func (*PCTransport) Negotiate 

func (t *PCTransport) Negotiate()

func (*PCTransport) OnOffer 

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

OnOffer is called when the PeerConnection starts negotiation and prepares an offer

func (*PCTransport) OnStreamStateChange added in v0.15.0 

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

func (*PCTransport) PeerConnection 

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

func (*PCTransport) RemoveTrack added in v0.15.0 

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

func (*PCTransport) SetPreviousAnswer added in v0.15.3 

func (t *PCTransport) SetPreviousAnswer(answer *webrtc.SessionDescription)

func (*PCTransport) SetRemoteDescription 

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

type ParticipantImpl 

type ParticipantImpl struct {
	*UpTrackManager
	// contains filtered or unexported fields
}

func NewParticipant 

func NewParticipant(params ParticipantParams, perms *livekit.ParticipantPermission) (*ParticipantImpl, error)

func (*ParticipantImpl) AddICECandidate 

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

AddICECandidate adds candidates for remote peer

func (*ParticipantImpl) AddMigratedTrack added in v0.15.3 

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

func (*ParticipantImpl) AddSubscribedTrack 

func (p *ParticipantImpl) AddSubscribedTrack(subTrack types.SubscribedTrack)

AddSubscribedTrack adds a track to the participant's subscribed list

func (*ParticipantImpl) AddTrack 

func (p *ParticipantImpl) AddTrack(req *livekit.AddTrackRequest)

AddTrack is called when client intends to publish track. records track details and lets client know it's ok to proceed

func (*ParticipantImpl) CanPublish 

func (p *ParticipantImpl) CanPublish() bool

func (*ParticipantImpl) CanPublishData added in v0.12.2 

func (p *ParticipantImpl) CanPublishData() bool

func (*ParticipantImpl) CanSubscribe 

func (p *ParticipantImpl) CanSubscribe() bool

func (*ParticipantImpl) ClaimGrants added in v0.15.3 

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

func (*ParticipantImpl) Close 

func (p *ParticipantImpl) Close(sendLeave bool) error

func (*ParticipantImpl) ConnectedAt 

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

func (*ParticipantImpl) DebugInfo added in v0.10.6 

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

func (*ParticipantImpl) GetAudioLevel 

func (p *ParticipantImpl) GetAudioLevel() (level uint8, active bool)

func (*ParticipantImpl) GetConnectionQuality added in v0.14.0 

func (p *ParticipantImpl) GetConnectionQuality() *livekit.ConnectionQualityInfo

func (*ParticipantImpl) GetLogger added in v0.15.4 

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

func (*ParticipantImpl) GetResponseSink 

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

func (*ParticipantImpl) GetSubscribedParticipants added in v0.14.0 

func (p *ParticipantImpl) GetSubscribedParticipants() []livekit.ParticipantID

func (*ParticipantImpl) HandleAnswer 

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

HandleAnswer handles a client answer response, with subscriber PC, server initiates the offer and client answers

func (*ParticipantImpl) HandleOffer 

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

HandleOffer an offer from remote participant, used when clients make the initial connection

func (*ParticipantImpl) Hidden added in v0.11.1 

func (p *ParticipantImpl) Hidden() bool

func (*ParticipantImpl) ICERestart 

func (p *ParticipantImpl) ICERestart() error

ICERestart restarts subscriber ICE connections

func (*ParticipantImpl) ID 

func (p *ParticipantImpl) ID() livekit.ParticipantID

func (*ParticipantImpl) Identity 

func (p *ParticipantImpl) Identity() livekit.ParticipantIdentity

func (*ParticipantImpl) IsReady 

func (p *ParticipantImpl) IsReady() bool

func (*ParticipantImpl) IsRecorder added in v0.15.0 

func (p *ParticipantImpl) IsRecorder() bool

func (*ParticipantImpl) MigrateState added in v0.15.3 

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

func (*ParticipantImpl) Negotiate 

func (p *ParticipantImpl) Negotiate()

func (*ParticipantImpl) OnClaimsChanged added in v0.15.3 

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

func (*ParticipantImpl) OnClose 

func (p *ParticipantImpl) OnClose(callback func(types.LocalParticipant, map[livekit.TrackID]livekit.ParticipantID))

func (*ParticipantImpl) OnDataPacket 

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

func (*ParticipantImpl) OnMetadataUpdate 

func (p *ParticipantImpl) OnMetadataUpdate(callback func(types.LocalParticipant))

func (*ParticipantImpl) OnStateChange 

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

func (*ParticipantImpl) OnTrackPublished 

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

func (*ParticipantImpl) OnTrackUpdated 

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

func (*ParticipantImpl) ProtocolVersion 

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

func (*ParticipantImpl) RemoveSubscribedTrack 

func (p *ParticipantImpl) RemoveSubscribedTrack(subTrack types.SubscribedTrack)

RemoveSubscribedTrack removes a track to the participant's subscribed list

func (*ParticipantImpl) SendConnectionQualityUpdate added in v0.14.0 

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

func (*ParticipantImpl) SendDataPacket 

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

func (*ParticipantImpl) SendJoinResponse 

func (p *ParticipantImpl) SendJoinResponse(
	roomInfo *livekit.Room,
	otherParticipants []*livekit.ParticipantInfo,
	iceServers []*livekit.ICEServer,
) error

signal connection methods

func (*ParticipantImpl) SendParticipantUpdate 

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

func (*ParticipantImpl) SendRefreshToken added in v0.15.3 

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

func (*ParticipantImpl) SendRoomUpdate added in v0.13.1 

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

func (*ParticipantImpl) SendSpeakerUpdate added in v0.13.0 

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

SendSpeakerUpdate notifies participant changes to speakers. only send members that have changed since last update

func (*ParticipantImpl) SetMetadata 

func (p *ParticipantImpl) SetMetadata(metadata string)

SetMetadata attaches metadata to the participant

func (*ParticipantImpl) SetMigrateState added in v0.15.3 

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

func (*ParticipantImpl) SetPermission 

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

func (*ParticipantImpl) SetPreviousAnswer added in v0.15.3 

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

func (*ParticipantImpl) SetResponseSink 

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

func (*ParticipantImpl) SetTrackMuted 

func (p *ParticipantImpl) SetTrackMuted(trackID livekit.TrackID, muted bool, fromAdmin bool)

func (*ParticipantImpl) Start 

func (p *ParticipantImpl) Start()

func (*ParticipantImpl) State 

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

func (*ParticipantImpl) SubscriberAsPrimary added in v0.15.0 

func (p *ParticipantImpl) SubscriberAsPrimary() bool

func (*ParticipantImpl) SubscriberMediaEngine 

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

func (*ParticipantImpl) SubscriberPC 

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

func (*ParticipantImpl) SubscriptionPermissionUpdate added in v0.15.2 

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

func (*ParticipantImpl) ToProto 

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

func (*ParticipantImpl) UpdateRTT added in v0.15.4 

func (p *ParticipantImpl) UpdateRTT(rtt uint32)

func (*ParticipantImpl) UpdateSubscribedTrackSettings added in v0.15.3 

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

type ParticipantOptions added in v0.9.4 

type ParticipantOptions struct {
	AutoSubscribe bool
}

type ParticipantParams 

type ParticipantParams struct {
	Identity                livekit.ParticipantIdentity
	Name                    livekit.ParticipantName
	SID                     livekit.ParticipantID
	Config                  *WebRTCConfig
	Sink                    routing.MessageSink
	AudioConfig             config.AudioConfig
	ProtocolVersion         types.ProtocolVersion
	Telemetry               telemetry.TelemetryService
	PLIThrottleConfig       config.PLIThrottleConfig
	CongestionControlConfig config.CongestionControlConfig
	EnabledCodecs           []*livekit.Codec
	Hidden                  bool
	Recorder                bool
	Logger                  logger.Logger
	SimTracks               map[uint32]SimulcastTrackInfo
	Grants                  *auth.ClaimGrants
	InitialVersion          uint32
}

type RTCPFeedbackConfig added in v0.15.2 

type RTCPFeedbackConfig struct {
	Audio []webrtc.RTCPFeedback
	Video []webrtc.RTCPFeedback
}

type RTPHeaderExtensionConfig added in v0.15.2 

type RTPHeaderExtensionConfig struct {
	Audio []string
	Video []string
}

type ReceiverConfig 

type ReceiverConfig struct {
	PacketBufferSize int
	// contains filtered or unexported fields
}

type Room 

type Room struct {
	Room   *livekit.Room
	Logger logger.Logger
	// contains filtered or unexported fields
}

func NewRoom 

func NewRoom(room *livekit.Room, config WebRTCConfig, audioConfig *config.AudioConfig, telemetry telemetry.TelemetryService) *Room

func (*Room) Close 

func (r *Room) Close()

func (*Room) CloseIfEmpty 

func (r *Room) CloseIfEmpty()

CloseIfEmpty closes the room if all participants had left, or it's still empty past timeout

func (*Room) DebugInfo added in v0.10.6 

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

func (*Room) FirstJoinedAt 

func (r *Room) FirstJoinedAt() int64

func (*Room) GetActiveSpeakers 

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

func (*Room) GetBufferFactory added in v0.15.2 

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

func (*Room) GetParticipant 

func (r *Room) GetParticipant(identity livekit.ParticipantIdentity) types.LocalParticipant

func (*Room) GetParticipantBySid added in v0.15.2 

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

func (*Room) GetParticipants 

func (r *Room) GetParticipants() []types.LocalParticipant

func (*Room) Hold added in v0.15.3 

func (r *Room) Hold() bool

func (*Room) ID added in v0.15.3 

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

func (*Room) IsClosed added in v0.13.7 

func (r *Room) IsClosed() bool

func (*Room) Join 

func (r *Room) Join(participant types.LocalParticipant, opts *ParticipantOptions, iceServers []*livekit.ICEServer) error

func (*Room) LastLeftAt 

func (r *Room) LastLeftAt() int64

func (*Room) Name added in v0.15.0 

func (r *Room) Name() livekit.RoomName

func (*Room) OnClose 

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

func (*Room) OnMetadataUpdate added in v0.13.1 

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

func (*Room) OnParticipantChanged 

func (r *Room) OnParticipantChanged(f func(participant types.LocalParticipant))

func (*Room) Release added in v0.15.3 

func (r *Room) Release()

func (*Room) RemoveDisallowedSubscriptions added in v0.15.2 

func (r *Room) RemoveDisallowedSubscriptions(sub types.LocalParticipant, disallowedSubscriptions map[livekit.TrackID]livekit.ParticipantID)

func (*Room) RemoveParticipant 

func (r *Room) RemoveParticipant(identity livekit.ParticipantIdentity)

func (*Room) ResumeParticipant added in v0.13.7 

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

func (*Room) SendDataPacket added in v0.12.2 

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

func (*Room) SetMetadata added in v0.13.1 

func (r *Room) SetMetadata(metadata string)

func (*Room) SetParticipantPermission added in v0.15.3 

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

func (*Room) SimulateScenario added in v0.15.3 

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

func (*Room) SyncState added in v0.15.3 

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

func (*Room) UpdateSubscriptionPermission added in v0.15.3 

func (r *Room) UpdateSubscriptionPermission(participant types.LocalParticipant, subscriptionPermission *livekit.SubscriptionPermission) error

func (*Room) UpdateSubscriptions 

func (r *Room) UpdateSubscriptions(
	participant types.LocalParticipant,
	trackIDs []livekit.TrackID,
	participantTracks []*livekit.ParticipantTracks,
	subscribe bool,
) error

func (*Room) UpdateVideoLayers added in v0.15.3 

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

type SimulcastTrackInfo added in v0.15.3 

type SimulcastTrackInfo struct {
	Mid string
	Rid string
}

type SubscribedTrack 

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

func NewSubscribedTrack 

func NewSubscribedTrack(params SubscribedTrackParams) *SubscribedTrack

func (*SubscribedTrack) Bound added in v0.15.0 

func (t *SubscribedTrack) Bound()

func (*SubscribedTrack) DownTrack 

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

func (*SubscribedTrack) ID 

func (t *SubscribedTrack) ID() livekit.TrackID

func (*SubscribedTrack) IsMuted 

func (t *SubscribedTrack) IsMuted() bool

has subscriber indicated it wants to mute this track

func (*SubscribedTrack) MediaTrack added in v0.15.0 

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

func (*SubscribedTrack) OnBind added in v0.15.0 

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

func (*SubscribedTrack) PublisherID added in v0.15.2 

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

func (*SubscribedTrack) PublisherIdentity added in v0.13.7 

func (t *SubscribedTrack) PublisherIdentity() livekit.ParticipantIdentity

func (*SubscribedTrack) SetPublisherMuted 

func (t *SubscribedTrack) SetPublisherMuted(muted bool)

func (*SubscribedTrack) SubscriberID added in v0.15.4 

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

func (*SubscribedTrack) UpdateSubscriberSettings added in v0.9.14 

func (t *SubscribedTrack) UpdateSubscriberSettings(settings *livekit.UpdateTrackSettings)

func (*SubscribedTrack) UpdateVideoLayer added in v0.15.0 

func (t *SubscribedTrack) UpdateVideoLayer()

type SubscribedTrackParams added in v0.15.0 

type SubscribedTrackParams struct {
	PublisherID       livekit.ParticipantID
	PublisherIdentity livekit.ParticipantIdentity
	SubscriberID      livekit.ParticipantID
	MediaTrack        types.MediaTrack
	DownTrack         *sfu.DownTrack
}

type TransportParams 

type TransportParams struct {
	ParticipantID           livekit.ParticipantID
	ParticipantIdentity     livekit.ParticipantIdentity
	ProtocolVersion         types.ProtocolVersion
	Target                  livekit.SignalTarget
	Config                  *WebRTCConfig
	CongestionControlConfig config.CongestionControlConfig
	Telemetry               telemetry.TelemetryService
	EnabledCodecs           []*livekit.Codec
	Logger                  logger.Logger
	SimTracks               map[uint32]SimulcastTrackInfo
}

type UnhandleSimulcastInterceptor added in v0.15.3 

type UnhandleSimulcastInterceptor struct {
	interceptor.NoOp
	// contains filtered or unexported fields
}

func (*UnhandleSimulcastInterceptor) BindRemoteStream added in v0.15.3 

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

type UnhandleSimulcastInterceptorFactory added in v0.15.3 

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

func NewUnhandleSimulcastInterceptorFactory added in v0.15.3 

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

func (*UnhandleSimulcastInterceptorFactory) NewInterceptor added in v0.15.3 

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

type UnhandleSimulcastOption added in v0.15.3 

type UnhandleSimulcastOption func(r *UnhandleSimulcastInterceptor) error

func UnhandleSimulcastTracks added in v0.15.3 

func UnhandleSimulcastTracks(tracks map[uint32]SimulcastTrackInfo) UnhandleSimulcastOption

type UpTrackManager added in v0.15.3 

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

func NewUpTrackManager added in v0.15.3 

func NewUpTrackManager(params UpTrackManagerParams) *UpTrackManager

func (*UpTrackManager) AddPublishedTrack added in v0.15.3 

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

func (*UpTrackManager) AddSubscriber added in v0.15.3 

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

AddSubscriber subscribes op to all publishedTracks

func (*UpTrackManager) Close added in v0.15.3 

func (u *UpTrackManager) Close()

func (*UpTrackManager) DebugInfo added in v0.15.3 

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

func (*UpTrackManager) GetPublishedTrack added in v0.15.3 

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

func (*UpTrackManager) GetPublishedTracks added in v0.15.3 

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

func (*UpTrackManager) OnPublishedTrackUpdated added in v0.15.3 

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

func (*UpTrackManager) OnUpTrackManagerClose added in v0.15.3 

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

func (*UpTrackManager) RemovePublishedTrack added in v0.15.3 

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

func (*UpTrackManager) RemoveSubscriber added in v0.15.3 

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

func (*UpTrackManager) SetPublishedTrackMuted added in v0.15.3 

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

func (*UpTrackManager) Start added in v0.15.3 

func (u *UpTrackManager) Start()

func (*UpTrackManager) SubscriptionPermission added in v0.15.3 

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

func (*UpTrackManager) ToProto added in v0.15.3 

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

func (*UpTrackManager) UpdateMediaLoss added in v0.15.3 

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

func (*UpTrackManager) UpdateSubscribedQuality added in v0.15.3 

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

func (*UpTrackManager) UpdateSubscriptionPermission added in v0.15.3 

func (u *UpTrackManager) UpdateSubscriptionPermission(
	subscriptionPermission *livekit.SubscriptionPermission,
	resolver func(participantID livekit.ParticipantID) types.LocalParticipant,
) error

func (*UpTrackManager) UpdateVideoLayers added in v0.15.3 

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

type UpTrackManagerParams added in v0.15.3 

type UpTrackManagerParams struct {
	SID    livekit.ParticipantID
	Logger logger.Logger
}

type WebRTCConfig 

type WebRTCConfig struct {
	Configuration  webrtc.Configuration
	SettingEngine  webrtc.SettingEngine
	Receiver       ReceiverConfig
	BufferFactory  *buffer.Factory
	UDPMux         ice.UDPMux
	UDPMuxConn     *net.UDPConn
	TCPMuxListener *net.TCPListener
	Publisher      DirectionConfig
	Subscriber     DirectionConfig
}

func NewWebRTCConfig 

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

func (*WebRTCConfig) SetBufferFactory added in v0.9.11 

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

type WrappedReceiver 

type WrappedReceiver struct {
	sfu.TrackReceiver
	// contains filtered or unexported fields
}

func NewWrappedReceiver 

func NewWrappedReceiver(receiver sfu.TrackReceiver, trackID livekit.TrackID, streamId string) WrappedReceiver

func (WrappedReceiver) StreamID 

func (r WrappedReceiver) StreamID() string

func (WrappedReceiver) TrackID 

func (r WrappedReceiver) TrackID() livekit.TrackID

Source Files

View all Source files

Directories

Path Synopsis
typesfakes
Code generated by counterfeiter.
 Code generated by counterfeiter.

Jump to

Keyboard shortcuts

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