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

Update doc API with new Typedoc camelcase syntax in links

pull/682/head
pabloFuente 2022-01-14 13:31:26 +01:00
parent 10e11072ab
commit 1965a6b44f
8 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -362,7 +362,7 @@ export class StreamManager extends EventDispatcher {
} }
/** /**
* Updates the current configuration for the [[PublisherSpeakingEvent]] feature and the [StreamManagerEvent.streamAudioVolumeChange](/en/stable/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.
* *

6
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](/en/stable/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)
* *
@ -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/stable/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/stable/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`.
*/ */

6
openvidu-java-client/src/main/java/io/openvidu/java/client/Connection.java
View File

@ -65,7 +65,7 @@ public class Connection {
* <ul> * <ul>
* <li><code>pending</code>: if the Connection is waiting for any user to use * <li><code>pending</code>: if the Connection is waiting for any user to use
* its internal token to connect to the session, calling method <a href= * its internal token to connect to the session, calling method <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/session.html#connect" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Session.html#connect"
* target ="_blank">Session.connect</a> in OpenVidu Browser.</li> * target ="_blank">Session.connect</a> in OpenVidu Browser.</li>
* <li><code>active</code>: if the internal token of the Connection has already * <li><code>active</code>: if the internal token of the Connection has already
* been used by some user to connect to the session, and it cannot be used * been used by some user to connect to the session, and it cannot be used
@ -194,7 +194,7 @@ public class Connection {
* Returns the token string associated to the Connection. This is the value that * 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 * must be sent to the client-side to be consumed in OpenVidu Browser method
* <a href= * <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/session.html#connect" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Session.html#connect"
* target="_blank">Session.connect</a>. * target="_blank">Session.connect</a>.
*/ */
public String getToken() { public String getToken() {
@ -234,7 +234,7 @@ public class Connection {
/** /**
* Returns the data associated to the connection on the client-side. This value * Returns the data associated to the connection on the client-side. This value
* is set with second parameter of method <a href= * is set with second parameter of method <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/session.html#connect" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Session.html#connect"
* target ="_blank">Session.connect</a> in OpenVidu Browser * target ="_blank">Session.connect</a> in OpenVidu Browser
*/ */
public String getClientData() { public String getClientData() {

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

@ -24,7 +24,7 @@ import com.google.gson.JsonObject;
* *
* <br> * <br>
* This is a backend representation of a published media stream (see <a href= * This is a backend representation of a published media stream (see <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/stream.html" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Stream.html"
* target="_blank"> OpenVidu Browser Stream class</a>). * target="_blank"> OpenVidu Browser Stream class</a>).
*/ */
public class Publisher { public class Publisher {
@ -45,11 +45,11 @@ public class Publisher {
/** /**
* Returns the unique identifier of the <a href= * Returns the unique identifier of the <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/stream.html" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Stream.html"
* target= "_blank">Stream</a> associated to this Publisher. Each Publisher is * target= "_blank">Stream</a> associated to this Publisher. Each Publisher is
* paired with only one Stream, so you can identify each Publisher by its * paired with only one Stream, so you can identify each Publisher by its
* <a href= * <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/stream.html#streamid" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Stream.html#streamId"
* target= "_blank"><code>Stream.streamId</code></a> * target= "_blank"><code>Stream.streamId</code></a>
*/ */
public String getStreamId() { public String getStreamId() {
@ -66,7 +66,7 @@ public class Publisher {
/** /**
* See properties of <a href= * See properties of <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/stream.html" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Stream.html"
* target= "_blank">Stream</a> object in OpenVidu Browser library to find out * target= "_blank">Stream</a> object in OpenVidu Browser library to find out
* more * more
*/ */
@ -76,7 +76,7 @@ public class Publisher {
/** /**
* See properties of <a href= * See properties of <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/stream.html" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Stream.html"
* target= "_blank">Stream</a> object in OpenVidu Browser library to find out * target= "_blank">Stream</a> object in OpenVidu Browser library to find out
* more * more
*/ */
@ -86,7 +86,7 @@ public class Publisher {
/** /**
* See properties of <a href= * See properties of <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/stream.html" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Stream.html"
* target= "_blank">Stream</a> object in OpenVidu Browser library to find out * target= "_blank">Stream</a> object in OpenVidu Browser library to find out
* more * more
*/ */
@ -96,7 +96,7 @@ public class Publisher {
/** /**
* See properties of <a href= * See properties of <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/stream.html" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Stream.html"
* target= "_blank">Stream</a> object in OpenVidu Browser library to find out * target= "_blank">Stream</a> object in OpenVidu Browser library to find out
* more * more
*/ */
@ -106,7 +106,7 @@ public class Publisher {
/** /**
* See properties of <a href= * See properties of <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/stream.html" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Stream.html"
* target= "_blank">Stream</a> object in OpenVidu Browser library to find out * target= "_blank">Stream</a> object in OpenVidu Browser library to find out
* more * more
*/ */
@ -116,7 +116,7 @@ public class Publisher {
/** /**
* See properties of <a href= * See properties of <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/stream.html" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Stream.html"
* target= "_blank">Stream</a> object in OpenVidu Browser library to find out * target= "_blank">Stream</a> object in OpenVidu Browser library to find out
* more * more
*/ */
@ -126,7 +126,7 @@ public class Publisher {
/** /**
* See properties of <a href= * See properties of <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/stream.html" * "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Stream.html"
* target= "_blank">Stream</a> object in OpenVidu Browser library to find out * target= "_blank">Stream</a> object in OpenVidu Browser library to find out
* more * more
*/ */

2
openvidu-java-client/src/main/java/io/openvidu/java/client/Session.java
View File

@ -474,7 +474,7 @@ public class Session {
* <br> * <br>
* *
* The affected client will trigger one <a href= * The affected client will trigger one <a href=
* "/en/stable/api/openvidu-browser/classes/connectionpropertychangedevent.html" * "/en/stable/api/openvidu-browser/classes/ConnectionPropertyChangedEvent.html"
* target="_blank">ConnectionPropertyChangedEvent</a> for each modified * target="_blank">ConnectionPropertyChangedEvent</a> for each modified
* property. * property.
* *

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

@ -34,7 +34,7 @@ export class Connection {
* Returns the status of the Connection. Can be: * Returns the status of the Connection. Can be:
* - `pending`: if the Connection is waiting for any user to use * - `pending`: if the Connection is waiting for any user to use
* its internal token to connect to the session, calling method * its internal token to connect to the session, calling method
* [Session.connect](https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/session.html#connect) * [Session.connect](https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Session.html#connect)
* in OpenVidu Browser. * in OpenVidu Browser.
* - `active`: if the internal token of the Connection has already * - `active`: if the internal token of the Connection has already
* been used by some user to connect to the session, and it cannot be used * been used by some user to connect to the session, and it cannot be used
@ -71,7 +71,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](/en/stable/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;
@ -82,7 +82,7 @@ export class Connection {
/** /**
* Token associated to the Connection. This is the value that must be sent to the client-side to be consumed in OpenVidu Browser * Token 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](https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/session.html#connect). * method [Session.connect](https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Session.html#connect).
*/ */
token: string; token: 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](/en/stable/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](/en/stable/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`](/en/stable/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](/en/stable/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](/en/stable/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](/en/stable/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](/en/stable/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](/en/stable/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](/en/stable/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](/en/stable/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;

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

@ -397,7 +397,7 @@ export class Session {
* This method automatically updates the properties of the local affected objects. This means that there is no need to call * 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. * [[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) * The affected client will trigger one [ConnectionPropertyChangedEvent](/en/stable/api/openvidu-browser/classes/ConnectionPropertyChangedEvent.html)
* for each modified property. * for each modified property.
* *
* @param connectionId The [[Connection.connectionId]] of the Connection object to modify * @param connectionId The [[Connection.connectionId]] of the Connection object to modify