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

Updated library documentations to support new docs.openvidu.io

pull/431/head
pabloFuente 2020-04-03 18:26:27 +02:00
parent eb87f3c9a2
commit a57defe69a
7 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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):
* - `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](api/openvidu-browser/classes/streammanagerevent.html) feature
*
* 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](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.
*

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

@ -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](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)
*

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

@ -118,7 +118,7 @@ public class Connection {
/**
* Returns the data associated to the connection on the client-side. This value
* is set with second parameter of method <a href=
* "https://openvidu.io/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
*/
public String getClientData() {

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>
* This is a backend representation of a published media stream (see
* <a href="/api/openvidu-browser/classes/stream.html" target="_blank"> OpenVidu
* <a href="api/openvidu-browser/classes/stream.html" target="_blank"> OpenVidu
* Browser Stream class</a>).
*/
public class Publisher {
@ -65,10 +65,10 @@ public class Publisher {
/**
* Returns the unique identifier of the
* <a href="/api/openvidu-browser/classes/stream.html" target=
* <a href="api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> associated to this Publisher. Each Publisher is paired
* with only one Stream, so you can identify each Publisher by its
* <a href="/api/openvidu-browser/classes/stream.html#streamid" target=
* <a href="api/openvidu-browser/classes/stream.html#streamid" target=
* "_blank"><code>Stream.streamId</code></a>
*/
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="api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/
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="api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/
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="api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/
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="api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/
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="api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/
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="api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/
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="api/openvidu-browser/classes/stream.html" target=
* "_blank">Stream</a> object in OpenVidu Browser library to find out more
*/
public String getVideoDimensions() {

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
* [Session.connect](/api/openvidu-browser/classes/session.html#connect) in OpenVidu Browser
* [Session.connect](api/openvidu-browser/classes/session.html#connect) in OpenVidu Browser
*/
clientData: string;

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

@ -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](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](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`](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](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](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](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](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](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](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](api/openvidu-browser/classes/stream.html) object in OpenVidu Browser library to find out more
*/
videoDimensions: string;