From 8538327940adb6af90749817b52744eb82cbd586 Mon Sep 17 00:00:00 2001 From: pabloFuente Date: Thu, 2 Jul 2020 12:16:13 +0200 Subject: [PATCH] OpenVidu SDKs docs updated with COMPOSED_QUICK_START --- .../io/openvidu/java/client/Recording.java | 2 +- .../java/client/RecordingProperties.java | 18 ++++++++++++------ .../java/client/SessionProperties.java | 12 ++++++++---- .../src/RecordingProperties.ts | 7 ++++--- 4 files changed, 25 insertions(+), 14 deletions(-) diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/Recording.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/Recording.java index 84f8500f..305201c6 100644 --- a/openvidu-java-client/src/main/java/io/openvidu/java/client/Recording.java +++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/Recording.java @@ -230,7 +230,7 @@ public class Recording { /** * Resolution of the video file. Only defined if OutputMode of the Recording is - * set to {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} + * set to {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} or {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED_QUICK_START} */ public String getResolution() { return this.recordingProperties.resolution(); 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 d280b13a..47f526ae 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 @@ -87,7 +87,8 @@ public class RecordingProperties { * 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 io.openvidu.java.client.Recording.OutputMode#COMPOSED} or + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED_QUICK_START} */ public RecordingProperties.Builder recordingLayout(RecordingLayout layout) { this.recordingLayout = layout; @@ -103,7 +104,8 @@ 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 io.openvidu.java.client.Recording.OutputMode#COMPOSED} or + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED_QUICK_START}.
* See Custom recording layouts to learn more */ @@ -119,7 +121,8 @@ 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}. For + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} or + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED_QUICK_START}. For * {@link io.openvidu.java.client.Recording.OutputMode#INDIVIDUAL} all * individual video files will have the native resolution of the published * stream @@ -181,7 +184,8 @@ public class RecordingProperties { } /** - * Defines the mode of recording: {@link Recording.OutputMode#COMPOSED} for a + * Defines the mode of recording: {@link Recording.OutputMode#COMPOSED} or + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED_QUICK_START} for a * single archive in a grid layout or {@link Recording.OutputMode#INDIVIDUAL} * for one archive for each stream.
*
@@ -196,7 +200,8 @@ public class RecordingProperties { * Defines the layout to be used in the recording.
* Will only have effect if * {@link io.openvidu.java.client.RecordingProperties.Builder#outputMode(Recording.OutputMode)} - * has been called with value {@link Recording.OutputMode#COMPOSED}.
+ * has been called with value {@link Recording.OutputMode#COMPOSED} or + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED_QUICK_START}.
*
* * Default to {@link RecordingLayout#BEST_FIT} @@ -221,7 +226,8 @@ 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}. For + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} or + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED_QUICK_START}. For * {@link io.openvidu.java.client.Recording.OutputMode#INDIVIDUAL} all * individual video files will have the native resolution of the published * stream.
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 cd4093be..8f436721 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 @@ -99,7 +99,8 @@ public class SessionProperties { * Default value is {@link RecordingLayout#BEST_FIT}
*
* Recording layouts are only applicable to recordings with OutputMode - * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} or + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED_QUICK_START} */ public SessionProperties.Builder defaultRecordingLayout(RecordingLayout layout) { this.defaultRecordingLayout = layout; @@ -116,7 +117,8 @@ public class SessionProperties { *
* * 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} (or + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED_QUICK_START}) and * RecordingLayout {@link io.openvidu.java.client.RecordingLayout#CUSTOM} */ public SessionProperties.Builder defaultCustomLayout(String path) { @@ -195,7 +197,8 @@ public class SessionProperties { * {@link io.openvidu.java.client.RecordingProperties.Builder#recordingLayout(RecordingLayout)} * with any other value.
* Recording layouts are only applicable to recordings with OutputMode - * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED} or + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED_QUICK_START} */ public RecordingLayout defaultRecordingLayout() { return this.defaultRecordingLayout; @@ -209,7 +212,8 @@ public class SessionProperties { * {@link io.openvidu.java.client.RecordingProperties.Builder#customLayout(String)} * with any other value.
* 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} (or + * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED_QUICK_START}) and * RecordingLayout {@link io.openvidu.java.client.RecordingLayout#CUSTOM} */ public String defaultCustomLayout() { diff --git a/openvidu-node-client/src/RecordingProperties.ts b/openvidu-node-client/src/RecordingProperties.ts index 7b935485..585b53c0 100644 --- a/openvidu-node-client/src/RecordingProperties.ts +++ b/openvidu-node-client/src/RecordingProperties.ts @@ -37,13 +37,13 @@ export interface RecordingProperties { /** * The layout to be used in the recording.
- * Will only have effect if [[RecordingProperties.outputMode]] is `COMPOSED` + * Will only have effect if [[RecordingProperties.outputMode]] is `COMPOSED` or `COMPOSED_QUICK_START` */ recordingLayout?: RecordingLayout; /** * The relative path to the specific custom layout you want to use.
- * Will only have effect if [[RecordingProperties.outputMode]] is `COMPOSED` and [[RecordingProperties.recordingLayout]] is `CUSTOM`
+ * Will only have effect if [[RecordingProperties.outputMode]] is `COMPOSED` (or `COMPOSED_QUICK_START`) and [[RecordingProperties.recordingLayout]] is `CUSTOM`
* See [Custom recording layouts](/en/stable/advanced-features/recording#custom-recording-layouts) to learn more */ customLayout?: string; @@ -52,7 +52,8 @@ export interface RecordingProperties { * Recording video file resolution. Must be a string with format "WIDTHxHEIGHT", * 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]]. For [[Recording.OutputMode.INDIVIDUAL]] all + * is set to [[Recording.OutputMode.COMPOSED]] or [[Recording.OutputMode.COMPOSED_QUICK_START]]. + * For [[Recording.OutputMode.INDIVIDUAL]] all * individual video files will have the native resolution of the published stream */ resolution?: string;