void |
WebRtcEndpoint.addIceCandidate(Transaction tx,
IceCandidate candidate) |
Process an ICE candidate sent by the remote peer of the connection.
|
void |
ImageOverlayFilter.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.
|
void |
MediaObject.addTag(Transaction tx,
String key,
String value) |
Adds a new tag to this MediaObject .
|
T |
AbstractBuilder.build(Transaction transaction) |
|
void |
WebRtcEndpoint.closeDataChannel(Transaction tx,
int channelId) |
Closes an open data channel
|
void |
Dispatcher.connect(Transaction tx,
HubPort source,
HubPort sink) |
Connects each corresponding MediaType of the given source port with the sink port.
|
void |
MediaElement.connect(Transaction tx,
MediaElement sink) |
Connects two elements, with the media flowing from left to right.
|
void |
MediaElement.connect(Transaction tx,
MediaElement sink,
MediaType mediaType) |
Connects two elements, with the media flowing from left to right.
|
void |
MediaElement.connect(Transaction tx,
MediaElement sink,
MediaType mediaType,
String sourceMediaDescription) |
Connects two elements, with the media flowing from left to right.
|
void |
MediaElement.connect(Transaction tx,
MediaElement sink,
MediaType mediaType,
String sourceMediaDescription,
String sinkMediaDescription) |
Connects two elements, with the media flowing from left to right.
|
void |
Mixer.connect(Transaction tx,
MediaType media,
HubPort source,
HubPort sink) |
Connects each corresponding MediaType of the given source port with the sink port.
|
void |
WebRtcEndpoint.createDataChannel(Transaction tx) |
Create a new data channel, if data channels are supported.
|
void |
WebRtcEndpoint.createDataChannel(Transaction tx,
String label) |
Create a new data channel, if data channels are supported.
|
void |
WebRtcEndpoint.createDataChannel(Transaction tx,
String label,
boolean ordered) |
Create a new data channel, if data channels are supported.
|
void |
WebRtcEndpoint.createDataChannel(Transaction tx,
String label,
boolean ordered,
int maxPacketLifeTime) |
Create a new data channel, if data channels are supported.
|
void |
WebRtcEndpoint.createDataChannel(Transaction tx,
String label,
boolean ordered,
int maxPacketLifeTime,
int maxRetransmits) |
Create a new data channel, if data channels are supported.
|
void |
WebRtcEndpoint.createDataChannel(Transaction tx,
String label,
boolean ordered,
int maxPacketLifeTime,
int maxRetransmits,
String protocol) |
Create a new data channel, if data channels are supported.
|
MediaPipeline |
KurentoClient.createMediaPipeline(Transaction tx) |
|
MediaPipeline |
KurentoClient.createMediaPipeline(Transaction tx,
Properties properties) |
|
void |
MediaElement.disconnect(Transaction tx,
MediaElement sink) |
Disconnects two media elements.
|
void |
MediaElement.disconnect(Transaction tx,
MediaElement sink,
MediaType mediaType) |
Disconnects two media elements.
|
void |
MediaElement.disconnect(Transaction tx,
MediaElement sink,
MediaType mediaType,
String sourceMediaDescription) |
Disconnects two media elements.
|
void |
MediaElement.disconnect(Transaction tx,
MediaElement sink,
MediaType mediaType,
String sourceMediaDescription,
String sinkMediaDescription) |
Disconnects two media elements.
|
void |
Mixer.disconnect(Transaction tx,
MediaType media,
HubPort source,
HubPort sink) |
Disonnects each corresponding MediaType of the given source port from the sink port.
|
void |
WebRtcEndpoint.gatherCandidates(Transaction tx) |
Start the ICE candidate gathering.
|
TFuture<String> |
SdpEndpoint.generateOffer(Transaction tx) |
Generates an SDP offer with media capabilities of the Endpoint.
|
TFuture<String> |
SdpEndpoint.generateOffer(Transaction tx,
OfferOptions options) |
Generates an SDP offer with media capabilities of the Endpoint.
|
TFuture<List<MediaObject>> |
MediaObject.getChildren(Transaction tx) |
Get Children of this MediaObject .
|
TFuture<String> |
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).
|
TFuture<ConnectionState> |
BaseRtpEndpoint.getConnectionState(Transaction tx) |
Get Connection state.
|
TFuture<Integer> |
ServerManager.getCpuCount(Transaction tx) |
Number of CPU cores that the media server can use.
|
TFuture<Integer> |
MediaObject.getCreationTime(Transaction tx) |
Get MediaObject creation time in seconds since Epoch.
|
TFuture<String> |
PlayerEndpoint.getElementGstreamerDot(Transaction tx) |
Get Returns the GStreamer DOT string for this element's private pipeline
|
TFuture<Integer> |
MediaElement.getEncoderBitrate(Transaction tx) |
Get Target video bitrate for media transcoding.
|
TFuture<String> |
WebRtcEndpoint.getExternalIPv4(Transaction tx) |
Get External IPv4 address of the media server.
|
TFuture<String> |
WebRtcEndpoint.getExternalIPv6(Transaction tx) |
Get External IPv6 address of the media server.
|
TFuture<String> |
Hub.getGstreamerDot(Transaction tx) |
Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
|
TFuture<String> |
Hub.getGstreamerDot(Transaction tx,
GstreamerDotDetails details) |
Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
|
TFuture<String> |
MediaElement.getGstreamerDot(Transaction tx) |
Return a .dot file describing the topology of the media element.
|
TFuture<String> |
MediaElement.getGstreamerDot(Transaction tx,
GstreamerDotDetails details) |
Return a .dot file describing the topology of the media element.
|
TFuture<String> |
MediaPipeline.getGstreamerDot(Transaction tx) |
Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
|
TFuture<String> |
MediaPipeline.getGstreamerDot(Transaction tx,
GstreamerDotDetails details) |
Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
|
TFuture<List<IceCandidatePair>> |
WebRtcEndpoint.getICECandidatePairs(Transaction tx) |
Get the ICE candidate pair (local and remote candidates) used by the ICE library for each stream.
|
TFuture<List<IceConnection>> |
WebRtcEndpoint.getIceConnectionState(Transaction tx) |
Get the ICE connection state for all the connections.
|
TFuture<Boolean> |
WebRtcEndpoint.getIceTcp(Transaction tx) |
Get Enable ICE-TCP candidate gathering.
|
TFuture<String> |
MediaObject.getId(Transaction tx) |
Get Unique identifier of this MediaObject .
|
TFuture<ServerInfo> |
ServerManager.getInfo(Transaction tx) |
Get Server information, version, modules, factories, etc
|
TFuture<String> |
ServerManager.getKmd(Transaction tx,
String moduleName) |
Returns the kmd associated to a module
|
TFuture<Boolean> |
MediaPipeline.getLatencyStats(Transaction tx) |
Get If statistics about pipeline latency are enabled for all mediaElements
|
TFuture<String> |
SdpEndpoint.getLocalSessionDescriptor(Transaction tx) |
Returns the local SDP.
|
TFuture<Integer> |
SdpEndpoint.getMaxAudioRecvBandwidth(Transaction tx) |
Get Maximum inbound bitrate requested by this endpoint.
|
TFuture<Integer> |
MediaElement.getMaxEncoderBitrate(Transaction tx) |
Get Maximum video bitrate for media transcoding.
|
TFuture<Integer> |
SdpEndpoint.getMaxVideoRecvBandwidth(Transaction tx) |
Get Maximum inbound bitrate requested by this endpoint.
|
TFuture<Integer> |
BaseRtpEndpoint.getMaxVideoSendBandwidth(Transaction tx) |
Get Maximum outbound bitrate sent by this endpoint.
|
TFuture<MediaPipeline> |
MediaObject.getMediaPipeline(Transaction tx) |
|
TFuture<MediaState> |
BaseRtpEndpoint.getMediaState(Transaction tx) |
Get Media flow state.
|
TFuture<String> |
ServerManager.getMetadata(Transaction tx) |
Get Metadata stored in the server
|
TFuture<Integer> |
MediaElement.getMinEncoderBitrate(Transaction tx) |
Get Minimum video bitrate for media transcoding.
|
TFuture<Integer> |
BaseRtpEndpoint.getMinVideoRecvBandwidth(Transaction tx) |
Get Minimum inbound bitrate requested by this endpoint.
|
TFuture<Integer> |
BaseRtpEndpoint.getMinVideoSendBandwidth(Transaction tx) |
Get Minimum outbound bitrate sent by this endpoint.
|
TFuture<Integer> |
BaseRtpEndpoint.getMtu(Transaction tx) |
Get Maximum Transmission Unit (MTU) used for RTP.
|
TFuture<String> |
MediaObject.getName(Transaction tx) |
Get This MediaObject 's name.
|
TFuture<String> |
WebRtcEndpoint.getNetworkInterfaces(Transaction tx) |
Get Local network interfaces used for ICE gathering.
|
TFuture<MediaObject> |
MediaObject.getParent(Transaction tx) |
Get Parent of this MediaObject .
|
TFuture<List<MediaPipeline>> |
ServerManager.getPipelines(Transaction tx) |
Get All the pipelines available in the server
|
TFuture<Long> |
PlayerEndpoint.getPosition(Transaction tx) |
Get Get or set the actual position of the video in ms.
|
TFuture<RembParams> |
BaseRtpEndpoint.getRembParams(Transaction tx) |
Get Advanced parameters to configure the congestion control algorithm.
|
TFuture<String> |
SdpEndpoint.getRemoteSessionDescriptor(Transaction tx) |
This method returns the remote SDP.
|
TFuture<Boolean> |
MediaObject.getSendTagsInEvents(Transaction tx) |
Get Flag activating or deactivating sending the element's tags in fired events.
|
TFuture<List<String>> |
ServerManager.getSessions(Transaction tx) |
Get All active sessions in the server
|
TFuture<List<ElementConnectionData>> |
MediaElement.getSinkConnections(Transaction tx) |
Gets information about the source pads of this media element.
|
TFuture<List<ElementConnectionData>> |
MediaElement.getSinkConnections(Transaction tx,
MediaType mediaType) |
Gets information about the source pads of this media element.
|
TFuture<List<ElementConnectionData>> |
MediaElement.getSinkConnections(Transaction tx,
MediaType mediaType,
String description) |
Gets information about the source pads of this media element.
|
TFuture<List<ElementConnectionData>> |
MediaElement.getSourceConnections(Transaction tx) |
Gets information about the sink pads of this media element.
|
TFuture<List<ElementConnectionData>> |
MediaElement.getSourceConnections(Transaction tx,
MediaType mediaType) |
Gets information about the sink pads of this media element.
|
TFuture<List<ElementConnectionData>> |
MediaElement.getSourceConnections(Transaction tx,
MediaType mediaType,
String description) |
Gets information about the sink pads of this media element.
|
TFuture<UriEndpointState> |
UriEndpoint.getState(Transaction tx) |
Get State of the endpoint
|
TFuture<Map<String,Stats>> |
MediaElement.getStats(Transaction tx) |
Gets the statistics related to an endpoint.
|
TFuture<Map<String,Stats>> |
MediaElement.getStats(Transaction tx,
MediaType mediaType) |
Gets the statistics related to an endpoint.
|
TFuture<String> |
WebRtcEndpoint.getStunServerAddress(Transaction tx) |
Get STUN server IP address.
|
TFuture<Integer> |
WebRtcEndpoint.getStunServerPort(Transaction tx) |
Get Port of the STUN server
|
TFuture<String> |
MediaObject.getTag(Transaction tx,
String key) |
Returns the value of given tag, or MEDIA_OBJECT_TAG_KEY_NOT_FOUND if tag is not defined.
|
TFuture<List<Tag>> |
MediaObject.getTags(Transaction tx) |
Returns all tags attached to this MediaObject .
|
TFuture<String> |
WebRtcEndpoint.getTurnUrl(Transaction tx) |
Get TURN server URL.
|
TFuture<String> |
UriEndpoint.getUri(Transaction tx) |
Get The uri for this endpoint.
|
TFuture<String> |
HttpEndpoint.getUrl(Transaction tx) |
Obtains the URL associated to this endpoint
|
TFuture<Float> |
ServerManager.getUsedCpu(Transaction tx,
int interval) |
Average CPU usage of the server.
|
TFuture<Long> |
ServerManager.getUsedMemory(Transaction tx) |
Returns the amount of memory that the server is using, in KiB
|
TFuture<VideoInfo> |
PlayerEndpoint.getVideoInfo(Transaction tx) |
Get Returns info about the source being played
|
TFuture<Boolean> |
MediaElement.isMediaFlowingIn(Transaction tx,
MediaType mediaType) |
This method indicates whether the media element is receiving media of a certain type.
|
TFuture<Boolean> |
MediaElement.isMediaFlowingIn(Transaction tx,
MediaType mediaType,
String sinkMediaDescription) |
This method indicates whether the media element is receiving media of a certain type.
|
TFuture<Boolean> |
MediaElement.isMediaFlowingOut(Transaction tx,
MediaType mediaType) |
This method indicates whether the media element is emitting media of a certain type.
|
TFuture<Boolean> |
MediaElement.isMediaFlowingOut(Transaction tx,
MediaType mediaType,
String sourceMediaDescription) |
This method indicates whether the media element is emitting media of a certain type.
|
TFuture<Boolean> |
MediaElement.isMediaTranscoding(Transaction tx,
MediaType mediaType) |
Indicates whether this media element is actively transcoding between input and output pads.
|
TFuture<Boolean> |
MediaElement.isMediaTranscoding(Transaction tx,
MediaType mediaType,
String binName) |
Indicates whether this media element is actively transcoding between input and output pads.
|
void |
UriEndpoint.pause(Transaction tx) |
Pauses the feed
|
void |
PlayerEndpoint.play(Transaction tx) |
Starts reproducing the media, sending it to the :rom:cls:`MediaSource`.
|
TFuture<String> |
SdpEndpoint.processAnswer(Transaction tx,
String answer) |
Generates an SDP offer with media capabilities of the Endpoint.
|
TFuture<String> |
SdpEndpoint.processOffer(Transaction tx,
String offer) |
Processes SDP offer of the remote peer, and generates an SDP answer based on the endpoint's capabilities.
|
void |
RecorderEndpoint.record(Transaction tx) |
Starts storing media received through the sink pad.
|
void |
KurentoObject.release(Transaction tx) |
|
void |
ImageOverlayFilter.removeImage(Transaction tx,
String id) |
Remove the image with the given ID.
|
void |
DispatcherOneToMany.removeSource(Transaction tx) |
Remove the source port and stop the media pipeline.
|
void |
MediaObject.removeTag(Transaction tx,
String key) |
Removes an existing tag.
|
void |
BaseRtpEndpoint.requestKeyframe(Transaction tx) |
Force sending a new keyframe request to the upstream elements in the Kurento
Pipeline, towards the associated producer.
|
void |
MediaElement.setAudioFormat(Transaction tx,
AudioCaps caps) |
Set the type of data for the audio stream.
|
void |
GStreamerFilter.setElementProperty(Transaction tx,
String propertyName,
String propertyValue) |
Provide a value to one of the GStreamer element's properties.
|
void |
MediaElement.setEncoderBitrate(int encoderBitrate,
Transaction tx) |
Set Target video bitrate for media transcoding.
|
void |
WebRtcEndpoint.setExternalIPv4(String externalIPv4,
Transaction tx) |
Set External IPv4 address of the media server.
|
void |
WebRtcEndpoint.setExternalIPv6(String externalIPv6,
Transaction tx) |
Set External IPv6 address of the media server.
|
void |
WebRtcEndpoint.setIceTcp(boolean iceTcp,
Transaction tx) |
Set Enable ICE-TCP candidate gathering.
|
void |
MediaPipeline.setLatencyStats(boolean latencyStats,
Transaction tx) |
Set If statistics about pipeline latency are enabled for all mediaElements
|
void |
AlphaBlending.setMaster(Transaction tx,
HubPort source,
int zOrder) |
Sets the source port that will be the master entry to the mixer
|
void |
SdpEndpoint.setMaxAudioRecvBandwidth(int maxAudioRecvBandwidth,
Transaction tx) |
Set Maximum inbound bitrate requested by this endpoint.
|
void |
MediaElement.setMaxEncoderBitrate(int maxEncoderBitrate,
Transaction tx) |
Set Maximum video bitrate for media transcoding.
|
void |
SdpEndpoint.setMaxVideoRecvBandwidth(int maxVideoRecvBandwidth,
Transaction tx) |
Set Maximum inbound bitrate requested by this endpoint.
|
void |
BaseRtpEndpoint.setMaxVideoSendBandwidth(int maxVideoSendBandwidth,
Transaction tx) |
Set Maximum outbound bitrate sent by this endpoint.
|
void |
MediaElement.setMinEncoderBitrate(int minEncoderBitrate,
Transaction tx) |
Set Minimum video bitrate for media transcoding.
|
void |
BaseRtpEndpoint.setMinVideoRecvBandwidth(int minVideoRecvBandwidth,
Transaction tx) |
Set Minimum inbound bitrate requested by this endpoint.
|
void |
BaseRtpEndpoint.setMinVideoSendBandwidth(int minVideoSendBandwidth,
Transaction tx) |
Set Minimum outbound bitrate sent by this endpoint.
|
void |
BaseRtpEndpoint.setMtu(int mtu,
Transaction tx) |
Set Maximum Transmission Unit (MTU) used for RTP.
|
void |
MediaObject.setName(String name,
Transaction tx) |
Set This MediaObject 's name.
|
void |
WebRtcEndpoint.setNetworkInterfaces(String networkInterfaces,
Transaction tx) |
Set Local network interfaces used for ICE gathering.
|
void |
FaceOverlayFilter.setOverlayedImage(Transaction tx,
String uri,
float offsetXPercent,
float offsetYPercent,
float widthPercent,
float heightPercent) |
Sets the image to use as overlay on the detected faces.
|
void |
AlphaBlending.setPortProperties(Transaction tx,
float relativeX,
float relativeY,
int zOrder,
float relativeWidth,
float relativeHeight,
HubPort port) |
Configure the blending mode of one port.
|
void |
PlayerEndpoint.setPosition(long position,
Transaction tx) |
Set Get or set the actual position of the video in ms.
|
void |
BaseRtpEndpoint.setRembParams(RembParams rembParams,
Transaction tx) |
Set Advanced parameters to configure the congestion control algorithm.
|
void |
MediaObject.setSendTagsInEvents(boolean sendTagsInEvents,
Transaction tx) |
Set Flag activating or deactivating sending the element's tags in fired events.
|
void |
DispatcherOneToMany.setSource(Transaction tx,
HubPort source) |
Sets the source port that will be connected to the sinks of every HubPort of the dispatcher
|
void |
WebRtcEndpoint.setStunServerAddress(String stunServerAddress,
Transaction tx) |
Set STUN server IP address.
|
void |
WebRtcEndpoint.setStunServerPort(int stunServerPort,
Transaction tx) |
Set Port of the STUN server
|
void |
WebRtcEndpoint.setTurnUrl(String turnUrl,
Transaction tx) |
Set TURN server URL.
|
void |
MediaElement.setVideoFormat(Transaction tx,
VideoCaps caps) |
Set the type of data for the video stream.
|
void |
UriEndpoint.stop(Transaction tx) |
Stops the feed
|
void |
RecorderEndpoint.stopAndWait(Transaction tx) |
Stops recording and does not return until all the content has been written to the selected uri.
|
void |
FaceOverlayFilter.unsetOverlayedImage(Transaction tx) |
Clear the image to be shown over each detected face.
|