OpenVidu SDKs COMPOSED_QUICK_START doc description

pull/508/head
pabloFuente 2020-07-01 17:38:01 +02:00
parent 11540fb50a
commit b58250b64f
2 changed files with 36 additions and 7 deletions

View File

@ -77,9 +77,26 @@ public class Recording {
INDIVIDUAL,
/**
* EXPERIMENTAL
* This option is intended to keep a recorder session openned for
* incoming recording requests to be recorded as fast as possible
* Works the same way as COMPOSED mode, but the necessary recorder
* service module will start some time in advance and won't be terminated
* once a specific session recording has ended. This module will remain
* up and running as long as the session remains active.<br><br>
*
* <ul>
* <li>
* <strong>Pros vs COMPOSED</strong>: the process of starting the recording will be noticeably
* faster. This can be very useful in use cases where a session needs to be
* recorded multiple times over time, when a better response time is usually
* desirable.
* </li>
* <li>
* <strong>Cons vs COMPOSED</strong>: for every session initialized with COMPOSED_QUICK_START
* recording output mode, extra CPU power will be required in OpenVidu Server.
* The recording module will be continuously rendering all of the streams being
* published to the session even when the session is not being recorded. And that
* is for every session configured with COMPOSED_QUICK_START.
* </li>
* </ul>
*/
COMPOSED_QUICK_START;
}

View File

@ -142,10 +142,22 @@ export namespace Recording {
*/
COMPOSED = 'COMPOSED',
/**
* EXPERIMENTAL
* This option is intended to keep a recorder session openned for
* incoming recording requests to be recorded as fast as possible
/**
* Works the same way as COMPOSED mode, but the necessary recorder
* service module will start some time in advance and won't be terminated
* once a specific session recording has ended. This module will remain
* up and running as long as the session remains active.
*
* - **Pros vs COMPOSED**: the process of starting the recording will be noticeably
* faster. This can be very useful in use cases where a session needs to be
* recorded multiple times over time, when a better response time is usually
* desirable.
* - **Cons vs COMPOSED**: for every session initialized with COMPOSED_QUICK_START
* recording output mode, extra CPU power will be required in OpenVidu Server.
* The recording module will be continuously rendering all of the streams being
* published to the session even when the session is not being recorded. And that
* is for every session configured with COMPOSED_QUICK_START.
*/
COMPOSED_QUICK_START = 'COMPOSED_QUICK_START',