Plugin:MirLua/Module/m sounds: Difference between revisions
Jump to navigation
Jump to search
(replace function subsections with headers; we should also get rid of the rest syntax as it produces wrong html markup) |
(mark parameters as definitions) |
||
| Line 17: | Line 17: | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
; {{nbsp|5}} ''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | |||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Unique name. | :: Unique name. | ||
; {{nbsp|5}} ''description'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | |||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Description. | :: Description. | ||
; {{nbsp|5}} ''section'' | |||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used. | :: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used. | ||
; {{nbsp|5}} ''path'' | |||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Path to sound file. | :: Path to sound file. | ||
| Line 41: | Line 44: | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
; {{nbsp|5}} '''''name''''' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | |||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Unique name. | :: Unique name. | ||
| Line 56: | Line 59: | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
; {{nbsp|5}} '''''path''''' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | |||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Path to file. | :: Path to file. | ||
Revision as of 17:25, 15 April 2018
Allows you to work with sounds.
Include module:: local sounds = require('m_sounds')
<translate> Note</translate>
Parameters written in bold italics are obligatory.
Parameters written in bold italics are obligatory.
Functions
AddSound
Registers a sound.
Parameters
- name (Translations:L10n:MirLua/Modules/obligatory param/en)
-
- Type:: string
- Unique name.
- description (Translations:L10n:MirLua/Modules/obligatory param/en)
-
- Type:: string
- Description.
- section
-
- Type:: string
- Section name in Miranda sound settings. By default plugin name (MirLua) is used.
- path
-
- Type:: string
- Path to sound file.
Result
- Type:: boolean
- Returns true if sound was registered successfully, otherwise false.
Example
local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')PlaySound
Plays sound by its unique name.
Parameters
- name (Translations:L10n:MirLua/Modules/obligatory param/en)
-
- Type:: string
- Unique name.
Result
- Type:: boolean
- Returns true if sound was played successfully, otherwise false.
Example
sounds.PlaySound('soundUniqueName')PlayFile
Plays sound from file.
Parameters
- path (Translations:L10n:MirLua/Modules/obligatory param/en)
-
- Type:: string
- Path to file.
Result
- Type:: boolean
- Returns true if sound was played successfully, otherwise false.
Example
sounds.PlayFile('c:\\lambada.wav')