Voice Flow

Only one type of analysers is available currently for the voice flow. This analyser calculates the Mean Opinion Score (MOS) which indicates the quality of the voice flow.

{
   "type":  "voice",
   "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>",
   "udp_src": "<udp_source_port:int>",
   "udp_dest": "<udp_destination_port:int>",
   "add_reverse_direction": "<add_reverse_direction_flow:bool>",
   "initial_time_to_wait": "<initial_time_to_wait:float|int|timedelta>",
   "duration": "<flow_duration:float|int|timedelta>",
   "packetization": "<packetization_time:int>",
   "number_of_frames": "<number_of_frames:int>",
   "analysis": {
      "mos": "<enable_mos:bool>"
   }
}

Voice flow
Specific parameters for voice flow. The type MUST be defined as voice.
type	object
properties
type	voice
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	number
		type	string
dscp	IP DSCP
	Differentiated Services Code Point, defaults to DEFAULT_IP_DSCP (0x00)
	oneOf	type	number
		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
add_reverse_direction	Enables adding a flow in the reverse direction of the original flow with the same configuration, defaults to false
	type	string
initial_time_to_wait	Initial time to wait to start the flow in seconds, defaults to 0 (start immediately).
	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
packetization	Packetization time of the RTP packets in milliseconds, defaults to none
	type	int
analysis	Sets latency related analysis configuration parameters
	Mean Opinion Score (MOS) analysis

Mean Opinion Score (MOS) analysis
type	object
properties
mos	Enables calculating Mean Opinion Score (MOS) to indicate the quality of the voice flow, mutual exclusive with latency and l4s, defaults to False
	type	bool