Skip to main content

showHelpNotification

xPlayer.showHelpNotification(msg, thisFrame, beep, duration)

This function shows a help notification with a message. These help notification support displaying button inputs, see this list

Arguments

ArgumentData TypeOptionalDefault ValueExplanation
msgstringNo-The message to display
thisFramebooleanYesfalseOnly show this frame? Should be used with scripts that show notifications in a loop
beepbooleanYestruePlay the beep sound?
durationnumberYes-1 (5000 ms)Duration to show the help notification in milliseconds