Plugin:MirLua/Module/m sounds: Difference between revisions
Jump to navigation
Jump to search
(add missing header (levels of headers shouldn't be skipped - html corectness)) |
(mark obligatory parameters explicitly with text rather than visual styles (accessibility)) |
||
| Line 18: | Line 18: | ||
; {{Ls|MirLua/Modules/parameters}} | ; {{Ls|MirLua/Modules/parameters}} | ||
: '''''name''''' | : '''''name''''' ({{Ls|MirLua/Modules/obligatory_param}}) | ||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Unique name. | :: Unique name. | ||
: '''''description''''' | : '''''description''''' ({{Ls|MirLua/Modules/obligatory_param}}) | ||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Description. | :: Description. | ||
| Line 42: | Line 42: | ||
; {{Ls|MirLua/Modules/parameters}} | ; {{Ls|MirLua/Modules/parameters}} | ||
: '''''name''''' | : '''''name''''' ({{Ls|MirLua/Modules/obligatory_param}}) | ||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Unique name. | :: Unique name. | ||
| Line 57: | Line 57: | ||
; {{Ls|MirLua/Modules/parameters}} | ; {{Ls|MirLua/Modules/parameters}} | ||
: '''''path''''' | : '''''path''''' ({{Ls|MirLua/Modules/obligatory_param}}) | ||
:: {{Ls|MirLua/Modules/type}}: '''string''' | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Path to file. | :: Path to file. | ||
Revision as of 15:48, 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')