Package livekit
See: Description
-
Enum Summary Enum Description AudioCodec Protobuf enum {@code livekit.AudioCodec}VideoCodec Protobuf enum {@code livekit.VideoCodec}ImageCodec Protobuf enum {@code livekit.ImageCodec}TrackType Protobuf enum {@code livekit.TrackType}TrackSource Protobuf enum {@code livekit.TrackSource}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}State Protobuf enum {@code livekit.ParticipantInfo.State}Type Protobuf enum {@code livekit.Encryption.Type}Kind Protobuf enum {@code livekit.DataPacket.Kind}ValueCase Edition Protobuf enum {@code livekit.ServerInfo.Edition}SDK Protobuf enum {@code livekit.ClientInfo.SDK}StreamType Protobuf enum {@code livekit.StreamType}AnalyticsEventType Protobuf enum {@code livekit.AnalyticsEventType}SignalTarget Protobuf enum {@code livekit.SignalTarget}StreamState Protobuf enum {@code livekit.StreamState}CandidateProtocol Protobuf enum {@code livekit.CandidateProtocol}MessageCase MessageCase ScenarioCase EncodedFileType Protobuf enum {@code livekit.EncodedFileType}SegmentedFileProtocol Protobuf enum {@code livekit.SegmentedFileProtocol}SegmentedFileSuffix Protobuf enum {@code livekit.SegmentedFileSuffix}ImageFileSuffix Protobuf enum {@code livekit.ImageFileSuffix}StreamProtocol Protobuf enum {@code livekit.StreamProtocol}EncodingOptionsPreset Protobuf enum {@code livekit.EncodingOptionsPreset}EgressStatus Protobuf enum {@code livekit.EgressStatus}OutputCase OptionsCase OutputCase OptionsCase OptionsCase OutputCase OptionsCase OutputCase OutputCase OutputCase OutputCase OutputCase RequestCase ResultCase Status Protobuf enum {@code livekit.StreamInfo.Status}OptionsCase OutputCase NodeType Protobuf enum {@code livekit.NodeType}NodeState Protobuf enum {@code livekit.NodeState}ICECandidateType Protobuf enum {@code livekit.ICECandidateType}MessageCase MessageCase IngressInput Protobuf enum {@code livekit.IngressInput}IngressAudioEncodingPreset Protobuf enum {@code livekit.IngressAudioEncodingPreset}IngressVideoEncodingPreset Protobuf enum {@code livekit.IngressVideoEncodingPreset}EncodingOptionsCase EncodingOptionsCase Status Protobuf enum {@code livekit.IngressState.Status} -
-
Class Summary Class Description 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 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.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.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.TimedVersion}TimedVersion Protobuf type {@code livekit.TimedVersion}LivekitModels Builder Protobuf type {@code livekit.AnalyticsVideoLayer}AnalyticsVideoLayer Protobuf type {@code livekit.AnalyticsVideoLayer}Builder Protobuf type {@code livekit.AnalyticsStream}AnalyticsStream Protobuf type {@code livekit.AnalyticsStream}Builder Protobuf type {@code livekit.AnalyticsStat}AnalyticsStat Protobuf type {@code livekit.AnalyticsStat}Builder Protobuf type {@code livekit.AnalyticsStats}AnalyticsStats Protobuf type {@code livekit.AnalyticsStats}Builder Protobuf type {@code livekit.AnalyticsClientMeta}AnalyticsClientMeta Protobuf type {@code livekit.AnalyticsClientMeta}Builder Protobuf type {@code livekit.AnalyticsEvent}AnalyticsEvent Protobuf type {@code livekit.AnalyticsEvent}Builder Protobuf type {@code livekit.AnalyticsEvents}AnalyticsEvents Protobuf type {@code livekit.AnalyticsEvents}LivekitAnalytics Builder Protobuf type {@code livekit.CreateRoomRequest}CreateRoomRequest Protobuf type {@code livekit.CreateRoomRequest}Builder Protobuf type {@code livekit.RoomEgress}RoomEgress Protobuf type {@code livekit.RoomEgress}Builder Protobuf type {@code livekit.ListRoomsRequest}ListRoomsRequest Protobuf type {@code livekit.ListRoomsRequest}Builder Protobuf type {@code livekit.ListRoomsResponse}ListRoomsResponse Protobuf type {@code livekit.ListRoomsResponse}Builder Protobuf type {@code livekit.DeleteRoomRequest}DeleteRoomRequest Protobuf type {@code livekit.DeleteRoomRequest}Builder Protobuf type {@code livekit.DeleteRoomResponse}DeleteRoomResponse Protobuf type {@code livekit.DeleteRoomResponse}Builder Protobuf type {@code livekit.ListParticipantsRequest}ListParticipantsRequest Protobuf type {@code livekit.ListParticipantsRequest}Builder Protobuf type {@code livekit.ListParticipantsResponse}ListParticipantsResponse Protobuf type {@code livekit.ListParticipantsResponse}Builder Protobuf type {@code livekit.RoomParticipantIdentity}RoomParticipantIdentity Protobuf type {@code livekit.RoomParticipantIdentity}Builder Protobuf type {@code livekit.RemoveParticipantResponse}RemoveParticipantResponse Protobuf type {@code livekit.RemoveParticipantResponse}Builder Protobuf type {@code livekit.MuteRoomTrackRequest}MuteRoomTrackRequest Protobuf type {@code livekit.MuteRoomTrackRequest}Builder Protobuf type {@code livekit.MuteRoomTrackResponse}MuteRoomTrackResponse Protobuf type {@code livekit.MuteRoomTrackResponse}Builder Protobuf type {@code livekit.UpdateParticipantRequest}UpdateParticipantRequest Protobuf type {@code livekit.UpdateParticipantRequest}Builder Protobuf type {@code livekit.UpdateSubscriptionsRequest}UpdateSubscriptionsRequest Protobuf type {@code livekit.UpdateSubscriptionsRequest}Builder
Protobuf typeempty for now{@code livekit.UpdateSubscriptionsResponse}UpdateSubscriptionsResponse
Protobuf typeempty for now{@code livekit.UpdateSubscriptionsResponse}Builder Protobuf type {@code livekit.SendDataRequest}SendDataRequest Protobuf type {@code livekit.SendDataRequest}Builder
Protobuf type{@code livekit.SendDataResponse}SendDataResponse
Protobuf type{@code livekit.SendDataResponse}Builder Protobuf type {@code livekit.UpdateRoomMetadataRequest}UpdateRoomMetadataRequest Protobuf type {@code livekit.UpdateRoomMetadataRequest}LivekitRoom 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.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.UpdateTrackSettings}UpdateTrackSettings Protobuf type {@code livekit.UpdateTrackSettings}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.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.SyncState}SyncState Protobuf type {@code livekit.SyncState}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}LivekitRtc Builder Protobuf type {@code livekit.WebhookEvent}WebhookEvent Protobuf type {@code livekit.WebhookEvent}LivekitWebhook Builder
Protobuf typecomposite using a web browser{@code livekit.RoomCompositeEgressRequest}RoomCompositeEgressRequest
Protobuf typecomposite using a web browser{@code livekit.RoomCompositeEgressRequest}Builder
Protobuf typerecord any website{@code livekit.WebEgressRequest}WebEgressRequest
Protobuf typerecord any website{@code livekit.WebEgressRequest}Builder
Protobuf typerecord audio and video from a single participant{@code livekit.ParticipantEgressRequest}ParticipantEgressRequest
Protobuf typerecord audio and video from a single participant{@code livekit.ParticipantEgressRequest}Builder
Protobuf typecontainerize up to one audio and one video track{@code livekit.TrackCompositeEgressRequest}TrackCompositeEgressRequest
Protobuf typecontainerize up to one audio and one video track{@code livekit.TrackCompositeEgressRequest}Builder
Protobuf typerecord tracks individually, without transcoding{@code livekit.TrackEgressRequest}TrackEgressRequest
Protobuf typerecord tracks individually, without transcoding{@code livekit.TrackEgressRequest}Builder Protobuf type {@code livekit.EncodedFileOutput}EncodedFileOutput Protobuf type {@code livekit.EncodedFileOutput}Builder
Protobuf typeUsed to generate HLS segments or other kind of segmented output{@code livekit.SegmentedFileOutput}SegmentedFileOutput
Protobuf typeUsed to generate HLS segments or other kind of segmented output{@code livekit.SegmentedFileOutput}Builder Protobuf type {@code livekit.DirectFileOutput}DirectFileOutput Protobuf type {@code livekit.DirectFileOutput}Builder Protobuf type {@code livekit.ImageOutput}ImageOutput Protobuf type {@code livekit.ImageOutput}Builder Protobuf type {@code livekit.S3Upload}S3Upload Protobuf type {@code livekit.S3Upload}Builder Protobuf type {@code livekit.GCPUpload}GCPUpload Protobuf type {@code livekit.GCPUpload}Builder Protobuf type {@code livekit.AzureBlobUpload}AzureBlobUpload Protobuf type {@code livekit.AzureBlobUpload}Builder Protobuf type {@code livekit.AliOSSUpload}AliOSSUpload Protobuf type {@code livekit.AliOSSUpload}Builder Protobuf type {@code livekit.StreamOutput}StreamOutput Protobuf type {@code livekit.StreamOutput}Builder Protobuf type {@code livekit.EncodingOptions}EncodingOptions Protobuf type {@code livekit.EncodingOptions}Builder Protobuf type {@code livekit.UpdateLayoutRequest}UpdateLayoutRequest Protobuf type {@code livekit.UpdateLayoutRequest}Builder Protobuf type {@code livekit.UpdateStreamRequest}UpdateStreamRequest Protobuf type {@code livekit.UpdateStreamRequest}Builder Protobuf type {@code livekit.UpdateOutputsRequest}UpdateOutputsRequest Protobuf type {@code livekit.UpdateOutputsRequest}Builder Protobuf type {@code livekit.ListEgressRequest}ListEgressRequest Protobuf type {@code livekit.ListEgressRequest}Builder Protobuf type {@code livekit.ListEgressResponse}ListEgressResponse Protobuf type {@code livekit.ListEgressResponse}Builder Protobuf type {@code livekit.StopEgressRequest}StopEgressRequest Protobuf type {@code livekit.StopEgressRequest}Builder Protobuf type {@code livekit.EgressInfo}EgressInfo Protobuf type {@code livekit.EgressInfo}Builder Protobuf type {@code livekit.StreamInfoList}StreamInfoList Protobuf type {@code livekit.StreamInfoList}Builder Protobuf type {@code livekit.StreamInfo}StreamInfo Protobuf type {@code livekit.StreamInfo}Builder Protobuf type {@code livekit.FileInfo}FileInfo Protobuf type {@code livekit.FileInfo}Builder Protobuf type {@code livekit.SegmentsInfo}SegmentsInfo Protobuf type {@code livekit.SegmentsInfo}Builder Protobuf type {@code livekit.ImagesInfo}ImagesInfo Protobuf type {@code livekit.ImagesInfo}Builder Protobuf type {@code livekit.AutoParticipantEgress}AutoParticipantEgress Protobuf type {@code livekit.AutoParticipantEgress}Builder Protobuf type {@code livekit.AutoTrackEgress}AutoTrackEgress Protobuf type {@code livekit.AutoTrackEgress}LivekitEgress Builder Protobuf type {@code livekit.Node}Node Protobuf type {@code livekit.Node}Builder Protobuf type {@code livekit.NodeStats}NodeStats Protobuf type {@code livekit.NodeStats}Builder
Protobuf typemessage to RTC nodes{@code livekit.RTCNodeMessage}RTCNodeMessage
Protobuf typemessage to RTC nodes{@code livekit.RTCNodeMessage}Builder
Protobuf typemessage to Signal nodes{@code livekit.SignalNodeMessage}SignalNodeMessage
Protobuf typemessage to Signal nodes{@code livekit.SignalNodeMessage}Builder Protobuf type {@code livekit.StartSession}StartSession Protobuf type {@code livekit.StartSession}Builder Protobuf type {@code livekit.EndSession}EndSession Protobuf type {@code livekit.EndSession}Builder Protobuf type {@code livekit.RemoveParticipant}RemoveParticipant Protobuf type {@code livekit.RemoveParticipant}Builder Protobuf type {@code livekit.KeepAlive}KeepAlive Protobuf type {@code livekit.KeepAlive}Builder
Protobuf typeroom info that should not be returned to clients{@code livekit.RoomInternal}RoomInternal
Protobuf typeroom info that should not be returned to clients{@code livekit.RoomInternal}Builder Protobuf type {@code livekit.ICEConfig}ICEConfig Protobuf type {@code livekit.ICEConfig}LivekitInternal Builder Protobuf type {@code livekit.CreateIngressRequest}CreateIngressRequest Protobuf type {@code livekit.CreateIngressRequest}Builder Protobuf type {@code livekit.IngressAudioOptions}IngressAudioOptions Protobuf type {@code livekit.IngressAudioOptions}Builder Protobuf type {@code livekit.IngressVideoOptions}IngressVideoOptions Protobuf type {@code livekit.IngressVideoOptions}Builder Protobuf type {@code livekit.IngressAudioEncodingOptions}IngressAudioEncodingOptions Protobuf type {@code livekit.IngressAudioEncodingOptions}Builder Protobuf type {@code livekit.IngressVideoEncodingOptions}IngressVideoEncodingOptions Protobuf type {@code livekit.IngressVideoEncodingOptions}Builder Protobuf type {@code livekit.IngressInfo}IngressInfo Protobuf type {@code livekit.IngressInfo}Builder Protobuf type {@code livekit.IngressState}IngressState Protobuf type {@code livekit.IngressState}Builder Protobuf type {@code livekit.InputVideoState}InputVideoState Protobuf type {@code livekit.InputVideoState}Builder Protobuf type {@code livekit.InputAudioState}InputAudioState Protobuf type {@code livekit.InputAudioState}Builder Protobuf type {@code livekit.UpdateIngressRequest}UpdateIngressRequest Protobuf type {@code livekit.UpdateIngressRequest}Builder Protobuf type {@code livekit.ListIngressRequest}ListIngressRequest Protobuf type {@code livekit.ListIngressRequest}Builder Protobuf type {@code livekit.ListIngressResponse}ListIngressResponse Protobuf type {@code livekit.ListIngressResponse}Builder Protobuf type {@code livekit.DeleteIngressRequest}DeleteIngressRequest Protobuf type {@code livekit.DeleteIngressRequest}LivekitIngress