Package org.kurento.client
-
Interface Summary Interface Description AlphaBlending AHub
that mixes theMediaType.AUDIO
stream of its connected sources and constructs one output withMediaType.VIDEO
streams of its connected sources into its sinkBaseRtpEndpoint Base class for the implementation of RTP-based communication endpoints.Composite AHub
that mixes theMediaType.AUDIO
stream of its connected sources and constructs a grid with theMediaType.VIDEO
streams of its connected sources into its sinkContinuation<F> This interface is to be used in asynchronous calls to the media server.Dispatcher AHub
that allows routing between arbitrary port pairsDispatcherOneToMany AHub
that sends a given source to all the connected sinksEndpoint Base interface for all end points.Event Parent interface for Kurento events.EventListener<T extends Event> Interface to be implemented byMediaEvent
listeners.FaceOverlayFilter FaceOverlayFilter interface.Filter Base interface for all filters.GenericMediaElement GStreamerFilter A generic filter that allows injecting a single GStreamer element.Handler HttpEndpoint Endpoint that enables Kurento to work as an HTTP server, allowing peer HTTP clients to access media.HttpPostEndpoint AnHttpPostEndpoint
contains SINK pads for AUDIO and VIDEO, which provide access to an HTTP file upload function This type of endpoint provide unidirectional communications.Hub A Hub is a routingMediaObject
.HubPort ThisMediaElement
specifies a connection with aHub
ImageOverlayFilter ImageOverlayFilter interface.KurentoConnectionListener KurentoObject ListenerSubscription Interface to be implemented by objects that represent the subscription to an event in Kurento.MediaElement The basic building block of the media server, that can be interconnected inside a pipeline.MediaObject Base interface used to manage capabilities common to all Kurento elements.MediaPipeline A pipeline is a container for a collection ofMediaElements
and :rom:cls:`MediaMixers`. Mixer AHub
that allows routing of video between arbitrary port pairs and mixing of audio among several portsOpenCVFilter Generic OpenCV FilterPassThrough ThisMediaElement
that just passes media throughPlayerEndpoint Retrieves content from external sources.ReconnectedHandler RecorderEndpoint Provides functionality to store media contents.RtpEndpoint Endpoint that provides bidirectional content delivery capabilities through the RTP or SRTP protocols.SdpEndpoint Interface implemented by Endpoints that require an SDP Offer/Answer negotiation in order to configure a media session.ServerManager This is a standalone object for managing the MediaServerSessionEndpoint All networked Endpoints that require to manage connection sessions with remote peers implement this interface.TFuture<V> Transaction UriEndpoint Interface for endpoints the require a URI to work.WebRtcEndpoint Endpoint that provides bidirectional WebRTC capabilities for Kurento.ZBarFilter This filter detects QR codes in a video feed. -
Class Summary Class Description AbstractBuilder<T> Kurento Media Builder base interface.AlphaBlending.Builder AudioCaps Format for audio mediaCodecConfiguration Defines specific configuration for codecsCodeFoundEvent Event raised by aZBarFilter
when a code is found in the data being streamed.Composite.Builder ConnectionStateChangedEvent This event is raised when the connection between two peers changes.DataChannelClosedEvent Event fired when a data channel is closed.DataChannelOpenedEvent Event fired when a new data channel is created.Dispatcher.Builder DispatcherOneToMany.Builder ElementConnectedEvent Indicates that an element has been connected to anotherElementConnectionData ElementDisconnectedEvent Indicates that an element has been disconnected from anotherElementStats A dictionary that represents the stats gathered in the media element.EndOfStreamEvent Event raised when the stream that the element sends out is finished.EndpointStats A dictionary that represents the stats gathered in the endpoint element.ErrorEvent Fired whenever an undefined error related to the MediaObject has occurredFaceOverlayFilter.Builder Fraction Type that represents a fraction of an integer numerator over an integer denominatorGenericMediaElement.Builder GenericMediaEvent GStreamerFilter.Builder HttpPostEndpoint.Builder HubPort.Builder IceCandidate IceCandidate representation based onRTCIceCandidate
interface.IceCandidateFoundEvent Notifies a new local candidate.IceCandidatePair The ICE candidate pair used by the ICE library, for a certain stream.IceComponentStateChangedEvent Event fired when and ICE component state changes.IceConnection The ICE connection state for a certain stream and component.IceGatheringDoneEvent Event fired when al ICE candidates have been gathered.ImageOverlayFilter.Builder KurentoClient Factory to createMediaPipeline
in the media server.KurentoClientBuilder MediaEvent Base for all events raised by elements in the Kurento media server.MediaFlowInStateChangedEvent Fired when the incoming media flow begins or ends.MediaFlowOutStateChangedEvent Fired when the outgoing media flow begins or ends.MediaLatencyStat A dictionary that represents the stats gathered.MediaSessionStartedEvent Event raised when the endpoint has successfully finished the signaling stage, and is ready for establishing a connection.MediaSessionTerminatedEvent Event raised when the endpoint has finished its operation and the connection has been tore down.MediaStateChangedEvent This event is fired when the media connection between two peers changes, based on the RTCP packet flow.MediaTranscodingStateChangedEvent Event fired when an incoming media begins and codec transcoding is either required or not.Mixer.Builder ModuleInfo Description of a loaded modulesNewCandidatePairSelectedEvent Event fired when a new pair of ICE candidates is used by the ICE library.ObjectCreatedEvent Indicates that an object has been created on the media serverObjectDestroyedEvent Indicates that an object has been destroyed on the media serverOfferOptions Used to customize the offer created bySdpEndpoint.generateOffer
.OnKeySoftLimitEvent Fired when encryption is used and any stream reached the soft key usage limit, which means it will expire soon.PassThrough.Builder PausedEvent Fired when the recorder goes to pause statePlayerEndpoint.Builder Properties RaiseBaseEvent RecorderEndpoint.Builder RecordingEvent Fired when the recoding effectively starts.RembParams Defines values for parameters of congestion controlRTCCertificateStats RTCCodec RTC codec statisticsRTCDataChannelStats Statistics related to RTC data channels.RTCIceCandidateAttributes RTCIceCandidatePairStats RTCInboundRTPStreamStats Statistics that represents the measurement metrics for the incoming media stream.RTCMediaStreamStats Statistics related to the media stream.RTCMediaStreamTrackStats Statistics related to the media stream.RTCOutboundRTPStreamStats Statistics that represents the measurement metrics for the outgoing media stream.RTCPeerConnectionStats Statistics related to the peer connection.RTCRTPStreamStats Statistics for the RTP streamRTCStats An RTCStats dictionary represents the stats gathered.RTCTransportStats Statistics related to RTC data channels.RtpEndpoint.Builder SDES Security Descriptions for Media StreamsServerInfo Description of the media serverStats A dictionary that represents the stats gathered.StoppedEvent Fired when the recorder has been stopped and all the media has been written to storage.Tag Pair key-value with info about a MediaObjectUriEndpointStateChangedEvent Indicates the new state of the endpointVideoCaps Format for video mediaVideoInfo WebRtcEndpoint.Builder ZBarFilter.Builder -
Enum Summary Enum Description AudioCodec Codec used for transmission of audio.CertificateKeyType .ConnectionState State of the connection.CryptoSuite Describes the encryption and authentication algorithmsDSCPValue Possible DSCP valuesFilterType Type of filter to be created.GapsFixMethod How to fix gaps when they are found in the recorded stream.GstreamerDotDetails Details of gstreamer dot graphsIceComponentState States of an ICE component.MediaFlowState Flowing state of the media.MediaProfileSpecType Media profile, used by the RecorderEndpoint builder to specify the codecs and media container that should be used for the recordings.MediaState State of the media.MediaTranscodingState Transcoding state for a media.MediaType Type of media stream to be exchanged.RTCDataChannelState Represents the state of the RTCDataChannelRTCStatsIceCandidatePairState Represents the state of the checklist for the local and remote candidates in a pair.RTCStatsIceCandidateType Types of candidatesServerType Indicates if the server is a real media server or a proxyStatsType The type of the object.UriEndpointState State of the endpointVideoCodec Codec used for transmission of video. -
Exception Summary Exception Description TransactionException TransactionExecutionException TransactionNotCommitedException TransactionNotExecutedException TransactionRollbackException