general

type BroadcastCustomEventParams struct {
	// Data payload to emit to all receivers
	EventData interface{} `json:"eventData,omitempty"`
}

type BroadcastCustomEventResponse struct{}

type CallVendorRequestParams struct {
	// Object containing appropriate request data
	RequestData interface{} `json:"requestData,omitempty"`

	// The request type to call
	RequestType string `json:"requestType,omitempty"`

	// Name of the vendor to use
	VendorName string `json:"vendorName,omitempty"`
}

type CallVendorRequestResponse struct {
	// Echoed of `requestType`
	RequestType string `json:"requestType,omitempty"`

	// Object containing appropriate response data. {} if request does not provide any response data
	ResponseData interface{} `json:"responseData,omitempty"`

	// Echoed of `vendorName`
	VendorName string `json:"vendorName,omitempty"`
}

type Client struct {
	*api.Client
}

type GetHotkeyListParams struct{}

type GetHotkeyListResponse struct {
	// Array of hotkey names
	Hotkeys []string `json:"hotkeys,omitempty"`
}

type GetStatsParams struct{}

type GetStatsResponse struct {
	// Current FPS being rendered
	ActiveFps float64 `json:"activeFps,omitempty"`

	// Available disk space on the device being used for recording storage
	AvailableDiskSpace float64 `json:"availableDiskSpace,omitempty"`

	// Average time in milliseconds that OBS is taking to render a frame
	AverageFrameRenderTime float64 `json:"averageFrameRenderTime,omitempty"`

	// Current CPU usage in percent
	CpuUsage float64 `json:"cpuUsage,omitempty"`

	// Amount of memory in MB currently being used by OBS
	MemoryUsage float64 `json:"memoryUsage,omitempty"`

	// Number of frames skipped by OBS in the output thread
	OutputSkippedFrames float64 `json:"outputSkippedFrames,omitempty"`

	// Total number of frames outputted by the output thread
	OutputTotalFrames float64 `json:"outputTotalFrames,omitempty"`

	// Number of frames skipped by OBS in the render thread
	RenderSkippedFrames float64 `json:"renderSkippedFrames,omitempty"`

	// Total number of frames outputted by the render thread
	RenderTotalFrames float64 `json:"renderTotalFrames,omitempty"`

	// Total number of messages received by obs-websocket from the client
	WebSocketSessionIncomingMessages float64 `json:"webSocketSessionIncomingMessages,omitempty"`

	// Total number of messages sent by obs-websocket to the client
	WebSocketSessionOutgoingMessages float64 `json:"webSocketSessionOutgoingMessages,omitempty"`
}

type GetVersionParams struct{}

type GetVersionResponse struct {
	// Array of available RPC requests for the currently negotiated RPC version
	AvailableRequests []string `json:"availableRequests,omitempty"`

	// Current OBS Studio version
	ObsVersion string `json:"obsVersion,omitempty"`

	// Current obs-websocket version
	ObsWebSocketVersion string `json:"obsWebSocketVersion,omitempty"`

	// Name of the platform. Usually `windows`, `macos`, or `ubuntu` (linux flavor). Not guaranteed to be any of those
	Platform string `json:"platform,omitempty"`

	// Description of the platform, like `Windows 10 (10.0)`
	PlatformDescription string `json:"platformDescription,omitempty"`

	// Current latest obs-websocket RPC version
	RpcVersion float64 `json:"rpcVersion,omitempty"`

	// Image formats available in `GetSourceScreenshot` and `SaveSourceScreenshot` requests.
	SupportedImageFormats []string `json:"supportedImageFormats,omitempty"`
}

type SleepParams struct {
	// Number of frames to sleep for (if `SERIAL_FRAME` mode)
	SleepFrames float64 `json:"sleepFrames,omitempty"`

	// Number of milliseconds to sleep for (if `SERIAL_REALTIME` mode)
	SleepMillis float64 `json:"sleepMillis,omitempty"`
}

type SleepResponse struct{}

type TriggerHotkeyByKeySequenceParams struct {
	// The OBS key ID to use. See https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
	KeyId string `json:"keyId,omitempty"`

	// Key modifiers to apply
	KeyModifiers *typedefs.KeyModifiers `json:"keyModifiers,omitempty"`
}

type TriggerHotkeyByKeySequenceResponse struct{}

type TriggerHotkeyByNameParams struct {
	// Name of the hotkey to trigger
	HotkeyName string `json:"hotkeyName,omitempty"`
}

type TriggerHotkeyByNameResponse struct{}