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

feat(vMix): add vMix input layers props and commands #331

Merged
merged 2 commits into from
Jul 9, 2024

Conversation

ianshade
Copy link
Contributor

About the Contributor

This PR is opened on behalf of TV 2 Norge.

Type of Contribution

This is a:

Feature

Current Behavior

Layer properties that can be set through the API since vMix 27 are not supported.

New Behavior

Introduces layers property on TimelineContentVMixInput. Deprecates the overlays (still functional).
The following properties/commands are now supported:

  • panX - SetLayer[1...10]PanX
  • panY - SetLayer[1...10]PanY
  • zoom - SetLayer[1...10]Zoom
  • cropLeft, cropTop, cropRight, cropBottom - SetLayer[1...10]Crop

Testing Instructions

Other Information

Status

  • PR is ready to be reviewed.
  • The functionality has been tested by the author.
  • Relevant unit tests has been added / updated.
  • Relevant documentation (code comments, system documentation) has been added / updated.

@codecov-commenter
Copy link

codecov-commenter commented Jun 12, 2024

Codecov Report

Attention: Patch coverage is 83.33333% with 15 lines in your changes missing coverage. Please review.

Project coverage is 38.01%. Comparing base (c782645) to head (dc719c8).
Report is 5 commits behind head on master.

Files Patch % Lines
...line-state-resolver/src/integrations/vmix/index.ts 0.00% 6 Missing ⚠️
...-resolver/src/integrations/vmix/vMixStateDiffer.ts 80.64% 6 Missing ⚠️
...rc/integrations/vmix/vMixTimelineStateConverter.ts 50.00% 2 Missing ⚠️
...state-resolver/src/integrations/vmix/connection.ts 96.15% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #331      +/-   ##
==========================================
+ Coverage   37.58%   38.01%   +0.43%     
==========================================
  Files         106      106              
  Lines       10247    10309      +62     
  Branches     2452     2481      +29     
==========================================
+ Hits         3851     3919      +68     
+ Misses       6395     6389       -6     
  Partials        1        1              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jstarpl jstarpl requested a review from a team June 13, 2024 05:27
@@ -136,7 +138,7 @@ export class VMixTimelineStateConverter {
loop: content.loop,
position: content.seek,
transform: content.transform,
overlays: content.overlays,
layers: content.overlays ? this._convertDeprecatedInputOverlays(content.overlays) : content.layers,
Copy link
Contributor

Choose a reason for hiding this comment

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

If we are filling in both overlays and layers, it would be preferred to look at the layers property. The current behaviour is acceptable but should be documented as such.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I changed the behavior as suggested, and updated the code comment, so that there's no doubt

@mint-dewit mint-dewit changed the base branch from master to release51 July 9, 2024 10:51
@mint-dewit mint-dewit merged commit be3ee42 into nrkno:release51 Jul 9, 2024
15 of 18 checks passed
@ianshade ianshade deleted the contribute/EAV-269 branch July 9, 2024 10:59
@ianshade
Copy link
Contributor Author

@mint-dewit, after merging to release51, this doesn't seem to pass linting and test. Will you look into it, or shall I?

@mint-dewit
Copy link
Contributor

They should be OK now!

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