forked from midnight-studios/obs-lua
-
Notifications
You must be signed in to change notification settings - Fork 0
/
source-visibility-timer.lua
413 lines (267 loc) · 7.34 KB
/
source-visibility-timer.lua
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
-- Open Broadcaster Software®️
-- OBS > Tools > Scripts
--
--
--
-- 06/11/2020 13:59 @achilles
-- Globals
local repeat_hold, repeat_source
obs = obslua
source_name = ""
mode = ""
total_ms = 0
delay = 0
hold = 0
start_visible = true
group_items = false
settings_ = nil
--
-- OBS Script Description
-- Displayed in the User Interface
--
--
--
function script_description()
return "Sets a source to show/hide on a timer."
end
--
-- Settings
-- Displayed in the User Interface
--
--
--
function script_properties()
local props = obs.obs_properties_create()
local mode = obs.obs_properties_add_list(props, "mode", "Mode", obs.OBS_COMBO_TYPE_LIST, obs.OBS_COMBO_FORMAT_STRING)
obs.obs_property_list_add_string(mode, "Hide source after specified time", "mode_hide")
obs.obs_property_list_add_string(mode, "Show source after specified time", "mode_show")
obs.obs_property_list_add_string(mode, "Repeat", "mode_repeat")
local p = obs.obs_properties_add_list(props, "source", "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
local name = obs.obs_source_get_name(source)
obs.obs_property_list_add_string(p, name, name)
end
end
obs.source_list_release(sources)
obs.obs_properties_add_int(props, "delay_ms", "Delay after activated (ms)", 0, 3600000, 1)
obs.obs_properties_add_int(props, "duration_ms", "Show (ms)", 1, 3600000, 1)
obs.obs_properties_add_int(props, "hold_ms", "Hide (ms)", 1, 3600000, 1)
obs.obs_properties_add_bool(props, "start_visible", "Start visible")
obs.obs_properties_add_bool(props, "group_items", "Include Group items?")
obs.obs_property_set_modified_callback(mode, settings_modified)
settings_modified(props, nil, settings_)
return props
end
--
-- Just a tool
-- If testing and log event writing is needed
--
--
--
local function log(name, msg)
if msg ~= nil then
msg = " > " .. tostring(msg)
else
msg = ""
end
obs.script_log(obs.LOG_DEBUG, name .. msg)
end
--
-- This will toggle the visibility Source (Scene Item/s)
--
--
--
--
function set_visibility(is_visible)
local scenes = obs.obs_frontend_get_scenes()
local is_source = false
if scenes ~= nil then
for _, scenesource in ipairs(scenes) do
local scenename = obs.obs_source_get_name(scenesource)
local scene = obs.obs_scene_from_source(scenesource)
local sceneitems = obs.obs_scene_enum_items(scene)
for i, sceneitem in ipairs(sceneitems) do
local source = obs.obs_sceneitem_get_source(sceneitem)
local sourcename = obs.obs_source_get_name(source)
if sourcename == source_name then
local group = obs.obs_group_from_source(source)
local groupitems = obs.obs_scene_enum_items(group)
if is_visible ~= nil then
obs.obs_sceneitem_set_visible(sceneitem, is_visible)
else
obs.obs_sceneitem_set_visible(sceneitem, not obs.obs_sceneitem_visible(sceneitem))
end
-- Target Sources inside Groups only if user specified
if group_items then
for j, groupitem in ipairs(groupitems) do
if is_visible ~= nil then
obs.obs_sceneitem_set_visible(groupitem, is_visible)
else
obs.obs_sceneitem_set_visible(groupitem, not obs.obs_sceneitem_visible(groupitem))
end
end
end
end
end
obs.sceneitem_list_release(groupitems)
obs.sceneitem_list_release(sceneitems)
end
obs.source_list_release(scenes)
--obs.obs_frontend_source_list_free(scenes)
end
obs.obs_source_release(source)
end
--
-- Hook function
-- Modify Source Visibility [Hide]
-- Stops Timer
--
--
function show_source()
set_visibility(true)
obs.timer_remove(show_source)
end
--
-- Hook function
-- Modify Source Visibility [Show]
-- Start Timer
--
--
function hide_source()
set_visibility(false)
obs.timer_remove(hide_source)
end
--
-- Hook function
--
-- Timer Modifications
--
--
function repeat_hold()
set_visibility()
obs.timer_remove(repeat_hold)
obs.timer_add(repeat_source, total_ms)
end
--
-- Hook function
--
-- Timer Modifications
--
--
function repeat_source()
set_visibility()
obs.timer_remove(repeat_source)
obs.timer_add(repeat_hold, hold)
end
--
--
--
--
--
--
function start_timer()
if (mode == "mode_hide") then
set_visibility(true)
obs.timer_add(hide_source, total_ms)
elseif (mode == "mode_show") then
set_visibility(false)
obs.timer_add(show_source, total_ms)
elseif (mode == "mode_repeat") then
set_visibility(start_visible)
obs.timer_add(repeat_source, total_ms)
end
obs.timer_remove(start_timer)
end
--
--
--
--
--
--
function activate(activating)
obs.timer_remove(start_timer)
obs.timer_remove(repeat_hold)
obs.timer_remove(repeat_source)
obs.timer_remove(hide_source)
obs.timer_remove(show_source)
if activating then
local source = obs.obs_get_source_by_name(source_name)
if source == nil then
return
end
obs.obs_source_release(source)
if delay ~= 0 then
obs.timer_add(start_timer, delay)
else
start_timer()
end
end
end
--
--
--
--
--
--
function settings_modified(props, prop, settings)
local mode_setting = obs.obs_data_get_string(settings, "mode")
local start = obs.obs_properties_get(props, "start_visible")
local hold = obs.obs_properties_get(props, "hold_ms")
local enabled
if (mode_setting == "mode_repeat") then
enabled = true
else
enabled = false
end
obs.obs_property_set_visible(start, enabled)
obs.obs_property_set_visible(hold, enabled)
return true
end
--
--
--
--
--
--
function script_update(settings)
total_ms = obs.obs_data_get_int(settings, "duration_ms")
delay = obs.obs_data_get_int(settings, "delay_ms")
hold = obs.obs_data_get_int(settings, "hold_ms")
source_name = obs.obs_data_get_string(settings, "source")
mode = obs.obs_data_get_string(settings, "mode")
start_visible = obs.obs_data_get_bool(settings, "start_visible")
group_items = obs.obs_data_get_bool(settings, "group_items")
activate(true)
end
--
--
--
--
--
--
function script_defaults(settings)
obs.obs_data_set_default_int(settings, "duration_ms", 1000)
obs.obs_data_set_default_int(settings, "delay_ms", 0)
obs.obs_data_set_default_int(settings, "hold_ms", 1000)
obs.obs_data_set_default_bool(setting, "start_visible", true)
obs.obs_data_set_default_bool(setting, "group_items", false)
end
--
--
--
--
--
--
function script_load(settings)
settings_ = settings
end
--
--
--
--
--
--
function script_unload()
end