owner.video

Video stream owner

type

object

properties

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • serverId

The video server who will use this stream.

type

string

  • urls

The RTSP addresses of the stream. This is an alternative to using urlProviders.

type

array

items

type

string

  • urlProviders

The providers (i.e. url stored in a value) of the RTSP addresses of the stream. This is an alternative to using urls. Takes precedence over the urls field. When the value is republished by this providers, the flux will be replaced

type

array

items

type

string

  • networkBufferingTime

When receiving media from an RTSP source, the streamed video can suffer spikes or stuttering, caused by hardware or network issues. Having a reception buffer helps alleviate these problems, because it smoothes the stream of incoming data to the receiving endpoint.

Finding a buffer length that works best for your connection might take some tweaking, which can be done with this optional property. Note that a longer buffer will be able to fix bigger network spikes, but at the cost of introducing more latency to the media playback.

DurationConfigurationEntity

  • keepMediaFluxOpen

This option avoid the closing of the connexion when there is no consumer. This is an expensive feature because the camera will stream without interruption (network consumption + encoding). But this provide a fast opening stream

type

boolean

default

False

  • disableStreamEncoding

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.

type

boolean

  • streamType

The type of video stream : Either a simple flux reading otherwise a composition of multiples flux called grid

type

string

enum

STREAM, GRID

additionalProperties

False

DurationConfigurationEntity

type

object

properties

  • value

The amount of time expressed with the unit

type

integer

  • unit

The unit of time expressed with the value

type

string

enum

NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

additionalProperties

False