org.kurento.client

Class HttpPostEndpoint.Builder

java.lang.Object

org.kurento.client.AbstractBuilder<HttpPostEndpoint>

org.kurento.client.HttpPostEndpoint.Builder

Enclosing interface:

HttpPostEndpoint

public static class HttpPostEndpoint.Builder
extends AbstractBuilder<HttpPostEndpoint>

Field Summary

Fields inherited from class org.kurento.client.AbstractBuilder

genericProperties, props

Constructor Summary

Constructors

Constructor and Description
Builder(MediaPipeline mediaPipeline) Creates a Builder for HttpPostEndpoint

Method Summary

Modifier and Type	Method and Description
HttpPostEndpoint.Builder	useEncodedMedia() Feed the input media as-is to the Media Pipeline, instead of first decoding it.
HttpPostEndpoint.Builder	with(String name, Object value)
HttpPostEndpoint.Builder	withDisconnectionTimeout(int disconnectionTimeout) Sets a value for disconnectionTimeout in Builder for HttpPostEndpoint.
HttpPostEndpoint.Builder	withProperties(Properties properties)

Methods inherited from class org.kurento.client.AbstractBuilder

build, build, buildAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(MediaPipeline mediaPipeline)

Creates a Builder for HttpPostEndpoint

Method Detail

withProperties

public HttpPostEndpoint.Builder withProperties(Properties properties)

Overrides:

withProperties in class AbstractBuilder<HttpPostEndpoint>

with

public HttpPostEndpoint.Builder with(String name,
                                     Object value)

Overrides:

with in class AbstractBuilder<HttpPostEndpoint>

withDisconnectionTimeout

public HttpPostEndpoint.Builder withDisconnectionTimeout(int disconnectionTimeout)

Sets a value for disconnectionTimeout in Builder for HttpPostEndpoint.

Parameters:

disconnectionTimeout - This is the time that an http endpoint will wait for a reconnection, in case an HTTP connection is lost.

useEncodedMedia

public HttpPostEndpoint.Builder useEncodedMedia()

Feed the input media as-is to the Media Pipeline, instead of first decoding it.

When this property is not enabled, the input media gets always decoded into a raw format before being processed by the rest of the Media Pipeline; this is done to ensure that Kurento is able to keep track of lost keyframes among other quality-control measurements. Of course, having to decode the media has a cost in terms of CPU usage, but ensures that the output streaming will be robust and reliable.

When this property is enabled, the explained behavior gets disabled. Instead, The endpoint will provide any input media directly to the Media Pipeline, without prior decoding. Enabling this mode of operation could have a severe effect on stability, because lost video keyframes will not be regenerated; however, avoiding a full cycle of decoding and encoding can be very useful for certain applications, because it improves performance by greatly reducing the CPU processing load.

Keep in mind that if this property is enabled, the original source media MUST already have an encoding format which is compatible with the destination target. For example: given a pipeline which uses this endpoint to read a file and then streams it to a WebRTC browser such as Chrome, then the file must already be encoded with a VP8 or H.264 codec profile which Chrome is able to decode. Note that for this example, most browsers don't support ANY combination of H.264 encoding options; instead, they tend to support only a very specific subset of the codec features (also known as 'profiles').

We strongly recommend to avoid using this option, because correct behavior cannot be guaranteed.