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 2: | Line 2: | ||
Allows you to work with sounds. | Allows you to work with sounds. | ||
{{Ls|MirLua/Modules/include_info}}: <code>local sounds = require('m_sounds')</code> | |||
__TOC__ | __TOC__ | ||
== Functions == | |||
=== AddSound === | === AddSound === | ||
Registers a sound. | Registers a sound. | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | |||
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | |||
:: | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Unique name. | :: Unique name. | ||
:: | ; {{nbsp|5}}''description'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | ||
:: {{Ls|MirLua/Modules/type}}: '''string''' | |||
:: Description. | :: Description. | ||
:: | ; {{nbsp|5}}''section'' | ||
:: {{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''' | |||
:: Path to sound file. | :: Path to sound file. | ||
==== {{Ls|MirLua/Modules/result}} ==== | |||
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: '''boolean''' | |||
{{nbsp|5}}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 36: | Line 37: | ||
Plays sound by its unique name. | Plays sound by its unique name. | ||
; | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | |||
:: | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Unique name. | :: Unique name. | ||
==== {{Ls|MirLua/Modules/result}} ==== | |||
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: '''boolean''' | |||
{{nbsp|5}}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 51: | Line 53: | ||
Plays sound from file. | Plays sound from file. | ||
; | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}} | |||
:: | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Path to file. | :: Path to file. | ||
==== {{Ls|MirLua/Modules/result}} ==== | |||
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: '''boolean''' | |||
{{nbsp|5}}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 18:28, 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.
- 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')