openvidu-browser: better docs for events

pull/405/head
pabloFuente 2020-02-19 12:09:46 +01:00
parent f23383008c
commit f35e380f97
6 changed files with 11 additions and 11 deletions

View File

@ -22,8 +22,8 @@ import { Session } from '../../OpenVidu/Session';
/**
* Defines the following events:
* - `connectionCreated`: dispatched by [[Session]]
* - `connectionDestroyed`: dispatched by [[Session]]
* - `connectionCreated`: dispatched by [[Session]] after a new user has connected to the session
* - `connectionDestroyed`: dispatched by [[Session]] after a new user has left the session
*/
export class ConnectionEvent extends Event {

View File

@ -22,8 +22,8 @@ import { Session } from '../..';
/**
* Defines the following events:
* - `publisherStartSpeaking`: dispatched by [[Session]]
* - `publisherStopSpeaking`: dispatched by [[Session]]
* - `publisherStartSpeaking`: dispatched by [[Session]] when a remote user has started speaking
* - `publisherStopSpeaking`: dispatched by [[Session]] when a remote user has stopped speaking
*
* More information:
* - This events will only be triggered for **remote streams that have audio tracks** ([[Stream.hasAudio]] must be true)

View File

@ -21,8 +21,8 @@ import { Session } from '../../OpenVidu/Session';
/**
* Defines the following events:
* - `recordingStarted`: dispatched by [[Session]]
* - `recordingStopped`: dispatched by [[Session]]
* - `recordingStarted`: dispatched by [[Session]] after the session has started being recorded
* - `recordingStopped`: dispatched by [[Session]] after the session has stopped being recorded
*/
export class RecordingEvent extends Event {

View File

@ -20,7 +20,7 @@ import { Session } from '../../OpenVidu/Session';
/**
* Defines event `sessionDisconnected` dispatched by [[Session]]
* Defines event `sessionDisconnected` dispatched by [[Session]] after the local user has left the session. This is the local version of the `connectionDestroyed` event, which is only dispatched by remote users
*/
export class SessionDisconnectedEvent extends Event {

View File

@ -22,8 +22,8 @@ import { Session } from '../../OpenVidu/Session';
/**
* Defines the following events:
* - `signal`: dispatched by [[Session]]
* - `signal:TYPE`: dispatched by [[Session]]
* - `signal`: dispatched by [[Session]] when a signal is received
* - `signal:TYPE`: dispatched by [[Session]] when a signal of type TYPE is received
*/
export class SignalEvent extends Event {

View File

@ -23,8 +23,8 @@ import { Stream } from '../../OpenVidu/Stream';
/**
* Defines the following events:
* - `streamCreated`: dispatched by [[Session]] and [[Publisher]]
* - `streamDestroyed`: dispatched by [[Session]] and [[Publisher]]
* - `streamCreated`: dispatched by [[Session]] and [[Publisher]] after some user has started publishing to the session
* - `streamDestroyed`: dispatched by [[Session]] and [[Publisher]] after some user has stopped publishing to the session
*/
export class StreamEvent extends Event {