Modifier and Type | Method and Description |
---|---|
Transaction |
MediaPipeline.beginTransaction() |
Transaction |
KurentoClient.beginTransaction() |
Modifier and Type | Method and Description |
---|---|
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: the elements that invokes the connect wil be the source of media, creating one sink pad for each type of media connected.
|
void |
MediaElement.connect(Transaction tx,
MediaElement sink,
MediaType mediaType)
Connects two elements, with the media flowing from left to right: the elements that invokes the connect wil be the source of media, creating one sink pad for each type of media connected.
|
void |
MediaElement.connect(Transaction tx,
MediaElement sink,
MediaType mediaType,
String sourceMediaDescription)
Connects two elements, with the media flowing from left to right: the elements that invokes the connect wil be the source of media, creating one sink pad for each type of media connected.
|
void |
MediaElement.connect(Transaction tx,
MediaElement sink,
MediaType mediaType,
String sourceMediaDescription,
String sinkMediaDescription)
Connects two elements, with the media flowing from left to right: the elements that invokes the connect wil be the source of media, creating one sink pad for each type of media connected.
|
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 gathering of ICE candidates.It must be called after SdpEndpoint::generateOffer or SdpEndpoint::processOffer for Trickle ICE.
|
TFuture<String> |
SdpEndpoint.generateOffer(Transaction tx)
Generates an SDP offer with media capabilities of the Endpoint.
|
TFuture<List<MediaObject>> |
MediaObject.getChildren(Transaction tx)
Get children of this
MediaObject . |
TFuture<List<MediaObject>> |
MediaObject.getChilds(Transaction tx)
Deprecated.
Get (Use children instead) children of this
MediaObject . |
TFuture<String> |
GStreamerFilter.getCommand(Transaction tx)
Get String used to instantiate the GStreamer element, as in `gst-launch
|
TFuture<ConnectionState> |
BaseRtpEndpoint.getConnectionState(Transaction tx)
Get Connection state.
|
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<String> |
MediaElement.getGstreamerDot(Transaction tx)
This method returns a .dot file describing the topology of the media element.
|
TFuture<String> |
Hub.getGstreamerDot(Transaction tx)
Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
|
TFuture<String> |
MediaPipeline.getGstreamerDot(Transaction tx)
Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
|
TFuture<String> |
MediaElement.getGstreamerDot(Transaction tx,
GstreamerDotDetails details)
This method returns a .dot file describing the topology of the media element.
|
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> |
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<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)
This method returns the local SDP.
|
TFuture<Integer> |
SdpEndpoint.getMaxAudioRecvBandwidth(Transaction tx)
Get Maximum bandwidth for audio reception, in kbps.
|
TFuture<Integer> |
MediaElement.getMaxOuputBitrate(Transaction tx)
Deprecated.
Get Deprecated due to a typo. Use maxOutputBitrate instead of this function. Maximum video bandwidth for transcoding. 0 = unlimited.
Unit: bps(bits per second).
Default value: MAXINT
|
TFuture<Integer> |
MediaElement.getMaxOutputBitrate(Transaction tx)
Get Maximum video bitrate for transcoding.
|
TFuture<Integer> |
SdpEndpoint.getMaxVideoRecvBandwidth(Transaction tx)
Get Maximum bandwidth for video reception, in kbps.
|
TFuture<Integer> |
BaseRtpEndpoint.getMaxVideoSendBandwidth(Transaction tx)
Get Maximum bandwidth for video transmission, in kbps.
|
TFuture<MediaPipeline> |
MediaObject.getMediaPipeline(Transaction tx)
Get
MediaPipeline to which this MediaObject belongs. |
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.getMinOuputBitrate(Transaction tx)
Deprecated.
Get Deprecated due to a typo. Use minOutputBitrate instead of this function. Minimum video bandwidth for transcoding.
Unit: bps(bits per second).
Default value: 0
|
TFuture<Integer> |
MediaElement.getMinOutputBitrate(Transaction tx)
Get Minimum video bitrate for transcoding.
|
TFuture<Integer> |
BaseRtpEndpoint.getMinVideoRecvBandwidth(Transaction tx)
Get Minimum bandwidth announced for video reception, in kbps.
|
TFuture<Integer> |
BaseRtpEndpoint.getMinVideoSendBandwidth(Transaction tx)
Get Minimum bandwidth for video transmission, in kbps.
|
TFuture<String> |
MediaObject.getName(Transaction tx)
Get this
MediaObject 's name. |
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 address of the STUN server (Only IP address are supported)
|
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 with this format:
user:password@address:port(?transport=[udp|tcp|tls]) .address must be an IP (not a domain).transport is optional (UDP by default). |
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<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 |
MediaElement.setAudioFormat(Transaction tx,
AudioCaps caps)
Sets 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 |
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 bandwidth for audio reception, in kbps.
|
void |
MediaElement.setMaxOuputBitrate(int maxOuputBitrate,
Transaction tx)
Deprecated.
Set Deprecated due to a typo. Use maxOutputBitrate instead of this function. Maximum video bandwidth for transcoding. 0 = unlimited.
Unit: bps(bits per second).
Default value: MAXINT
|
void |
MediaElement.setMaxOutputBitrate(int maxOutputBitrate,
Transaction tx)
Set Maximum video bitrate for transcoding.
|
void |
SdpEndpoint.setMaxVideoRecvBandwidth(int maxVideoRecvBandwidth,
Transaction tx)
Set Maximum bandwidth for video reception, in kbps.
|
void |
BaseRtpEndpoint.setMaxVideoSendBandwidth(int maxVideoSendBandwidth,
Transaction tx)
Set Maximum bandwidth for video transmission, in kbps.
|
void |
MediaElement.setMinOuputBitrate(int minOuputBitrate,
Transaction tx)
Deprecated.
Set Deprecated due to a typo. Use minOutputBitrate instead of this function. Minimum video bandwidth for transcoding.
Unit: bps(bits per second).
Default value: 0
|
void |
MediaElement.setMinOutputBitrate(int minOutputBitrate,
Transaction tx)
Set Minimum video bitrate for transcoding.
|
void |
BaseRtpEndpoint.setMinVideoRecvBandwidth(int minVideoRecvBandwidth,
Transaction tx)
Set Minimum bandwidth announced for video reception, in kbps.
|
void |
BaseRtpEndpoint.setMinVideoSendBandwidth(int minVideoSendBandwidth,
Transaction tx)
Set Minimum bandwidth for video transmission, in kbps.
|
void |
MediaObject.setName(String name,
Transaction tx)
Set this
MediaObject 's name. |
void |
MediaElement.setOutputBitrate(Transaction tx,
int bitrate)
Deprecated.
Allows change the target bitrate for the media output, if the media is encoded using VP8 or H264. This method only works if it is called before the media starts to flow.
|
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 address of the STUN server (Only IP address are supported)
|
void |
WebRtcEndpoint.setStunServerPort(int stunServerPort,
Transaction tx)
Set port of the STUN server
|
void |
WebRtcEndpoint.setTurnUrl(String turnUrl,
Transaction tx)
Set TURN server URL with this format:
user:password@address:port(?transport=[udp|tcp|tls]) .address must be an IP (not a domain).transport is optional (UDP by default). |
void |
MediaElement.setVideoFormat(Transaction tx,
VideoCaps caps)
Sets 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.
|
Copyright © 2018 Kurento. All rights reserved.