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

openvidu-java-client: JavaDoc update

pull/203/head
pabloFuente 2019-02-01 14:11:32 +01:00
parent d884555cbd
commit 5c4441e592
3 changed files with 26 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
openvidu-java-client/src/main/java/io/openvidu/java/client/KurentoOptions.java
View File

@ -165,7 +165,9 @@ public class KurentoOptions {
/** /**
* Defines the names of the filters the user owning the token will be able to * Defines the names of the filters the user owning the token will be able to
* apply. See <a href="https://openvidu.io/docs/advanced-features/filters/" target="_blank">Voice and video filters</a> * apply. See
* <a href="https://openvidu.io/docs/advanced-features/filters/" target=
* "_blank">Voice and video filters</a>
*/ */
public String[] getAllowedFilters() { public String[] getAllowedFilters() {
return allowedFilters; return allowedFilters;

28
openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingProperties.java
View File

@ -123,7 +123,8 @@ public class RecordingProperties {
} }
/** /**
* Call this method to specify whether to record audio or not. Cannot be set to false at the same time as {@link hasVideo(boolean)} * Call this method to specify whether to record audio or not. Cannot be set to
* false at the same time as {@link hasVideo(boolean)}
*/ */
public RecordingProperties.Builder hasAudio(boolean hasAudio) { public RecordingProperties.Builder hasAudio(boolean hasAudio) {
this.hasAudio = hasAudio; this.hasAudio = hasAudio;
@ -131,7 +132,8 @@ public class RecordingProperties {
} }
/** /**
* Call this method to specify whether to record video or not. Cannot be set to false at the same time as {@link hasAudio(boolean)} * Call this method to specify whether to record video or not. Cannot be set to
* false at the same time as {@link hasAudio(boolean)}
*/ */
public RecordingProperties.Builder hasVideo(boolean hasVideo) { public RecordingProperties.Builder hasVideo(boolean hasVideo) {
this.hasVideo = hasVideo; this.hasVideo = hasVideo;
@ -163,7 +165,9 @@ public class RecordingProperties {
/** /**
* Defines the mode of recording: {@link Recording.OutputMode#COMPOSED} for a * Defines the mode of recording: {@link Recording.OutputMode#COMPOSED} for a
* single archive in a grid layout or {@link Recording.OutputMode#INDIVIDUAL} * single archive in a grid layout or {@link Recording.OutputMode#INDIVIDUAL}
* for one archive for each stream * for one archive for each stream.<br><br>
*
* Default to {@link Recording.OutputMode#COMPOSED}
*/ */
public Recording.OutputMode outputMode() { public Recording.OutputMode outputMode() {
return this.outputMode; return this.outputMode;
@ -174,7 +178,9 @@ public class RecordingProperties {
* Will only have effect if * Will only have effect if
* {@link io.openvidu.java.client.RecordingProperties.Builder#outputMode(Recording.OutputMode)} * {@link io.openvidu.java.client.RecordingProperties.Builder#outputMode(Recording.OutputMode)}
* has been called with value * has been called with value
* {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} * {@link Recording.OutputMode#COMPOSED}.<br><br>
*
* Default to {@link RecordingLayout#BEST_FIT}
*/ */
public RecordingLayout recordingLayout() { public RecordingLayout recordingLayout() {
return this.recordingLayout; return this.recordingLayout;
@ -200,21 +206,29 @@ public class RecordingProperties {
* {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED}. For * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED}. For
* {@link io.openvidu.java.client.Recording.OutputMode#INDIVIDUAL} all * {@link io.openvidu.java.client.Recording.OutputMode#INDIVIDUAL} all
* individual video files will have the native resolution of the published * individual video files will have the native resolution of the published
* stream * stream.<br><br>
*
* Default to "1920x1080"
*/ */
public String resolution() { public String resolution() {
return this.resolution; return this.resolution;
} }
/** /**
* Defines whether to record audio or not. Cannot be set to false at the same time as {@link hasVideo()} * Defines whether to record audio or not. Cannot be set to false at the same
* time as {@link hasVideo()}.<br><br>
*
* Default to true
*/ */
public boolean hasAudio() { public boolean hasAudio() {
return this.hasAudio; return this.hasAudio;
} }
/** /**
* Defines whether to record video or not. Cannot be set to false at the same time as {@link hasAudio()} * Defines whether to record video or not. Cannot be set to false at the same
* time as {@link hasAudio()}.<br><br>
*
* Default to true
*/ */
public boolean hasVideo() { public boolean hasVideo() {
return this.hasVideo; return this.hasVideo;

3
openvidu-java-client/src/main/java/io/openvidu/java/client/SessionProperties.java
View File

@ -112,7 +112,8 @@ public class SessionProperties {
* recording of this session. You can easily override this value later when * recording of this session. You can easily override this value later when
* starting a {@link io.openvidu.java.client.Recording} by calling * starting a {@link io.openvidu.java.client.Recording} by calling
* {@link io.openvidu.java.client.RecordingProperties.Builder#customLayout(String)} * {@link io.openvidu.java.client.RecordingProperties.Builder#customLayout(String)}
* with any other value.<br><br> * with any other value.<br>
* <br>
* *
* Custom layouts are only applicable to recordings with OutputMode * Custom layouts are only applicable to recordings with OutputMode
* {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} and * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} and