Plugin:MirLua/Module/m sounds: Difference between revisions
Jump to navigation
Jump to search
(turn all parameters list into tables) |
(import correct table headers; remove untranslatable colons) |
||
| Line 5: | Line 5: | ||
</translate> | </translate> | ||
{{Ls|MirLua/Modules/include_info}} | {{Ls|MirLua/Modules/include_info}} <code>local sounds = require('m_sounds')</code> | ||
__TOC__ | __TOC__ | ||
| Line 19: | Line 19: | ||
! scope="col" | {{Ls|MirLua/Modules/param_name}} | ! scope="col" | {{Ls|MirLua/Modules/param_name}} | ||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | ! scope="col" | {{Ls|MirLua/Modules/required_param}} | ||
! scope="col" | {{Ls| | ! scope="col" | {{Ls|Content/TableHeaders/type}} | ||
! scope="col" | {{Ls|Content/TableHeaders/description}} | ! scope="col" | {{Ls|Content/TableHeaders/description}} | ||
|- | |- | ||
| Line 44: | Line 44: | ||
==== {{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><code>true</code></> if sound was registered successfully, otherwise <tvar|return_on_fail><code>false</code></>.</translate> | {{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> | ||
| Line 60: | Line 60: | ||
! scope="col" | {{Ls|MirLua/Modules/param_name}} | ! scope="col" | {{Ls|MirLua/Modules/param_name}} | ||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | ! scope="col" | {{Ls|MirLua/Modules/required_param}} | ||
! scope="col" | {{Ls| | ! scope="col" | {{Ls|Content/TableHeaders/type}} | ||
! scope="col" | {{Ls|Content/TableHeaders/description}} | ! scope="col" | {{Ls|Content/TableHeaders/description}} | ||
|- | |- | ||
| Line 70: | Line 70: | ||
==== {{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><code>true</code></> if sound was played successfully, otherwise <tvar|return_on_fail><code>false</code></>.</translate> | {{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> | ||
| Line 86: | Line 86: | ||
! scope="col" | {{Ls|MirLua/Modules/param_name}} | ! scope="col" | {{Ls|MirLua/Modules/param_name}} | ||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | ! scope="col" | {{Ls|MirLua/Modules/required_param}} | ||
! scope="col" | {{Ls| | ! scope="col" | {{Ls|Content/TableHeaders/type}} | ||
! scope="col" | {{Ls|Content/TableHeaders/description}} | ! scope="col" | {{Ls|Content/TableHeaders/description}} | ||
|- | |- | ||
| Line 96: | Line 96: | ||
==== {{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><code>true</code></> if sound was played successfully, otherwise <tvar|return_on_fail><code>false</code></>.</translate> | {{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> | ||
Latest revision as of 13:59, 2 June 2018
Allows you to work with sounds.
Include module: local sounds = require('m_sounds')
Functions
AddSound
Registers a sound.
Parameters
| Parameter name | Required | Type | Description |
|---|---|---|---|
| name | Yes | string
|
Unique name. |
| description | Yes | string
|
Description. |
| section | No | string
|
Section name in Miranda sound settings. By default plugin name (MirLua) is used. |
| path | No | 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
| Parameter name | Required | Type | Description |
|---|---|---|---|
| name | Yes | 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
| Parameter name | Required | Type | Description |
|---|---|---|---|
| path | Yes | string
|
Path to file. |
Result
Type: boolean
Returns true if sound was played successfully, otherwise false.
Example
sounds.PlayFile('c:\\lambada.wav')