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.

Sign up for GitHub

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

Jump to bottom

Deprecate mediaRecorderOptions #251 #268

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Deprecate mediaRecorderOptions #251 #268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/movie/movie.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,8 @@ export class Movie {
* @param [options.type='video/webm'] - MIME type for exported video
* @param [options.onStart] - Called when the recording starts
* @return Resolves when done recording, rejects when media recorder errors
* @deprecated Use individual options instead of mediaRecorderOptions.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you add an example of which individual options we're referring to (for users)? Something like

Use individual options (such as `type`) instead.

Copy link
Collaborator

Choose a reason for hiding this comment

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

It looks like @deprecated only applies to the entire function (https://stackoverflow.com/a/42457901/3783155). To only deprecate mediaRecorderOptions, you may need to add a docstring with @deprecated to mediaRecorderOptions in the options type definition below.

*
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please remove this blank line

*/
// TODO: Improve recording performance to increase frame rate
async record (options: {
Expand Down