Update public Player API to improve usability #53
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`buildQueryOnly()` lets us construct Player instances that we intend to use only for query purposes without having to provide a bogus ChromecastDevice just to satisfy the requirements to `build()`. The return type of this new method reflects that it does not have the ability to `play()` anything. In addition, we now provide `Player.buildUpon` to construct a new `PlayerBuilder` with the same starting params as the Player, facilitating a factory-like approach where you eg: reuse configured apps then `buildUpon().addDevice(...).build()` to play on a specified device per-request.
Calling `Builder.build()` twice should yield equivalent but unconnected Player instances—in other words, we should be able to call `build()`, subsequently `addDevice`, then `build()` again, and the two created Player instances should *not* have the same set of devices configured.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In particular:
PlayerBuilder.build()now return distinct Player instances; previously, the array of apps/devices were shared across all instances created by a singlePlayerBuilder. This is unexpected and bizarre behavior that no longer occurs.Playertype is now properly exported for use in client codePlayerBuilder.buildQueryOnly()can be used to ignore the requirement that Player instances must have at least one target Device attached, for when you don't care about playback.Player.buildUpon()andPlayerBuilder.clone()methods can be used to simplify factory use cases, where eg configured apps will be shared acrossPlayerinstances, but the target devices will change per request.