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

Standardize method names #302

Merged
merged 8 commits into from
Sep 22, 2021
Merged

Standardize method names #302

merged 8 commits into from
Sep 22, 2021

Conversation

framini
Copy link
Contributor

@framini framini commented Sep 21, 2021

The code in this changeset includes setInputVolume and setOutputVolume as future replacements for setMicrophoneVolume and setSpeakerVolume respectively.

@changeset-bot
Copy link

changeset-bot bot commented Sep 21, 2021

🦋 Changeset detected

Latest commit: 14047b2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
Name Type
@signalwire/core Patch
@signalwire/js Patch
@signalwire/realtime-api Patch
@signalwire/react-native Patch
@signalwire/web-api Patch
@signalwire/webrtc Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@framini framini changed the title WIP: Standardize method names Standardize method names Sep 22, 2021
@framini
Copy link
Contributor Author

framini commented Sep 22, 2021

@danieleds Adding you as a reviewer to double check the docs are still ok.

@framini framini requested a review from danieleds September 22, 2021 06:59
edolix
edolix previously approved these changes Sep 22, 2021
Copy link
Contributor

@edolix edolix left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@danieleds danieleds left a comment

Choose a reason for hiding this comment

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

@framini I have left a few comments

* **room.ended**<br>
* **room.started**,<br>
* **room.updated**,<br>
* **room.ended**<br>
* Emitted when the room session is, respectively, started, updated, or ended.
Copy link
Contributor

Choose a reason for hiding this comment

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

@framini these eol spaces were needed for intellisense, which otherwise puts everything on the same line. For readme instead, we need the <br>

Copy link
Contributor

Choose a reason for hiding this comment

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

all other eol spaces which are not preceded by a <br> are fine to be removed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's Prettier in action 🤔

setMicrophoneVolume(params: { volume: number }): Rooms.SetInputVolumeMember

/**
* Sets the input level for the member.
Copy link
Contributor

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 real quick? e.g.

Sets the input volume for the member (e.g., the microphone input level).


/**
* Sets the speaker output level.
* Sets the output level.
Copy link
Contributor

@danieleds danieleds Sep 22, 2021

Choose a reason for hiding this comment

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

same as above, this could be

Sets the output volume for the member (e.g., the speaker output level).

}): Promise<void>

/**
* Sets the input level for a given member.
Copy link
Contributor

Choose a reason for hiding this comment

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

could you add the same change as above?

setSpeakerVolume(params: { memberId: string; volume: number }): Promise<void>

/**
* Sets the output level.
Copy link
Contributor

Choose a reason for hiding this comment

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

same as above

@framini framini merged commit 2ac7f6d into main Sep 22, 2021
@framini framini deleted the fr/standarize-method-names branch September 22, 2021 10:51
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.

3 participants