org.kurento.client.MediaPipeline Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kurento-client Show documentation
Kurento Client The Kurento Client project allows server applications to control media server resources.
There is a newer version: 7.1.0
/**
 * This file is generated with Kurento-maven-plugin.
 * Please don't edit.
 */
package org.kurento.client;


/**
 *
 * A pipeline is a container for a collection of {@link module:core/abstracts.MediaElement MediaElements} and :rom:cls:`MediaMixers`. It offers the methods needed to control the creation and connection of elements inside a certain pipeline.
 *
 **/
@org.kurento.client.internal.RemoteClass
public interface MediaPipeline extends MediaObject {

/**
 *
 * Get If statistics about pipeline latency are enabled for all mediaElements
 *
 **/
     boolean getLatencyStats();

/**
 *
 * Get If statistics about pipeline latency are enabled for all mediaElements
 *
 **/
     void getLatencyStats(Continuation cont);

/**
 *
 * Get If statistics about pipeline latency are enabled for all mediaElements
 *
 **/
     TFuture getLatencyStats(Transaction tx);

/**
 *
 * Set If statistics about pipeline latency are enabled for all mediaElements
 *
 **/
     void setLatencyStats(@org.kurento.client.internal.server.Param("latencyStats") boolean latencyStats);

/**
 *
 * Set If statistics about pipeline latency are enabled for all mediaElements
 *
 **/
     void setLatencyStats(@org.kurento.client.internal.server.Param("latencyStats") boolean latencyStats, Continuation cont);

/**
 *
 * Set If statistics about pipeline latency are enabled for all mediaElements
 *
 **/
     void setLatencyStats(@org.kurento.client.internal.server.Param("latencyStats") boolean latencyStats, Transaction tx);


/**
 *
 * Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
 *
 * @param details
 *       Details of graph
 * @return The dot graph *
 **/
  String getGstreamerDot(@org.kurento.client.internal.server.Param("details") org.kurento.client.GstreamerDotDetails details);

/**
 *
 * Asynchronous version of getGstreamerDot:
 * {@link Continuation#onSuccess} is called when the action is
 * done. If an error occurs, {@link Continuation#onError} is called.
 * @see MediaPipeline#getGstreamerDot
 *
 * @param details
 *       Details of graph
 *
 **/
    void getGstreamerDot(@org.kurento.client.internal.server.Param("details") org.kurento.client.GstreamerDotDetails details, Continuation cont);

/**
 *
 * Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
 *
 * @param details
 *       Details of graph
 * @return The dot graph *
 **/
    TFuture getGstreamerDot(Transaction tx, @org.kurento.client.internal.server.Param("details") org.kurento.client.GstreamerDotDetails details);


/**
 *
 * Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
 * @return The dot graph *
 **/
  String getGstreamerDot();

/**
 *
 * Asynchronous version of getGstreamerDot:
 * {@link Continuation#onSuccess} is called when the action is
 * done. If an error occurs, {@link Continuation#onError} is called.
 * @see MediaPipeline#getGstreamerDot
 *
 **/
    void getGstreamerDot(Continuation cont);

/**
 *
 * Returns a string in dot (graphviz) format that represents the gstreamer elements inside the pipeline
 * @return The dot graph *
 **/
    TFuture getGstreamerDot(Transaction tx);

    
    Transaction beginTransaction();




}