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 | This param may be used 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 param only applies to calls using Opus codec. Check out RFC-7587 section 7.1 for more info. | 8000 - 48000 | 48000 |
Events | Description | Example | ||
---|---|---|---|---|
high_jitter | when the jitter is higher than 30 ms for 2 out of the last 3 samples. This event will be 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 the RTT is higher than 400 ms for 2 out of the last 3 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% PCMU. This event will be 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 mos is < 3.5 for 2 out of the last 3 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 will be 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’ } |