diff --git a/openvidu-browser/config/typedoc.js b/openvidu-browser/config/typedoc.js index 73994c59..5516ee51 100644 --- a/openvidu-browser/config/typedoc.js +++ b/openvidu-browser/config/typedoc.js @@ -19,6 +19,10 @@ module.exports = { ], excludeExternals: true, excludePrivate: true, + excludeNotExported: true, theme: "default", - readme: "none" + readme: "none", + includeVersion: true, + listInvalidSymbolLinks: true, + out: "./docs" } \ No newline at end of file diff --git a/openvidu-browser/package.json b/openvidu-browser/package.json index 8d0c67ec..bcee7aeb 100644 --- a/openvidu-browser/package.json +++ b/openvidu-browser/package.json @@ -38,7 +38,7 @@ "browserify": "VERSION=${VERSION:-dev}; cd src && ../node_modules/browserify/bin/cmd.js Main.ts -p [ tsify ] --exclude kurento-browser-extensions --debug -o ../static/js/openvidu-browser-$VERSION.js -v", "browserify-prod": "VERSION=${VERSION:-dev}; cd src && ../node_modules/browserify/bin/cmd.js --debug Main.ts -p [ tsify ] --exclude kurento-browser-extensions | ../node_modules/uglify-js/bin/uglifyjs --source-map content=inline --output ../static/js/openvidu-browser-$VERSION.min.js", "build": "cd src/OpenVidu && ./../../node_modules/typescript/bin/tsc && cd ../.. && ./node_modules/typescript/bin/tsc --declaration src/index.ts --outDir ./lib --sourceMap --lib dom,es5,es2015.promise,scripthost", - "docs": "./node_modules/typedoc/bin/typedoc --options ./config/typedoc.js --out ./docs ./src && rm -rf ../../openvidu.io-docs/docs/api/openvidu-browser/* && cp -R ./docs/. ../../openvidu.io-docs/docs/api/openvidu-browser" + "docs": "./node_modules/typedoc/bin/typedoc --options ./config/typedoc.js ./src && rm -rf ../../openvidu.io-docs/docs/api/openvidu-browser/* && cp -R ./docs/. ../../openvidu.io-docs/docs/api/openvidu-browser" }, "types": "lib/index.d.ts", "version": "2.12.0" diff --git a/openvidu-browser/src/OpenVidu/OpenVidu.ts b/openvidu-browser/src/OpenVidu/OpenVidu.ts index 92d02cde..7235b256 100644 --- a/openvidu-browser/src/OpenVidu/OpenVidu.ts +++ b/openvidu-browser/src/OpenVidu/OpenVidu.ts @@ -652,7 +652,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](api/openvidu-browser/classes/streammanagerevent.html) feature + * - `publisherSpeakingEventsOptions`: custom configuration for the [[PublisherSpeakingEvent]] feature and the [StreamManagerEvent.streamAudioVolumeChange](/en/stable/api/openvidu-browser/classes/streammanagerevent.html) feature * * Call this method to override previous values at any moment. */ diff --git a/openvidu-browser/src/OpenVidu/StreamManager.ts b/openvidu-browser/src/OpenVidu/StreamManager.ts index 57800e4d..63318a58 100644 --- a/openvidu-browser/src/OpenVidu/StreamManager.ts +++ b/openvidu-browser/src/OpenVidu/StreamManager.ts @@ -351,7 +351,7 @@ export class StreamManager implements EventDispatcher { } /** - * Updates the current configuration for the [[PublisherSpeakingEvent]] feature and the [StreamManagerEvent.streamAudioVolumeChange](api/openvidu-browser/classes/streammanagerevent.html) feature for this specific + * Updates the current configuration for the [[PublisherSpeakingEvent]] feature and the [StreamManagerEvent.streamAudioVolumeChange](/en/stable/api/openvidu-browser/classes/streammanagerevent.html) feature for this specific * StreamManager audio stream, overriding the global options set with [[OpenVidu.setAdvancedConfiguration]]. This way you can customize the audio events options * for each specific StreamManager and change them dynamically. * diff --git a/openvidu-browser/src/OpenViduInternal/Interfaces/Public/OpenViduAdvancedConfiguration.ts b/openvidu-browser/src/OpenViduInternal/Interfaces/Public/OpenViduAdvancedConfiguration.ts index 64301c58..1233f1fa 100644 --- a/openvidu-browser/src/OpenViduInternal/Interfaces/Public/OpenViduAdvancedConfiguration.ts +++ b/openvidu-browser/src/OpenViduInternal/Interfaces/Public/OpenViduAdvancedConfiguration.ts @@ -33,7 +33,7 @@ export interface OpenViduAdvancedConfiguration { screenShareChromeExtension?: string; /** - * Custom configuration for the [[PublisherSpeakingEvent]] feature and the [StreamManagerEvent.streamAudioVolumeChange](api/openvidu-browser/classes/streammanagerevent.html) feature. It is an object which includes the following optional properties: + * Custom configuration for the [[PublisherSpeakingEvent]] feature and the [StreamManagerEvent.streamAudioVolumeChange](/en/stable/api/openvidu-browser/classes/streammanagerevent.html) feature. It is an object which includes the following optional properties: * - `interval`: (number) how frequently the analyser polls the audio stream to check if speaking has started/stopped or audio volume has changed. Default **100** (ms) * - `threshold`: (number) the volume at which _publisherStartSpeaking_ and _publisherStopSpeaking_ events will be fired. Default **-50** (dB) * diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/Publisher.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/Publisher.java index 2a03b4b9..184760c8 100644 --- a/openvidu-java-client/src/main/java/io/openvidu/java/client/Publisher.java +++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/Publisher.java @@ -25,7 +25,7 @@ import com.google.gson.JsonObject; * *
* This is a backend representation of a published media stream (see - * OpenVidu + * OpenVidu * Browser Stream class). */ public class Publisher { @@ -65,10 +65,10 @@ public class Publisher { /** * Returns the unique identifier of the - * Stream associated to this Publisher. Each Publisher is paired * with only one Stream, so you can identify each Publisher by its - * Stream.streamId */ public String getStreamId() { @@ -84,7 +84,7 @@ public class Publisher { } /** - * See properties of Stream object in OpenVidu Browser library to find out more */ public boolean hasVideo() { @@ -92,7 +92,7 @@ public class Publisher { } /** - * See properties of Stream object in OpenVidu Browser library to find out more */ public boolean hasAudio() { @@ -100,7 +100,7 @@ public class Publisher { } /** - * See properties of Stream object in OpenVidu Browser library to find out more */ public Boolean isAudioActive() { @@ -108,7 +108,7 @@ public class Publisher { } /** - * See properties of Stream object in OpenVidu Browser library to find out more */ public Boolean isVideoActive() { @@ -116,7 +116,7 @@ public class Publisher { } /** - * See properties of Stream object in OpenVidu Browser library to find out more */ public Integer getFrameRate() { @@ -124,7 +124,7 @@ public class Publisher { } /** - * See properties of Stream object in OpenVidu Browser library to find out more */ public String getTypeOfVideo() { @@ -132,7 +132,7 @@ public class Publisher { } /** - * See properties of Stream object in OpenVidu Browser library to find out more */ public String getVideoDimensions() { diff --git a/openvidu-node-client/config/typedoc.js b/openvidu-node-client/config/typedoc.js index 57f06d04..62bd81de 100644 --- a/openvidu-node-client/config/typedoc.js +++ b/openvidu-node-client/config/typedoc.js @@ -12,6 +12,10 @@ module.exports = { externalPattern: "node_modules", excludeExternals: true, excludePrivate: true, + excludeNotExported: true, theme: "default", - readme: "none" + readme: "none", + includeVersion: true, + listInvalidSymbolLinks: true, + out: "./docs" } \ No newline at end of file diff --git a/openvidu-node-client/src/Connection.ts b/openvidu-node-client/src/Connection.ts index c1c61f75..836eaa81 100644 --- a/openvidu-node-client/src/Connection.ts +++ b/openvidu-node-client/src/Connection.ts @@ -61,7 +61,7 @@ export class Connection { /** * Data associated to the connection on the client-side. This value is set with second parameter of method - * [Session.connect](api/openvidu-browser/classes/session.html#connect) in OpenVidu Browser + * [Session.connect](/en/stable/api/openvidu-browser/classes/session.html#connect) in OpenVidu Browser */ clientData: string; diff --git a/openvidu-node-client/src/Publisher.ts b/openvidu-node-client/src/Publisher.ts index 661ed6b6..d88a009a 100644 --- a/openvidu-node-client/src/Publisher.ts +++ b/openvidu-node-client/src/Publisher.ts @@ -19,14 +19,14 @@ /** * See [[Connection.publishers]] * - * This is a backend representation of a published media stream (see [OpenVidu Browser Stream class](api/openvidu-browser/classes/stream.html)) + * This is a backend representation of a published media stream (see [OpenVidu Browser Stream class](/en/stable/api/openvidu-browser/classes/stream.html)) */ export class Publisher { /** - * Unique identifier of the [Stream](api/openvidu-browser/classes/stream.html) associated to this Publisher. + * Unique identifier of the [Stream](/en/stable/api/openvidu-browser/classes/stream.html) associated to this Publisher. * Each Publisher is paired with only one Stream, so you can identify each Publisher by its - * [`Stream.streamId`](api/openvidu-browser/classes/stream.html#streamid) + * [`Stream.streamId`](/en/stable/api/openvidu-browser/classes/stream.html#streamid) */ streamId: string; @@ -36,37 +36,37 @@ export class Publisher { createdAt: number; /** - * See properties of [Stream](api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more + * See properties of [Stream](/en/stable/api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more */ hasAudio: boolean; /** - * See properties of [Stream](api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more + * See properties of [Stream](/en/stable/api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more */ hasVideo: boolean; /** - * See properties of [Stream](api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more + * See properties of [Stream](/en/stable/api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more */ audioActive: boolean; /** - * See properties of [Stream](api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more + * See properties of [Stream](/en/stable/api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more */ videoActive: boolean; /** - * See properties of [Stream](api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more + * See properties of [Stream](/en/stable/api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more */ frameRate: number; /** - * See properties of [Stream](api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more + * See properties of [Stream](/en/stable/api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more */ typeOfVideo: string; /** - * See properties of [Stream](api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more + * See properties of [Stream](/en/stable/api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more */ videoDimensions: string;