OBS Lua: Sound notification on replay buffer save [Windows]

README.md

A simple Lua script which plays a .wav sound whenever replay buffer is saved.

Installation

1. Download Half-Life 2 City Scanner NPC's camera shutter sound: https://github.com/sourcesounds/hl2/blob/master/sound/npc/scanner/scanner_photo1.wav

   • Or use any .wav sound but make sure to match its name either in "Beep on replay buffer save.lua" (edit with any text editor) or rename your .wav file to "sound_npc_scanner_scanner_photo1.wav".

2. Put it in the same location with "Beep on replay buffer save.lua"

   • A good way is to create a separate "scripts" folder in %AppData%\obs-studio\ and keep all your scripts there in case you need to backup your OBS Settings.

3. OBS → Tools → Scripts → +

This Lua script was downloaded from https://gist.github.com/snakecase/e816384a071cec31efbb4b9e429c108d

Credits:

• upgradeQ
• gima
• AkazaRenn

Thank you guys!

Beep on replay buffer save.lua

local obs = obslua
local ffi = require("ffi")
local winmm = ffi.load("Winmm")

-- Put a sound of your choosing next to "Beep on replay save.lua" and don't forget to match its name either in code below or rename your file.
PROP_AUDIO_FILEPATH = script_path() .. "sound_npc_scanner_scanner_photo1.wav"

ffi.cdef[[
    bool PlaySound(const char *pszSound, void *hmod, uint32_t fdwSound);
]]

function playsound(filepath)
    winmm.PlaySound(filepath, nil, 0x00020000)
end

function on_event(event) 
  if event == obs.OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED 
    then playsound(PROP_AUDIO_FILEPATH) 
  end 
end

function script_load(settings)
  obs.obs_frontend_add_event_callback(on_event)
end

-- This Lua script was downloaded from https://gist.github.com/snakecase/e816384a071cec31efbb4b9e429c108d

-- Credits: upgradeQ (https://gist.github.com/upgradeQ/b2412242d76790d7618d6b0996c4562f), gima (https://gitlab.com/gima/obsnotification)
-- Thank you guys!

Does it still work for OBS version 29.0.2? Does not seem to work for me.

Using Windows 11, no errors in the log, my suspicion is this part of the code: winmm.PlaySound(filepath, nil, 0x00020003) The winmm for the soundsystem has probably changed on Windows 11?

Figured out how to fix it, replace that line with: winmm.PlaySound(filepath, nil, 0x0001) -- The 0x0001 flag is for SND_FILENAME

Works like a charm. Thanks copilot!

Though Copilot provided a working solution, 0x0001 is actually SND_ASYNC. And you won't believe but 0x00020003 that was set in this script before (which was blindly copy pasted from one of the credited scripts) doesn't have any aliases and was working only because

If none of these flags are specified, PlaySound searches the registry or the WIN.INI file for an association with the specified sound name. If an association is found, the sound event is played. If no association is found in the registry, the name is interpreted as a file name.

🤣

Fixed with 0x00020000, should be working for everyone.

Does it still work for OBS version 29.0.2? Does not seem to work for me.

Using Windows 11, no errors in the log, my suspicion is this part of the code: winmm.PlaySound(filepath, nil, 0x00020003) The winmm for the soundsystem has probably changed on Windows 11?

Figured out how to fix it, replace that line with: winmm.PlaySound(filepath, nil, 0x0001) -- The 0x0001 flag is for SND_FILENAME
Works like a charm. Thanks copilot!

Though Copilot provided a working solution, 0x0001 is actually SND_ASYNC. And you won't believe but 0x00020003 that was set in this script before (which was blindly copy pasted from one of the credited scripts) doesn't have any aliases and was working only because

If none of these flags are specified, PlaySound searches the registry or the WIN.INI file for an association with the specified sound name. If an association is found, the sound event is played. If no association is found in the registry, the name is interpreted as a file name.

🤣

Fixed with 0x00020000, should be working for everyone.

Thanks for the correction. Seemed to work, but will also try 0x00020000 if it seems a better option.

Hello!

Ha, I enjoyed this script, so I made some additions to it. I made some sounds based off on the Black Mesa's turret sounds (we're still using Half Life related effects, right?).
As I toggle buffer on and off, I wanted a way to know whether it was toggled on or off.

here's how the script would be

local obs = obslua
local ffi = require("ffi")
local winmm = ffi.load("Winmm")

-- Put a sound of your choosing next to "Beep on replay save.lua" and don't forget to match its name either in code below or rename your file.
PROP_AUDIO_SAVE = script_path() .. "Cam_SAVE.wav"
PROP_AUDIO_START = script_path() .. "Cam_ON.wav"
PROP_AUDIO_SHUTDOWN = script_path() .. "Cam_OFF.wav"

ffi.cdef[[
    bool PlaySound(const char *pszSound, void *hmod, uint32_t fdwSound);
]]

function playsound(filepath)
    winmm.PlaySound(filepath, nil, 0x00020000)
end

function on_event(event) 
  if event == obs.OBS_FRONTEND_EVENT_REPLAY_BUFFER_STARTED 
    then playsound(PROP_AUDIO_START) 
  end 
  if event == obs.OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED 
    then playsound(PROP_AUDIO_SAVE) 
  end 
  if event == obs.OBS_FRONTEND_EVENT_REPLAY_BUFFER_STOPPED
    then playsound(PROP_AUDIO_SHUTDOWN) 
  end 
end

function script_load(settings)
  obs.obs_frontend_add_event_callback(on_event)
end

-- This Lua script was downloaded from https://gist.github.com/snakecase/e816384a071cec31efbb4b9e429c108d

-- Credits: upgradeQ (https://gist.github.com/upgradeQ/b2412242d76790d7618d6b0996c4562f), gima (https://gitlab.com/gima/obsnotification)
-- Thank you guys!

bear in mind I'm no programmer, but I think I heard something about case switch or something that would be better here? idk, it's just basic code. It works.

These are the wav files
click here

Same installation procedure as the original script. I used the lowered volume WAV files that someone supplied here (with I guess 75% lower volume?) File was also actually an MP3, but I'm sending it over as a correct .wav file anyway.

And there you have it. Volume is pretty quiet, I guess. Sounds OK from the TV speakers, which is what I'm listening from.

wasnt working until i corrected to 0x00020000 but now its does the windows background sound instead of the wav sound idk why

It's already set to 0x00020000 in the sctipt. 🤔

Hello!

Ha, I enjoyed this script, so I made some additions to it. I made some sounds based off on the Black Mesa's turret sounds (we're still using Half Life related effects, right?). As I toggle buffer on and off, I wanted a way to know whether it was toggled on or off.

here's how the script would be

local obs = obslua
local ffi = require("ffi")
local winmm = ffi.load("Winmm")

-- Put a sound of your choosing next to "Beep on replay save.lua" and don't forget to match its name either in code below or rename your file.
PROP_AUDIO_SAVE = script_path() .. "Cam_SAVE.wav"
PROP_AUDIO_START = script_path() .. "Cam_ON.wav"
PROP_AUDIO_SHUTDOWN = script_path() .. "Cam_OFF.wav"

ffi.cdef[[
    bool PlaySound(const char *pszSound, void *hmod, uint32_t fdwSound);
]]

function playsound(filepath)
    winmm.PlaySound(filepath, nil, 0x00020000)
end

function on_event(event) 
  if event == obs.OBS_FRONTEND_EVENT_REPLAY_BUFFER_STARTED 
    then playsound(PROP_AUDIO_START) 
  end 
  if event == obs.OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED 
    then playsound(PROP_AUDIO_SAVE) 
  end 
  if event == obs.OBS_FRONTEND_EVENT_REPLAY_BUFFER_STOPPED
    then playsound(PROP_AUDIO_SHUTDOWN) 
  end 
end

function script_load(settings)
  obs.obs_frontend_add_event_callback(on_event)
end

-- This Lua script was downloaded from https://gist.github.com/snakecase/e816384a071cec31efbb4b9e429c108d

-- Credits: upgradeQ (https://gist.github.com/upgradeQ/b2412242d76790d7618d6b0996c4562f), gima (https://gitlab.com/gima/obsnotification)
-- Thank you guys!

bear in mind I'm no programmer, but I think I heard something about case switch or something that would be better here? idk, it's just basic code. It works.

These are the wav files click here

Same installation procedure as the original script. I used the lowered volume WAV files that someone supplied here (with I guess 75% lower volume?) File was also actually an MP3, but I'm sending it over as a correct .wav file anyway.

And there you have it. Volume is pretty quiet, I guess. Sounds OK from the TV speakers, which is what I'm listening from.

Hi when I use this script and turn on the replay buffer, it turns off seconds later. In the original, this didn't happen.

Hello!

Ha, I enjoyed this script, so I made some additions to it. I made some sounds based off on the Black Mesa's turret sounds (we're still using Half Life related effects, right?). As I toggle buffer on and off, I wanted a way to know whether it was toggled on or off.

here's how the script would be

local obs = obslua
local ffi = require("ffi")
local winmm = ffi.load("Winmm")

-- Put a sound of your choosing next to "Beep on replay save.lua" and don't forget to match its name either in code below or rename your file.
PROP_AUDIO_SAVE = script_path() .. "Cam_SAVE.wav"
PROP_AUDIO_START = script_path() .. "Cam_ON.wav"
PROP_AUDIO_SHUTDOWN = script_path() .. "Cam_OFF.wav"

ffi.cdef[[
    bool PlaySound(const char *pszSound, void *hmod, uint32_t fdwSound);
]]

function playsound(filepath)
    winmm.PlaySound(filepath, nil, 0x00020000)
end

function on_event(event) 
  if event == obs.OBS_FRONTEND_EVENT_REPLAY_BUFFER_STARTED 
    then playsound(PROP_AUDIO_START) 
  end 
  if event == obs.OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED 
    then playsound(PROP_AUDIO_SAVE) 
  end 
  if event == obs.OBS_FRONTEND_EVENT_REPLAY_BUFFER_STOPPED
    then playsound(PROP_AUDIO_SHUTDOWN) 
  end 
end

function script_load(settings)
  obs.obs_frontend_add_event_callback(on_event)
end

-- This Lua script was downloaded from https://gist.github.com/snakecase/e816384a071cec31efbb4b9e429c108d

-- Credits: upgradeQ (https://gist.github.com/upgradeQ/b2412242d76790d7618d6b0996c4562f), gima (https://gitlab.com/gima/obsnotification)
-- Thank you guys!

bear in mind I'm no programmer, but I think I heard something about case switch or something that would be better here? idk, it's just basic code. It works.

These are the wav files click here

Same installation procedure as the original script. I used the lowered volume WAV files that someone supplied here (with I guess 75% lower volume?) File was also actually an MP3, but I'm sending it over as a correct .wav file anyway.

And there you have it. Volume is pretty quiet, I guess. Sounds OK from the TV speakers, which is what I'm listening from.

This worked for me, where the original script didn't. Thank you! It might have been a problem with my WAV file tbh...

wasnt working until i corrected to 0x00020000 but now its does the windows background sound instead of the wav sound idk why

Yeah I'm having the same issue now as well. I am on OBS 30.1.2 if that might affect things.

Thanks for this.
It works as intended.

Got a question though.
How can I mute the sound notifcation on the recording itself? Like it will activate the sound notifcation but on the recording it wont capture the sound?

For those getting the default windows background sound, make sure your WAV file is uncompressed.

Windows seems to have issue playing compressed WAV files. Spent too much time googling before I stumbled upon this.

Just getting the default windows background sound as well

How can I mute the sound notifcation on the recording itself? Like it will activate the sound notifcation but on the recording it wont capture the sound?

you found a workaround yet?

Sorry for the late reply. To stop this sound from showing up in recordings you either have to:
A. Reroute playback of this sound to some other device/software channel (not sure it's possible) via code which I have no clue how to implement
B. Record audio only from applications of your preference which can be done via OBS → Sources → Add → Application Audio Capture (BETA). This should work but will require setup each time you change applications (e.g. playing different games)

Regarding issues with playback, I have now tested this script in Win 11 Pro, and it works just fine, as well as in Win 10.