MediaElement (Kurento Client 6.2.0 API)

All Superinterfaces:

KurentoObject, MediaObject

All Known Subinterfaces:

BaseRtpEndpoint, Endpoint, FaceOverlayFilter, Filter, GStreamerFilter, HttpEndpoint, HttpPostEndpoint, HubPort, ImageOverlayFilter, OpenCVFilter, PassThrough, PlayerEndpoint, RecorderEndpoint, RtpEndpoint, SdpEndpoint, SessionEndpoint, UriEndpoint, WebRtcEndpoint, ZBarFilter
```
public interface MediaElement
extends MediaObject
```
Basic building blocks of the media server, that can be interconnected through the API. A MediaElement is a module that encapsulates a specific media capability. They can be connected to create media pipelines where those capabilities are applied, in sequence, to the stream going through the pipeline. MediaElement objects are classified by its supported media type (audio, video, etc.)

Method Summary

Methods
Modifier and Type	Method and Description
`ListenerSubscription`	`addElementConnectedListener(EventListener<ElementConnectedEvent> listener)` Add a `EventListener` for event `ElementConnectedEvent`.
`void`	`addElementConnectedListener(EventListener<ElementConnectedEvent> listener, Continuation<ListenerSubscription> cont)` Add a `EventListener` for event `ElementConnectedEvent`.
`ListenerSubscription`	`addElementDisconnectedListener(EventListener<ElementDisconnectedEvent> listener)` Add a `EventListener` for event `ElementDisconnectedEvent`.
`void`	`addElementDisconnectedListener(EventListener<ElementDisconnectedEvent> listener, Continuation<ListenerSubscription> cont)` Add a `EventListener` for event `ElementDisconnectedEvent`.
`void`	`connect(MediaElement sink)` Connects two elements, with the given restrictions, current `MediaElement` will start emmit media to sink element.
`void`	`connect(MediaElement sink, Continuation<Void> cont)` Asynchronous version of connect: `Continuation.onSuccess(F)` is called when the action is done.
`void`	`connect(MediaElement sink, MediaType mediaType)` Connects two elements, with the given restrictions, current `MediaElement` will start emmit media to sink element.
`void`	`connect(MediaElement sink, MediaType mediaType, Continuation<Void> cont)` Asynchronous version of connect: `Continuation.onSuccess(F)` is called when the action is done.
`void`	`connect(MediaElement sink, MediaType mediaType, String sourceMediaDescription)` Connects two elements, with the given restrictions, current `MediaElement` will start emmit media to sink element.
`void`	`connect(MediaElement sink, MediaType mediaType, String sourceMediaDescription, Continuation<Void> cont)` Asynchronous version of connect: `Continuation.onSuccess(F)` is called when the action is done.
`void`	`connect(MediaElement sink, MediaType mediaType, String sourceMediaDescription, String sinkMediaDescription)` Connects two elements, with the given restrictions, current `MediaElement` will start emmit media to sink element.
`void`	`connect(MediaElement sink, MediaType mediaType, String sourceMediaDescription, String sinkMediaDescription, Continuation<Void> cont)` Asynchronous version of connect: `Continuation.onSuccess(F)` is called when the action is done.
`void`	`connect(Transaction tx, MediaElement sink)` Connects two elements, with the given restrictions, current `MediaElement` will start emmit media to sink element.
`void`	`connect(Transaction tx, MediaElement sink, MediaType mediaType)` Connects two elements, with the given restrictions, current `MediaElement` will start emmit media to sink element.
`void`	`connect(Transaction tx, MediaElement sink, MediaType mediaType, String sourceMediaDescription)` Connects two elements, with the given restrictions, current `MediaElement` will start emmit media to sink element.
`void`	`connect(Transaction tx, MediaElement sink, MediaType mediaType, String sourceMediaDescription, String sinkMediaDescription)` Connects two elements, with the given restrictions, current `MediaElement` will start emmit media to sink element.
`void`	`disconnect(MediaElement sink)` Disconnects two elements, with the given restrictions, current `MediaElement` stops sending media to sink element.
`void`	`disconnect(MediaElement sink, Continuation<Void> cont)` Asynchronous version of disconnect: `Continuation.onSuccess(F)` is called when the action is done.
`void`	`disconnect(MediaElement sink, MediaType mediaType)` Disconnects two elements, with the given restrictions, current `MediaElement` stops sending media to sink element.
`void`	`disconnect(MediaElement sink, MediaType mediaType, Continuation<Void> cont)` Asynchronous version of disconnect: `Continuation.onSuccess(F)` is called when the action is done.
`void`	`disconnect(MediaElement sink, MediaType mediaType, String sourceMediaDescription)` Disconnects two elements, with the given restrictions, current `MediaElement` stops sending media to sink element.
`void`	`disconnect(MediaElement sink, MediaType mediaType, String sourceMediaDescription, Continuation<Void> cont)` Asynchronous version of disconnect: `Continuation.onSuccess(F)` is called when the action is done.
`void`	`disconnect(MediaElement sink, MediaType mediaType, String sourceMediaDescription, String sinkMediaDescription)` Disconnects two elements, with the given restrictions, current `MediaElement` stops sending media to sink element.
`void`	`disconnect(MediaElement sink, MediaType mediaType, String sourceMediaDescription, String sinkMediaDescription, Continuation<Void> cont)` Asynchronous version of disconnect: `Continuation.onSuccess(F)` is called when the action is done.
`void`	`disconnect(Transaction tx, MediaElement sink)` Disconnects two elements, with the given restrictions, current `MediaElement` stops sending media to sink element.
`void`	`disconnect(Transaction tx, MediaElement sink, MediaType mediaType)` Disconnects two elements, with the given restrictions, current `MediaElement` stops sending media to sink element.
`void`	`disconnect(Transaction tx, MediaElement sink, MediaType mediaType, String sourceMediaDescription)` Disconnects two elements, with the given restrictions, current `MediaElement` stops sending media to sink element.
`void`	`disconnect(Transaction tx, MediaElement sink, MediaType mediaType, String sourceMediaDescription, String sinkMediaDescription)` Disconnects two elements, with the given restrictions, current `MediaElement` stops sending media to sink element.
`String`	`getGstreamerDot()` Returns a string in dot (graphviz) format that represents the gstreamer elements inside
`void`	`getGstreamerDot(Continuation<String> cont)` Asynchronous version of getGstreamerDot: `Continuation.onSuccess(F)` is called when the action is done.
`String`	`getGstreamerDot(GstreamerDotDetails details)` Returns a string in dot (graphviz) format that represents the gstreamer elements inside
`void`	`getGstreamerDot(GstreamerDotDetails details, Continuation<String> cont)` Asynchronous version of getGstreamerDot: `Continuation.onSuccess(F)` is called when the action is done.
`TFuture<String>`	`getGstreamerDot(Transaction tx)` Returns a string in dot (graphviz) format that represents the gstreamer elements inside
`TFuture<String>`	`getGstreamerDot(Transaction tx, GstreamerDotDetails details)` Returns a string in dot (graphviz) format that represents the gstreamer elements inside
`int`	`getMaxOuputBitrate()`
`void`	`getMaxOuputBitrate(Continuation<Integer> cont)`
`TFuture<Integer>`	`getMaxOuputBitrate(Transaction tx)`
`int`	`getMinOuputBitrate()`
`void`	`getMinOuputBitrate(Continuation<Integer> cont)`
`TFuture<Integer>`	`getMinOuputBitrate(Transaction tx)`
`List<ElementConnectionData>`	`getSinkConnections()` Returns a list of the connections information of the elements that ere receiving media from this element.
`void`	`getSinkConnections(Continuation<List<ElementConnectionData>> cont)` Asynchronous version of getSinkConnections: `Continuation.onSuccess(F)` is called when the action is done.
`List<ElementConnectionData>`	`getSinkConnections(MediaType mediaType)` Returns a list of the connections information of the elements that ere receiving media from this element.
`void`	`getSinkConnections(MediaType mediaType, Continuation<List<ElementConnectionData>> cont)` Asynchronous version of getSinkConnections: `Continuation.onSuccess(F)` is called when the action is done.
`List<ElementConnectionData>`	`getSinkConnections(MediaType mediaType, String description)` Returns a list of the connections information of the elements that ere receiving media from this element.
`void`	`getSinkConnections(MediaType mediaType, String description, Continuation<List<ElementConnectionData>> cont)` Asynchronous version of getSinkConnections: `Continuation.onSuccess(F)` is called when the action is done.
`TFuture<List<ElementConnectionData>>`	`getSinkConnections(Transaction tx)` Returns a list of the connections information of the elements that ere receiving media from this element.
`TFuture<List<ElementConnectionData>>`	`getSinkConnections(Transaction tx, MediaType mediaType)` Returns a list of the connections information of the elements that ere receiving media from this element.
`TFuture<List<ElementConnectionData>>`	`getSinkConnections(Transaction tx, MediaType mediaType, String description)` Returns a list of the connections information of the elements that ere receiving media from this element.
`List<ElementConnectionData>`	`getSourceConnections()` Get the connections information of the elements that are sending media to this element `MediaElement`
`void`	`getSourceConnections(Continuation<List<ElementConnectionData>> cont)` Asynchronous version of getSourceConnections: `Continuation.onSuccess(F)` is called when the action is done.
`List<ElementConnectionData>`	`getSourceConnections(MediaType mediaType)` Get the connections information of the elements that are sending media to this element `MediaElement`
`void`	`getSourceConnections(MediaType mediaType, Continuation<List<ElementConnectionData>> cont)` Asynchronous version of getSourceConnections: `Continuation.onSuccess(F)` is called when the action is done.
`List<ElementConnectionData>`	`getSourceConnections(MediaType mediaType, String description)` Get the connections information of the elements that are sending media to this element `MediaElement`
`void`	`getSourceConnections(MediaType mediaType, String description, Continuation<List<ElementConnectionData>> cont)` Asynchronous version of getSourceConnections: `Continuation.onSuccess(F)` is called when the action is done.
`TFuture<List<ElementConnectionData>>`	`getSourceConnections(Transaction tx)` Get the connections information of the elements that are sending media to this element `MediaElement`
`TFuture<List<ElementConnectionData>>`	`getSourceConnections(Transaction tx, MediaType mediaType)` Get the connections information of the elements that are sending media to this element `MediaElement`
`TFuture<List<ElementConnectionData>>`	`getSourceConnections(Transaction tx, MediaType mediaType, String description)` Get the connections information of the elements that are sending media to this element `MediaElement`
`Map<String,Stats>`	`getStats()` Provides statistics collected for this endpoint
`void`	`getStats(Continuation<Map<String,Stats>> cont)` Asynchronous version of getStats: `Continuation.onSuccess(F)` is called when the action is done.
`Map<String,Stats>`	`getStats(MediaType mediaType)` Provides statistics collected for this endpoint
`void`	`getStats(MediaType mediaType, Continuation<Map<String,Stats>> cont)` Asynchronous version of getStats: `Continuation.onSuccess(F)` is called when the action is done.
`TFuture<Map<String,Stats>>`	`getStats(Transaction tx)` Provides statistics collected for this endpoint
`TFuture<Map<String,Stats>>`	`getStats(Transaction tx, MediaType mediaType)` Provides statistics collected for this endpoint
`void`	`removeElementConnectedListener(ListenerSubscription listenerSubscription)` Remove a `ListenerSubscription` for event `ElementConnectedEvent`.
`void`	`removeElementConnectedListener(ListenerSubscription listenerSubscription, Continuation<Void> cont)` Remove a `ListenerSubscription` for event `ElementConnectedEvent`.
`void`	`removeElementDisconnectedListener(ListenerSubscription listenerSubscription)` Remove a `ListenerSubscription` for event `ElementDisconnectedEvent`.
`void`	`removeElementDisconnectedListener(ListenerSubscription listenerSubscription, Continuation<Void> cont)` Remove a `ListenerSubscription` for event `ElementDisconnectedEvent`.
`void`	`setAudioFormat(AudioCaps caps)` Sets the type of data for the audio stream.
`void`	`setAudioFormat(AudioCaps caps, Continuation<Void> cont)` Asynchronous version of setAudioFormat: `Continuation.onSuccess(F)` is called when the action is done.
`void`	`setAudioFormat(Transaction tx, AudioCaps caps)` Sets the type of data for the audio stream.
`void`	`setMaxOuputBitrate(int maxOuputBitrate)`
`void`	`setMaxOuputBitrate(int maxOuputBitrate, Continuation<Void> cont)`
`void`	`setMaxOuputBitrate(int maxOuputBitrate, Transaction tx)`
`void`	`setMinOuputBitrate(int minOuputBitrate)`
`void`	`setMinOuputBitrate(int minOuputBitrate, Continuation<Void> cont)`
`void`	`setMinOuputBitrate(int minOuputBitrate, Transaction tx)`
`void`	`setOutputBitrate(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`	`setOutputBitrate(int bitrate, Continuation<Void> cont)` Asynchronous version of setOutputBitrate: `Continuation.onSuccess(F)` is called when the action is done.
`void`	`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`	`setVideoFormat(Transaction tx, VideoCaps caps)` Sets the type of data for the video stream.
`void`	`setVideoFormat(VideoCaps caps)` Sets the type of data for the video stream.
`void`	`setVideoFormat(VideoCaps caps, Continuation<Void> cont)` Asynchronous version of setVideoFormat: `Continuation.onSuccess(F)` is called when the action is done.

Methods inherited from interface org.kurento.client.MediaObject
addErrorListener, addErrorListener, addTag, addTag, addTag, getChilds, getChilds, getChilds, getCreationTime, getCreationTime, getCreationTime, getId, getId, getId, getMediaPipeline, getMediaPipeline, getMediaPipeline, getName, getName, getName, getParent, getParent, getParent, getSendTagsInEvents, getSendTagsInEvents, getSendTagsInEvents, getTag, getTag, getTag, getTags, getTags, getTags, removeErrorListener, removeErrorListener, removeTag, removeTag, removeTag, setName, setName, setName, setSendTagsInEvents, setSendTagsInEvents, setSendTagsInEvents

Methods inherited from interface org.kurento.client.KurentoObject
isCommited, release, release, release, waitCommited, whenCommited, whenCommited

- Method Detail
  - getMinOuputBitrate
```
int getMinOuputBitrate()
```
  - getMinOuputBitrate
```
void getMinOuputBitrate(Continuation<Integer> cont)
```
  - getMinOuputBitrate
```
TFuture<Integer> getMinOuputBitrate(Transaction tx)
```
  - setMinOuputBitrate
```
void setMinOuputBitrate(int minOuputBitrate)
```
  - setMinOuputBitrate
```
void setMinOuputBitrate(int minOuputBitrate,
                      Continuation<Void> cont)
```
  - setMinOuputBitrate
```
void setMinOuputBitrate(int minOuputBitrate,
                      Transaction tx)
```
  - getMaxOuputBitrate
```
int getMaxOuputBitrate()
```
  - getMaxOuputBitrate
```
void getMaxOuputBitrate(Continuation<Integer> cont)
```
  - getMaxOuputBitrate
```
TFuture<Integer> getMaxOuputBitrate(Transaction tx)
```
  - setMaxOuputBitrate
```
void setMaxOuputBitrate(int maxOuputBitrate)
```
  - setMaxOuputBitrate
```
void setMaxOuputBitrate(int maxOuputBitrate,
                      Continuation<Void> cont)
```
  - setMaxOuputBitrate
```
void setMaxOuputBitrate(int maxOuputBitrate,
                      Transaction tx)
```
  - getSourceConnections
```
List<ElementConnectionData> getSourceConnections(MediaType mediaType,
                                               String description)
```
    Get the connections information of the elements that are sending media to this element MediaElement
    
    Parameters:
    mediaType - One of #MediaType.AUDIO, #MediaType.VIDEO or #MediaType.DATA
    description - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    
    Returns:
    A list of the connections information that are sending media to this element. The list will be empty if no sources are found. *
  - getSourceConnections
```
void getSourceConnections(MediaType mediaType,
                        String description,
                        Continuation<List<ElementConnectionData>> cont)
```
    Asynchronous version of getSourceConnections: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    mediaType - One of #MediaType.AUDIO, #MediaType.VIDEO or #MediaType.DATA
    description - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    See Also:
    getSourceConnections(org.kurento.client.MediaType, java.lang.String)
  - getSourceConnections
```
TFuture<List<ElementConnectionData>> getSourceConnections(Transaction tx,
                                                        MediaType mediaType,
                                                        String description)
```
    Get the connections information of the elements that are sending media to this element MediaElement
    
    Parameters:
    mediaType - One of #MediaType.AUDIO, #MediaType.VIDEO or #MediaType.DATA
    description - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    
    Returns:
    A list of the connections information that are sending media to this element. The list will be empty if no sources are found. *
  - getSinkConnections
```
List<ElementConnectionData> getSinkConnections(MediaType mediaType,
                                             String description)
```
    Returns a list of the connections information of the elements that ere receiving media from this element.
    
    Parameters:
    mediaType - One of #MediaType.AUDIO, #MediaType.VIDEO or #MediaType.DATA
    description - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    
    Returns:
    A list of the connections information that arereceiving media from this element. The list will be empty if no sinks are found. *
  - getSinkConnections
```
void getSinkConnections(MediaType mediaType,
                      String description,
                      Continuation<List<ElementConnectionData>> cont)
```
    Asynchronous version of getSinkConnections: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    mediaType - One of #MediaType.AUDIO, #MediaType.VIDEO or #MediaType.DATA
    description - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    See Also:
    getSinkConnections(org.kurento.client.MediaType, java.lang.String)
  - getSinkConnections
```
TFuture<List<ElementConnectionData>> getSinkConnections(Transaction tx,
                                                      MediaType mediaType,
                                                      String description)
```
    Returns a list of the connections information of the elements that ere receiving media from this element.
    
    Parameters:
    mediaType - One of #MediaType.AUDIO, #MediaType.VIDEO or #MediaType.DATA
    description - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    
    Returns:
    A list of the connections information that arereceiving media from this element. The list will be empty if no sinks are found. *
  - connect
```
void connect(MediaElement sink,
           MediaType mediaType,
           String sourceMediaDescription,
           String sinkMediaDescription)
```
    Connects two elements, with the given restrictions, current MediaElement will start emmit media to sink element. Connection could take place in the future, when both media element show capabilities for connecting with the given restrictions
    
    Parameters:
    sink - the target MediaElement that will receive media
    mediaType - the MediaType of the pads that will be connected
    sourceMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    sinkMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
  - connect
```
void connect(MediaElement sink,
           MediaType mediaType,
           String sourceMediaDescription,
           String sinkMediaDescription,
           Continuation<Void> cont)
```
    Asynchronous version of connect: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    sink - the target MediaElement that will receive media
    mediaType - the MediaType of the pads that will be connected
    sourceMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    sinkMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    See Also:
    connect(org.kurento.client.MediaElement, org.kurento.client.MediaType, java.lang.String, java.lang.String)
  - connect
```
void connect(Transaction tx,
           MediaElement sink,
           MediaType mediaType,
           String sourceMediaDescription,
           String sinkMediaDescription)
```
    Connects two elements, with the given restrictions, current MediaElement will start emmit media to sink element. Connection could take place in the future, when both media element show capabilities for connecting with the given restrictions
    
    Parameters:
    sink - the target MediaElement that will receive media
    mediaType - the MediaType of the pads that will be connected
    sourceMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    sinkMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
  - disconnect
```
void disconnect(MediaElement sink,
              MediaType mediaType,
              String sourceMediaDescription,
              String sinkMediaDescription)
```
    Disconnects two elements, with the given restrictions, current MediaElement stops sending media to sink element. If the previously requested connection didn't took place it is also removed
    
    Parameters:
    sink - the target MediaElement that will stop receiving media
    mediaType - the MediaType of the pads that will be connected
    sourceMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    sinkMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
  - disconnect
```
void disconnect(MediaElement sink,
              MediaType mediaType,
              String sourceMediaDescription,
              String sinkMediaDescription,
              Continuation<Void> cont)
```
    Asynchronous version of disconnect: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    sink - the target MediaElement that will stop receiving media
    mediaType - the MediaType of the pads that will be connected
    sourceMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    sinkMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    See Also:
    disconnect(org.kurento.client.MediaElement, org.kurento.client.MediaType, java.lang.String, java.lang.String)
  - disconnect
```
void disconnect(Transaction tx,
              MediaElement sink,
              MediaType mediaType,
              String sourceMediaDescription,
              String sinkMediaDescription)
```
    Disconnects two elements, with the given restrictions, current MediaElement stops sending media to sink element. If the previously requested connection didn't took place it is also removed
    
    Parameters:
    sink - the target MediaElement that will stop receiving media
    mediaType - the MediaType of the pads that will be connected
    sourceMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    sinkMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
  - setAudioFormat
```
void setAudioFormat(AudioCaps caps)
```
    Sets the type of data for the audio stream. MediaElements that do not support configuration of audio capabilities will raise an exception
    
    Parameters:
    caps - The format for the stream of audio
  - setAudioFormat
```
void setAudioFormat(AudioCaps caps,
                  Continuation<Void> cont)
```
    Asynchronous version of setAudioFormat: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    caps - The format for the stream of audio
    See Also:
    setAudioFormat(org.kurento.client.AudioCaps)
  - setAudioFormat
```
void setAudioFormat(Transaction tx,
                  AudioCaps caps)
```
    Sets the type of data for the audio stream. MediaElements that do not support configuration of audio capabilities will raise an exception
    
    Parameters:
    caps - The format for the stream of audio
  - setVideoFormat
```
void setVideoFormat(VideoCaps caps)
```
    Sets the type of data for the video stream. MediaElements that do not support configuration of video capabilities will raise an exception
    
    Parameters:
    caps - The format for the stream of video
  - setVideoFormat
```
void setVideoFormat(VideoCaps caps,
                  Continuation<Void> cont)
```
    Asynchronous version of setVideoFormat: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    caps - The format for the stream of video
    See Also:
    setVideoFormat(org.kurento.client.VideoCaps)
  - setVideoFormat
```
void setVideoFormat(Transaction tx,
                  VideoCaps caps)
```
    Sets the type of data for the video stream. MediaElements that do not support configuration of video capabilities will raise an exception
    
    Parameters:
    caps - The format for the stream of video
  - getGstreamerDot
```
String getGstreamerDot(GstreamerDotDetails details)
```
    Returns a string in dot (graphviz) format that represents the gstreamer elements inside
    
    Parameters:
    details - Details of graph
    
    Returns:
    The dot graph *
  - getGstreamerDot
```
void getGstreamerDot(GstreamerDotDetails details,
                   Continuation<String> cont)
```
    Asynchronous version of getGstreamerDot: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    details - Details of graph
    See Also:
    getGstreamerDot(org.kurento.client.GstreamerDotDetails)
  - getGstreamerDot
```
TFuture<String> getGstreamerDot(Transaction tx,
                              GstreamerDotDetails details)
```
    Returns a string in dot (graphviz) format that represents the gstreamer elements inside
    
    Parameters:
    details - Details of graph
    
    Returns:
    The dot graph *
  - setOutputBitrate
```
void setOutputBitrate(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.
    
    Parameters:
    bitrate - Configure the enconding media bitrate in bps
  - setOutputBitrate
```
void setOutputBitrate(int bitrate,
                    Continuation<Void> cont)
```
    Asynchronous version of setOutputBitrate: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    bitrate - Configure the enconding media bitrate in bps
    See Also:
    setOutputBitrate(int)
  - setOutputBitrate
```
void 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.
    
    Parameters:
    bitrate - Configure the enconding media bitrate in bps
  - getStats
```
Map<String,Stats> getStats(MediaType mediaType)
```
    Provides statistics collected for this endpoint
    
    Parameters:
    mediaType - One of #MediaType.AUDIO or #MediaType.VIDEO
    
    Returns:
    Delivers a successful result in the form of a RTC stats report. A RTC stats report represents a map between strings, identifying the inspected objects (RTCStats.id), and their corresponding RTCStats objects. *
  - getStats
```
void getStats(MediaType mediaType,
            Continuation<Map<String,Stats>> cont)
```
    Asynchronous version of getStats: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    mediaType - One of #MediaType.AUDIO or #MediaType.VIDEO
    See Also:
    getStats(org.kurento.client.MediaType)
  - getStats
```
TFuture<Map<String,Stats>> getStats(Transaction tx,
                                  MediaType mediaType)
```
    Provides statistics collected for this endpoint
    
    Parameters:
    mediaType - One of #MediaType.AUDIO or #MediaType.VIDEO
    
    Returns:
    Delivers a successful result in the form of a RTC stats report. A RTC stats report represents a map between strings, identifying the inspected objects (RTCStats.id), and their corresponding RTCStats objects. *
  - getSourceConnections
```
List<ElementConnectionData> getSourceConnections()
```
    Get the connections information of the elements that are sending media to this element MediaElement
    
    Returns:
    A list of the connections information that are sending media to this element. The list will be empty if no sources are found. *
  - getSourceConnections
```
void getSourceConnections(Continuation<List<ElementConnectionData>> cont)
```
    Asynchronous version of getSourceConnections: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    See Also:
    getSourceConnections(org.kurento.client.MediaType, java.lang.String)
  - getSourceConnections
```
TFuture<List<ElementConnectionData>> getSourceConnections(Transaction tx)
```
    Get the connections information of the elements that are sending media to this element MediaElement
    
    Returns:
    A list of the connections information that are sending media to this element. The list will be empty if no sources are found. *
  - getSourceConnections
```
List<ElementConnectionData> getSourceConnections(MediaType mediaType)
```
    Get the connections information of the elements that are sending media to this element MediaElement
    
    Parameters:
    mediaType - One of #MediaType.AUDIO, #MediaType.VIDEO or #MediaType.DATA
    
    Returns:
    A list of the connections information that are sending media to this element. The list will be empty if no sources are found. *
  - getSourceConnections
```
void getSourceConnections(MediaType mediaType,
                        Continuation<List<ElementConnectionData>> cont)
```
    Asynchronous version of getSourceConnections: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    mediaType - One of #MediaType.AUDIO, #MediaType.VIDEO or #MediaType.DATA
    See Also:
    getSourceConnections(org.kurento.client.MediaType, java.lang.String)
  - getSourceConnections
```
TFuture<List<ElementConnectionData>> getSourceConnections(Transaction tx,
                                                        MediaType mediaType)
```
    Get the connections information of the elements that are sending media to this element MediaElement
    
    Parameters:
    mediaType - One of #MediaType.AUDIO, #MediaType.VIDEO or #MediaType.DATA
    
    Returns:
    A list of the connections information that are sending media to this element. The list will be empty if no sources are found. *
  - getSinkConnections
```
List<ElementConnectionData> getSinkConnections()
```
    Returns a list of the connections information of the elements that ere receiving media from this element.
    
    Returns:
    A list of the connections information that arereceiving media from this element. The list will be empty if no sinks are found. *
  - getSinkConnections
```
void getSinkConnections(Continuation<List<ElementConnectionData>> cont)
```
    Asynchronous version of getSinkConnections: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    See Also:
    getSinkConnections(org.kurento.client.MediaType, java.lang.String)
  - getSinkConnections
```
TFuture<List<ElementConnectionData>> getSinkConnections(Transaction tx)
```
    Returns a list of the connections information of the elements that ere receiving media from this element.
    
    Returns:
    A list of the connections information that arereceiving media from this element. The list will be empty if no sinks are found. *
  - getSinkConnections
```
List<ElementConnectionData> getSinkConnections(MediaType mediaType)
```
    Returns a list of the connections information of the elements that ere receiving media from this element.
    
    Parameters:
    mediaType - One of #MediaType.AUDIO, #MediaType.VIDEO or #MediaType.DATA
    
    Returns:
    A list of the connections information that arereceiving media from this element. The list will be empty if no sinks are found. *
  - getSinkConnections
```
void getSinkConnections(MediaType mediaType,
                      Continuation<List<ElementConnectionData>> cont)
```
    Asynchronous version of getSinkConnections: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    mediaType - One of #MediaType.AUDIO, #MediaType.VIDEO or #MediaType.DATA
    See Also:
    getSinkConnections(org.kurento.client.MediaType, java.lang.String)
  - getSinkConnections
```
TFuture<List<ElementConnectionData>> getSinkConnections(Transaction tx,
                                                      MediaType mediaType)
```
    Returns a list of the connections information of the elements that ere receiving media from this element.
    
    Parameters:
    mediaType - One of #MediaType.AUDIO, #MediaType.VIDEO or #MediaType.DATA
    
    Returns:
    A list of the connections information that arereceiving media from this element. The list will be empty if no sinks are found. *
  - connect
```
void connect(MediaElement sink)
```
    Connects two elements, with the given restrictions, current MediaElement will start emmit media to sink element. Connection could take place in the future, when both media element show capabilities for connecting with the given restrictions
    
    Parameters:
    sink - the target MediaElement that will receive media
  - connect
```
void connect(MediaElement sink,
           Continuation<Void> cont)
```
    Asynchronous version of connect: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    sink - the target MediaElement that will receive media
    See Also:
    connect(org.kurento.client.MediaElement, org.kurento.client.MediaType, java.lang.String, java.lang.String)
  - connect
```
void connect(Transaction tx,
           MediaElement sink)
```
    Connects two elements, with the given restrictions, current MediaElement will start emmit media to sink element. Connection could take place in the future, when both media element show capabilities for connecting with the given restrictions
    
    Parameters:
    sink - the target MediaElement that will receive media
  - connect
```
void connect(MediaElement sink,
           MediaType mediaType)
```
    Connects two elements, with the given restrictions, current MediaElement will start emmit media to sink element. Connection could take place in the future, when both media element show capabilities for connecting with the given restrictions
    
    Parameters:
    sink - the target MediaElement that will receive media
    mediaType - the MediaType of the pads that will be connected
  - connect
```
void connect(MediaElement sink,
           MediaType mediaType,
           Continuation<Void> cont)
```
    Asynchronous version of connect: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    sink - the target MediaElement that will receive media
    mediaType - the MediaType of the pads that will be connected
    See Also:
    connect(org.kurento.client.MediaElement, org.kurento.client.MediaType, java.lang.String, java.lang.String)
  - connect
```
void connect(Transaction tx,
           MediaElement sink,
           MediaType mediaType)
```
    Connects two elements, with the given restrictions, current MediaElement will start emmit media to sink element. Connection could take place in the future, when both media element show capabilities for connecting with the given restrictions
    
    Parameters:
    sink - the target MediaElement that will receive media
    mediaType - the MediaType of the pads that will be connected
  - connect
```
void connect(MediaElement sink,
           MediaType mediaType,
           String sourceMediaDescription)
```
    Connects two elements, with the given restrictions, current MediaElement will start emmit media to sink element. Connection could take place in the future, when both media element show capabilities for connecting with the given restrictions
    
    Parameters:
    sink - the target MediaElement that will receive media
    mediaType - the MediaType of the pads that will be connected
    sourceMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
  - connect
```
void connect(MediaElement sink,
           MediaType mediaType,
           String sourceMediaDescription,
           Continuation<Void> cont)
```
    Asynchronous version of connect: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    sink - the target MediaElement that will receive media
    mediaType - the MediaType of the pads that will be connected
    sourceMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    See Also:
    connect(org.kurento.client.MediaElement, org.kurento.client.MediaType, java.lang.String, java.lang.String)
  - connect
```
void connect(Transaction tx,
           MediaElement sink,
           MediaType mediaType,
           String sourceMediaDescription)
```
    Connects two elements, with the given restrictions, current MediaElement will start emmit media to sink element. Connection could take place in the future, when both media element show capabilities for connecting with the given restrictions
    
    Parameters:
    sink - the target MediaElement that will receive media
    mediaType - the MediaType of the pads that will be connected
    sourceMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
  - disconnect
```
void disconnect(MediaElement sink)
```
    Disconnects two elements, with the given restrictions, current MediaElement stops sending media to sink element. If the previously requested connection didn't took place it is also removed
    
    Parameters:
    sink - the target MediaElement that will stop receiving media
  - disconnect
```
void disconnect(MediaElement sink,
              Continuation<Void> cont)
```
    Asynchronous version of disconnect: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    sink - the target MediaElement that will stop receiving media
    See Also:
    disconnect(org.kurento.client.MediaElement, org.kurento.client.MediaType, java.lang.String, java.lang.String)
  - disconnect
```
void disconnect(Transaction tx,
              MediaElement sink)
```
    Disconnects two elements, with the given restrictions, current MediaElement stops sending media to sink element. If the previously requested connection didn't took place it is also removed
    
    Parameters:
    sink - the target MediaElement that will stop receiving media
  - disconnect
```
void disconnect(MediaElement sink,
              MediaType mediaType)
```
    Disconnects two elements, with the given restrictions, current MediaElement stops sending media to sink element. If the previously requested connection didn't took place it is also removed
    
    Parameters:
    sink - the target MediaElement that will stop receiving media
    mediaType - the MediaType of the pads that will be connected
  - disconnect
```
void disconnect(MediaElement sink,
              MediaType mediaType,
              Continuation<Void> cont)
```
    Asynchronous version of disconnect: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    sink - the target MediaElement that will stop receiving media
    mediaType - the MediaType of the pads that will be connected
    See Also:
    disconnect(org.kurento.client.MediaElement, org.kurento.client.MediaType, java.lang.String, java.lang.String)
  - disconnect
```
void disconnect(Transaction tx,
              MediaElement sink,
              MediaType mediaType)
```
    Disconnects two elements, with the given restrictions, current MediaElement stops sending media to sink element. If the previously requested connection didn't took place it is also removed
    
    Parameters:
    sink - the target MediaElement that will stop receiving media
    mediaType - the MediaType of the pads that will be connected
  - disconnect
```
void disconnect(MediaElement sink,
              MediaType mediaType,
              String sourceMediaDescription)
```
    Disconnects two elements, with the given restrictions, current MediaElement stops sending media to sink element. If the previously requested connection didn't took place it is also removed
    
    Parameters:
    sink - the target MediaElement that will stop receiving media
    mediaType - the MediaType of the pads that will be connected
    sourceMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
  - disconnect
```
void disconnect(MediaElement sink,
              MediaType mediaType,
              String sourceMediaDescription,
              Continuation<Void> cont)
```
    Asynchronous version of disconnect: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    Parameters:
    sink - the target MediaElement that will stop receiving media
    mediaType - the MediaType of the pads that will be connected
    sourceMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
    See Also:
    disconnect(org.kurento.client.MediaElement, org.kurento.client.MediaType, java.lang.String, java.lang.String)
  - disconnect
```
void disconnect(Transaction tx,
              MediaElement sink,
              MediaType mediaType,
              String sourceMediaDescription)
```
    Disconnects two elements, with the given restrictions, current MediaElement stops sending media to sink element. If the previously requested connection didn't took place it is also removed
    
    Parameters:
    sink - the target MediaElement that will stop receiving media
    mediaType - the MediaType of the pads that will be connected
    sourceMediaDescription - A textual description of the media source. Currently not used, aimed mainly for #MediaType.DATA sources
  - getGstreamerDot
```
String getGstreamerDot()
```
    Returns a string in dot (graphviz) format that represents the gstreamer elements inside
    
    Returns:
    The dot graph *
  - getGstreamerDot
```
void getGstreamerDot(Continuation<String> cont)
```
    Asynchronous version of getGstreamerDot: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    See Also:
    getGstreamerDot(org.kurento.client.GstreamerDotDetails)
  - getGstreamerDot
```
TFuture<String> getGstreamerDot(Transaction tx)
```
    Returns a string in dot (graphviz) format that represents the gstreamer elements inside
    
    Returns:
    The dot graph *
  - getStats
```
Map<String,Stats> getStats()
```
    Provides statistics collected for this endpoint
    
    Returns:
    Delivers a successful result in the form of a RTC stats report. A RTC stats report represents a map between strings, identifying the inspected objects (RTCStats.id), and their corresponding RTCStats objects. *
  - getStats
```
void getStats(Continuation<Map<String,Stats>> cont)
```
    Asynchronous version of getStats: Continuation.onSuccess(F) is called when the action is done. If an error occurs, Continuation.onError(java.lang.Throwable) is called.
    
    See Also:
    getStats(org.kurento.client.MediaType)
  - getStats
```
TFuture<Map<String,Stats>> getStats(Transaction tx)
```
    Provides statistics collected for this endpoint
    
    Returns:
    Delivers a successful result in the form of a RTC stats report. A RTC stats report represents a map between strings, identifying the inspected objects (RTCStats.id), and their corresponding RTCStats objects. *
  - addElementConnectedListener
```
ListenerSubscription addElementConnectedListener(EventListener<ElementConnectedEvent> listener)
```
    Add a EventListener for event ElementConnectedEvent. Synchronous call.
    
    Parameters:
    listener - Listener to be called on ElementConnectedEvent
    
    Returns:
    ListenerSubscription for the given Listener
  - addElementConnectedListener
```
void addElementConnectedListener(EventListener<ElementConnectedEvent> listener,
                               Continuation<ListenerSubscription> cont)
```
    Add a EventListener for event ElementConnectedEvent. Asynchronous call. Calls Continuation<ListenerSubscription> when it has been added.
    
    Parameters:
    listener - Listener to be called on ElementConnectedEvent
    cont - Continuation to be called when the listener is registered
  - removeElementConnectedListener
```
void removeElementConnectedListener(ListenerSubscription listenerSubscription)
```
    Remove a ListenerSubscription for event ElementConnectedEvent. Synchronous call.
    
    Parameters:
    listenerSubscription - Listener subscription to be removed
  - removeElementConnectedListener
```
void removeElementConnectedListener(ListenerSubscription listenerSubscription,
                                  Continuation<Void> cont)
```
    Remove a ListenerSubscription for event ElementConnectedEvent. Asynchronous call. Calls Continuation<Void> when it has been removed.
    
    Parameters:
    listenerSubscription - Listener subscription to be removed
    cont - Continuation to be called when the listener is removed
  - addElementDisconnectedListener
```
ListenerSubscription addElementDisconnectedListener(EventListener<ElementDisconnectedEvent> listener)
```
    Add a EventListener for event ElementDisconnectedEvent. Synchronous call.
    
    Parameters:
    listener - Listener to be called on ElementDisconnectedEvent
    
    Returns:
    ListenerSubscription for the given Listener
  - addElementDisconnectedListener
```
void addElementDisconnectedListener(EventListener<ElementDisconnectedEvent> listener,
                                  Continuation<ListenerSubscription> cont)
```
    Add a EventListener for event ElementDisconnectedEvent. Asynchronous call. Calls Continuation<ListenerSubscription> when it has been added.
    
    Parameters:
    listener - Listener to be called on ElementDisconnectedEvent
    cont - Continuation to be called when the listener is registered
  - removeElementDisconnectedListener
```
void removeElementDisconnectedListener(ListenerSubscription listenerSubscription)
```
    Remove a ListenerSubscription for event ElementDisconnectedEvent. Synchronous call.
    
    Parameters:
    listenerSubscription - Listener subscription to be removed
  - removeElementDisconnectedListener
```
void removeElementDisconnectedListener(ListenerSubscription listenerSubscription,
                                     Continuation<Void> cont)
```
    Remove a ListenerSubscription for event ElementDisconnectedEvent. Asynchronous call. Calls Continuation<Void> when it has been removed.
    
    Parameters:
    listenerSubscription - Listener subscription to be removed
    cont - Continuation to be called when the listener is removed

Interface MediaElement

Method Summary

Methods inherited from interface org.kurento.client.MediaObject

Methods inherited from interface org.kurento.client.KurentoObject

Method Detail

getMinOuputBitrate

getMinOuputBitrate

getMinOuputBitrate

setMinOuputBitrate

setMinOuputBitrate

setMinOuputBitrate

getMaxOuputBitrate

getMaxOuputBitrate

getMaxOuputBitrate

setMaxOuputBitrate

setMaxOuputBitrate

setMaxOuputBitrate

getSourceConnections

getSourceConnections

getSourceConnections

getSinkConnections

getSinkConnections

getSinkConnections

connect

connect

connect

disconnect

disconnect

disconnect

setAudioFormat

setAudioFormat

setAudioFormat

setVideoFormat

setVideoFormat

setVideoFormat

getGstreamerDot

getGstreamerDot

getGstreamerDot

setOutputBitrate

setOutputBitrate

setOutputBitrate

getStats

getStats

getStats

getSourceConnections

getSourceConnections

getSourceConnections

getSourceConnections

getSourceConnections

getSourceConnections

getSinkConnections

getSinkConnections

getSinkConnections

getSinkConnections

getSinkConnections

getSinkConnections

connect

connect

connect

connect

connect

connect

connect

connect

connect

disconnect

disconnect

disconnect

disconnect

disconnect

disconnect

disconnect

disconnect

disconnect

getGstreamerDot

getGstreamerDot

getGstreamerDot

getStats

getStats

getStats