openvidu/openvidu-browser/src/OpenViduInternal/Events/NetworkQualityLevelChangedEvent.ts

/*
 * (C) Copyright 2017-2020 OpenVidu (https://openvidu.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

import { Event } from './Event';
import { Session } from '../../OpenVidu/Session';
import { Connection } from '../../OpenVidu/Connection';

/**
 * **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
 * 
 * Defines event `networkQualityLevelChanged` dispatched by [[Session]].
 * This event is fired when the network quality level of a [[Connection]] changes. See [network quality](/en/stable/advanced-features/network-quality/)
 */
export class NetworkQualityLevelChangedEvent extends Event {

    /**
     * New value of the network quality level
     */
    qualityLevel: number;

    /**
     * Connection for whom the network quality level changed
     */
    connection: Connection

    /**
     * @hidden
     */
    constructor(target: Session, qualityLevel: number, connection: Connection) {
        super(false, target, 'networkQualityLevelChanged');
        this.qualityLevel = qualityLevel;
        this.connection = connection;
    }

    /**
     * @hidden
     */
    // tslint:disable-next-line:no-empty
    callDefaultBehavior() { }

}