Overview
The Overwolf Electron recording APIs integrate recording into the Overwolf Electron framework allowing you to record both audio and video. The recoding API supports many different encoders and provides two recording modes so that you can create dynamic recording apps.
Recording modes
The recording feature supports two types of recording modes:
- Standard—all video is recorded from start to finish when stopped and is saved to storage.
- Replay—records based on a provided time frame (cached sliding buffer). Specify total buffer time and how much time to record before and/or after the recording starts. Once recording is complete the video will be saved to your storage.
Recorder package features
Capture Audio / Video
- Capture video from a specific display device or capture from a running game.
- Capture any audio input or output device, such as speakers, a microphone, or the game sound alone.
- Split capture into separate video files on-demand or using a timer.
- Multiple audio and video encoders supported.
- Multiple output formats supported.
- Control bitrate and encoding rate.
- Options to allocate specific audio tracks to specific audio devices.
Replay Capture
- Record a buffer of
x
seconds to memory without saving to disk. - Allow for on-demand video capture to disk with a portion or all of the in-memory buffer. For example, when a highlight is detected while the replay is running, capture can be turned on to run for a timer, using
x
seconds already captured by the replay.
Game Listener
- Register for general events from supported games, such as game launch or exit.
- Trigger seamless recording as the game is loaded, or alternately to start a replay and trigger capture during appropriate moments.
Usage stats
You can capture the following usage stats while the recorder is actively recording:
- CPU & memory usage
- Available disk space
- Active FPS
- Dropped frames information
Supported encoders
The following video encoders are supported:
- ffmpeg_svt_av1
- ffmpeg_aom_av1
- jim_nvenc
- jim_hevc_nvenc
- jim_av1_nvenc
- obs_x264
- h264_texture_amf
- h265_texture_amf
- av1_texture_amf
- obs_qsv11_v2
- obs_qsv11_hevc
- obs_qsv11_av1
Supported audio encoders:
- ffmpeg_aac
- ffmpeg_opus
- ffmpeg_pcm_s16le
- ffmpeg_pcm_s24le
- ffmpeg_pcm_f32le
- ffmpeg_alac
- ffmpeg_flac
Supported audio sample rates:
- 48000
- 44100
Supported speaker layouts:
- Mono
- Stereo
- 2.1
- 4.0
- 4.1
- 5.1
- 7.1
Example app 1
Use the recording APIs with game events supplied by the Game Events Provider to create apps that can record video game play based on game events. This sample app has a recording feature.
Example app 2
Use the recording APIs to record videos for game performance analysis. Comparing recorded videos can give players recommendations on how to improve their performance. You can even provide granular performance advice when you combine recording based on game events.