5982a8cd28
With the "instant-replay.lua" script, it would only play the last replay buffer saved, meaning the user would have to save a replay with the replay buffer hotkey, and then press the "Play Last Replay" hotkey to play the last replay buffer. Instead, combine the two and make the script save the replay automatically first, and then play it back as soon as it's available. This makes it actually qualify as an "instant replay" script, as its name implies.
131 lines
4.4 KiB
Lua
131 lines
4.4 KiB
Lua
obs = obslua
|
|
source_name = ""
|
|
hotkey_id = obs.OBS_INVALID_HOTKEY_ID
|
|
attempts = 0
|
|
|
|
----------------------------------------------------------
|
|
|
|
function try_play()
|
|
local replay_buffer = obs.obs_frontend_get_replay_buffer_output()
|
|
if replay_buffer == nil then
|
|
obs.remove_current_callback()
|
|
return
|
|
end
|
|
|
|
-- Call the procedure of the replay buffer named "get_last_replay" to
|
|
-- get the last replay created by the replay buffer
|
|
local cd = obs.calldata_create()
|
|
local ph = obs.obs_output_get_proc_handler(replay_buffer)
|
|
obs.proc_handler_call(ph, "get_last_replay", cd)
|
|
local path = obs.calldata_string(cd, "path")
|
|
obs.calldata_destroy(cd)
|
|
|
|
obs.obs_output_release(replay_buffer)
|
|
|
|
-- If the path is valid and the source exists, update it with the
|
|
-- replay file to play back the replay. Otherwise, stop attempting to
|
|
-- replay after 10 seconds
|
|
if path == nil then
|
|
attempts = attempts + 1
|
|
if attempts >= 10 then
|
|
obs.remove_current_callback()
|
|
end
|
|
else
|
|
local source = obs.obs_get_source_by_name(source_name)
|
|
if source ~= nil then
|
|
local settings = obs.obs_data_create()
|
|
obs.obs_data_set_string(settings, "local_file", path)
|
|
obs.obs_data_set_bool(settings, "is_local_file", true)
|
|
obs.obs_data_set_bool(settings, "close_when_inactive", true)
|
|
obs.obs_data_set_bool(settings, "restart_on_activate", true)
|
|
|
|
-- updating will automatically cause the source to
|
|
-- refresh if the source is currently active, otherwise
|
|
-- the source will play whenever its scene is activated
|
|
obs.obs_source_update(source, settings)
|
|
|
|
obs.obs_data_release(settings)
|
|
obs.obs_source_release(source)
|
|
end
|
|
|
|
obs.remove_current_callback()
|
|
end
|
|
end
|
|
|
|
-- The "Instant Replay" hotkey callback
|
|
function instant_replay(pressed)
|
|
if not pressed then
|
|
return
|
|
end
|
|
|
|
local replay_buffer = obs.obs_frontend_get_replay_buffer_output()
|
|
if replay_buffer ~= nil then
|
|
-- Call the procedure of the replay buffer named "get_last_replay" to
|
|
-- get the last replay created by the replay buffer
|
|
local ph = obs.obs_output_get_proc_handler(replay_buffer)
|
|
obs.proc_handler_call(ph, "save", nil)
|
|
|
|
-- Set a 1-second timer to attempt playback every 1 second
|
|
-- until the replay is available
|
|
if obs.obs_output_active(replay_buffer) then
|
|
attempts = 0
|
|
obs.timer_add(try_play, 1000)
|
|
end
|
|
|
|
obs.obs_output_release(replay_buffer)
|
|
end
|
|
end
|
|
|
|
----------------------------------------------------------
|
|
|
|
-- A function named script_update will be called when settings are changed
|
|
function script_update(settings)
|
|
source_name = obs.obs_data_get_string(settings, "source")
|
|
end
|
|
|
|
-- A function named script_description returns the description shown to
|
|
-- the user
|
|
function script_description()
|
|
return "When the \"Instant Replay\" hotkey is triggered, saves a replay with the replay buffer, and then plays it in a media source as soon as the replay is ready. Requires an active replay buffer.\n\nMade by Jim"
|
|
end
|
|
|
|
-- A function named script_properties defines the properties that the user
|
|
-- can change for the entire script module itself
|
|
function script_properties()
|
|
props = obs.obs_properties_create()
|
|
|
|
local p = obs.obs_properties_add_list(props, "source", "Media Source", obs.OBS_COMBO_TYPE_EDITABLE, obs.OBS_COMBO_FORMAT_STRING)
|
|
local sources = obs.obs_enum_sources()
|
|
if sources ~= nil then
|
|
for _, source in ipairs(sources) do
|
|
source_id = obs.obs_source_get_id(source)
|
|
if source_id == "ffmpeg_source" then
|
|
local name = obs.obs_source_get_name(source)
|
|
obs.obs_property_list_add_string(p, name, name)
|
|
end
|
|
end
|
|
end
|
|
obs.source_list_release(sources)
|
|
|
|
return props
|
|
end
|
|
|
|
-- A function named script_load will be called on startup
|
|
function script_load(settings)
|
|
hotkey_id = obs.obs_hotkey_register_frontend("instant_replay.trigger", "Instant Replay", instant_replay)
|
|
local hotkey_save_array = obs.obs_data_get_array(settings, "instant_replay.trigger")
|
|
obs.obs_hotkey_load(hotkey_id, hotkey_save_array)
|
|
obs.obs_data_array_release(hotkey_save_array)
|
|
end
|
|
|
|
-- A function named script_save will be called when the script is saved
|
|
--
|
|
-- NOTE: This function is usually used for saving extra data (such as in this
|
|
-- case, a hotkey's save data). Settings set via the properties are saved
|
|
-- automatically.
|
|
function script_save(settings)
|
|
local hotkey_save_array = obs.obs_hotkey_save(hotkey_id)
|
|
obs.obs_data_set_array(settings, "instant_replay.trigger", hotkey_save_array)
|
|
obs.obs_data_array_release(hotkey_save_array)
|
|
end
|