Skip to content

New actions, renamed existing ones and descriptions for all#12

Merged
bryce-seifert merged 5 commits intobitfocus:mainfrom
qqquiu:main
Jul 24, 2023
Merged

New actions, renamed existing ones and descriptions for all#12
bryce-seifert merged 5 commits intobitfocus:mainfrom
qqquiu:main

Conversation

@qqquiu
Copy link
Contributor

@qqquiu qqquiu commented Jul 15, 2023

This PR focuses on reviewing, adding and updating API-available actions. It requires using version 23 or above of VDO.Ninja.

Testing

  • Tested on experimental version of Companion 3.99.0+6136
  • I don't have PowerPoint to fully test nextSlide and previousSlide

Reordered actions

Inside action.js they're ordered based on:

  1. Local actions
  2. Director actions that target self
  3. Director actions that target guests

Inside HELP.md they're listed on the same categories, but ordered more relevantly to the user or similarity-based.

Action IDs and "parameters"

The IDs remain unchanged as to avoid problems with current users of the module, however actions that manipulate groups should now accept an integer 1-8 only (previously accepted strings, too).
While the API seems to accept strings (similar to how scenes work) - I was not able to test this functionality with strings, I decided to force integers as per the API documentation, at least for now.

Action descriptions

All actions should now have a description mostly based on how the API describes the function, with minor changes to keep things simple and easy to read.

Renamed actions

General

Old name New name
Mic Control Local: Mic Control
Camera Control Local: Camera Control
Speaker Control Local: Speaker Control
Speaker Volume Local: Playback Volume
Send Chat Message Local: Send Chat Message
Record Local Video Local: Record Video
Reload Local: Reload
Hang Up Local: Hang Up
Set Bitrate Local: Set Video Bitrate
Set Panning Local: Set Audio Pan
Raise Hand Local: Raise Hand
Toggle Screen Share Local: Screen Share

Control Rooms

Old name New name
Room Guest: Mute/Unmute Guest Director: Guest Mic
Room Guest: Deafen/Undeafen Guest Director: Guest Speaker
Room Guest: Mic Volume Director: Set Guest Mic Volume
Room Guest: Hang Up Director: Hang Up Guest
Room Guest: Transfer Director: Transfer Guest
Room Guest: Add/Remove Group Director: Guest in Group
Room Guest: Add/Remove Scene Director: Guest in Scene
Room Guest: Mute Guest in Scene Director: Guest Mic in Scene
Room Guest: Blind/Un-Blind Guest Director: Guest Blind
Room Guest: Toggle Highlight Guest Director: Toggle Guest Highlight
Room Guest: Send Keyframe Director: Force Keyframe

New actions

Local

API function Name
forceKeyframe Local: Force Keyframe
nextSlide Local: Next Slide
previousSlide Local: Previous Slide

Director

Targets self (starts after forceKeyframe)
API function Name
group Director: Self in Group
joinGroup Director: Join Group
leaveGroup Director: Leave Group
viewGroup Director: View Group
joinViewGroup Director: Join View Group
leaveViewGroup Director: Leave View Group
soloVideo Director: Toggle Highlight Video
Targets room guest
API function Name
soloChat Director: Solo Talk
soloChatBidirectional Director: Two-way Solo Talk

Future plans

I intend to implement feedbacks (higher priority) and presets (lower priority) based on the new functionality.

@bryce-seifert
Copy link
Member

@qqquiu Just tested these actions, and all looks good.

Would you be able to run yarn format to lint the code, and then commit that. Then it will be good to merge! Thank you!

@qqquiu
Copy link
Contributor Author

qqquiu commented Jul 24, 2023

@qqquiu Just tested these actions, and all looks good.

Would you be able to run yarn format to lint the code, and then commit that. Then it will be good to merge! Thank you!

It should be good to go now.

@bryce-seifert bryce-seifert merged commit c16a7cc into bitfocus:main Jul 24, 2023
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.

2 participants