openvidu-browser: TypeDoc "nodeCrashed" events reason

pull/630/head
pabloFuente 2021-06-01 15:01:40 +02:00
parent 0b84cfdc58
commit d2f020415e
4 changed files with 5 additions and 2 deletions

View File

@ -39,6 +39,7 @@ export class ConnectionEvent extends Event {
* - "forceDisconnectByServer": the remote user has been evicted from the Session by the application * - "forceDisconnectByServer": the remote user has been evicted from the Session by the application
* - "sessionClosedByServer": the Session has been closed by the application * - "sessionClosedByServer": the Session has been closed by the application
* - "networkDisconnect": the remote user network connection has dropped * - "networkDisconnect": the remote user network connection has dropped
* - "nodeCrashed": a node has crashed in the server side
* *
* For `connectionCreated` event an empty string * For `connectionCreated` event an empty string
*/ */

View File

@ -46,7 +46,7 @@ export class RecordingEvent extends Event {
* - "recordingStoppedByServer": the recording has been gracefully stopped by the application * - "recordingStoppedByServer": the recording has been gracefully stopped by the application
* - "sessionClosedByServer": the Session has been closed by the application * - "sessionClosedByServer": the Session has been closed by the application
* - "automaticStop": see [Automatic stop of recordings](/en/stable/advanced-features/recording/#automatic-stop-of-recordings) * - "automaticStop": see [Automatic stop of recordings](/en/stable/advanced-features/recording/#automatic-stop-of-recordings)
* - "mediaServerDisconnect": OpenVidu Media Node has crashed or lost its connection. A new Media Node instance is active and the recording has been stopped (no media streams are available in the new Media Node) * - "nodeCrashed": a node has crashed in the server side
* *
* For 'recordingStarted' empty string * For 'recordingStarted' empty string
*/ */

View File

@ -39,6 +39,8 @@ export class SessionDisconnectedEvent extends Event {
* Session object will always have previously dispatched a `reconnecting` event. If the reconnection process succeeds, * Session object will always have previously dispatched a `reconnecting` event. If the reconnection process succeeds,
* Session object will dispatch a `reconnected` event. If it fails, Session object will dispatch a SessionDisconnectedEvent * Session object will dispatch a `reconnected` event. If it fails, Session object will dispatch a SessionDisconnectedEvent
* with reason "networkDisconnect" * with reason "networkDisconnect"
* - "nodeCrashed": a node has crashed in the server side. You can use this reason to ask your application's backend to reconnect
* to a new session to replace the crashed one
*/ */
reason: string; reason: string;

View File

@ -48,7 +48,7 @@ export class StreamEvent extends Event {
* - "forceDisconnectByServer": the user has been evicted from the Session by the application * - "forceDisconnectByServer": the user has been evicted from the Session by the application
* - "sessionClosedByServer": the Session has been closed by the application * - "sessionClosedByServer": the Session has been closed by the application
* - "networkDisconnect": the user's network connection has dropped * - "networkDisconnect": the user's network connection has dropped
* - "mediaServerDisconnect": OpenVidu Media Node has crashed or lost its connection. A new Media Node instance is active and no media streams are available in the Media Node * - "nodeCrashed": a node has crashed in the server side
* *
* For 'streamCreated' empty string * For 'streamCreated' empty string
*/ */