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

Rework how we handle Scenes #105

Open
mikeybanez opened this issue Jun 21, 2016 · 4 comments
Open

Rework how we handle Scenes #105

mikeybanez opened this issue Jun 21, 2016 · 4 comments

Comments

@mikeybanez
Copy link
Collaborator

We have a number of scene-related events in the pipeline (#98 for both add and remove), which will help a lot now that XSplit 2.8 has unlimited scenes.

However, this means we will have to revisit how we handle scenes. Currently we have two methods for fetching scenes:

  1. Scene.getByName: we've already handled duplicate scene names by returning an array
  2. Scene.getByIdAsync: this is very dependent on scene index under the hood. For a long time we haven't considered that index is fragile due to how users can simply reorder scenes. Now that adding and deleting scenes is available, index is now a larger source for bugs in scene-sensitive plugins.

Since 1.5.0 is a small release, I'm putting this into 1.6.0 for now. When 1.5.0 is released, let's revisit the requirements to do this. Here are some suggestions for improvement.

  • complete the set of scene events from XSplit core: add, remove, move/swap, rename (although the latter isn't relevant to the potential bugs above.)
  • let's confer with the core team and see if it is possible to have a unique identifier for scenes. Perhaps we can instead have some sort of Scene.getByUid for better tracking of a scene as users move them around.
@mikeybanez mikeybanez added this to the 1.6.0 milestone Jun 21, 2016
@virn virn modified the milestones: 2.2.0, 2.1.0 Jan 9, 2017
@virn virn modified the milestones: 2.2.0, 2.3.0 Feb 23, 2017
@mikeybanez
Copy link
Collaborator Author

Scene add and remove events were accomplished in a different issue, while rename/move events are not currently planned for the application. Therefore it seems that the only scene-related improvement we can do at the moment will be #142.

I'm removing this from 2.3.0.

@mikeybanez mikeybanez removed this from the 2.3.0 milestone May 26, 2017
@mikeybanez
Copy link
Collaborator Author

This issue involves scene rename/reorder events. With the upcoming #165 allowing for scene indexes, is it already possible for consumers to detect name/index changes on their own, @virn ? If not, then do we already have all necessary prerequisites to implement these events in xjs?

(Noting also that #97 is a feature request for rename events.)

@virn
Copy link
Contributor

virn commented Oct 3, 2017

It's still not possible to detect name/index changes, but I am watching CPPCORE-1048 for this. Which should then allow us to listen to these events.

@mikeybanez
Copy link
Collaborator Author

With the release of 2.7.0, the only remaining scene handling issue should be an index-change event (and a scene rename event: #97)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants