Plugin:MirLua/Module/m sounds: Difference between revisions
Jump to navigation
Jump to search
(add separators for better visual distinction between consecutive functions) |
(wrap language keywords with code tags) |
||
Line 16: | Line 16: | ||
==== {{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> | ||
:: <translate><!--T:4--> Unique name.</translate> | :: <translate><!--T:4--> Unique name.</translate> | ||
; {{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> | ||
:: <translate><!--T:5--> Description.</translate> | :: <translate><!--T:5--> Description.</translate> | ||
; {{nbsp|5}}''section'' | ; {{nbsp|5}}''section'' | ||
:: {{Ls|MirLua/Modules/type}}: | :: {{Ls|MirLua/Modules/type}}: <code>string</code> | ||
:: <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar|default_name>''MirLua''</>) is used.</translate> | :: <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar|default_name>''MirLua''</>) is used.</translate> | ||
; {{nbsp|5}}''path'' | ; {{nbsp|5}}''path'' | ||
:: {{Ls|MirLua/Modules/type}}: | :: {{Ls|MirLua/Modules/type}}: <code>string</code> | ||
:: <translate><!--T:7--> Path to sound file.</translate> | :: <translate><!--T:7--> Path to sound file.</translate> | ||
==== {{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}}<translate><!--T:8--> Returns <tvar|return_on_success> | {{nbsp|5}}<translate><!--T:8--> Returns <tvar|return_on_success><code>true</code></> if sound was registered successfully, otherwise <tvar|return_on_fail><code>false</code></>.</translate> | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
Line 45: | Line 45: | ||
==== {{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> | ||
:: <translate><!--T:10--> Unique name.</translate> | :: <translate><!--T:10--> Unique name.</translate> | ||
==== {{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}}<translate><!--T:11--> Returns <tvar|return_on_success> | {{nbsp|5}}<translate><!--T:11--> Returns <tvar|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar|return_on_fail><code>false</code></>.</translate> | ||
==== {{Ls|MirLua/Modules/example}} ==== | ==== {{Ls|MirLua/Modules/example}} ==== | ||
Line 62: | Line 62: | ||
==== {{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> | ||
:: <translate><!--T:13--> Path to file.</translate> | :: <translate><!--T:13--> Path to file.</translate> | ||
==== {{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}}<translate><!--T:14--> Returns <tvar|return_on_success> | {{nbsp|5}}<translate><!--T:14--> Returns <tvar|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar|return_on_fail><code>false</code></>.</translate> | ||
==== {{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:50, 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')