Attribute | Description | Allowed Values | Default Value |
---|---|---|---|
debug | Enable log messages. | true/false | false |
enableTracking | Set to true if you want to get MediaMetrics events and enable call quality tracking. | true/false | true |
maxAverageBitrate | You can use this parameter to control your application’s bandwidth consumption for calls. A higher maxAverageBitrate value may result in more bandwidth consumption, but also better audio quality. Lowering the maxAverageBitrate impacts call quality, as the audio is compressed to a greater extent to reduce bandwidth consumption. This parameter applies only to calls using the Opus codec. Check out RFC-7587 section 7.1 for more information. | 8000 – 48000 | 48000 |
Events | Description | Example |
---|---|---|
high_jitter | When jitter is higher than 30 milliseconds for two out of the last three samples. This event is generated individually for the local stream and remote stream. | { group: ‘network’, level: ‘warning’, type: ‘high_jitter’, active: true/false, // false when the value goes to normal level (last 2 out of 3 samples have jitter less than 30 ms) value: ‘<average jitter value>’, desc: ‘high jitter detected due to network congestion, can result in audio quality problems’, stream: ‘local || remote’ } |
high_rtt | When round-trip time (RTT) is higher than 400 milliseconds for two out of the last three samples. | { group: ‘network’, level: ‘warning’, type: ‘high_rtt’, active: true/false, // false when value goes to normal level (last 2 out of 3 samples have RTT less than 400 ms) value: ‘<average rtt value>’, desc: ‘high latency detected, can result in delay in audio’, stream: ‘None’ } |
high_packetloss | When the packet loss is > 10% for Opus and loss > 2% for PCMU. This event is generated individually for the local stream and remote stream. | { group: ‘network’, level: ‘warning’, type: ‘high_packetloss’, active: true/false, // false when value goes to normal level value: ‘<average packet loss value>’, desc: ‘high packet loss is detected on media stream, can result in choppy audio or dropped call’, stream: ‘local || remote’ } |
low_mos | When sampled mean opinion score (MOS) is < 3.5 for two out of the last three samples. | { group: ‘network’, level: ‘warning’, type: ‘low_mos’, active: true/false, // false when value goes to normal level. value: ‘<current_mos_value>’, desc: ‘low Mean Opinion Score (MOS)’, stream: ‘None’ } |
no_audio_received | When remote or local audio is silent. This event is generated individually for the local stream and remote stream. | { group: ‘audio’, level: ‘warning’, type: ‘no_audio_received’, active: true/false, // false when value goes to normal level value: ‘<current_value_in_dB>’, desc: ‘no audio packets received’ stream: ‘local || remote’ } |