triggerMediaInputAction method

Future<void> triggerMediaInputAction({
  1. String? inputName,
  2. String? inputUuid,
  3. required ObsMediaInputAction mediaAction,
})

Triggers an action on a media input.

  • Complexity Rating: 2/5
  • Latest Supported RPC Version: 1
  • Added in v5.0.0 Request Fields:
Name Type Description Value Restrictions ?Default Behavior
inputName String Name of the media input None Unknown
inputUuid String UUID of the media input None Unknown
mediaAction String String Identifier of the ObsMediaInputAction enum None N/A

Implementation

Future<void> triggerMediaInputAction({
  String? inputName,
  String? inputUuid,
  required ObsMediaInputAction mediaAction,
}) async => await obsWebSocket.sendRequest(
  Request(
    'TriggerMediaInputAction',
    requestData: {
      'inputName': inputName,
      'inputUuid': inputUuid,
      'mediaAction': mediaAction.code,
    },
  ),
);