Skip to content

Commit 7ffda5e

Browse files
author
Manik Sachdeva
authored
Merge pull request #177 from msach22/readme-edits
Fixes #173
2 parents 9f5c714 + d8f4017 commit 7ffda5e

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -187,19 +187,22 @@ import com.opentok.Archive;
187187
import com.opentok.ArchiveProperties;
188188

189189
Archive archive = opentok.startArchive(sessionId, new ArchiveProperties.Builder()
190-
.archiveMode(Archive.OutputMode.INDIVIDUAL)
190+
.outputMode(Archive.OutputMode.INDIVIDUAL)
191191
.build()););
192192

193193
// Store this archiveId in the database for later use
194194
String archiveId = archive.getId();
195195
```
196196

197-
The `Archive.OutputMode.COMPOSED` setting (the default) causes all streams in the archive to be
198-
recorded to a single (composed) file.
197+
The `Archive.OutputMode.COMPOSED` option is the default value for `outputMode`. It archives all streams to be recorded to a single (composed) file.
198+
199+
You can only specify the `resolution` for composed archives using the `ArchiveProperties` builder. If you set the `resolution` property and also set the `outputMode` property to `Archive.OutputMode.INDIVIDUAL`, the method will throw an `InvalidArgumentException`.
200+
201+
The accepted values for `resolution` are:
202+
- `"640x480"` (SD, the default)
203+
- `"1280x720"` (HD)
204+
> Please note that setting any other value for the `resolution` property will result in an exception.
199205
200-
You can set the composed archive resolution to either "640x480" (SD, the default) or "1280x720" (HD) using the ArchiveProperties builder.
201-
Any other value will result in an exception.The property only applies to composed archives.
202-
If you set this property and also set the outputMode property to "individual", the method results in an `InvalidArgumentException`.
203206

204207
```java
205208
import com.opentok.ArchiveProperties;

0 commit comments

Comments
 (0)