mirror of https://github.com/OpenVidu/openvidu.git
/latest to /stable
parent
396081055f
commit
2e5f605225
|
@ -286,7 +286,7 @@ export class Stream {
|
||||||
* of a new one, that will apply the same properties.
|
* of a new one, that will apply the same properties.
|
||||||
*
|
*
|
||||||
* This method can be useful in those situations were there the media connection breaks and OpenVidu is not able to recover on its own
|
* This method can be useful in those situations were there the media connection breaks and OpenVidu is not able to recover on its own
|
||||||
* for any kind of unanticipated reason (see [Automatic reconnection](/en/latest/advanced-features/automatic-reconnection/)).
|
* for any kind of unanticipated reason (see [Automatic reconnection](/en/stable/advanced-features/automatic-reconnection/)).
|
||||||
*
|
*
|
||||||
* @returns A Promise (to which you can optionally subscribe to) that is resolved if the reconnection operation was successful and rejected with an Error object if not
|
* @returns A Promise (to which you can optionally subscribe to) that is resolved if the reconnection operation was successful and rejected with an Error object if not
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -28,7 +28,7 @@ import { Event } from './Event';
|
||||||
*
|
*
|
||||||
* The only way the Connection properties may change is by updating them through:
|
* The only way the Connection properties may change is by updating them through:
|
||||||
*
|
*
|
||||||
* - [API REST](/en/stable/reference-docs/REST-API/#patch-openviduapisessionsltsession_idgtconnectionltconnection_idgt)
|
* - [API REST](/en/stable/reference-docs/REST-API/#patch-connection)
|
||||||
* - [openvidu-java-client](/en/stable/reference-docs/openvidu-java-client/#update-a-connection)
|
* - [openvidu-java-client](/en/stable/reference-docs/openvidu-java-client/#update-a-connection)
|
||||||
* - [openvidu-node-client](/en/stable/reference-docs/openvidu-node-client/#update-a-connection)<br><br>
|
* - [openvidu-node-client](/en/stable/reference-docs/openvidu-node-client/#update-a-connection)<br><br>
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -65,8 +65,8 @@ export enum ExceptionEventName {
|
||||||
* A [[Subscriber]] object has not fired event `streamPlaying` after certain timeout. `streamPlaying` event belongs to [[StreamManagerEvent]]
|
* A [[Subscriber]] object has not fired event `streamPlaying` after certain timeout. `streamPlaying` event belongs to [[StreamManagerEvent]]
|
||||||
* category. It wraps Web API native event [canplay](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/canplay_event).
|
* category. It wraps Web API native event [canplay](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/canplay_event).
|
||||||
*
|
*
|
||||||
* OpenVidu Browser can take care of the video players (see [here](/en/latest/cheatsheet/manage-videos/#let-openvidu-take-care-of-the-video-players)),
|
* OpenVidu Browser can take care of the video players (see [here](/en/stable/cheatsheet/manage-videos/#let-openvidu-take-care-of-the-video-players)),
|
||||||
* or you can take care of video players on your own (see [here](/en/latest/cheatsheet/manage-videos/#you-take-care-of-the-video-players)).
|
* or you can take care of video players on your own (see [here](/en/stable/cheatsheet/manage-videos/#you-take-care-of-the-video-players)).
|
||||||
* Either way, whenever a [[Subscriber]] object is commanded to attach its [[Stream]] to a video element, it is supposed to fire `streamPlaying`
|
* Either way, whenever a [[Subscriber]] object is commanded to attach its [[Stream]] to a video element, it is supposed to fire `streamPlaying`
|
||||||
* event shortly after. If it does not, then we can safely assume that something wrong has happened while playing the remote video and the
|
* event shortly after. If it does not, then we can safely assume that something wrong has happened while playing the remote video and the
|
||||||
* application may be notified through this specific ExceptionEvent.
|
* application may be notified through this specific ExceptionEvent.
|
||||||
|
|
|
@ -56,7 +56,7 @@ export interface OpenViduAdvancedConfiguration {
|
||||||
forceMediaReconnectionAfterNetworkDrop?: boolean;
|
forceMediaReconnectionAfterNetworkDrop?: boolean;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The milliseconds that must elapse after triggering [[ExceptionEvent]] of name [`ICE_CONNECTION_DISCONNECTED`](/en/latest/api/openvidu-browser/enums/exceptioneventname.html#ice_connection_disconnected) to perform an automatic reconnection process of the affected media stream.
|
* The milliseconds that must elapse after triggering [[ExceptionEvent]] of name [`ICE_CONNECTION_DISCONNECTED`](/en/stable/api/openvidu-browser/enums/exceptioneventname.html#ice_connection_disconnected) to perform an automatic reconnection process of the affected media stream.
|
||||||
* This automatic reconnection process can only take place if the client still has network connection to OpenVidu Server. If the ICE connection has broken because of a total network drop,
|
* This automatic reconnection process can only take place if the client still has network connection to OpenVidu Server. If the ICE connection has broken because of a total network drop,
|
||||||
* then no reconnection process will be possible at all.
|
* then no reconnection process will be possible at all.
|
||||||
*
|
*
|
||||||
|
@ -65,7 +65,7 @@ export interface OpenViduAdvancedConfiguration {
|
||||||
iceConnectionDisconnectedExceptionTimeout?: number;
|
iceConnectionDisconnectedExceptionTimeout?: number;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The milliseconds that must elapse for the [[ExceptionEvent]] of name [`NO_STREAM_PLAYING_EVENT`](/en/latest/api/openvidu-browser/enums/exceptioneventname.html#no_stream_playing_event) to be fired.
|
* The milliseconds that must elapse for the [[ExceptionEvent]] of name [`NO_STREAM_PLAYING_EVENT`](/en/stable/api/openvidu-browser/enums/exceptioneventname.html#no_stream_playing_event) to be fired.
|
||||||
*
|
*
|
||||||
* Default to `4000`.
|
* Default to `4000`.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -124,7 +124,7 @@ public enum EndReason {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A recording has been stopped automatically
|
* A recording has been stopped automatically
|
||||||
* (https://docs.openvidu.io/en/latest/advanced-features/recording/#automatic-stop-of-recordings).
|
* (https://docs.openvidu.io/en/stable/advanced-features/recording/#automatic-stop-of-recordings).
|
||||||
* Applies to recordingStatusChanged
|
* Applies to recordingStatusChanged
|
||||||
*/
|
*/
|
||||||
automaticStop
|
automaticStop
|
||||||
|
|
Loading…
Reference in New Issue