ambiser
/
openvidu
mirror of https://github.com/OpenVidu/openvidu.git
8
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation links to /en/stable/

pull/431/head
pabloFuente 2020-04-05 20:03:46 +02:00
parent 7e282b239b
commit d838518ae3
9 changed files with 35 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
openvidu-browser/config/typedoc.js
View File

@ -19,6 +19,10 @@ module.exports = {
], ],
excludeExternals: true, excludeExternals: true,
excludePrivate: true, excludePrivate: true,
excludeNotExported: true,
theme: "default", theme: "default",
readme: "none" readme: "none",
includeVersion: true,
listInvalidSymbolLinks: true,
out: "./docs"
} }

2
openvidu-browser/package.json
View File

@ -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": "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", "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", "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", "types": "lib/index.d.ts",
"version": "2.12.0" "version": "2.12.0"

2
openvidu-browser/src/OpenVidu/OpenVidu.ts
View File

@ -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): * 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 * - `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) * - `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. * Call this method to override previous values at any moment.
*/ */

2
openvidu-browser/src/OpenVidu/StreamManager.ts
View File

@ -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 * 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. * for each specific StreamManager and change them dynamically.
* *

2
openvidu-browser/src/OpenViduInternal/Interfaces/Public/OpenViduAdvancedConfiguration.ts
View File

@ -33,7 +33,7 @@ export interface OpenViduAdvancedConfiguration {
screenShareChromeExtension?: string; 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) * - `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) * - `threshold`: (number) the volume at which _publisherStartSpeaking_ and _publisherStopSpeaking_ events will be fired. Default **-50** (dB)
* *

20
openvidu-java-client/src/main/java/io/openvidu/java/client/Publisher.java
View File

@ -25,7 +25,7 @@ import com.google.gson.JsonObject;
* *
* <br> * <br>
* This is a backend representation of a published media stream (see * This is a backend representation of a published media stream (see
* <a href="api/openvidu-browser/classes/stream.html" target="_blank"> OpenVidu * <a href="/en/stable/api/openvidu-browser/classes/stream.html" target="_blank"> OpenVidu
* Browser Stream class</a>). * Browser Stream class</a>).
*/ */
public class Publisher { public class Publisher {
@ -65,10 +65,10 @@ public class Publisher {
/** /**
* Returns the unique identifier of the * Returns the unique identifier of the
* <a href="api/openvidu-browser/classes/stream.html" target= * <a href="/en/stable/api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> associated to this Publisher. Each Publisher is paired * "_blank">Stream</a> associated to this Publisher. Each Publisher is paired
* with only one Stream, so you can identify each Publisher by its * with only one Stream, so you can identify each Publisher by its
* <a href="api/openvidu-browser/classes/stream.html#streamid" target= * <a href="/en/stable/api/openvidu-browser/classes/stream.html#streamid" target=
* "_blank"><code>Stream.streamId</code></a> * "_blank"><code>Stream.streamId</code></a>
*/ */
public String getStreamId() { public String getStreamId() {
@ -84,7 +84,7 @@ public class Publisher {
} }
/** /**
* See properties of <a href="api/openvidu-browser/classes/stream.html" target= * See properties of <a href="/en/stable/api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more * "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/ */
public boolean hasVideo() { public boolean hasVideo() {
@ -92,7 +92,7 @@ public class Publisher {
} }
/** /**
* See properties of <a href="api/openvidu-browser/classes/stream.html" target= * See properties of <a href="/en/stable/api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more * "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/ */
public boolean hasAudio() { public boolean hasAudio() {
@ -100,7 +100,7 @@ public class Publisher {
} }
/** /**
* See properties of <a href="api/openvidu-browser/classes/stream.html" target= * See properties of <a href="/en/stable/api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more * "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/ */
public Boolean isAudioActive() { public Boolean isAudioActive() {
@ -108,7 +108,7 @@ public class Publisher {
} }
/** /**
* See properties of <a href="api/openvidu-browser/classes/stream.html" target= * See properties of <a href="/en/stable/api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more * "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/ */
public Boolean isVideoActive() { public Boolean isVideoActive() {
@ -116,7 +116,7 @@ public class Publisher {
} }
/** /**
* See properties of <a href="api/openvidu-browser/classes/stream.html" target= * See properties of <a href="/en/stable/api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more * "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/ */
public Integer getFrameRate() { public Integer getFrameRate() {
@ -124,7 +124,7 @@ public class Publisher {
} }
/** /**
* See properties of <a href="api/openvidu-browser/classes/stream.html" target= * See properties of <a href="/en/stable/api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more * "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/ */
public String getTypeOfVideo() { public String getTypeOfVideo() {
@ -132,7 +132,7 @@ public class Publisher {
} }
/** /**
* See properties of <a href="api/openvidu-browser/classes/stream.html" target= * See properties of <a href="/en/stable/api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more * "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/ */
public String getVideoDimensions() { public String getVideoDimensions() {

6
openvidu-node-client/config/typedoc.js
View File

@ -12,6 +12,10 @@ module.exports = {
externalPattern: "node_modules", externalPattern: "node_modules",
excludeExternals: true, excludeExternals: true,
excludePrivate: true, excludePrivate: true,
excludeNotExported: true,
theme: "default", theme: "default",
readme: "none" readme: "none",
includeVersion: true,
listInvalidSymbolLinks: true,
out: "./docs"
} }

2
openvidu-node-client/src/Connection.ts
View File

@ -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 * 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; clientData: string;

20
openvidu-node-client/src/Publisher.ts
View File

@ -19,14 +19,14 @@
/** /**
* See [[Connection.publishers]] * 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 { 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 * 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; streamId: string;
@ -36,37 +36,37 @@ export class Publisher {
createdAt: number; 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; 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; 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; 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; 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; 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; 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; videoDimensions: string;