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 11: | Line 11: | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | ; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | ||
:: {{Ls|MirLua/Modules/type}}: | :: {{Ls|MirLua/Modules/type}}: <code>string</code> | ||
:: Unique name. | :: Unique name. | ||
; {{nbsp|5}}''description'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | ; {{nbsp|5}}''description'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | ||
:: {{Ls|MirLua/Modules/type}}: | :: {{Ls|MirLua/Modules/type}}: <code>string</code> | ||
:: Description. | :: Description. | ||
; {{nbsp|5}}''section'' | ; {{nbsp|5}}''section'' | ||
:: {{Ls|MirLua/Modules/type}}: | :: {{Ls|MirLua/Modules/type}}: <code>string</code> | ||
:: 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'' | ; {{nbsp|5}}''path'' | ||
:: {{Ls|MirLua/Modules/type}}: | :: {{Ls|MirLua/Modules/type}}: <code>string</code> | ||
:: Path to sound file. | :: Path to sound file. | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: | {{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>boolean</code> | ||
{{nbsp|5}}Returns | {{nbsp|5}}Returns <code>true</code> if sound was registered successfully, otherwise <code>false</code>. | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{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')}} | ||
---- | |||
=== PlaySound === | === PlaySound === | ||
Line 39: | Line 40: | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | ; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | ||
:: {{Ls|MirLua/Modules/type}}: | :: {{Ls|MirLua/Modules/type}}: <code>string</code> | ||
:: Unique name. | :: Unique name. | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: | {{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>boolean</code> | ||
{{nbsp|5}}Returns | {{nbsp|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>. | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}} | {{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}} | ||
---- | |||
=== PlayFile === | === PlayFile === | ||
Line 55: | Line 57: | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | ; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | ||
:: {{Ls|MirLua/Modules/type}}: | :: {{Ls|MirLua/Modules/type}}: <code>string</code> | ||
:: Path to file. | :: Path to file. | ||
==== {{Ls|MirLua/Modules/result}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: | {{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>boolean</code> | ||
{{nbsp|5}}Returns | {{nbsp|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>. | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{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 18:52, 15 April 2018
Allows you to work with sounds.
Include module:: local sounds = require('m_sounds')
Functions
AddSound
Registers a sound.
Parameters
- name (Translations:L10n:MirLua/Modules/obligatory param/en)
-
- Type::
string
- Unique name.
- Type::
- description (Translations:L10n:MirLua/Modules/obligatory param/en)
-
- 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 (Translations:L10n:MirLua/Modules/obligatory param/en)
-
- 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 (Translations:L10n:MirLua/Modules/obligatory param/en)
-
- Type::
string
- Path to file.
- Type::
Result
Type:: boolean
Returns true
if sound was played successfully, otherwise false
.
Example
sounds.PlayFile('c:\\lambada.wav')