Skip to content

Permite a dispositivos MIDI interactuar con OBS Studio.

License

Notifications You must be signed in to change notification settings

isaiaslafon/obs-midi-mg-es

 
 

Repository files navigation

obs-midi-mg

Permite a Dispositivos MIDI interactuar con OBS Studio.

El plugin requiere versiones de OBS Studios iguales o superiores a la 28.0.0 dado el uso de Qt 6, usuarios con sistemas operativos por debajo de Windows 10 o MacOS 10.15 no podrán usarlo.

(Esto podrá ser solucionado a una versión posterior)

CodeFactor

Descripción

Conecta Dispositivos MIDI e integralo sin problemas con OBS Studios! El plugin ofrece:

  • Fácil Easy setup/preparación
  • Fácil navegación
  • Muchas opciones de customización
  • Cross-platform

Instalación

Vé a Releases page y descarga e instala el último lanzamiento para el sistema operativo acorde. Listo!

Uso

Para configurar //--------TRANSLATION---------IN PROGRESS!------------ To set up bindings, open OBS Studio and open the setup window under Tools > obs-midi-mg Setup. The setup window should appear.

If any MIDI devices are connected, they should appear in the Devices display on the left.

A device must be chosen as an active device in order to receive messages. To do this, select the Set As Active Device option in the device's status tab. Only one device can be active at a time.

To access the bindings display, select the device to use for interacting with OBS Studio, and click View Bindings in the bottom right.

//-----------------

Bindings

To add a binding, click the Add button in the bottom left. A new binding will appear in the Bindings display for the selected device.

To rename the binding, double-click the binding and type to change the name. To remove the binding (if needed), select the binding and click Remove in the bottom left.

To use a binding, messages and actions must be added. To add messages and actions, click View Messages and View Actions respectively.

Messages

To add a message, click the Add button in the bottom left. A new message will appear in the Messages display for the selected binding.

To rename the message, double-click the message and type to change the name. To remove the message (if needed), select the message and click Remove in the bottom left.

To edit the message, select the message in the Messages display, and the editor will appear on the right.

Adjust the values as necessary for the message. By default, the value/velocity option is Off for the use of its value in executing actions. If you wish to make the value required for executing an action, click the Require Value button in the bottom right, and it will switch to a number. Clicking the button again will revert it to the Off state.

A message can be provided by the device. This can be done by selecting the Listen to Message button and sending the message to the plugin. It will automatically fill in the message values for you. Make sure to click Cancel when finished.

Note: You can use multiple messages in a binding by adding more messages. If this is desired, the behavior of the binding may not be appropriate. See Reception Methods for more details.

Actions

To add an action, click the Add button in the bottom left. A new message will appear in the Actions display for the selected binding.

To rename the action, double-click the action and type to change the name. To remove the action (if needed), select the action and click Remove in the bottom left.

To edit the action, select the action in the Actions display, and the editor will appear on the right.

Adjust the values as necessary for the action(s) in this binding. Settings will appear as the form is filled out. To use a value from a message, either click the label for the number fields, or select Use Message Value in the selection fields.

Note: You can use multiple actions in a binding by adding more actions. If this is desired, the behavior of the binding may not be appropriate. See Reception Methods for more details.

Reception Methods

When selecting a binding, a selection field will appear displaying the reception method. Each method changes how actions are executed, and which messages will be sent as values to each action. In all methods, messages will be evaluated before actions, and all actions will execute after the final message is received.

  • Consecutive: In this mode, actions can only use the final message as a value. This is the default method, and should be used in most cases.
  • Correspondence: In this mode, actions can use the corresponding message as their value.
    • Example: There are five messages and five actions in a binding. When all five messages have been heard, the first message received will be sent as a parameter to the first action, the second message to the second action, and so on.
  • Multiply: In this mode, actions receive all previous messages as values. Only use this mode for multiple messages and singular actions as this may take a long time.
    • Example: There are five messages before five actions. When all five messages have been heard, the first action receives all five messages as parameters (in order), then the second action receives all five messages, and so on.

Message Toggling

A binding can now be set up so that it is easily able to toggle an action, without the need for extra bindings. Message toggling changes how messages are received by changing them before the next message.

  • Off: Message toggling is disabled, and messages will not change. An unlimited amount of messages can be used.
  • Note Type: Messages will change based on type. Note On and Note Off messages will switch to the other. Only one message can be used in this mode, and nothing will happen if the message is not a Note On or Note Off message.
  • Velocity: Messages will change based on velocity. Velocities will switch between 127 and 0. Only one message can be used in this mode, and nothing will happen if the initial velocity is not set to 127 or 0.
  • Note Type and Velocity: Messages will change based on both message type and velocity. Note On and Note Off messages will switch to the other, and velocities will switch between 127 and 0. The same restrictions apply as above.

Returning to a Previous Menu

To return to the menu before the current menu, click the Return button in the bottom left. The Messages and Actions menus will return to the Bindings menu, and the Bindings menu will return to the Devices menu.

Help

If something needs explanation in the plugin, click the Help button located to the right of the Preferences button. If more help is needed, feel free to look at this page by clicking the Help button in the Preferences menu, or post a thought on the OBS forum.

Preferences

To adjust other settings, click the Preferences button in the bottom left. Bindings can be exported, imported and transferred here, and the whole plugin can be turned off here as well.

Future Content

The coming updates will hopefully introduce these new features:

  • MIDI Output device support - send a message when an event in OBS Studio occurs (well underway!)

Feedback

I would love to hear honestly from you about this plugin. Feel free to share some ideas and don't be afraid to report an issue!

Click here to go to the Issues Page.

Credits

I have to give a shoutout to @cpyarger and @Alzy for the inspiration of this plugin. Many ideas found in obs-midi-mg can be found in their plugin. Without obs-midi, obs-midi-mg would have never been possible.

About

Permite a dispositivos MIDI interactuar con OBS Studio.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 83.6%
  • CMake 16.4%