Conference Flow

This flow allows to simulate a video conference call which could involve the exchanges of three types of flows: Video, audio, and screensharing. Each one is simulated as a UDP frame blasting flow with possible parameters similar to the basic FrameBlasting flow.

Unlike the other types of flows, the conference flow takes separate configurations for each one of the video, voice, and screen sharing flows. The configuration structure is as follows:

{
   "type":  "conference",
   "name":  "<flow_name:str>",
   "source": {
         "port_group": [
            "<source_group:str>"
         ]
   },
   "destination": {
         "port_group": [
            "<destination_group:str>"
         ]
   },
   "video":{
      "ecn": "<ecn_code_point:str|int>",
      "dscp": "<dscp_code_point:str|int>",
      "initial_time_to_wait": "<initial_time_to_wait:float|int|timedelta>",
      "bitrate": "<flow_bitrate:float>",
      "frame_size": "<frame_size_without_crc:int>",
      "frame_rate": "<frame_rate:float>",
      "number_of_frames": "<number_of_frames:float>",
      "duration": "<flow_duration:float|int|timedelta>",
      "udp_src": "<udp_source_port:int>",
      "udp_dest": "<udp_destination_port:int>",
      "analysis": {
         "latency":"<enable_latency_analysis:bool>",
         "max_threshold_latency": "<max_threshold_latency:float>",
         "max_loss_percentage": "<max_loss_percentage:float>",
         "quantile": "<quantile:float>",
         "min_percentile": "<min_percentile:float>",
         "max_percentile": "<max_percentile:float>"
      }
   },
   "voice":{
      "ecn": "<ecn_code_point:str|int>",
      "dscp": "<dscp_code_point:str|int>",
      "initial_time_to_wait": "<initial_time_to_wait:float|int|timedelta>",
      "bitrate": "<flow_bitrate:float>",
      "frame_size": "<frame_size_without_crc:int>",
      "frame_rate": "<frame_rate:float>",
      "number_of_frames": "<number_of_frames:float>",
      "duration": "<flow_duration:float|int|timedelta>",
      "udp_src": "<udp_source_port:int>",
      "udp_dest": "<udp_destination_port:int>",
      "analysis": {
         "mos": "<enable_mos:bool>"
      }
   },
   "screenshare":{
      "ecn": "<ecn_code_point:str|int>",
      "dscp": "<dscp_code_point:str|int>",
      "initial_time_to_wait": "<initial_time_to_wait:float|int|timedelta>",
      "bitrate": "<flow_bitrate:float>",
      "frame_size": "<frame_size_without_crc:int>",
      "frame_rate": "<frame_rate:float>",
      "number_of_frames": "<number_of_frames:float>",
      "duration": "<flow_duration:float|int|timedelta>",
      "udp_src": "<udp_source_port:int>",
      "udp_dest": "<udp_destination_port:int>",
      "analysis": {
         "latency":"<enable_latency_analysis:bool>",
         "max_threshold_latency": "<max_threshold_latency:float>",
         "max_loss_percentage": "<max_loss_percentage:float>",
         "quantile": "<quantile:float>",
         "min_percentile": "<min_percentile:float>",
         "max_percentile": "<max_percentile:float>"
      }
   },
   "add_reverse_direction": "<add_reverse_direction_flow:bool>"
}

All of the conference’s flows are configured as basic FrameBlasting flows.

Conference flow
Specific parameters for conference flow. The `type` MUST be defined as `conference`.
type	object
properties
type	Type of the flow. Defines which specific flow parameters will be possible.
	type	string
	enum	conference
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
initial_time_to_wait	Initial time to wait to start the flow in seconds.
	Defaults to 0 (start immediately).
	type	number
	minimum	0
duration	Duration of the flow in seconds.
	Defaults to `none` (use `number_of_frames` instead)
	type	number
	exclusiveMinimum	0
video	Configuration of the simulated Video UDP flow
	type	object
	properties
	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
	initial_time_to_wait	Initial time to wait to start the flow in seconds.
		Defaults to 0 (start immediately).
		type	number
		minimum	0
	bitrate	Rate at which the bits are transmitted (in bits per second).
		Excludes the VLAN tag bytes (when applicable), mutual exclusive with `frame_rate`, defaults to `none`
		type	number
		exclusiveMinimum	0
	frame_size	Frame size in Bytes without CRC, defaults to `none`
		type	integer
		minimum	42
	frame_rate	Rate at which the frames are transmitted (in frames per second).
		Mutual exclusive with `bitrate`. Defaults to `DEFAULT_FRAME_RATE` (`100`) when `bitrate` is not provided.
		type	number
		exclusiveMinimum	0
	number_of_frames	Number of frames to transmit.
		Defaults to `DEFAULT_NUMBER_OF_FRAMES` (`none` == defined by scenario maximum run time).
		type	integer
		exclusiveMinimum	0
	duration	Duration of the flow in seconds.
		Defaults to `none` (use `number_of_frames` instead)
		type	number
		exclusiveMinimum	0
	udp_src	UDP port number in range [49152,65534] , defaults to udp_dynamic_port
		type	integer
		maximum	65535
		minimum	0
	udp_dest	UDP port number in range [49152,65534] , defaults to udp_dynamic_port
		type	integer
		maximum	65535
		minimum	0
	analysis	Sets latency related analysis configuration parameters
		oneOf	Frame loss analysis parameters
			Latency & frame loss analysis parameters
	additionalProperties	False
voice	Configuration of the simulated Voice UDP flow
	type	object
	properties
	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
	initial_time_to_wait	Initial time to wait to start the flow in seconds.
		Defaults to 0 (start immediately).
		type	number
		minimum	0
	bitrate	Rate at which the bits are transmitted (in bits per second).
		Excludes the VLAN tag bytes (when applicable), mutual exclusive with `frame_rate`, defaults to `none`
		type	number
		exclusiveMinimum	0
	frame_size	Frame size in Bytes without CRC, defaults to `none`
		type	integer
		minimum	42
	frame_rate	Rate at which the frames are transmitted (in frames per second).
		Mutual exclusive with `bitrate`. Defaults to `DEFAULT_FRAME_RATE` (`100`) when `bitrate` is not provided.
		type	number
		exclusiveMinimum	0
	number_of_frames	Number of frames to transmit.
		Defaults to `DEFAULT_NUMBER_OF_FRAMES` (`none` == defined by scenario maximum run time).
		type	integer
		exclusiveMinimum	0
	duration	Duration of the flow in seconds.
		Defaults to `none` (use `number_of_frames` instead)
		type	number
		exclusiveMinimum	0
	udp_src	UDP port number in range [49152,65534] , defaults to udp_dynamic_port
		type	integer
		maximum	65535
		minimum	0
	udp_dest	UDP port number in range [49152,65534] , defaults to udp_dynamic_port
		type	integer
		maximum	65535
		minimum	0
	analysis	Sets voice related analysis configuration parameters
		Mean Opinion Score (MOS) analysis
	additionalProperties	False
screenshare	Configuration of the simulated Screenshare UDP flow
	type	object
	properties
	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
	initial_time_to_wait	Initial time to wait to start the flow in seconds.
		Defaults to 0 (start immediately).
		type	number
		minimum	0
	bitrate	Rate at which the bits are transmitted (in bits per second).
		Excludes the VLAN tag bytes (when applicable), mutual exclusive with `frame_rate`, defaults to `none`
		type	number
		exclusiveMinimum	0
	frame_size	Frame size in Bytes without CRC, defaults to `none`
		type	integer
		minimum	42
	frame_rate	Rate at which the frames are transmitted (in frames per second).
		Mutual exclusive with `bitrate`. Defaults to `DEFAULT_FRAME_RATE` (`100`) when `bitrate` is not provided.
		type	number
		exclusiveMinimum	0
	number_of_frames	Number of frames to transmit.
		Defaults to `DEFAULT_NUMBER_OF_FRAMES` (`none` == defined by scenario maximum run time).
		type	integer
		exclusiveMinimum	0
	duration	Duration of the flow in seconds.
		Defaults to `none` (use `number_of_frames` instead)
		type	number
		exclusiveMinimum	0
	udp_src	UDP port number in range [49152,65534] , defaults to udp_dynamic_port
		type	integer
		maximum	65535
		minimum	0
	udp_dest	UDP port number in range [49152,65534] , defaults to udp_dynamic_port
		type	integer
		maximum	65535
		minimum	0
	analysis	Sets latency related analysis configuration parameters
		oneOf	Frame loss analysis parameters
			Latency & frame loss analysis parameters
	additionalProperties	False
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