Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adding auto archive documentation #305

Merged
merged 3 commits into from
Jul 21, 2023
Merged

docs: adding auto archive documentation #305

merged 3 commits into from
Jul 21, 2023

Conversation

manchuck
Copy link
Contributor

What is this PR doing?

Adding new parameters for archive documentation in createSession

How should this be manually tested?

What are the relevant tickets?

@manchuck manchuck requested a review from jeffswartz May 22, 2023 15:28
@codecov
Copy link

codecov bot commented May 22, 2023

Codecov Report

Merging #305 (7e92e8e) into main (111be34) will not change coverage.
The diff coverage is 28.5%.

Impacted Files Coverage Δ
lib/render.js 21.6% <ø> (ø)
lib/opentok.js 76.7% <28.5%> (ø)

lib/opentok.js Outdated
Comment on lines 1844 to 1848
* <li><code>archiveName</code> (String) &mdash; Name of the archives in auto archived sessions</li>
*
* <li><code>archiveResolution</code> (Enum) &mdash; Resolution of the archives in
* auto archived sessions. Can be one of "480x640", "640x480", "720x1280", "1280x720", "1080x1920", "1920x1080">
* </li>
Copy link
Collaborator

@jeffswartz jeffswartz Jul 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* <li><code>archiveName</code> (String) &mdash; Name of the archives in auto archived sessions</li>
*
* <li><code>archiveResolution</code> (Enum) &mdash; Resolution of the archives in
* auto archived sessions. Can be one of "480x640", "640x480", "720x1280", "1280x720", "1080x1920", "1920x1080">
* </li>
* <li><code>archiveName</code> (String) &mdash; The name of the archives to be used in
* auto-archived sessions</li>
*
* <li><code>archiveResolution</code> (Enum) &mdash; The resolution of archives in an auto-archived session.
* Valid values are "480x640", "640x480", "720x1280", "1280x720", "1080x1920", and "1920x1080".
* </li>

@jeffswartz jeffswartz merged commit baa3f38 into main Jul 21, 2023
@manchuck manchuck deleted the auto-archive branch June 3, 2024 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants