getMediaInputStatus method

Future<MediaInputStatusResponse> getMediaInputStatus({
  1. String? inputName,
  2. String? inputUuid,
})

Gets the status of a media input.

Media States:

OBS_MEDIA_STATE_NONE OBS_MEDIA_STATE_PLAYING OBS_MEDIA_STATE_OPENING OBS_MEDIA_STATE_BUFFERING OBS_MEDIA_STATE_PAUSED OBS_MEDIA_STATE_STOPPED OBS_MEDIA_STATE_ENDED OBS_MEDIA_STATE_ERROR

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

Implementation

Future<MediaInputStatusResponse> getMediaInputStatus({
  String? inputName,
  String? inputUuid,
}) async {
  final response = await obsWebSocket.sendRequest(
    Request(
      'GetMediaInputStatus',
      requestData: {'inputName': inputName, 'inputUuid': inputUuid},
    ),
  );

  final mediaInputStatusResponse = MediaInputStatusResponse.fromJson(
    response!.responseData!,
  );

  return mediaInputStatusResponse;
}