Uses of Interface
org.kurento.client.Transaction
-
Uses of Transaction in org.kurento.client
Methods in org.kurento.client that return TransactionModifier and TypeMethodDescriptionKurentoClient.beginTransaction()MediaPipeline.beginTransaction()Methods in org.kurento.client with parameters of type TransactionModifier and TypeMethodDescriptionvoidWebRtcEndpoint.addIceCandidate(Transaction tx, IceCandidate candidate) Process an ICE candidate sent by the remote peer of the connection.voidImageOverlayFilter.addImage(Transaction tx, String id, String uri, float offsetXPercent, float offsetYPercent, float widthPercent, float heightPercent, boolean keepAspectRatio, boolean center) Add an image to be used as overlay.voidMediaObject.addTag(Transaction tx, String key, String value) Adds a new tag to thisMediaObject.AbstractBuilder.build(Transaction transaction) voidWebRtcEndpoint.closeDataChannel(Transaction tx, int channelId) Closes an open data channelvoidDispatcher.connect(Transaction tx, HubPort source, HubPort sink) Connects each correspondingMediaTypeof the given source port with the sink port.voidMediaElement.connect(Transaction tx, MediaElement sink) Connects two elements, with the media flowing from left to right.voidMediaElement.connect(Transaction tx, MediaElement sink, MediaType mediaType) Connects two elements, with the media flowing from left to right.voidMediaElement.connect(Transaction tx, MediaElement sink, MediaType mediaType, String sourceMediaDescription) Connects two elements, with the media flowing from left to right.voidMediaElement.connect(Transaction tx, MediaElement sink, MediaType mediaType, String sourceMediaDescription, String sinkMediaDescription) Connects two elements, with the media flowing from left to right.voidMixer.connect(Transaction tx, MediaType media, HubPort source, HubPort sink) Connects each correspondingMediaTypeof the given source port with the sink port.voidWebRtcEndpoint.createDataChannel(Transaction tx) Create a new data channel, if data channels are supported.voidWebRtcEndpoint.createDataChannel(Transaction tx, String label) Create a new data channel, if data channels are supported.voidWebRtcEndpoint.createDataChannel(Transaction tx, String label, boolean ordered) Create a new data channel, if data channels are supported.voidWebRtcEndpoint.createDataChannel(Transaction tx, String label, boolean ordered, int maxPacketLifeTime) Create a new data channel, if data channels are supported.voidWebRtcEndpoint.createDataChannel(Transaction tx, String label, boolean ordered, int maxPacketLifeTime, int maxRetransmits) Create a new data channel, if data channels are supported.voidWebRtcEndpoint.createDataChannel(Transaction tx, String label, boolean ordered, int maxPacketLifeTime, int maxRetransmits, String protocol) Create a new data channel, if data channels are supported.KurentoClient.createMediaPipeline(Transaction tx) KurentoClient.createMediaPipeline(Transaction tx, Properties properties) voidMediaElement.disconnect(Transaction tx, MediaElement sink) Disconnects two media elements.voidMediaElement.disconnect(Transaction tx, MediaElement sink, MediaType mediaType) Disconnects two media elements.voidMediaElement.disconnect(Transaction tx, MediaElement sink, MediaType mediaType, String sourceMediaDescription) Disconnects two media elements.voidMediaElement.disconnect(Transaction tx, MediaElement sink, MediaType mediaType, String sourceMediaDescription, String sinkMediaDescription) Disconnects two media elements.voidMixer.disconnect(Transaction tx, MediaType media, HubPort source, HubPort sink) Disonnects each correspondingMediaTypeof the given source port from the sink port.voidHub.dumpGstreamerDot(Transaction tx) If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the Hub.voidHub.dumpGstreamerDot(Transaction tx, GstreamerDotDetails details) If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the Hub.voidMediaElement.dumpGstreamerDot(Transaction tx) If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the Media Element.voidMediaElement.dumpGstreamerDot(Transaction tx, GstreamerDotDetails details) If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the Media Element.voidMediaPipeline.dumpGstreamerDot(Transaction tx) If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the pipelinevoidMediaPipeline.dumpGstreamerDot(Transaction tx, GstreamerDotDetails details) If GST_DEBUG_DUMP_DOT_DIR environment variable is defined dumps in that directoy a file with the GStreamer dot of the pipelinevoidWebRtcEndpoint.gatherCandidates(Transaction tx) Start the ICE candidate gathering.SdpEndpoint.generateOffer(Transaction tx) Generates an SDP offer with media capabilities of the Endpoint.SdpEndpoint.generateOffer(Transaction tx, OfferOptions options) Generates an SDP offer with media capabilities of the Endpoint.MediaObject.getChildren(Transaction tx) Get Children of thisMediaObject.GStreamerFilter.getCommand(Transaction tx) Get String used to instantiate the GStreamer element, as in gst-launch (https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html).BaseRtpEndpoint.getConnectionState(Transaction tx) Get Connection state.ServerManager.getCpuCount(Transaction tx) Number of CPU cores that the media server can use.MediaObject.getCreationTime(Transaction tx) GetMediaObjectcreation time in seconds since Epoch.WebRtcEndpoint.getDtlsConnectionState(Transaction tx) Get the DTLS connection state for all the connections.PlayerEndpoint.getElementGstreamerDot(Transaction tx) Get Returns the GStreamer DOT string for this element's private pipelineMediaElement.getEncoderBitrate(Transaction tx) Get Target video bitrate for media transcoding.WebRtcEndpoint.getExternalIPv4(Transaction tx) Get External IPv4 address of the media server.WebRtcEndpoint.getExternalIPv6(Transaction tx) Get External IPv6 address of the media server.Hub.getGstreamerDot(Transaction tx) Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipelineHub.getGstreamerDot(Transaction tx, GstreamerDotDetails details) Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipelineMediaElement.getGstreamerDot(Transaction tx) Return a .dot file describing the topology of the media element.MediaElement.getGstreamerDot(Transaction tx, GstreamerDotDetails details) Return a .dot file describing the topology of the media element.MediaPipeline.getGstreamerDot(Transaction tx) Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipelineMediaPipeline.getGstreamerDot(Transaction tx, GstreamerDotDetails details) Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipelineWebRtcEndpoint.getICECandidatePairs(Transaction tx) Get the ICE candidate pair (local and remote candidates) used by the ICE library for each stream.WebRtcEndpoint.getIceConnectionState(Transaction tx) Get the ICE connection state for all the connections.WebRtcEndpoint.getIceTcp(Transaction tx) Get Enable ICE-TCP candidate gathering.MediaObject.getId(Transaction tx) Get Unique identifier of thisMediaObject.ServerManager.getInfo(Transaction tx) Get Server information, version, modules, factories, etcServerManager.getKmd(Transaction tx, String moduleName) Returns the kmd associated to a moduleMediaPipeline.getLatencyStats(Transaction tx) Get If statistics about pipeline latency are enabled for all mediaElementsSdpEndpoint.getLocalSessionDescriptor(Transaction tx) Returns the local SDP.SdpEndpoint.getMaxAudioRecvBandwidth(Transaction tx) Get Maximum inbound bitrate requested by this endpoint.MediaElement.getMaxEncoderBitrate(Transaction tx) Get Maximum video bitrate for media transcoding.SdpEndpoint.getMaxVideoRecvBandwidth(Transaction tx) Get Maximum inbound bitrate requested by this endpoint.BaseRtpEndpoint.getMaxVideoSendBandwidth(Transaction tx) Get Maximum outbound bitrate sent by this endpoint.MediaObject.getMediaPipeline(Transaction tx) GetMediaPipelineto which thisMediaObjectbelongs.BaseRtpEndpoint.getMediaState(Transaction tx) Get Media flow state.ServerManager.getMetadata(Transaction tx) Get Metadata stored in the serverMediaElement.getMinEncoderBitrate(Transaction tx) Get Minimum video bitrate for media transcoding.BaseRtpEndpoint.getMinVideoRecvBandwidth(Transaction tx) Get Minimum inbound bitrate requested by this endpoint.BaseRtpEndpoint.getMinVideoSendBandwidth(Transaction tx) Get Minimum outbound bitrate sent by this endpoint.BaseRtpEndpoint.getMtu(Transaction tx) Get Maximum Transmission Unit (MTU) used for RTP.MediaObject.getName(Transaction tx) Get ThisMediaObject's name.WebRtcEndpoint.getNetworkInterfaces(Transaction tx) Get Local network interfaces used for ICE gathering.MediaObject.getParent(Transaction tx) Get Parent of thisMediaObject.ServerManager.getPipelines(Transaction tx) Get All the pipelines available in the serverPlayerEndpoint.getPosition(Transaction tx) Get Get or set the actual position of the video in ms.BaseRtpEndpoint.getRembParams(Transaction tx) Get Advanced parameters to configure the congestion control algorithm.SdpEndpoint.getRemoteSessionDescriptor(Transaction tx) This method returns the remote SDP.MediaObject.getSendTagsInEvents(Transaction tx) Get Flag activating or deactivating sending the element's tags in fired events.ServerManager.getSessions(Transaction tx) Get All active sessions in the serverMediaElement.getSinkConnections(Transaction tx) Gets information about the source pads of this media element.MediaElement.getSinkConnections(Transaction tx, MediaType mediaType) Gets information about the source pads of this media element.MediaElement.getSinkConnections(Transaction tx, MediaType mediaType, String description) Gets information about the source pads of this media element.MediaElement.getSourceConnections(Transaction tx) Gets information about the sink pads of this media element.MediaElement.getSourceConnections(Transaction tx, MediaType mediaType) Gets information about the sink pads of this media element.MediaElement.getSourceConnections(Transaction tx, MediaType mediaType, String description) Gets information about the sink pads of this media element.UriEndpoint.getState(Transaction tx) Get State of the endpointMediaElement.getStats(Transaction tx) Gets the statistics related to an endpoint.MediaElement.getStats(Transaction tx, MediaType mediaType) Gets the statistics related to an endpoint.WebRtcEndpoint.getStunServerAddress(Transaction tx) Get STUN server IP address.WebRtcEndpoint.getStunServerPort(Transaction tx) Get Port of the STUN serverMediaObject.getTag(Transaction tx, String key) Returns the value of given tag, or MEDIA_OBJECT_TAG_KEY_NOT_FOUND if tag is not defined.MediaObject.getTags(Transaction tx) Returns all tags attached to thisMediaObject.WebRtcEndpoint.getTurnUrl(Transaction tx) Get TURN server URL.UriEndpoint.getUri(Transaction tx) Get The uri for this endpoint.HttpEndpoint.getUrl(Transaction tx) Obtains the URL associated to this endpointServerManager.getUsedCpu(Transaction tx, int interval) Average CPU usage of the server.ServerManager.getUsedMemory(Transaction tx) Returns the amount of memory that the server is using, in KiBPlayerEndpoint.getVideoInfo(Transaction tx) Get Returns info about the source being playedMediaElement.isMediaFlowingIn(Transaction tx, MediaType mediaType) This method indicates whether the media element is receiving media of a certain type.MediaElement.isMediaFlowingIn(Transaction tx, MediaType mediaType, String sinkMediaDescription) This method indicates whether the media element is receiving media of a certain type.MediaElement.isMediaFlowingOut(Transaction tx, MediaType mediaType) This method indicates whether the media element is emitting media of a certain type.MediaElement.isMediaFlowingOut(Transaction tx, MediaType mediaType, String sourceMediaDescription) This method indicates whether the media element is emitting media of a certain type.MediaElement.isMediaTranscoding(Transaction tx, MediaType mediaType) Indicates whether this media element is actively transcoding between input and output pads.MediaElement.isMediaTranscoding(Transaction tx, MediaType mediaType, String binName) Indicates whether this media element is actively transcoding between input and output pads.voidUriEndpoint.pause(Transaction tx) Pauses the feedvoidPlayerEndpoint.play(Transaction tx) Starts reproducing the media, sending it to the :rom:cls:`MediaSource`.SdpEndpoint.processAnswer(Transaction tx, String answer) Generates an SDP offer with media capabilities of the Endpoint.SdpEndpoint.processOffer(Transaction tx, String offer) Processes SDP offer of the remote peer, and generates an SDP answer based on the endpoint's capabilities.voidRecorderEndpoint.record(Transaction tx) Starts storing media received through the sink pad.voidKurentoObject.release(Transaction tx) voidImageOverlayFilter.removeImage(Transaction tx, String id) Remove the image with the given ID.voidDispatcherOneToMany.removeSource(Transaction tx) Remove the source port and stop the media pipeline.voidMediaObject.removeTag(Transaction tx, String key) Removes an existing tag.voidBaseRtpEndpoint.requestKeyframe(Transaction tx) Force sending a new keyframe request to the upstream elements in the Kurento Pipeline, towards the associated producer.voidMediaElement.setAudioFormat(Transaction tx, AudioCaps caps) Set the type of data for the audio stream.voidGStreamerFilter.setElementProperty(Transaction tx, String propertyName, String propertyValue) Provide a value to one of the GStreamer element's properties.voidMediaElement.setEncoderBitrate(int encoderBitrate, Transaction tx) Set Target video bitrate for media transcoding.voidWebRtcEndpoint.setExternalIPv4(String externalIPv4, Transaction tx) Set External IPv4 address of the media server.voidWebRtcEndpoint.setExternalIPv6(String externalIPv6, Transaction tx) Set External IPv6 address of the media server.voidWebRtcEndpoint.setIceTcp(boolean iceTcp, Transaction tx) Set Enable ICE-TCP candidate gathering.voidMediaPipeline.setLatencyStats(boolean latencyStats, Transaction tx) Set If statistics about pipeline latency are enabled for all mediaElementsvoidAlphaBlending.setMaster(Transaction tx, HubPort source, int zOrder) Sets the source port that will be the master entry to the mixervoidSdpEndpoint.setMaxAudioRecvBandwidth(int maxAudioRecvBandwidth, Transaction tx) Set Maximum inbound bitrate requested by this endpoint.voidMediaElement.setMaxEncoderBitrate(int maxEncoderBitrate, Transaction tx) Set Maximum video bitrate for media transcoding.voidSdpEndpoint.setMaxVideoRecvBandwidth(int maxVideoRecvBandwidth, Transaction tx) Set Maximum inbound bitrate requested by this endpoint.voidBaseRtpEndpoint.setMaxVideoSendBandwidth(int maxVideoSendBandwidth, Transaction tx) Set Maximum outbound bitrate sent by this endpoint.voidMediaElement.setMinEncoderBitrate(int minEncoderBitrate, Transaction tx) Set Minimum video bitrate for media transcoding.voidBaseRtpEndpoint.setMinVideoRecvBandwidth(int minVideoRecvBandwidth, Transaction tx) Set Minimum inbound bitrate requested by this endpoint.voidBaseRtpEndpoint.setMinVideoSendBandwidth(int minVideoSendBandwidth, Transaction tx) Set Minimum outbound bitrate sent by this endpoint.voidBaseRtpEndpoint.setMtu(int mtu, Transaction tx) Set Maximum Transmission Unit (MTU) used for RTP.voidMediaObject.setName(String name, Transaction tx) Set ThisMediaObject's name.voidWebRtcEndpoint.setNetworkInterfaces(String networkInterfaces, Transaction tx) Set Local network interfaces used for ICE gathering.voidFaceOverlayFilter.setOverlayedImage(Transaction tx, String uri, float offsetXPercent, float offsetYPercent, float widthPercent, float heightPercent) Sets the image to use as overlay on the detected faces.voidAlphaBlending.setPortProperties(Transaction tx, float relativeX, float relativeY, int zOrder, float relativeWidth, float relativeHeight, HubPort port) Configure the blending mode of one port.voidPlayerEndpoint.setPosition(long position, Transaction tx) Set Get or set the actual position of the video in ms.voidBaseRtpEndpoint.setRembParams(RembParams rembParams, Transaction tx) Set Advanced parameters to configure the congestion control algorithm.voidMediaObject.setSendTagsInEvents(boolean sendTagsInEvents, Transaction tx) Set Flag activating or deactivating sending the element's tags in fired events.voidDispatcherOneToMany.setSource(Transaction tx, HubPort source) Sets the source port that will be connected to the sinks of everyHubPortof the dispatchervoidWebRtcEndpoint.setStunServerAddress(String stunServerAddress, Transaction tx) Set STUN server IP address.voidWebRtcEndpoint.setStunServerPort(int stunServerPort, Transaction tx) Set Port of the STUN servervoidWebRtcEndpoint.setTurnUrl(String turnUrl, Transaction tx) Set TURN server URL.voidMediaElement.setVideoFormat(Transaction tx, VideoCaps caps) Set the type of data for the video stream.voidUriEndpoint.stop(Transaction tx) Stops the feedvoidRecorderEndpoint.stopAndWait(Transaction tx) Stops recording and does not return until all the content has been written to the selected uri.voidFaceOverlayFilter.unsetOverlayedImage(Transaction tx) Clear the image to be shown over each detected face.