Plugin:MirLua/Module/m sounds: Difference between revisions
Jump to navigation
Jump to search
(mark obligatory parameters explicitly with text rather than visual styles (accessibility)) |
(replace function subsections with headers; we should also get rid of the rest syntax as it produces wrong html markup) |
||
| Line 8: | Line 8: | ||
{{Note|Parameters written in '''''bold italics''''' are obligatory.}} | {{Note|Parameters written in '''''bold italics''''' are obligatory.}} | ||
__TOC__ | __TOC__ | ||
| Line 17: | Line 16: | ||
Registers a sound. | Registers a sound. | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | |||
: '''''name''''' ({{Ls|MirLua/Modules/obligatory_param}}) | : '''''name''''' ({{Ls|MirLua/Modules/obligatory_param}}) | ||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
| Line 31: | Line 30: | ||
:: Path to sound file. | :: Path to sound file. | ||
==== {{Ls|MirLua/Modules/result}} ==== | |||
: {{Ls|MirLua/Modules/type}}: '''boolean''' | : {{Ls|MirLua/Modules/type}}: '''boolean''' | ||
: Returns '''true''' if sound was registered successfully, otherwise '''false'''. | : Returns '''true''' if sound was registered successfully, otherwise '''false'''. | ||
==== {{Ls|MirLua/Modules/example}} ==== | |||
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}} | {{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}} | ||
| Line 41: | Line 40: | ||
Plays sound by its unique name. | Plays sound by its unique name. | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | |||
: '''''name''''' ({{Ls|MirLua/Modules/obligatory_param}}) | : '''''name''''' ({{Ls|MirLua/Modules/obligatory_param}}) | ||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Unique name. | :: Unique name. | ||
==== {{Ls|MirLua/Modules/result}} ==== | |||
: {{Ls|MirLua/Modules/type}}: '''boolean''' | : {{Ls|MirLua/Modules/type}}: '''boolean''' | ||
: Returns '''true''' if sound was played successfully, otherwise '''false'''. | : Returns '''true''' if sound was played successfully, otherwise '''false'''. | ||
==== {{Ls|MirLua/Modules/example}} ==== | |||
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}} | {{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}} | ||
| Line 56: | Line 55: | ||
Plays sound from file. | Plays sound from file. | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | |||
: '''''path''''' ({{Ls|MirLua/Modules/obligatory_param}}) | : '''''path''''' ({{Ls|MirLua/Modules/obligatory_param}}) | ||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Path to file. | :: Path to file. | ||
==== {{Ls|MirLua/Modules/result}} ==== | |||
: {{Ls|MirLua/Modules/type}}: '''boolean''' | : {{Ls|MirLua/Modules/type}}: '''boolean''' | ||
: Returns '''true''' if sound was played successfully, otherwise '''false'''. | : Returns '''true''' if sound was played successfully, otherwise '''false'''. | ||
==== {{Ls|MirLua/Modules/example}} ==== | |||
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}} | {{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}} | ||
Revision as of 16:13, 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')