From 4d004e4a9e7212a7d85b8fe0823b5bb2ded684a8 Mon Sep 17 00:00:00 2001 From: Juan Navarro Date: Mon, 28 Feb 2022 13:51:26 +0100 Subject: [PATCH] Review all href usages of target="_blank" Do not force the user's browser to open new tabs when navigating within the documentation pages. We discussed about this and agreed that doing so is user hostile and goes away from how HTTP links have been working for 30 years (i.e. leave users decide if THEY want a new tab or not, by how they open the links). Used these regexes: From: target="blank" To: target="_blank" From: (\]\((?!http)[^)]+\))\{:target="_blank"\} To: $1 From: (\]\(https?://docs.openvidu.io[^)]+\))\{:target="_blank"\} To: $1 From: href="((?!http)\S+)" target="_blank" To: href="$1" From: href="(https?://docs.openvidu.io\S+)" target="_blank" To: href="$1" --- openvidu-browser/src/OpenVidu/Connection.ts | 4 +- .../Events/ConnectionPropertyChangedEvent.ts | 6 +- .../Events/EventMap/SessionEventMap.ts | 48 ++++++------- .../io/openvidu/java/client/Connection.java | 27 ++++---- .../java/client/ConnectionProperties.java | 42 ++++++------ .../openvidu/java/client/KurentoOptions.java | 32 +++++---- .../io/openvidu/java/client/Publisher.java | 9 +-- .../openvidu/java/client/RecordingLayout.java | 7 +- .../java/client/RecordingProperties.java | 32 ++++----- .../java/io/openvidu/java/client/Session.java | 68 +++++++++---------- .../java/client/SessionProperties.java | 4 +- openvidu-node-client/src/Connection.ts | 4 +- .../src/ConnectionProperties.ts | 32 ++++----- .../src/RecordingProperties.ts | 24 +++---- openvidu-node-client/src/Session.ts | 32 ++++----- openvidu-node-client/src/SessionProperties.ts | 2 +- .../src/main/resources/static/index.html | 17 +++-- 17 files changed, 202 insertions(+), 188 deletions(-) diff --git a/openvidu-browser/src/OpenVidu/Connection.ts b/openvidu-browser/src/OpenVidu/Connection.ts index 1c122d8b..2fc6383a 100644 --- a/openvidu-browser/src/OpenVidu/Connection.ts +++ b/openvidu-browser/src/OpenVidu/Connection.ts @@ -63,7 +63,7 @@ export class Connection { role: string; /** - * Whether the streams published by this Connection will be recorded or not. This only affects [INDIVIDUAL recording](/en/stable/advanced-features/recording/#individual-recording-selection) PRO + * Whether the streams published by this Connection will be recorded or not. This only affects [INDIVIDUAL recording](/en/stable/advanced-features/recording/#individual-recording-selection) PRO * * **Only defined for the local connection. In remote connections will be `undefined`** */ @@ -174,7 +174,7 @@ export class Connection { this.addStream(stream); }); - + logger.info("Remote 'Connection' with 'connectionId' [" + this.connectionId + '] is now configured for receiving Streams with options: ', this.stream!.inboundStreamOpts); } diff --git a/openvidu-browser/src/OpenViduInternal/Events/ConnectionPropertyChangedEvent.ts b/openvidu-browser/src/OpenViduInternal/Events/ConnectionPropertyChangedEvent.ts index 32fdbf96..10e73273 100644 --- a/openvidu-browser/src/OpenViduInternal/Events/ConnectionPropertyChangedEvent.ts +++ b/openvidu-browser/src/OpenViduInternal/Events/ConnectionPropertyChangedEvent.ts @@ -20,8 +20,8 @@ import { Session } from '../../OpenVidu/Session'; import { Event } from './Event'; /** - * **This feature is part of OpenVidu Pro tier** PRO - * + * **This feature is part of OpenVidu Pro tier** PRO + * * Triggered by [[connectionPropertyChanged]] */ export class ConnectionPropertyChangedEvent extends Event { @@ -63,4 +63,4 @@ export class ConnectionPropertyChangedEvent extends Event { // tslint:disable-next-line:no-empty callDefaultBehavior() { } -} \ No newline at end of file +} diff --git a/openvidu-browser/src/OpenViduInternal/Events/EventMap/SessionEventMap.ts b/openvidu-browser/src/OpenViduInternal/Events/EventMap/SessionEventMap.ts index d1af74b9..1ec7fd6a 100644 --- a/openvidu-browser/src/OpenViduInternal/Events/EventMap/SessionEventMap.ts +++ b/openvidu-browser/src/OpenViduInternal/Events/EventMap/SessionEventMap.ts @@ -35,28 +35,28 @@ export interface SessionEventMap extends EventMap { /** * Event dispatched when a new user has connected to the session. - * + * * It is fired for both the local user and remote users. */ connectionCreated: ConnectionEvent; /** * Event dispatched when a remote user has left the session. - * + * * For the local user see [[sessionDisconnected]]. */ connectionDestroyed: ConnectionEvent; /** - * **This feature is part of OpenVidu Pro tier** PRO - * + * **This feature is part of OpenVidu Pro tier** PRO + * * Event dispatched when a property of the local [[Connection]] object changes. - * + * * It is fired only for the local user. - * + * * The properties that may change are [[Connection.role]] and [[Connection.record]]. * The only way the Connection properties may change is by updating them through: - * + * * - [API REST](/en/stable/reference-docs/REST-API/#patch-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)

@@ -65,21 +65,21 @@ export interface SessionEventMap extends EventMap { /** * Event dispatched when the local user has left the session. - * + * * For remote users see [[connectionDestroyed]]. */ sessionDisconnected: SessionDisconnectedEvent; /** * Event dispatched when a user has started publishing media to the session (see [[Session.publish]]). - * + * * It is fired for both the local user and remote users. */ streamCreated: StreamEvent; /** * Event dispatched when a user stops publishing media to the session. - * + * * It is fired for both the local user and remote users. */ streamDestroyed: StreamEvent; @@ -87,16 +87,16 @@ export interface SessionEventMap extends EventMap { /** * Event dispatched when a Stream undergoes any change in any of its mutable properties * (see [[StreamPropertyChangedEvent.changedProperty]]). - * + * * It is fired for both remote streams (owned by a [[Subscriber]]) or local streams (owned by a [[Publisher]]). */ streamPropertyChanged: StreamPropertyChangedEvent; /** * Event dispatched when a user has started speaking. - * + * * It is fired for both the local user and remote users. - * + * * Extra information: * - This event will only be triggered for **streams that have audio tracks** ([[Stream.hasAudio]] must be true). * - Further configuration can be applied on how the event is dispatched by setting property `publisherSpeakingEventsOptions` in the call of [[OpenVidu.setAdvancedConfiguration]]. @@ -105,9 +105,9 @@ export interface SessionEventMap extends EventMap { /** * Event dispatched when a user has stopped speaking. - * + * * It is fired for both the local user and remote users. - * + * * Extra information: * - This event will only be triggered for **streams that have audio tracks** ([[Stream.hasAudio]] must be true). * - Further configuration can be applied on how the event is dispatched by setting property `publisherSpeakingEventsOptions` in the call of [[OpenVidu.setAdvancedConfiguration]]. @@ -121,14 +121,14 @@ export interface SessionEventMap extends EventMap { /** * Event dispatched when a signal is received (see [Send text messages between users](/en/stable/cheatsheet/send-messages)). - * + * * If the listener is added as **`signal:TYPE`**, only signals of type **`TYPE`** will trigger the event. */ signal: SignalEvent; /** * Event dispatched when the session has started being recorded. - * + * * Property **`OPENVIDU_RECORDING_NOTIFICATION`** of [OpenVidu Server configuration](/en/stable/reference-docs/openvidu-config/) * defines which users should receive this events (by default, only users with role `PUBLISHER` or `MODERATOR`) */ @@ -136,32 +136,32 @@ export interface SessionEventMap extends EventMap { /** * Event dispatched when the session has stopped being recorded. - * + * * Property **`OPENVIDU_RECORDING_NOTIFICATION`** of [OpenVidu Server configuration](/en/stable/reference-docs/openvidu-config/) * defines which users should receive this events (by default, only users with role `PUBLISHER` or `MODERATOR`) */ recordingStopped: RecordingEvent; /** - * **This feature is part of OpenVidu Pro tier** PRO - * + * **This feature is part of OpenVidu Pro tier** PRO + * * Event dispatched when the network quality level of a [[Connection]] changes. See [network quality](/en/stable/advanced-features/network-quality/). */ networkQualityLevelChanged: NetworkQualityLevelChangedEvent; /** * Event dispatched when the local user has lost its connection to the session, and starts the automatic reconnection process. - * + * * See [Reconnection events](/en/stable/advanced-features/automatic-reconnection/#reconnection-events). */ reconnecting: never; /** * Event dispatched when the local user has successfully recovered its connection to the session after losing it. - * + * * If the connection was recovered but OpenVidu Server already evicted the user due to timeout, then this event will * not be dispatched. A [[sessionDisconnected]] event with reason `networkDisconnect` will be triggered instead. - * + * * See [Reconnection events](/en/stable/advanced-features/automatic-reconnection/#reconnection-events). */ reconnected: never; @@ -171,4 +171,4 @@ export interface SessionEventMap extends EventMap { * To see the different types of exceptions go to [[ExceptionEventName]]. */ exception: ExceptionEvent; -} \ No newline at end of file +} diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/Connection.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/Connection.java index aff66866..30f10235 100644 --- a/openvidu-java-client/src/main/java/io/openvidu/java/client/Connection.java +++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/Connection.java @@ -112,9 +112,10 @@ public class Connection { /** * Whether the streams published by this Connection will be recorded or not. - * This only affects INDIVIDUAL recording. + * This only affects + * + * INDIVIDUAL recording + * . */ public boolean record() { return this.connectionProperties.record(); @@ -122,7 +123,7 @@ public class Connection { /** * Returns the role of the Connection. - * + * *
*
* Only for @@ -134,7 +135,7 @@ public class Connection { /** * Returns the RTSP URI of the Connection. - * + * *
*
* Only for @@ -150,7 +151,7 @@ public class Connection { * transcoding this can be disabled to save CPU power. If you are not sure if * transcoding might be necessary, setting this property to false may * result in media connections not being established. - * + * *
*
* Only for @@ -166,7 +167,7 @@ public class Connection { * consumption and network bandwidth in your server while nobody is asking to * receive the camera's video. On the counterpart, first user subscribing to the * IP camera stream will take a little longer to receive its video. - * + * *
*
* Only for @@ -182,7 +183,7 @@ public class Connection { * have, but more problematic will be in unstable networks. Use short buffers * only if there is a quality connection between the IP camera and OpenVidu * Server. - * + * *
*
* Only for @@ -208,21 +209,21 @@ public class Connection { /** * Returns the token string associated to the Connection. This is the value that * must be sent to the client-side to be consumed in OpenVidu Browser method - * Session.connect. + * + * Session.connect + * . */ public String getToken() { return this.token; } /** - * PRO - * + * * Returns the geo location of the connection, with the following format: * "CITY, COUNTRY" ("unknown" if it wasn't possible to * locate it) diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/ConnectionProperties.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/ConnectionProperties.java index f61a339c..307e28d9 100644 --- a/openvidu-java-client/src/main/java/io/openvidu/java/client/ConnectionProperties.java +++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/ConnectionProperties.java @@ -30,7 +30,7 @@ public class ConnectionProperties { private List customIceServers; /** - * + * * Builder for {@link io.openvidu.java.client.ConnectionProperties} * */ @@ -125,9 +125,10 @@ public class ConnectionProperties { /** * Call this method to flag the streams published by this Connection to be - * recorded or not. This only affects INDIVIDUAL recording. If not set by default will be true. + * recorded or not. This only affects + * + * INDIVIDUAL recording + * . If not set, by default will be true. */ public Builder record(boolean record) { this.record = record; @@ -138,7 +139,7 @@ public class ConnectionProperties { * Call this method to set the role assigned to this Connection. If not set by * default will be {@link io.openvidu.java.client.OpenViduRole#PUBLISHER * PUBLISHER}. - * + * *
*
* Only for @@ -152,7 +153,7 @@ public class ConnectionProperties { /** * Call this method to set a {@link io.openvidu.java.client.KurentoOptions} * object for this Connection. - * + * *
*
* Only for @@ -166,7 +167,7 @@ public class ConnectionProperties { /** * Call this method to set the RTSP URI of an IP camera. For example: * rtsp://your.camera.ip:7777/path - * + * *
*
* Only for @@ -184,7 +185,7 @@ public class ConnectionProperties { * if transcoding might be necessary, setting this property to false may * result in media connections not being established. Default to * true. - * + * *
*
* Only for @@ -202,7 +203,7 @@ public class ConnectionProperties { * camera's video. On the counterpart, first user subscribing to the IP camera * stream will take a little longer to receive its video. Default to * true. - * + * *
*
* Only for @@ -219,7 +220,7 @@ public class ConnectionProperties { * signal will have, but more problematic will be in unstable networks. Use * short buffers only if there is a quality connection between the IP camera and * OpenVidu Server. Default to 2000. - * + * *
*
* Only for @@ -292,14 +293,15 @@ public class ConnectionProperties { } /** - * PRO Whether the streams published by this Connection will be - * recorded or not. This only affects INDIVIDUAL recording. + * recorded or not. This only affects + * + * INDIVIDUAL recording + * . */ public Boolean record() { return this.record; @@ -307,7 +309,7 @@ public class ConnectionProperties { /** * Returns the role assigned to this Connection. - * + * *
*
* Only for @@ -319,7 +321,7 @@ public class ConnectionProperties { /** * Returns the KurentoOptions assigned to this Connection. - * + * *
*
* Only for @@ -331,7 +333,7 @@ public class ConnectionProperties { /** * Returns the RTSP URI of this Connection. - * + * *
*
* Only for @@ -347,7 +349,7 @@ public class ConnectionProperties { * transcoding this can be disabled to save CPU power. If you are not sure if * transcoding might be necessary, setting this property to false may * result in media connections not being established. - * + * *
*
* Only for @@ -363,7 +365,7 @@ public class ConnectionProperties { * server while nobody is asking to receive the camera's video. On the * counterpart, first user subscribing to the IP camera stream will take a * little longer to receive its video. - * + * *
*
* Only for @@ -378,7 +380,7 @@ public class ConnectionProperties { * milliseconds. The smaller it is, the less delay the signal will have, but * more problematic will be in unstable networks. Use short buffers only if * there is a quality connection between the IP camera and OpenVidu Server. - * + * *
*
* Only for diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/KurentoOptions.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/KurentoOptions.java index 0f5f5fa3..130c690d 100644 --- a/openvidu-java-client/src/main/java/io/openvidu/java/client/KurentoOptions.java +++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/KurentoOptions.java @@ -34,7 +34,7 @@ public class KurentoOptions { private String[] allowedFilters; /** - * + * * Builder for {@link io.openvidu.java.client.KurentoOptions} * */ @@ -113,8 +113,9 @@ public class KurentoOptions { * Defines the maximum number of Kbps that the Connection will be able to * receive from Kurento Media Server per media stream. 0 means unconstrained. * Giving a value to this property will override the global configuration set in - * OpenVidu Server configuration (parameter + * + * OpenVidu Server configuration + * (parameter * OPENVIDU_STREAMS_VIDEO_MAX_RECV_BANDWIDTH) for every incoming * stream of the user owning the token.
* WARNING: the lower value set to this property limits every @@ -130,8 +131,9 @@ public class KurentoOptions { * Defines the minimum number of Kbps that the Connection will try to receive * from Kurento Media Server per media stream. 0 means unconstrained. Giving a * value to this property will override the global configuration set in - * OpenVidu Server configuration (parameter + * + * OpenVidu Server configuration + * (parameter * OPENVIDU_STREAMS_VIDEO_MIN_RECV_BANDWIDTH) for every incoming * stream of the user owning the token. */ @@ -143,8 +145,9 @@ public class KurentoOptions { * Defines the maximum number of Kbps that the Connection will be able to send * to Kurento Media Server per media stream. 0 means unconstrained. Giving a * value to this property will override the global configuration set in - * OpenVidu Server configuration (parameter + * + * OpenVidu Server configuration + * (parameter * OPENVIDU_STREAMS_VIDEO_MAX_SEND_BANDWIDTH) for every outgoing * stream of the user owning the token.
* WARNING: this value limits every other bandwidth of the @@ -159,8 +162,9 @@ public class KurentoOptions { * Defines the minimum number of Kbps that the Connection will try to send to * Kurento Media Server per media stream. 0 means unconstrained. Giving a value * to this property will override the global configuration set in - * OpenVidu Server configuration (parameter + * + * OpenVidu Server configuration + * (parameter * OPENVIDU_STREAMS_VIDEO_MIN_SEND_BANDWIDTH) for every outgoing * stream of the user owning the token. */ @@ -171,8 +175,9 @@ public class KurentoOptions { /** * Defines the names of the filters the Connection will be able to apply to its * published streams. See - * Voice and video filters. + * + * Voice and video filters + * . */ public String[] getAllowedFilters() { return allowedFilters; @@ -180,8 +185,9 @@ public class KurentoOptions { /** * See if the Connection can apply certain filter. See - * Voice and video filters. + * + * Voice and video filters + * . */ public boolean isFilterAllowed(String filterType) { if (filterType == null) { 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 5edf7b02..1c7b1908 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 @@ -21,11 +21,12 @@ import com.google.gson.JsonObject; /** * See {@link io.openvidu.java.client.Connection#getPublishers()}. - * + * *
- * This is a backend representation of a published media stream (see OpenVidu Browser Stream class). + * This is a backend representation of a published media stream (see + * + * OpenVidu Browser Stream class + * ). */ public class Publisher { diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingLayout.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingLayout.java index 700bf2fc..38d0a3cd 100644 --- a/openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingLayout.java +++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingLayout.java @@ -44,9 +44,10 @@ public enum RecordingLayout { HORIZONTAL_PRESENTATION, /** - * Use your own custom recording layout. See Custom recording layouts to learn more + * Use your own custom recording layout. See + * + * Custom recording layouts + * to learn more. */ CUSTOM } diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingProperties.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingProperties.java index 2e3a5ec4..928b834e 100644 --- a/openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingProperties.java +++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingProperties.java @@ -202,9 +202,9 @@ public class RecordingProperties { * to {@link io.openvidu.java.client.RecordingLayout#CUSTOM} you can call this * method to set the relative path to the specific custom layout you want to * use.
- * See Custom recording layouts to learn more + * See + * Custom recording layouts + * to learn more */ public RecordingProperties.Builder customLayout(String path) { this.customLayout = path; @@ -234,7 +234,7 @@ public class RecordingProperties { } /** - * *
- * + * * Default to 25 */ public Integer frameRate() { @@ -379,7 +379,7 @@ public class RecordingProperties { * recordings with {@link RecordingProperties#hasVideo()} to true. Property * ignored for INDIVIDUAL recordings and audio-only recordings
*
- * + * * Default to 536870912 (512 MB) */ public Long shmSize() { @@ -390,9 +390,9 @@ public class RecordingProperties { * If {@link io.openvidu.java.client.RecordingProperties#recordingLayout()} is * set to {@link io.openvidu.java.client.RecordingLayout#CUSTOM}, this property * defines the relative path to the specific custom layout you want to use.
- * See Custom recording layouts to learn more + * See + * Custom recording layouts + * to learn more */ public String customLayout() { return this.customLayout; @@ -415,7 +415,7 @@ public class RecordingProperties { * guarantee that all streams present at the beginning of a recording are * actually being recorded.
*
- * + * * Default to false */ public Boolean ignoreFailedStreams() { @@ -423,7 +423,7 @@ public class RecordingProperties { } /** - * .
*
- * + * * In the second case, the token of the Connection will be invalidated and no * user will be able to connect to the session with it.
*
- * + * * This method automatically updates the properties of the local affected * objects. This means that there is no need to call * {@link io.openvidu.java.client.Session#fetch() Session.fetch()} or * {@link io.openvidu.java.client.OpenVidu#fetch() OpenVidu.fetch()} to see the * changes consequence of the execution of this method applied in the local * objects. - * + * * @param connection The Connection to remove - * + * * @throws OpenViduJavaClientException * @throws OpenViduHttpException */ @@ -329,9 +329,9 @@ public class Session { * forceDisconnect(ConnectionProperties)} but providing the * {@link io.openvidu.java.client.Connection#getConnectionId() connectionId} * instead of the Connection object. - * + * * @param connectionId The identifier of the Connection object to remove - * + * * @throws OpenViduJavaClientException * @throws OpenViduHttpException */ @@ -382,7 +382,7 @@ public class Session { * the proper events in the client-side (streamDestroyed) with * reason set to "forceUnpublishByServer".
*
- * + * * You can get publisher parameter with * {@link io.openvidu.java.client.Session#getActiveConnections()} and then for * each Connection you can call @@ -390,16 +390,16 @@ public class Session { * {@link io.openvidu.java.client.Session#fetch()} before to fetch the current * actual properties of the Session from OpenVidu Server.
*
- * + * * This method automatically updates the properties of the local affected * objects. This means that there is no need to call * {@link io.openvidu.java.client.Session#fetch() Session.fetch()} or * {@link io.openvidu.java.client.OpenVidu#fetch() OpenVidu.fetch()} to see the * changes consequence of the execution of this method applied in the local * objects. - * + * * @param publisher The Publisher object to unpublish - * + * * @throws OpenViduJavaClientException * @throws OpenViduHttpException */ @@ -412,9 +412,9 @@ public class Session { * forceUnpublish(Publisher)} but providing the * {@link io.openvidu.java.client.Publisher#getStreamId() streamId} instead of * the Publisher object. - * + * * @param streamId The identifier of the Publisher object to remove - * + * * @throws OpenViduJavaClientException * @throws OpenViduHttpException */ @@ -451,7 +451,7 @@ public class Session { } /** - * ConnectionPropertyChangedEvent for each modified - * property. - * + * + * The affected client will trigger one + * + * ConnectionPropertyChangedEvent + * for each modified property. + * * @param connectionId The Connection to modify * @param connectionProperties A ConnectionProperties object with the new values * to apply - * + * * @return The updated {@link io.openvidu.java.client.Connection Connection} * object - * + * * @throws OpenViduJavaClientException * @throws OpenViduHttpException */ @@ -542,9 +542,9 @@ public class Session { * actual value you must call first * {@link io.openvidu.java.client.Session#fetch() Session.fetch()} or * {@link io.openvidu.java.client.OpenVidu#fetch() OpenVidu.fetch()}. - * + * * @param id The Connection to get - * + * * @return The {@link io.openvidu.java.client.Connection Connection} object, or * null if no Connection is found for param id */ @@ -558,7 +558,7 @@ public class Session { * current actual value you must call first * {@link io.openvidu.java.client.Session#fetch() Session.fetch()} or * {@link io.openvidu.java.client.OpenVidu#fetch() OpenVidu.fetch()}. - * + * * The list of Connections will remain unchanged since the last time * method {@link io.openvidu.java.client.Session#fetch() Session.fetch()} or * {@link io.openvidu.java.client.OpenVidu#fetch() OpenVidu.fetch()} was diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/SessionProperties.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/SessionProperties.java index 4ca54a22..a475f587 100644 --- a/openvidu-java-client/src/main/java/io/openvidu/java/client/SessionProperties.java +++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/SessionProperties.java @@ -104,7 +104,7 @@ public class SessionProperties { } /** - * PRO + * PRO * Geo location of the Connection, with the following format: `"CITY, COUNTRY"` (`"unknown"` if it wasn't possible to locate it) */ location: string; @@ -281,4 +281,4 @@ export class Connection { } } -} \ No newline at end of file +} diff --git a/openvidu-node-client/src/ConnectionProperties.ts b/openvidu-node-client/src/ConnectionProperties.ts index d3acc760..2cc1ab35 100644 --- a/openvidu-node-client/src/ConnectionProperties.ts +++ b/openvidu-node-client/src/ConnectionProperties.ts @@ -23,10 +23,10 @@ export interface ConnectionProperties { /** * Type of Connection. The [[ConnectionType]] dictates what properties will have effect: - * + * * - **[[ConnectionType.WEBRTC]]**: [[data]], [[record]], [[role]], [[kurentoOptions]] * - **[[ConnectionType.IPCAM]]**: [[data]], [[record]], [[rtspUri]], [[adaptativeBitrate]], [[onlyPlayWithSubscribers]], [[networkCache]] - * + * * @default WEBRTC */ type?: ConnectionType; @@ -40,19 +40,19 @@ export interface ConnectionProperties { data?: string; /** - * **This feature is part of OpenVidu Pro tier** PRO - * + * **This feature is part of OpenVidu Pro tier** PRO + * * Whether to record the streams published by this Connection or not. This only affects [INDIVIDUAL recording](/en/stable/advanced-features/recording/#individual-recording-selection) - * + * * @default true */ record?: boolean; /** * The role assigned to this Connection - * + * * **Only for [[ConnectionType.WEBRTC]]** - * + * * @default PUBLISHER */ role?: OpenViduRole; @@ -77,7 +77,7 @@ export interface ConnectionProperties { * the global configuration set in [OpenVidu Server configuration](/en/stable/reference-docs/openvidu-config/) * (parameter `OPENVIDU_STREAMS_VIDEO_MIN_SEND_BANDWIDTH`) for every outgoing stream of the Connection. * - `allowedFilters`: names of the filters the Connection will be able to apply. See [Voice and video filters](/en/stable/advanced-features/filters/) - * + * * **Only for [[ConnectionType.WEBRTC]]** */ kurentoOptions?: { @@ -90,8 +90,8 @@ export interface ConnectionProperties { /** * RTSP URI of an IP camera. For example: `rtsp://your.camera.ip:7777/path` - * - * **Only for [[ConnectionType.IPCAM]]** + * + * **Only for [[ConnectionType.IPCAM]]** */ rtspUri?: string; @@ -99,9 +99,9 @@ export interface ConnectionProperties { * Whether to use adaptative bitrate (and therefore adaptative quality) or not. For local network connections * that do not require media transcoding this can be disabled to save CPU power. If you are not sure if transcoding * might be necessary, setting this property to false **may result in media connections not being established**. - * + * * **Only for [[ConnectionType.IPCAM]]** - * + * * @default true */ adaptativeBitrate?: boolean; @@ -110,9 +110,9 @@ export interface ConnectionProperties { * Whether to enable the IP camera stream only when some user is subscribed to it, or not. This allows you to reduce * power consumption and network bandwidth in your server while nobody is asking to receive the camera's video. * On the counterpart, first user subscribing to the IP camera stream will take a little longer to receive its video. - * + * * **Only for [[ConnectionType.IPCAM]]** - * + * * @default true */ onlyPlayWithSubscribers?: boolean; @@ -121,9 +121,9 @@ export interface ConnectionProperties { * Size of the buffer of the endpoint receiving the IP camera's stream, in milliseconds. The smaller it is, the less * delay the signal will have, but more problematic will be in unstable networks. Use short buffers only if there is * a quality connection between the IP camera and OpenVidu Server. - * + * * **Only for [[ConnectionType.IPCAM]]** - * + * * @default 2000 */ networkCache?: number; diff --git a/openvidu-node-client/src/RecordingProperties.ts b/openvidu-node-client/src/RecordingProperties.ts index 2bc3bfd2..7988b560 100644 --- a/openvidu-node-client/src/RecordingProperties.ts +++ b/openvidu-node-client/src/RecordingProperties.ts @@ -32,21 +32,21 @@ export interface RecordingProperties { /** * Whether or not to record audio. Cannot be set to false at the same time as [[RecordingProperties.hasVideo]] - * + * * Default to true */ hasAudio?: boolean; /** * Whether or not to record video. Cannot be set to false at the same time as [[RecordingProperties.hasAudio]] - * + * * Default to true */ hasVideo?: boolean; /** * The mode of recording: COMPOSED for a single archive in a grid layout or INDIVIDUAL for one archive for each stream - * + * * Default to [[Recording.OutputMode.COMPOSED]] */ outputMode?: Recording.OutputMode; @@ -54,7 +54,7 @@ export interface RecordingProperties { /** * The layout to be used in the recording.
* Will only have effect if [[RecordingProperties.outputMode]] is set to [[Recording.OutputMode.COMPOSED]] or [[Recording.OutputMode.COMPOSED_QUICK_START]] - * + * * Default to [[RecordingLayout.BEST_FIT]] */ recordingLayout?: RecordingLayout; @@ -64,7 +64,7 @@ export interface RecordingProperties { * being both WIDTH and HEIGHT the number of pixels between 100 and 1999.
* Will only have effect if [[RecordingProperties.outputMode]] is set to [[Recording.OutputMode.COMPOSED]] or [[Recording.OutputMode.COMPOSED_QUICK_START]] * and [[RecordingProperties.hasVideo]] is set to true. For [[Recording.OutputMode.INDIVIDUAL]] all individual video files will have the native resolution of the published stream. - * + * * Default to "1280x720" */ resolution?: string; @@ -73,7 +73,7 @@ export interface RecordingProperties { * Recording video file frame rate.
* Will only have effect if [[RecordingProperties.outputMode]] is set to [[Recording.OutputMode.COMPOSED]] or [[Recording.OutputMode.COMPOSED_QUICK_START]] * and [[RecordingProperties.hasVideo]] is set to true. For [[Recording.OutputMode.INDIVIDUAL]] all individual video files will have the native frame rate of the published stream. - * + * * Default to 25 */ frameRate?: number; @@ -83,7 +83,7 @@ export interface RecordingProperties { * Will only have effect if [[RecordingProperties.outputMode]] is set to [[Recording.OutputMode.COMPOSED]] or [[Recording.OutputMode.COMPOSED_QUICK_START]] * and [[RecordingProperties.hasVideo]] is set to true. Property ignored for INDIVIDUAL recordings and audio-only recordings. * Minimum 134217728 (128MB). - * + * * Default to 536870912 (512 MB) */ shmSize?: number; @@ -101,17 +101,17 @@ export interface RecordingProperties { * For this type of recordings, when calling [[OpenVidu.startRecording]] by default all the streams available at the moment the recording process starts must be healthy * and properly sending media. If some stream that should be sending media is broken, then the recording process fails after a 10s timeout. In this way your application is notified * that some stream is not being recorded, so it can retry the process again. - * + * * But you can disable this rollback behavior and simply ignore any failed stream, which will be susceptible to be recorded in the future if media starts flowing as expected at any point. * The downside of this behavior is that you will have no guarantee that all streams present at the beginning of a recording are actually being recorded. - * + * * Default to false */ ignoreFailedStreams?: boolean; /** - * **This feature is part of OpenVidu Pro tier** PRO - * + * **This feature is part of OpenVidu Pro tier** PRO + * * The Media Node where to host the recording. The default option if this property is not defined is the same * Media Node hosting the Session to record. This object defines the following properties as Media Node selector: * - `id`: Media Node unique identifier @@ -120,4 +120,4 @@ export interface RecordingProperties { id: string; } -} \ No newline at end of file +} diff --git a/openvidu-node-client/src/Session.ts b/openvidu-node-client/src/Session.ts index 9b98473b..8a2484d5 100644 --- a/openvidu-node-client/src/Session.ts +++ b/openvidu-node-client/src/Session.ts @@ -65,7 +65,7 @@ export class Session { /** * Array containing the active Connections of the Session. It is a subset of [[Session.connections]] array containing only * those Connections with property [[Connection.status]] to `active`. - * + * * To get the array of active Connections with their current actual value, you must call [[Session.fetch]] or [[OpenVidu.fetch]] * before consulting property [[activeConnections]] */ @@ -98,7 +98,7 @@ export class Session { /** * @deprecated Use [[Session.createConnection]] instead to get a [[Connection]] object. - * + * * @returns A Promise that is resolved to the generated _token_ string if success and rejected with an Error object if not */ public generateToken(tokenOptions?: TokenOptions): Promise { @@ -137,7 +137,7 @@ export class Session { * Creates a new Connection object associated to Session object and configured with * `connectionProperties`. Each user connecting to the Session requires a Connection. * The token string value to send to the client side is available at [[Connection.token]]. - * + * * @returns A Promise that is resolved to the generated [[Connection]] object if success and rejected with an Error object if not */ public createConnection(connectionProperties?: ConnectionProperties): Promise { @@ -258,17 +258,17 @@ export class Session { /** * Removes the Connection from the Session. This can translate into a forced eviction of a user from the Session if the * Connection had status `active` or into a token invalidation if no user had taken the Connection yet (status `pending`). - * + * * In the first case, OpenVidu Browser will trigger the proper events in the client-side (`streamDestroyed`, `connectionDestroyed`, * `sessionDisconnected`) with reason set to `"forceDisconnectByServer"`. - * + * * In the second case, the token of the Connection will be invalidated and no user will be able to connect to the session with it. - * + * * This method automatically updates the properties of the local affected objects. This means that there is no need to call * [[Session.fetch]] or [[OpenVidu.fetch]]] to see the changes consequence of the execution of this method applied in the local objects. * * @param connection The Connection object to remove from the session, or its `connectionId` property - * + * * @returns A Promise that is resolved if the Connection was successfully removed from the Session and rejected with an Error object if not */ public forceDisconnect(connection: string | Connection): Promise { @@ -338,9 +338,9 @@ export class Session { * * This method automatically updates the properties of the local affected objects. This means that there is no need to call * [[Session.fetch]] or [[OpenVidu.fetch]] to see the changes consequence of the execution of this method applied in the local objects. - * + * * @param publisher The Publisher object to unpublish, or its `streamId` property - * + * * @returns A Promise that is resolved if the stream was successfully unpublished and rejected with an Error object if not */ public forceUnpublish(publisher: string | Publisher): Promise { @@ -388,23 +388,23 @@ export class Session { } /** - * **This feature is part of OpenVidu Pro tier** PRO - * + * **This feature is part of OpenVidu Pro tier** PRO + * * Updates the properties of a Connection with a [[ConnectionProperties]] object. * Only these properties can be updated: - * + * * - [[ConnectionProperties.role]] * - [[ConnectionProperties.record]] - * + * * This method automatically updates the properties of the local affected objects. This means that there is no need to call * [[Session.fetch]] or [[OpenVidu.fetch]] to see the changes consequence of the execution of this method applied in the local objects. - * + * * The affected client will trigger one [ConnectionPropertyChangedEvent](/en/stable/api/openvidu-browser/classes/ConnectionPropertyChangedEvent.html) * for each modified property. - * + * * @param connectionId The [[Connection.connectionId]] of the Connection object to modify * @param connectionProperties A new [[ConnectionProperties]] object with the updated values to apply - * + * * @returns A Promise that is resolved to the updated [[Connection]] object if the operation was * successful and rejected with an Error object if not */ diff --git a/openvidu-node-client/src/SessionProperties.ts b/openvidu-node-client/src/SessionProperties.ts index 9b23203a..b1f2f2ec 100644 --- a/openvidu-node-client/src/SessionProperties.ts +++ b/openvidu-node-client/src/SessionProperties.ts @@ -56,7 +56,7 @@ export interface SessionProperties { customSessionId?: string; /** - * **This feature is part of OpenVidu Pro tier** PRO + * **This feature is part of OpenVidu Pro tier** PRO * * The Media Node where to host the session. The default option if this property is not defined is the less loaded * Media Node at the moment the first user joins the session. This object defines the following properties as Media Node selector: diff --git a/openvidu-server/src/main/resources/static/index.html b/openvidu-server/src/main/resources/static/index.html index 23dcf63e..71c5049e 100644 --- a/openvidu-server/src/main/resources/static/index.html +++ b/openvidu-server/src/main/resources/static/index.html @@ -7,12 +7,15 @@

Welcome to OpenVidu

    -
  • OpenVidu Server URL: - (consume REST API in this URL) -
    • -
  • OpenVidu Dashboard:
    • +
  • + OpenVidu Server URL: + + (consume REST API in this URL) + +
    • +
  • + OpenVidu Dashboard: +
- \ No newline at end of file +