Plugin:MirLua/Module/m sounds/en: Difference between revisions
Jump to navigation
Jump to search
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
| Line 10: | Line 10: | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/ | ; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/required_param}})}} | ||
:: {{Ls|MirLua/Modules/type}}: <code>string</code> | :: {{Ls|MirLua/Modules/type}}: <code>string</code> | ||
:: Unique name. | :: Unique name. | ||
; {{nbsp|5}}''description'' {{Nobold|({{Ls|MirLua/Modules/ | ; {{nbsp|5}}''description'' {{Nobold|({{Ls|MirLua/Modules/required_param}})}} | ||
:: {{Ls|MirLua/Modules/type}}: <code>string</code> | :: {{Ls|MirLua/Modules/type}}: <code>string</code> | ||
:: Description. | :: Description. | ||
| Line 39: | Line 39: | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/ | ; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/required_param}})}} | ||
:: {{Ls|MirLua/Modules/type}}: <code>string</code> | :: {{Ls|MirLua/Modules/type}}: <code>string</code> | ||
:: Unique name. | :: Unique name. | ||
| Line 56: | Line 56: | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/ | ; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/required_param}})}} | ||
:: {{Ls|MirLua/Modules/type}}: <code>string</code> | :: {{Ls|MirLua/Modules/type}}: <code>string</code> | ||
:: Path to file. | :: Path to file. | ||
Revision as of 19:19, 17 April 2018
Allows you to work with sounds.
Include module:: local sounds = require('m_sounds')
Functions
AddSound
Registers a sound.
Parameters
- name (Required)
-
- Type::
string - Unique name.
- Type::
- description (Required)
-
- Type::
string - Description.
- Type::
- section
-
- Type::
string - Section name in Miranda sound settings. By default plugin name (MirLua) is used.
- Type::
- path
-
- Type::
string - Path to sound file.
- Type::
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 (Required)
-
- Type::
string - Unique name.
- Type::
Result
Type:: boolean
Returns true if sound was played successfully, otherwise false.
Example
sounds.PlaySound('soundUniqueName')PlayFile
Plays sound from file.
Parameters
- path (Required)
-
- Type::
string - Path to file.
- Type::
Result
Type:: boolean
Returns true if sound was played successfully, otherwise false.
Example
sounds.PlayFile('c:\\lambada.wav')