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	Type of the flow. Defines which specific flow parameters will be possible.
	type	string
	enum	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	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
initial_time_to_wait	Initial time to wait to start the flow in seconds.
	Defaults to 0 (start immediately).
	type	number
	minimum	0
packetization	Packetization time of the RTP packets in milliseconds, defaults to none
	type	integer
	enum	10, 20
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
nat_keep_alive	Enable a flow to keep Network Address (and Port) Translation (NAT/NAPT) entries alive.
	The direction will be from the endpoint behind a NAT/NAPT gateway to the port at the public side of the NAT/NAPT gateway. Defaults to false. We always enable the NAT/NAPT keep alive when the user asks for it, even when: The reverse flow is enabled and source and destination UDP ports are the same The source is the endpoint behind the NAT/NAPT gateway: An initial time to wait on the flow can still cause the NAPT entries at the gateway might still timeout before the traffic starts. This might cause the NAPT gateway to create a new (maybe different!) NAPT entry, causing our traffic analysis to fail (with 100% loss). Added in version v1.1.1: NAT keepalive is supported for all standard frame blasting based flows.
	type	boolean
analysis	Sets voice 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	boolean