mirror of https://github.com/OpenVidu/openvidu.git
openvidu server SDKs: docs fix
parent
5c4441e592
commit
3fc14fb58f
|
@ -169,8 +169,14 @@ public class OpenVidu {
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li><code>404</code>: no session exists
|
* <li><code>404</code>: no session exists
|
||||||
* for the passed <i>sessionId</i></li>
|
* for the passed <i>sessionId</i></li>
|
||||||
* <li><code>400</code>: the session has no
|
* <li><code>406</code>: the session has no
|
||||||
* connected participants</li>
|
* connected participants</li>
|
||||||
|
* <li><code>422</code>: "resolution"
|
||||||
|
* parameter exceeds acceptable values (for
|
||||||
|
* both width and height, min 100px and max
|
||||||
|
* 1999px) or trying to start a recording
|
||||||
|
* with both "hasAudio" and "hasVideo" to
|
||||||
|
* false</li>
|
||||||
* <li><code>409</code>: the session is not
|
* <li><code>409</code>: the session is not
|
||||||
* configured for using
|
* configured for using
|
||||||
* {@link io.openvidu.java.client.MediaMode#ROUTED}
|
* {@link io.openvidu.java.client.MediaMode#ROUTED}
|
||||||
|
|
|
@ -108,8 +108,10 @@ public class RecordingProperties {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Call this method to specify the recording resolution. Will only have effect
|
* Call this method to specify the recording resolution. Must be a string with
|
||||||
* if
|
* format "WIDTHxHEIGHT", being both WIDTH and HEIGHT the number of pixels
|
||||||
|
* between 100 and 1999.<br>
|
||||||
|
* 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}. For
|
* {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED}. For
|
||||||
|
@ -165,7 +167,8 @@ 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.<br><br>
|
* for one archive for each stream.<br>
|
||||||
|
* <br>
|
||||||
*
|
*
|
||||||
* Default to {@link Recording.OutputMode#COMPOSED}
|
* Default to {@link Recording.OutputMode#COMPOSED}
|
||||||
*/
|
*/
|
||||||
|
@ -177,8 +180,8 @@ public class RecordingProperties {
|
||||||
* Defines the layout to be used in the recording.<br>
|
* Defines the layout to be used in the recording.<br>
|
||||||
* 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 Recording.OutputMode#COMPOSED}.<br>
|
||||||
* {@link Recording.OutputMode#COMPOSED}.<br><br>
|
* <br>
|
||||||
*
|
*
|
||||||
* Default to {@link RecordingLayout#BEST_FIT}
|
* Default to {@link RecordingLayout#BEST_FIT}
|
||||||
*/
|
*/
|
||||||
|
@ -206,7 +209,8 @@ 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.<br><br>
|
* stream.<br>
|
||||||
|
* <br>
|
||||||
*
|
*
|
||||||
* Default to "1920x1080"
|
* Default to "1920x1080"
|
||||||
*/
|
*/
|
||||||
|
@ -216,7 +220,8 @@ public class RecordingProperties {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Defines whether to record audio or not. Cannot be set to false at the same
|
* Defines whether to record audio or not. Cannot be set to false at the same
|
||||||
* time as {@link hasVideo()}.<br><br>
|
* time as {@link hasVideo()}.<br>
|
||||||
|
* <br>
|
||||||
*
|
*
|
||||||
* Default to true
|
* Default to true
|
||||||
*/
|
*/
|
||||||
|
@ -226,7 +231,8 @@ public class RecordingProperties {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Defines whether to record video or not. Cannot be set to false at the same
|
* Defines whether to record video or not. Cannot be set to false at the same
|
||||||
* time as {@link hasAudio()}.<br><br>
|
* time as {@link hasAudio()}.<br>
|
||||||
|
* <br>
|
||||||
*
|
*
|
||||||
* Default to true
|
* Default to true
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -126,9 +126,12 @@ export class OpenVidu {
|
||||||
* @param sessionId The `sessionId` of the [[Session]] you want to start recording
|
* @param sessionId The `sessionId` of the [[Session]] you want to start recording
|
||||||
* @param name The name you want to give to the video file. You can access this same value in your clients on recording events (`recordingStarted`, `recordingStopped`)
|
* @param name The name you want to give to the video file. You can access this same value in your clients on recording events (`recordingStarted`, `recordingStopped`)
|
||||||
*
|
*
|
||||||
* @returns A Promise that is resolved to the [[Recording]] if it successfully started (the recording can be stopped with guarantees) and rejected with an Error object if not. This Error object has as `message` property with the following values:
|
* @returns A Promise that is resolved to the [[Recording]] if it successfully started (the recording can be stopped with guarantees) and rejected with an Error
|
||||||
|
* object if not. This Error object has as `message` property with the following values:
|
||||||
* - `404`: no session exists for the passed `sessionId`
|
* - `404`: no session exists for the passed `sessionId`
|
||||||
* - `400`: the session has no connected participants
|
* - `406`: the session has no connected participants
|
||||||
|
* - `422`: when passing [[RecordingProperties]], `resolution` parameter exceeds acceptable values (for both width and height, min 100px and max 1999px) or trying
|
||||||
|
* to start a recording with both `hasAudio` and `hasVideo` to false
|
||||||
* - `409`: the session is not configured for using [[MediaMode.ROUTED]] or it is already being recorded
|
* - `409`: the session is not configured for using [[MediaMode.ROUTED]] or it is already being recorded
|
||||||
* - `501`: OpenVidu Server recording module is disabled (`openvidu.recording` property set to `false`)
|
* - `501`: OpenVidu Server recording module is disabled (`openvidu.recording` property set to `false`)
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -49,7 +49,8 @@ export interface RecordingProperties {
|
||||||
customLayout?: string;
|
customLayout?: string;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Recording video file resolution.<br>
|
* Recording video file resolution. Must be a string with format "WIDTHxHEIGHT",
|
||||||
|
* being both WIDTH and HEIGHT the number of pixels between 100 and 1999.<br>
|
||||||
* Will only have effect if [[RecordingProperties.outputMode]]
|
* Will only have effect if [[RecordingProperties.outputMode]]
|
||||||
* is set to [[Recording.OutputMode.COMPOSED]]. For [[Recording.OutputMode.INDIVIDUAL]] all
|
* is set to [[Recording.OutputMode.COMPOSED]]. For [[Recording.OutputMode.INDIVIDUAL]] all
|
||||||
* individual video files will have the native resolution of the published stream
|
* individual video files will have the native resolution of the published stream
|
||||||
|
|
Loading…
Reference in New Issue