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>",
      "add_reverse_direction": "<add_reverse_direction_flow:bool>",
      "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>",
      "add_reverse_direction": "<add_reverse_direction_flow:bool>",
      "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>",
      "add_reverse_direction": "<add_reverse_direction_flow:bool>",
      "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	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
video	Configuration of the simulated Video UDP flow
	type	object
	properties
	initial_time_to_wait	Initial time to wait to start the flow in seconds, defaults to 0 (start immediately).
		type	number
	bitrate	Rate at which the bits are transmitted in bits/s. Excludes the VLAN tag bytes (when applicable), mutual exclusive with frame_rate, defaults to none
		type	string
	frame_size	Frame size in Bytes without CRC, defaults to none
		type	number
	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
	number_of_frames	Number of frames to transmit, defaults to DEFAULT_NUMBER_OF_FRAMES (none == defined by scenario maximum run time).
		type	string
	duration	Duration of the flow in seconds, defaults to none (use number_of_frames instead)
		type	string
	udp_src	UDP port number in range [49152,65534] , defaults to udp_dynamic_port
		type	number
	udp_dest	UDP port number in range [49152,65534] , defaults to udp_dynamic_port
		type	number
	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
	initial_time_to_wait	Initial time to wait to start the flow in seconds, defaults to 0 (start immediately).
		type	number
	bitrate	Rate at which the bits are transmitted in bits/s. Excludes the VLAN tag bytes (when applicable), mutual exclusive with frame_rate, defaults to none
		type	string
	frame_size	Frame size in Bytes without CRC, defaults to none
		type	number
	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
	number_of_frames	Number of frames to transmit, defaults to DEFAULT_NUMBER_OF_FRAMES (none == defined by scenario maximum run time).
		type	string
	duration	Duration of the flow in seconds, defaults to none (use number_of_frames instead)
		type	string
	udp_src	UDP port number in range [49152,65534] , defaults to udp_dynamic_port
		type	number
	udp_dest	UDP port number in range [49152,65534] , defaults to udp_dynamic_port
		type	number
	analysis	Sets latency related analysis configuration parameters
		Mean Opinion Score (MOS) analysis
	additionalProperties	False
screenshare	Configuration of the simulated Screenshare UDP flow
	type	object
	properties
	initial_time_to_wait	Initial time to wait to start the flow in seconds, defaults to 0 (start immediately).
		type	number
	bitrate	Rate at which the bits are transmitted in bits/s. Excludes the VLAN tag bytes (when applicable), mutual exclusive with frame_rate, defaults to none
		type	string
	frame_size	Frame size in Bytes without CRC, defaults to none
		type	number
	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
	number_of_frames	Number of frames to transmit, defaults to DEFAULT_NUMBER_OF_FRAMES (none == defined by scenario maximum run time).
		type	string
	duration	Duration of the flow in seconds, defaults to none (use number_of_frames instead)
		type	string
	udp_src	UDP port number in range [49152,65534] , defaults to udp_dynamic_port
		type	number
	udp_dest	UDP port number in range [49152,65534] , defaults to udp_dynamic_port
		type	number
	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 with the same configuration, defaults to false
	type	string