Class RequestBatchMessage

Namespace: OBSStudioClient.Messages

Assembly: OBSClient.dll

Class for a Request Batch Message

public sealed class RequestBatchMessage

Inheritance: object

RequestBatchMessage

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Creates a new instance of a RequestBatchMessage object.

Constructors

RequestBatchMessage(bool, RequestBatchExecutionType): Class for a Request Batch Message

Properties

HaltOnFailure: Whether to stop processing requests when a failure occurs.

RequestBatchExecutionType: The indication of how to process multiple requests in the batch.

RequestId: The identifier of the request.

Requests: The requests to execute in the batch.

Methods

AddBroadcastCustomEventRequest(JsonElement): Adds a BroadcastCustomEvent request to the batch.

AddCallVendorRequestRequest(string, string, JsonElement?): Adds a CallVendorRequest request to the batch.

AddCreateInputRequest(SceneRef, string, string, Dictionary<string, object>?, bool?, Guid?): Adds a CreateInput request to the batch.

AddCreateProfileRequest(string): Adds a CreateProfile request to the batch.

AddCreateRecordChapterRequest(string?): Adds a CreateRecordChapter request to the batch.

AddCreateSceneCollectionRequest(string): Adds a CreateSceneCollection request to the batch.

AddCreateSceneItemRequest(SceneRef, SourceRef, bool?, Guid?): Adds a CreateSceneItem request to the batch.

AddCreateSceneRequest(string, Guid?): Adds a CreateScene request to the batch.

AddCreateSourceFilterRequest(SourceRef, string, string, Dictionary<string, object>?, Guid?): Adds a CreateSourceFilter request to the batch.

AddDuplicateSceneItemRequest(SceneRef, int, SceneRef?, Guid?): Adds a DuplicateSceneItem request to the batch.

AddGetCanvasListRequest(): Adds a GetCanvasList request to the batch.

AddGetCurrentPreviewSceneRequest(): Adds a GetCurrentPreviewScene request to the batch.

AddGetCurrentProgramSceneRequest(): Adds a GetCurrentProgramScene request to the batch.

AddGetCurrentSceneTransitionCursorRequest(): Adds a GetCurrentSceneTransitionCursor request to the batch.

AddGetCurrentSceneTransitionRequest(): Adds a GetCurrentSceneTransition request to the batch.

AddGetGroupListRequest(): Adds a GetGroupList request to the batch.

AddGetGroupSceneItemListRequest(SceneRef, Guid?): Adds a GetGroupSceneItemList request to the batch.

AddGetHotkeyListRequest(): Adds a GetHotkeyList request to the batch.

AddGetInputAudioBalanceRequest(InputRef): Adds a GetInputAudioBalance request to the batch.

AddGetInputAudioMonitorTypeRequest(InputRef): Adds a GetInputAudioMonitorType request to the batch.

AddGetInputAudioSyncOffsetRequest(InputRef): Adds a GetInputAudioSyncOffset request to the batch.

AddGetInputAudioTracksRequest(InputRef): Adds a GetInputAudioTracks request to the batch.

AddGetInputDefaultSettingsRequest(string): Adds a GetInputDefaultSettings request to the batch.

AddGetInputDeinterlaceFieldOrderRequest(InputRef): Adds a GetInputDeinterlaceFieldOrder request to the batch.

AddGetInputDeinterlaceModeRequest(InputRef): Adds a GetInputDeinterlaceMode request to the batch.

AddGetInputKindListRequest(bool?): Adds a GetInputKindList request to the batch.

AddGetInputListRequest(string?): Adds a GetInputList request to the batch.

AddGetInputMuteRequest(InputRef): Adds a GetInputMute request to the batch.

AddGetInputPropertiesListPropertyItemsRequest(InputRef, string): Adds a GetInputPropertiesListPropertyItems request to the batch.

AddGetInputSettingsRequest(InputRef): Adds a GetInputSettings request to the batch.

AddGetInputVolumeRequest(InputRef): Adds a GetInputVolume request to the batch.

AddGetLastReplayBufferReplayRequest(): Adds a GetLastReplayBufferReplay request to the batch.

AddGetMediaInputStatusRequest(InputRef): Adds a GetMediaInputStatus request to the batch.

AddGetMonitorListRequest(): Adds a GetMonitorList request to the batch.

AddGetOutputListRequest(): Adds a GetOutputList request to the batch.

AddGetOutputSettingsRequest(string): Adds a GetOutputSettings request to the batch.

AddGetOutputStatusRequest(string): Adds a GetOutputStatus request to the batch.

AddGetPersistentDataRequest(Realm, string): Adds a GetPersistentData request to the batch.

AddGetProfileListRequest(): Adds a GetProfileList request to the batch.

AddGetProfileParameterRequest(string, string): Adds a GetProfileParameter request to the batch.

AddGetRecordDirectoryRequest(): Adds a GetRecordDirectory request to the batch.

AddGetRecordStatusRequest(): Adds a GetRecordStatus request to the batch.

AddGetReplayBufferStatusRequest(): Adds a GetReplayBufferStatus request to the batch.

AddGetSceneCollectionListRequest(): Adds a GetSceneCollectionList request to the batch.

AddGetSceneItemBlendModeRequest(SceneRef, int, Guid?): Adds a GetSceneItemBlendMode request to the batch.

AddGetSceneItemEnabledRequest(SceneRef, int, Guid?): Adds a GetSceneItemEnabled request to the batch.

AddGetSceneItemIdRequest(SceneRef, string, int?, Guid?): Adds a GetSceneItemId request to the batch.

AddGetSceneItemIndexRequest(SceneRef, int, Guid?): Adds a GetSceneItemIndex request to the batch.

AddGetSceneItemListRequest(SceneRef, Guid?): Adds a GetSceneItemList request to the batch.

AddGetSceneItemLockedRequest(SceneRef, int, Guid?): Adds a GetSceneItemLocked request to the batch.

AddGetSceneItemSourceRequest(SceneRef, int, Guid?): Adds a GetSceneItemSource request to the batch.

AddGetSceneItemTransformRequest(SceneRef, int, Guid?): Adds a GetSceneItemTransform request to the batch.

AddGetSceneListRequest(Guid?): Adds a GetSceneList request to the batch.

AddGetSceneSceneTransitionOverrideRequest(SceneRef, Guid?): Adds a GetSceneSceneTransitionOverride request to the batch.

AddGetSceneTransitionListRequest(): Adds a GetSceneTransitionList request to the batch.

AddGetSourceActiveRequest(SourceRef, Guid?): Adds a GetSourceActive request to the batch.

AddGetSourceFilterDefaultSettingsRequest(string): Adds a GetSourceFilterDefaultSettings request to the batch.

AddGetSourceFilterKindListRequest(): Adds a GetSourceFilterKindList request to the batch.

AddGetSourceFilterListRequest(SourceRef, Guid?): Adds a GetSourceFilterList request to the batch.

AddGetSourceFilterRequest(SourceRef, string, Guid?): Adds a GetSourceFilter request to the batch.

AddGetSourceScreenshotRequest(SourceRef, string, int?, int?, int?, Guid?): Adds a GetSourceScreenshot request to the batch.

AddGetSpecialInputsRequest(): Adds a GetSpecialInputs request to the batch.

AddGetStatsRequest(): Adds a GetStats request to the batch.

AddGetStreamServiceSettingsRequest(): Adds a GetStreamServiceSettings request to the batch.

AddGetStreamStatusRequest(): Adds a GetStreamStatus request to the batch.

AddGetStudioModeEnabledRequest(): Adds a GetStudioModeEnabled request to the batch.

AddGetTransitionKindListRequest(): Adds a GetTransitionKindList request to the batch.

AddGetVersionRequest(): Adds a GetVersion request to the batch.

AddGetVideoSettingsRequest(): Adds a GetVideoSettings request to the batch.

AddGetVirtualCamStatusRequest(): Adds a GetVirtualCamStatus request to the batch.

AddOffsetMediaInputCursorRequest(InputRef, int): Adds a OffsetMediaInputCursor request to the batch.

AddOpenInputFiltersDialogRequest(InputRef): Adds a OpenInputFiltersDialog request to the batch.

AddOpenInputInteractDialogRequest(InputRef): Adds a OpenInputInteractDialog request to the batch.

AddOpenInputPropertiesDialogRequest(InputRef): Adds a OpenInputPropertiesDialog request to the batch.

AddOpenSourceProjectorRequest(SourceRef, int?, string?, Guid?): Adds a OpenSourceProjector request to the batch.

AddOpenVideoMixProjectorRequest(MixType, int?, string?): Adds a OpenVideoMixProjector request to the batch.

AddPauseRecordRequest(): Adds a PauseRecord request to the batch.

AddPressInputPropertiesButtonRequest(InputRef, string): Adds a PressInputPropertiesButton request to the batch.

AddRemoveInputRequest(InputRef): Adds a RemoveInput request to the batch.

AddRemoveProfileRequest(string): Adds a RemoveProfile request to the batch.

AddRemoveSceneItemRequest(SceneRef, int, Guid?): Adds a RemoveSceneItem request to the batch.

AddRemoveSceneRequest(SceneRef, Guid?): Adds a RemoveScene request to the batch.

AddRemoveSourceFilterRequest(SourceRef, string, Guid?): Adds a RemoveSourceFilter request to the batch.

AddResumeRecordRequest(): Adds a ResumeRecord request to the batch.

AddSaveReplayBufferRequest(): Adds a SaveReplayBuffer request to the batch.

AddSaveSourceScreenshotRequest(SourceRef, string, string, int?, int?, int?, Guid?): Adds a SaveSourceScreenshot request to the batch.

AddSendStreamCaptionRequest(string): Adds a SendStreamCaption request to the batch.

AddSetCurrentPreviewSceneRequest(SceneRef): Adds a SetCurrentPreviewScene request to the batch.

AddSetCurrentProfileRequest(string): Adds a SetCurrentProfile request to the batch.

AddSetCurrentProgramSceneRequest(SceneRef): Adds a SetCurrentProgramScene request to the batch.

AddSetCurrentSceneCollectionRequest(string): Adds a SetCurrentSceneCollection request to the batch.

AddSetCurrentSceneTransitionDurationRequest(float): Adds a SetCurrentSceneTransitionDuration request to the batch.

AddSetCurrentSceneTransitionRequest(string): Adds a SetCurrentSceneTransition request to the batch.

AddSetCurrentSceneTransitionSettingsRequest(Dictionary<string, object>, bool?): Adds a SetCurrentSceneTransitionSettings request to the batch.

AddSetInputAudioBalanceRequest(InputRef, float): Adds a SetInputAudioBalance request to the batch.

AddSetInputAudioMonitorTypeRequest(InputRef, MonitorType): Adds a SetInputAudioMonitorType request to the batch.

AddSetInputAudioSyncOffsetRequest(InputRef, int): Adds a SetInputAudioSyncOffset request to the batch.

AddSetInputAudioTracksRequest(InputRef, AudioTracks): Adds a SetInputAudioTracks request to the batch.

AddSetInputDeinterlaceFieldOrderRequest(InputRef, string): Adds a SetInputDeinterlaceFieldOrder request to the batch.

AddSetInputDeinterlaceModeRequest(InputRef, DeinterlaceMode): Adds a SetInputDeinterlaceMode request to the batch.

AddSetInputMuteRequest(InputRef, bool): Adds a SetInputMute request to the batch.

AddSetInputNameRequest(InputRef, string): Adds a SetInputName request to the batch.

AddSetInputSettingsRequest(InputRef, Dictionary<string, object>, bool?): Adds a SetInputSettings request to the batch.

AddSetInputVolumeRequest(InputRef, float?, float?): Adds a SetInputVolume request to the batch.

AddSetMediaInputCursorRequest(InputRef, int): Adds a SetMediaInputCursor request to the batch.

AddSetOutputSettingsRequest(string, Dictionary<string, object>): Adds a SetOutputSettings request to the batch.

AddSetPersistentDataRequest(Realm, string, object): Adds a SetPersistentData request to the batch.

AddSetProfileParameterRequest(string, string, string?): Adds a SetProfileParameter request to the batch.

AddSetRecordDirectoryRequest(string): Adds a SetRecordDirectory request to the batch.

AddSetSceneItemBlendModeRequest(SceneRef, int, BlendMode, Guid?): Adds a SetSceneItemBlendMode request to the batch.

AddSetSceneItemEnabledRequest(SceneRef, int, bool, Guid?): Adds a SetSceneItemEnabled request to the batch.

AddSetSceneItemIndexRequest(SceneRef, int, int, Guid?): Adds a SetSceneItemIndex request to the batch.

AddSetSceneItemLockedRequest(SceneRef, int, bool, Guid?): Adds a SetSceneItemLocked request to the batch.

AddSetSceneItemTransformRequest(SceneRef, int, SceneItemTransformUpdate, Guid?): Adds a SetSceneItemTransform request to the batch.

AddSetSceneNameRequest(SceneRef, string, Guid?): Adds a SetSceneName request to the batch.

AddSetSceneSceneTransitionOverrideRequest(SceneRef, string?, int?, Guid?): Adds a SetSceneSceneTransitionOverride request to the batch.

AddSetSourceFilterEnabledRequest(SourceRef, string, bool, Guid?): Adds a SetSourceFilterEnabled request to the batch.

AddSetSourceFilterIndexRequest(SourceRef, string, int, Guid?): Adds a SetSourceFilterIndex request to the batch.

AddSetSourceFilterNameRequest(SourceRef, string, string, Guid?): Adds a SetSourceFilterName request to the batch.

AddSetSourceFilterSettingsRequest(SourceRef, string, Dictionary<string, object>, bool?, Guid?): Adds a SetSourceFilterSettings request to the batch.

AddSetStreamServiceSettingsRequest(string, object): Adds a SetStreamServiceSettings request to the batch.

AddSetStudioModeEnabledRequest(bool): Adds a SetStudioModeEnabled request to the batch.

AddSetTBarPositionRequest(float, bool?): Adds a SetTBarPosition request to the batch.

AddSetVideoSettingsRequest(float?, float?, int?, int?, int?, int?): Adds a SetVideoSettings request to the batch.

AddSleepRequest(int?, int?): Adds a request to sleep for a time duration or number of frames. Only available in request batches with types SERIAL_REALTIME or SERIAL_FRAME.

AddSplitRecordFileRequest(): Adds a SplitRecordFile request to the batch.

AddStartOutputRequest(string): Adds a StartOutput request to the batch.

AddStartRecordRequest(): Adds a StartRecord request to the batch.

AddStartReplayBufferRequest(): Adds a StartReplayBuffer request to the batch.

AddStartStreamRequest(): Adds a StartStream request to the batch.

AddStartVirtualCamRequest(): Adds a StartVirtualCam request to the batch.

AddStopOutputRequest(string): Adds a StopOutput request to the batch.

AddStopRecordRequest(): Adds a StopRecord request to the batch.

AddStopReplayBufferRequest(): Adds a StopReplayBuffer request to the batch.

AddStopStreamRequest(): Adds a StopStream request to the batch.

AddStopVirtualCamRequest(): Adds a StopVirtualCam request to the batch.

AddToggleInputMuteRequest(InputRef): Adds a ToggleInputMute request to the batch.

AddToggleOutputRequest(string): Adds a ToggleOutput request to the batch.

AddToggleRecordPauseRequest(): Adds a ToggleRecordPause request to the batch.

AddToggleRecordRequest(): Adds a ToggleRecord request to the batch.

AddToggleReplayBufferRequest(): Adds a ToggleReplayBuffer request to the batch.

AddToggleStreamRequest(): Adds a ToggleStream request to the batch.

AddToggleVirtualCamRequest(): Adds a ToggleVirtualCam request to the batch.

AddTriggerHotkeyByKeySequenceRequest(ObsKey?, KeyModifier?): Adds a request to trigger a hotkey using a sequence of keys.

AddTriggerHotkeyByNameRequest(string, string?): Adds a TriggerHotkeyByName request to the batch.

AddTriggerMediaInputActionRequest(InputRef, ObsMediaInputAction): Adds a TriggerMediaInputAction request to the batch.

AddTriggerStudioModeTransitionRequest(): Adds a TriggerStudioModeTransition request to the batch.