mirror of https://github.com/OpenVidu/openvidu.git
43 lines
1.6 KiB
TypeScript
43 lines
1.6 KiB
TypeScript
|
import { Event } from './Event';
|
||
|
|
import { Session } from '../../OpenVidu/Session';
|
||
|
|
import { Stream } from '../../OpenVidu/Stream';
|
||
|
|
import { StreamManager } from '../../OpenVidu/StreamManager';
|
||
|
|
/**
|
||
|
|
* Defines event `streamPropertyChanged` dispatched by [[Session]] as well as by [[StreamManager]] ([[Publisher]] and [[Subscriber]]).
|
||
|
|
* This event is fired when any remote stream (owned by a Subscriber) or local stream (owned by a Publisher) undergoes
|
||
|
|
* any change in any of its mutable properties (see [[changedProperty]]).
|
||
|
|
*/
|
||
|
|
export declare class StreamPropertyChangedEvent extends Event {
|
||
|
|
/**
|
||
|
|
* The Stream whose property has changed. You can always identify the user publishing the changed stream by consulting property [[Stream.connection]]
|
||
|
|
*/
|
||
|
|
stream: Stream;
|
||
|
|
/**
|
||
|
|
* The property of the stream that changed. This value is either `"videoActive"`, `"audioActive"` or `"videoDimensions"`
|
||
|
|
*/
|
||
|
|
changedProperty: string;
|
||
|
|
/**
|
||
|
|
* Cause of the change on the stream's property:
|
||
|
|
* - For `videoActive`: `"publishVideo"`
|
||
|
|
* - For `audioActive`: `"publishAudio"`
|
||
|
|
* - For `videoDimensions`: `"deviceRotated"` or `"screenResized"`
|
||
|
|
*/
|
||
|
|
reason: string;
|
||
|
|
/**
|
||
|
|
* New value of the property (after change, current value)
|
||
|
|
*/
|
||
|
|
newValue: Object;
|
||
|
|
/**
|
||
|
|
* Previous value of the property (before change)
|
||
|
|
*/
|
||
|
|
oldValue: Object;
|
||
|
|
/**
|
||
|
|
* @hidden
|
||
|
|
*/
|
||
|
|
constructor(target: Session | StreamManager, stream: Stream, changedProperty: string, newValue: Object, oldValue: Object, reason: string);
|
||
|
|
/**
|
||
|
|
* @hidden
|
||
|
|
*/
|
||
|
|
callDefaultBehavior(): void;
|
||
|
|
}
|