mirror of https://github.com/OpenVidu/openvidu.git
57 lines
2.4 KiB
TypeScript
57 lines
2.4 KiB
TypeScript
/*
|
|
* (C) Copyright 2017-2022 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 { StreamManager } from '../../OpenVidu/StreamManager';
|
|
|
|
/**
|
|
* Defines the following events:
|
|
* - `streamPlaying`: dispatched by [[StreamManager]] ([[Publisher]] and [[Subscriber]]) whenever its media stream starts playing (one of its videos has media
|
|
* and has begun to play). This event will be dispatched when these 3 conditions are met:
|
|
* 1. The StreamManager has no video associated in the DOM
|
|
* 2. It is associated to one video
|
|
* 3. That video starts playing. Internally the expected Web API event is [HTMLMediaElement.canplay](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/canplay_event)
|
|
* - `streamAudioVolumeChange`: dispatched by [[StreamManager]] ([[Publisher]] and [[Subscriber]]) when the volume of its Stream's audio track
|
|
* changes. Only applies if [[Stream.hasAudio]] is `true`. The frequency this event is fired with is defined by property `interval` of
|
|
* [[OpenViduAdvancedConfiguration.publisherSpeakingEventsOptions]] (default 100ms)
|
|
*/
|
|
export class StreamManagerEvent extends Event {
|
|
|
|
/**
|
|
* For `streamAudioVolumeChange` event:
|
|
* - `{newValue: number, oldValue: number}`: new and old audio volume values. These values are between -100 (silence) and 0 (loudest possible volume).
|
|
* They are not exact and depend on how the browser is managing the audio track, but -100 and 0 can be taken as limit values.
|
|
*
|
|
* For `streamPlaying` event undefined
|
|
*/
|
|
value: Object | undefined;
|
|
|
|
/**
|
|
* @hidden
|
|
*/
|
|
constructor(target: StreamManager, type: string, value: Object | undefined) {
|
|
super(false, target, type);
|
|
this.value = value;
|
|
}
|
|
|
|
/**
|
|
* @hidden
|
|
*/
|
|
// tslint:disable-next-line:no-empty
|
|
callDefaultBehavior() { }
|
|
|
|
} |