Video Flow

  {
   "type":  "video",
   "name":  "<flow_name:str>",
   "source": {
         "port_group": [
            "<source_group:str>"
         ]
   },
   "destination": {
         "port_group": [
            "<destination_group:str>"
         ]
   },
   "ecn": "<ecn_code_point:str|int>",
   "dscp": "<dscp_code_point:str|int>",
   "add_reverse_direction": "<add_reverse_direction_flow:bool>",
   "segment_size": "<segment_size:int>",
   "segment_duration": "<segment_duration:float|timedelta>",
   "buffering_goal": "<buffering_goal:float|timedelta>",
   "play_goal": "<play_goal:float|timedelta>"
}

Video flow

Specific parameters for video flow. The type MUST be defined as video.

Note

Not supported by ByteBlower Endpoint.

type

object

properties

  • type

Type of the flow. Defines which specific flow parameters will be possible.

type

string

enum

video

  • name

Name of this Flow, defaults to auto-generated name when set to none

type

string

  • source

Specifying the source of transmitted data for this flow

type

object

properties

  • port_group

List of port groups specifying the transmitting ports

type

array

items

Port group

additionalProperties

False

  • destination

Specifying the destination for receiving data for this flow

type

object

properties

  • port_group

List of port groups specifying the receiving ports

type

array

items

Port group

additionalProperties

False

  • ecn

IP ECN

Explicit Congestion Notification code point. Defaults to DEFAULT_IP_ECN (0x00)

oneOf

type

integer

maximum

3

minimum

0

type

string

  • dscp

IP DSCP

Differentiated Services Code Point. Defaults to DEFAULT_IP_DSCP (0x00)

oneOf

type

integer

maximum

63

minimum

0

type

string

  • add_reverse_direction

Enables adding a flow in the reverse direction of the original flow.

The reverse flow uses the same configuration as the original. Defaults to false

type

boolean

  • segment_size

Size of each individual segment of data that is encoded and transmitted in bytes, defaults to (2 MB)

type

number

exclusiveMinimum

0

  • segment_duration

Length of time that each segment of data represents in the video stream in seconds, defaults to 2.5s

type

number

exclusiveMinimum

0

  • buffering_goal

The amount of video data that the playback device should be able to buffer in seconds, defaults to 60s

type

number

minimum

0

  • play_goal

The minimum amount of video data that should be buffered before starting playback in seconds, defaults to 5s

type

number

minimum

0