mirror of https://github.com/OpenVidu/openvidu.git
openvidu-browser: better Events dispatched typedocs
parent
f287828295
commit
b44323c96c
|
@ -32,6 +32,16 @@ import platform = require('platform');
|
|||
|
||||
/**
|
||||
* Packs local media streams. Participants can publish it to a session. Initialized with [[OpenVidu.initPublisher]] method
|
||||
*
|
||||
* ### Available event listeners (and events dispatched)
|
||||
*
|
||||
* - accessAllowed
|
||||
* - accessDenied
|
||||
* - accessDialogOpened
|
||||
* - accessDialogClosed
|
||||
* - streamCreated ([[StreamEvent]])
|
||||
* - streamDestroyed ([[StreamEvent]])
|
||||
* - streamPropertyChanged ([[StreamPropertyChangedEvent]])
|
||||
*/
|
||||
export class Publisher extends StreamManager {
|
||||
|
||||
|
|
|
@ -46,7 +46,24 @@ import platform = require('platform');
|
|||
/**
|
||||
* Represents a video call. It can also be seen as a videoconference room where multiple users can connect.
|
||||
* Participants who publish their videos to a session can be seen by the rest of users connected to that specific session.
|
||||
* Initialized with [[OpenVidu.initSession]] method
|
||||
* Initialized with [[OpenVidu.initSession]] method.
|
||||
*
|
||||
* ### Available event listeners (and events dispatched)
|
||||
*
|
||||
* - connectionCreated ([[ConnectionEvent]])
|
||||
* - connectionDestroyed ([[ConnectionEvent]])
|
||||
* - sessionDisconnected ([[SessionDisconnectedEvent]])
|
||||
* - streamCreated ([[StreamEvent]])
|
||||
* - streamDestroyed ([[StreamEvent]])
|
||||
* - streamPropertyChanged ([[StreamPropertyChangedEvent]])
|
||||
* - publisherStartSpeaking ([[PublisherSpeakingEvent]])
|
||||
* - publisherStopSpeaking ([[PublisherSpeakingEvent]])
|
||||
* - signal ([[SignalEvent]])
|
||||
* - recordingStarted ([[RecordingEvent]])
|
||||
* - recordingStopped ([[RecordingEvent]])
|
||||
* - reconnecting
|
||||
* - reconnected
|
||||
*
|
||||
*/
|
||||
export class Session implements EventDispatcher {
|
||||
|
||||
|
|
|
@ -30,10 +30,17 @@ import platform = require('platform');
|
|||
* Interface in charge of displaying the media streams in the HTML DOM. This wraps any [[Publisher]] and [[Subscriber]] object.
|
||||
* You can insert as many video players fo the same Stream as you want by calling [[StreamManager.addVideoElement]] or
|
||||
* [[StreamManager.createVideoElement]].
|
||||
*
|
||||
* The use of StreamManager wrapper is particularly useful when you don't need to differentiate between Publisher or Subscriber streams or just
|
||||
* want to directly manage your own video elements (even more than one video element per Stream). This scenario is pretty common in
|
||||
* declarative, MVC frontend frameworks such as Angular, React or Vue.js
|
||||
*
|
||||
* ### Available event listeners (and events dispatched)
|
||||
*
|
||||
* - videoElementCreated ([[VideoElementEvent]])
|
||||
* - videoElementDestroyed ([[VideoElementEvent]])
|
||||
* - streamPlaying ([[StreamManagerEvent]])
|
||||
* - streamAudioVolumeChange ([[StreamManagerEvent]])
|
||||
*
|
||||
*/
|
||||
export class StreamManager implements EventDispatcher {
|
||||
|
||||
|
|
Loading…
Reference in New Issue