From 5c4441e59282b5adf5f4943da8efa459f67f8756 Mon Sep 17 00:00:00 2001 From: pabloFuente Date: Fri, 1 Feb 2019 14:11:32 +0100 Subject: [PATCH] openvidu-java-client: JavaDoc update --- .../openvidu/java/client/KurentoOptions.java | 4 ++- .../java/client/RecordingProperties.java | 28 ++++++++++++++----- .../java/client/SessionProperties.java | 3 +- 3 files changed, 26 insertions(+), 9 deletions(-) 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 d8fec7ac..9f586d9f 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 @@ -165,7 +165,9 @@ public class KurentoOptions { /** * Defines the names of the filters the user owning the token will be able to - * apply. See Voice and video filters + * apply. See + * Voice and video filters */ public String[] getAllowedFilters() { return allowedFilters; 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 c89c490b..4096b085 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 @@ -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) { 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) { this.hasVideo = hasVideo; @@ -163,7 +165,9 @@ public class RecordingProperties { /** * Defines the mode of recording: {@link Recording.OutputMode#COMPOSED} for a * single archive in a grid layout or {@link Recording.OutputMode#INDIVIDUAL} - * for one archive for each stream + * for one archive for each stream.

+ * + * Default to {@link Recording.OutputMode#COMPOSED} */ public Recording.OutputMode outputMode() { return this.outputMode; @@ -174,7 +178,9 @@ public class RecordingProperties { * Will only have effect if * {@link io.openvidu.java.client.RecordingProperties.Builder#outputMode(Recording.OutputMode)} * has been called with value - * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} + * {@link Recording.OutputMode#COMPOSED}.

+ * + * Default to {@link RecordingLayout#BEST_FIT} */ public RecordingLayout 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#INDIVIDUAL} all * individual video files will have the native resolution of the published - * stream + * stream.

+ * + * Default to "1920x1080" */ public String 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()}.

+ * + * Default to true */ public boolean 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()}.

+ * + * Default to true */ public boolean hasVideo() { return this.hasVideo; 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 83f2358a..8949890a 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 @@ -112,7 +112,8 @@ public class SessionProperties { * recording of this session. You can easily override this value later when * starting a {@link io.openvidu.java.client.Recording} by calling * {@link io.openvidu.java.client.RecordingProperties.Builder#customLayout(String)} - * with any other value.

+ * with any other value.
+ *
* * Custom layouts are only applicable to recordings with OutputMode * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} and