Skip to main content

Overview

APIDescription
overwolf.settings.enums.eIndicationPosition-
overwolf.settings.enums.ResolutionSettings-
overwolf.settings.getAudioCaptureSettingsReturns the current audio capture settings.
overwolf.settings.getClientInfoRetrieve information about the client - such as when it was first installed and how long is it running.
overwolf.settings.getCurrentOverwolfLanguageReturns the current language overwolf is set to in a two letter ISO name format.
overwolf.settings.getExtensionSettingsGets the extension settings.
overwolf.settings.getFpsSettingsGets the status of the FPS control (on/off), its position, its offset (in pixels) and its scale [0, 1].
overwolf.settings.getHotKeyReturns the hotkey assigned to a given feature id by calling the callback.
overwolf.settings.getOverwolfScreenshotsFolderReturns the current folder overwolf uses to store screenshots.
overwolf.settings.getOverwolfVideosFolderReturns the current folder overwolf uses to store videos.
overwolf.settings.getVideoCaptureSettingsReturns the current video capture settings.
overwolf.settings.registerHotKeyRegisters a callback for a given hotkey action. If the registration had failed, the callback function will be called immediately with the status "error" and another property, "error", indicating the reason for the failure. Otherwise, the callback function will be called when the hotkey is pressed and the status will be "success". Note that Shift can only be combined with F keys.
overwolf.settings.setAudioCaptureSettingsSets new audio capture settings.
overwolf.settings.setExtensionSettingsSets the extension settings.
overwolf.settings.setFpsSettingsSets the state (on/off), position, offset (in pixels) and scale [0, 1] of the Fps control.
overwolf.settings.setOverwolfScreenshotsFolderSets the folder Overwolf uses to store screenshots.
overwolf.settings.setOverwolfVideosFolderSets the folder Overwolf uses to store videos.
overwolf.settings.setVideoCaptureSettingsSets new video capture settings.
overwolf.settings.AudioCaptureSettingsChangedEvent-
overwolf.settings.FolderResult-
overwolf.settings.FpsSettings-
overwolf.settings.FpsSettingsChangedEvent-
overwolf.settings.GeneralExtensionSettings-
overwolf.settings.GetAudioCaptureSettingsResult-
overwolf.settings.GetExtensionSettingsResult-
overwolf.settings.GetFpsSettingsResult-
overwolf.settings.GetHotKeyResult-
overwolf.settings.GetVideoCaptureSettingsResult-
overwolf.settings.HotKeyChangedEvent-
overwolf.settings.HotKeyResult-
overwolf.settings.SetFolderResult-
overwolf.settings.VideoCaptureSettingsChangedEvent-
overwolf.settings.OnAudioCaptureSettingsChangedFired when audio capture settings are changed.
overwolf.settings.onFpsSettingsChangedFired when fps settings are changed.
overwolf.settings.OnVideoCaptureSettingsChangedFired when video capture settings are changed.