From 9dd62009fb4403b4e284d3afa9fef2bd6b77724a Mon Sep 17 00:00:00 2001 From: Juan Navarro Date: Thu, 9 Sep 2021 17:40:01 +0200 Subject: [PATCH] openvidu-browser: remove inline outdated description of OpenViduAdvancedConfiguration The resulting HTML docs are bad because they show an incomplete description of the OpenViduAdvancedConfiguration type, which is then duplicated (and more complete) in that type's description. --- openvidu-browser/src/OpenVidu/OpenVidu.ts | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/openvidu-browser/src/OpenVidu/OpenVidu.ts b/openvidu-browser/src/OpenVidu/OpenVidu.ts index ec9124b7..56e29e42 100644 --- a/openvidu-browser/src/OpenVidu/OpenVidu.ts +++ b/openvidu-browser/src/OpenVidu/OpenVidu.ts @@ -642,13 +642,7 @@ export class OpenVidu { /** - * Set OpenVidu advanced configuration options. Currently `configuration` is an object with the following optional properties (see [[OpenViduAdvancedConfiguration]] for more details): - * - `iceServers`: set custom STUN/TURN servers to be used by OpenVidu Browser - * - `screenShareChromeExtension`: url to a custom screen share extension for Chrome to be used instead of the default one, based on ours [https://github.com/OpenVidu/openvidu-screen-sharing-chrome-extension](https://github.com/OpenVidu/openvidu-screen-sharing-chrome-extension) - * - `publisherSpeakingEventsOptions`: custom configuration for the [[PublisherSpeakingEvent]] feature and the [StreamManagerEvent.streamAudioVolumeChange](/en/stable/api/openvidu-browser/classes/streammanagerevent.html) feature - * - `forceMediaReconnectionAfterNetworkDrop`: always force WebRTC renegotiation of all the streams of a client after a network loss and reconnection. This can help reducing frozen videos in low quality networks. - * - * Call this method to override previous values at any moment. + * Set OpenVidu advanced configuration options. `configuration` is an object of type [[OpenViduAdvancedConfiguration]]. Call this method to override previous values at any moment. */ setAdvancedConfiguration(configuration: OpenViduAdvancedConfiguration): void { this.advancedConfiguration = configuration; @@ -1081,4 +1075,4 @@ export class OpenVidu { (platform.isElectron() && videoSource.startsWith('screen:')) } -} \ No newline at end of file +}