Package livekit
See: Description
-
Enum Summary Enum Description MetricLabel
Protobuf enumindex from [0: MAX_LABEL_PREDEFINED_MAX_VALUE) are for predefined labels (`MetricLabel`){@code livekit.MetricLabel}SignalTarget Protobuf enum {@code livekit.SignalTarget}StreamState Protobuf enum {@code livekit.StreamState}CandidateProtocol Protobuf enum {@code livekit.CandidateProtocol}MessageCase MessageCase Action
Protobuf enumindicates action clients should take on receiving this message{@code livekit.LeaveRequest.Action}ScenarioCase Reason Protobuf enum {@code livekit.RequestResponse.Reason}RequestCase Compression Protobuf enum {@code livekit.WrappedJoinRequest.Compression}AudioCodec Protobuf enum {@code livekit.AudioCodec}VideoCodec Protobuf enum {@code livekit.VideoCodec}ImageCodec Protobuf enum {@code livekit.ImageCodec}BackupCodecPolicy
Protobuf enumPolicy for publisher to handle subscribers that are unable to support the primary codec of a track{@code livekit.BackupCodecPolicy}TrackType Protobuf enum {@code livekit.TrackType}TrackSource Protobuf enum {@code livekit.TrackSource}DataTrackExtensionID Protobuf enum {@code livekit.DataTrackExtensionID}VideoQuality Protobuf enum {@code livekit.VideoQuality}ConnectionQuality Protobuf enum {@code livekit.ConnectionQuality}ClientConfigSetting Protobuf enum {@code livekit.ClientConfigSetting}DisconnectReason Protobuf enum {@code livekit.DisconnectReason}ReconnectReason Protobuf enum {@code livekit.ReconnectReason}SubscriptionError Protobuf enum {@code livekit.SubscriptionError}AudioTrackFeature Protobuf enum {@code livekit.AudioTrackFeature}PacketTrailerFeature Protobuf enum {@code livekit.PacketTrailerFeature}State Protobuf enum {@code livekit.ParticipantInfo.State}Kind Protobuf enum {@code livekit.ParticipantInfo.Kind}KindDetail Protobuf enum {@code livekit.ParticipantInfo.KindDetail}Type Protobuf enum {@code livekit.Encryption.Type}Mode Protobuf enum {@code livekit.VideoLayer.Mode}Kind Protobuf enum {@code livekit.DataPacket.Kind}ValueCase ValueCase ValueCase Edition Protobuf enum {@code livekit.ServerInfo.Edition}SDK Protobuf enum {@code livekit.ClientInfo.SDK}Capability
Protobuf enumOptional capabilities advertised by the client at connect time. The SFU uses these flags to decide whether to enable features that require client-side support (e.g. passing RTP packet trailers through to the subscriber instead of stripping them).{@code livekit.ClientInfo.Capability}CodecMungerCase OperationType
Protobuf enumenum for operation types (specific to TextHeader){@code livekit.DataStream.OperationType}ContentHeaderCase -
-
Class Summary Class Description Builder Protobuf type {@code livekit.MetricsBatch}MetricsBatch Protobuf type {@code livekit.MetricsBatch}Builder Protobuf type {@code livekit.TimeSeriesMetric}TimeSeriesMetric Protobuf type {@code livekit.TimeSeriesMetric}Builder Protobuf type {@code livekit.MetricSample}MetricSample Protobuf type {@code livekit.MetricSample}Builder Protobuf type {@code livekit.EventMetric}EventMetric Protobuf type {@code livekit.EventMetric}Builder Protobuf type {@code livekit.MetricsRecordingHeader}MetricsRecordingHeader Protobuf type {@code livekit.MetricsRecordingHeader}LivekitMetrics Builder Protobuf type {@code livekit.SignalRequest}SignalRequest Protobuf type {@code livekit.SignalRequest}Builder Protobuf type {@code livekit.SignalResponse}SignalResponse Protobuf type {@code livekit.SignalResponse}Builder Protobuf type {@code livekit.SimulcastCodec}SimulcastCodec Protobuf type {@code livekit.SimulcastCodec}Builder Protobuf type {@code livekit.AddTrackRequest}AddTrackRequest Protobuf type {@code livekit.AddTrackRequest}Builder Protobuf type {@code livekit.PublishDataTrackRequest}PublishDataTrackRequest Protobuf type {@code livekit.PublishDataTrackRequest}Builder Protobuf type {@code livekit.PublishDataTrackResponse}PublishDataTrackResponse Protobuf type {@code livekit.PublishDataTrackResponse}Builder Protobuf type {@code livekit.UnpublishDataTrackRequest}UnpublishDataTrackRequest Protobuf type {@code livekit.UnpublishDataTrackRequest}Builder Protobuf type {@code livekit.UnpublishDataTrackResponse}UnpublishDataTrackResponse Protobuf type {@code livekit.UnpublishDataTrackResponse}Builder Protobuf type {@code livekit.DataTrackSubscriberHandles.PublishedDataTrack}PublishedDataTrack Protobuf type {@code livekit.DataTrackSubscriberHandles.PublishedDataTrack}Builder Protobuf type {@code livekit.DataTrackSubscriberHandles}DataTrackSubscriberHandles Protobuf type {@code livekit.DataTrackSubscriberHandles}Builder Protobuf type {@code livekit.TrickleRequest}TrickleRequest Protobuf type {@code livekit.TrickleRequest}Builder Protobuf type {@code livekit.MuteTrackRequest}MuteTrackRequest Protobuf type {@code livekit.MuteTrackRequest}Builder Protobuf type {@code livekit.JoinResponse}JoinResponse Protobuf type {@code livekit.JoinResponse}Builder Protobuf type {@code livekit.ReconnectResponse}ReconnectResponse Protobuf type {@code livekit.ReconnectResponse}Builder Protobuf type {@code livekit.TrackPublishedResponse}TrackPublishedResponse Protobuf type {@code livekit.TrackPublishedResponse}Builder Protobuf type {@code livekit.TrackUnpublishedResponse}TrackUnpublishedResponse Protobuf type {@code livekit.TrackUnpublishedResponse}Builder Protobuf type {@code livekit.SessionDescription}SessionDescription Protobuf type {@code livekit.SessionDescription}Builder Protobuf type {@code livekit.ParticipantUpdate}ParticipantUpdate Protobuf type {@code livekit.ParticipantUpdate}Builder Protobuf type {@code livekit.UpdateSubscription}UpdateSubscription Protobuf type {@code livekit.UpdateSubscription}Builder Protobuf type {@code livekit.UpdateDataSubscription.Update}Update Protobuf type {@code livekit.UpdateDataSubscription.Update}Builder Protobuf type {@code livekit.UpdateDataSubscription}UpdateDataSubscription Protobuf type {@code livekit.UpdateDataSubscription}Builder Protobuf type {@code livekit.UpdateTrackSettings}UpdateTrackSettings Protobuf type {@code livekit.UpdateTrackSettings}Builder Protobuf type {@code livekit.UpdateLocalAudioTrack}UpdateLocalAudioTrack Protobuf type {@code livekit.UpdateLocalAudioTrack}Builder Protobuf type {@code livekit.UpdateLocalVideoTrack}UpdateLocalVideoTrack Protobuf type {@code livekit.UpdateLocalVideoTrack}Builder Protobuf type {@code livekit.LeaveRequest}LeaveRequest Protobuf type {@code livekit.LeaveRequest}Builder
Protobuf typemessage to indicate published video track dimensions are changing{@code livekit.UpdateVideoLayers}UpdateVideoLayers
Protobuf typemessage to indicate published video track dimensions are changing{@code livekit.UpdateVideoLayers}Builder Protobuf type {@code livekit.UpdateParticipantMetadata}UpdateParticipantMetadata Protobuf type {@code livekit.UpdateParticipantMetadata}Builder Protobuf type {@code livekit.ICEServer}ICEServer Protobuf type {@code livekit.ICEServer}Builder Protobuf type {@code livekit.SpeakersChanged}SpeakersChanged Protobuf type {@code livekit.SpeakersChanged}Builder Protobuf type {@code livekit.RoomUpdate}RoomUpdate Protobuf type {@code livekit.RoomUpdate}Builder Protobuf type {@code livekit.ConnectionQualityInfo}ConnectionQualityInfo Protobuf type {@code livekit.ConnectionQualityInfo}Builder Protobuf type {@code livekit.ConnectionQualityUpdate}ConnectionQualityUpdate Protobuf type {@code livekit.ConnectionQualityUpdate}Builder Protobuf type {@code livekit.StreamStateInfo}StreamStateInfo Protobuf type {@code livekit.StreamStateInfo}Builder Protobuf type {@code livekit.StreamStateUpdate}StreamStateUpdate Protobuf type {@code livekit.StreamStateUpdate}Builder Protobuf type {@code livekit.SubscribedQuality}SubscribedQuality Protobuf type {@code livekit.SubscribedQuality}Builder Protobuf type {@code livekit.SubscribedCodec}SubscribedCodec Protobuf type {@code livekit.SubscribedCodec}Builder Protobuf type {@code livekit.SubscribedQualityUpdate}SubscribedQualityUpdate Protobuf type {@code livekit.SubscribedQualityUpdate}Builder Protobuf type {@code livekit.SubscribedAudioCodecUpdate}SubscribedAudioCodecUpdate Protobuf type {@code livekit.SubscribedAudioCodecUpdate}Builder Protobuf type {@code livekit.TrackPermission}TrackPermission Protobuf type {@code livekit.TrackPermission}Builder Protobuf type {@code livekit.SubscriptionPermission}SubscriptionPermission Protobuf type {@code livekit.SubscriptionPermission}Builder Protobuf type {@code livekit.SubscriptionPermissionUpdate}SubscriptionPermissionUpdate Protobuf type {@code livekit.SubscriptionPermissionUpdate}Builder Protobuf type {@code livekit.RoomMovedResponse}RoomMovedResponse Protobuf type {@code livekit.RoomMovedResponse}Builder Protobuf type {@code livekit.SyncState}SyncState Protobuf type {@code livekit.SyncState}Builder Protobuf type {@code livekit.DataChannelReceiveState}DataChannelReceiveState Protobuf type {@code livekit.DataChannelReceiveState}Builder Protobuf type {@code livekit.DataChannelInfo}DataChannelInfo Protobuf type {@code livekit.DataChannelInfo}Builder Protobuf type {@code livekit.SimulateScenario}SimulateScenario Protobuf type {@code livekit.SimulateScenario}Builder Protobuf type {@code livekit.Ping}Ping Protobuf type {@code livekit.Ping}Builder Protobuf type {@code livekit.Pong}Pong Protobuf type {@code livekit.Pong}Builder Protobuf type {@code livekit.RegionSettings}RegionSettings Protobuf type {@code livekit.RegionSettings}Builder Protobuf type {@code livekit.RegionInfo}RegionInfo Protobuf type {@code livekit.RegionInfo}Builder Protobuf type {@code livekit.SubscriptionResponse}SubscriptionResponse Protobuf type {@code livekit.SubscriptionResponse}Builder Protobuf type {@code livekit.RequestResponse}RequestResponse Protobuf type {@code livekit.RequestResponse}Builder Protobuf type {@code livekit.TrackSubscribed}TrackSubscribed Protobuf type {@code livekit.TrackSubscribed}Builder Protobuf type {@code livekit.ConnectionSettings}ConnectionSettings Protobuf type {@code livekit.ConnectionSettings}Builder Protobuf type {@code livekit.JoinRequest}JoinRequest Protobuf type {@code livekit.JoinRequest}Builder Protobuf type {@code livekit.WrappedJoinRequest}WrappedJoinRequest Protobuf type {@code livekit.WrappedJoinRequest}Builder Protobuf type {@code livekit.MediaSectionsRequirement}MediaSectionsRequirement Protobuf type {@code livekit.MediaSectionsRequirement}LivekitRtc Builder Protobuf type {@code livekit.Pagination}Pagination Protobuf type {@code livekit.Pagination}Builder Protobuf type {@code livekit.TokenPagination}TokenPagination Protobuf type {@code livekit.TokenPagination}Builder
Protobuf typeListUpdate is used for updated APIs where 'repeated string' field is modified.{@code livekit.ListUpdate}ListUpdate
Protobuf typeListUpdate is used for updated APIs where 'repeated string' field is modified.{@code livekit.ListUpdate}Builder Protobuf type {@code livekit.Room}Room Protobuf type {@code livekit.Room}Builder Protobuf type {@code livekit.Codec}Codec Protobuf type {@code livekit.Codec}Builder Protobuf type {@code livekit.PlayoutDelay}PlayoutDelay Protobuf type {@code livekit.PlayoutDelay}Builder Protobuf type {@code livekit.ParticipantPermission}ParticipantPermission Protobuf type {@code livekit.ParticipantPermission}Builder Protobuf type {@code livekit.ParticipantInfo}ParticipantInfo Protobuf type {@code livekit.ParticipantInfo}Builder Protobuf type {@code livekit.Encryption}Encryption Protobuf type {@code livekit.Encryption}Builder Protobuf type {@code livekit.SimulcastCodecInfo}SimulcastCodecInfo Protobuf type {@code livekit.SimulcastCodecInfo}Builder Protobuf type {@code livekit.TrackInfo}TrackInfo Protobuf type {@code livekit.TrackInfo}Builder Protobuf type {@code livekit.DataTrackInfo}DataTrackInfo Protobuf type {@code livekit.DataTrackInfo}Builder Protobuf type {@code livekit.DataTrackExtensionParticipantSid}DataTrackExtensionParticipantSid Protobuf type {@code livekit.DataTrackExtensionParticipantSid}Builder Protobuf type {@code livekit.DataTrackSubscriptionOptions}DataTrackSubscriptionOptions Protobuf type {@code livekit.DataTrackSubscriptionOptions}Builder
Protobuf typeprovide information about available spatial layers{@code livekit.VideoLayer}VideoLayer
Protobuf typeprovide information about available spatial layers{@code livekit.VideoLayer}Builder
Protobuf typenew DataPacket API{@code livekit.DataPacket}DataPacket
Protobuf typenew DataPacket API{@code livekit.DataPacket}Builder Protobuf type {@code livekit.EncryptedPacket}EncryptedPacket Protobuf type {@code livekit.EncryptedPacket}Builder Protobuf type {@code livekit.EncryptedPacketPayload}EncryptedPacketPayload Protobuf type {@code livekit.EncryptedPacketPayload}Builder Protobuf type {@code livekit.ActiveSpeakerUpdate}ActiveSpeakerUpdate Protobuf type {@code livekit.ActiveSpeakerUpdate}Builder Protobuf type {@code livekit.SpeakerInfo}SpeakerInfo Protobuf type {@code livekit.SpeakerInfo}Builder Protobuf type {@code livekit.UserPacket}UserPacket Protobuf type {@code livekit.UserPacket}Builder Protobuf type {@code livekit.SipDTMF}SipDTMF Protobuf type {@code livekit.SipDTMF}Builder Protobuf type {@code livekit.Transcription}Transcription Protobuf type {@code livekit.Transcription}Builder Protobuf type {@code livekit.TranscriptionSegment}TranscriptionSegment Protobuf type {@code livekit.TranscriptionSegment}Builder Protobuf type {@code livekit.ChatMessage}ChatMessage Protobuf type {@code livekit.ChatMessage}Builder Protobuf type {@code livekit.RpcRequest}RpcRequest Protobuf type {@code livekit.RpcRequest}Builder Protobuf type {@code livekit.RpcAck}RpcAck Protobuf type {@code livekit.RpcAck}Builder Protobuf type {@code livekit.RpcResponse}RpcResponse Protobuf type {@code livekit.RpcResponse}Builder Protobuf type {@code livekit.RpcError}RpcError Protobuf type {@code livekit.RpcError}Builder Protobuf type {@code livekit.ParticipantTracks}ParticipantTracks Protobuf type {@code livekit.ParticipantTracks}Builder
Protobuf typedetails about the server{@code livekit.ServerInfo}ServerInfo
Protobuf typedetails about the server{@code livekit.ServerInfo}Builder
Protobuf typedetails about the client{@code livekit.ClientInfo}ClientInfo
Protobuf typedetails about the client{@code livekit.ClientInfo}Builder
Protobuf typeserver provided client configuration{@code livekit.ClientConfiguration}ClientConfiguration
Protobuf typeserver provided client configuration{@code livekit.ClientConfiguration}Builder Protobuf type {@code livekit.VideoConfiguration}VideoConfiguration Protobuf type {@code livekit.VideoConfiguration}Builder Protobuf type {@code livekit.DisabledCodecs}DisabledCodecs Protobuf type {@code livekit.DisabledCodecs}Builder Protobuf type {@code livekit.RTPDrift}RTPDrift Protobuf type {@code livekit.RTPDrift}Builder Protobuf type {@code livekit.RTPStats}RTPStats Protobuf type {@code livekit.RTPStats}Builder Protobuf type {@code livekit.RTCPSenderReportState}RTCPSenderReportState Protobuf type {@code livekit.RTCPSenderReportState}Builder Protobuf type {@code livekit.RTPForwarderState}RTPForwarderState Protobuf type {@code livekit.RTPForwarderState}Builder Protobuf type {@code livekit.RTPMungerState}RTPMungerState Protobuf type {@code livekit.RTPMungerState}Builder Protobuf type {@code livekit.VP8MungerState}VP8MungerState Protobuf type {@code livekit.VP8MungerState}Builder Protobuf type {@code livekit.TimedVersion}TimedVersion Protobuf type {@code livekit.TimedVersion}Builder
Protobuf typeheader properties specific to text streams{@code livekit.DataStream.TextHeader}TextHeader
Protobuf typeheader properties specific to text streams{@code livekit.DataStream.TextHeader}Builder
Protobuf typeheader properties specific to byte or file streams{@code livekit.DataStream.ByteHeader}ByteHeader
Protobuf typeheader properties specific to byte or file streams{@code livekit.DataStream.ByteHeader}Builder
Protobuf typemain DataStream.Header that contains a oneof for specific headers{@code livekit.DataStream.Header}Header
Protobuf typemain DataStream.Header that contains a oneof for specific headers{@code livekit.DataStream.Header}Builder Protobuf type {@code livekit.DataStream.Chunk}Chunk Protobuf type {@code livekit.DataStream.Chunk}Builder Protobuf type {@code livekit.DataStream.Trailer}Trailer Protobuf type {@code livekit.DataStream.Trailer}Builder Protobuf type {@code livekit.DataStream}DataStream Protobuf type {@code livekit.DataStream}Builder Protobuf type {@code livekit.FilterParams}FilterParams Protobuf type {@code livekit.FilterParams}Builder Protobuf type {@code livekit.WebhookConfig}WebhookConfig Protobuf type {@code livekit.WebhookConfig}Builder Protobuf type {@code livekit.SubscribedAudioCodec}SubscribedAudioCodec Protobuf type {@code livekit.SubscribedAudioCodec}LivekitModels