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}} | {{Ls|MirLua/Modules/include_info}} <code>local sounds = require('m_sounds')</code> | ||
__TOC__ | __TOC__ | ||
| Line 14: | Line 14: | ||
! 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 39: | Line 39: | ||
==== {{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 <code>true</code> if sound was registered successfully, otherwise <code>false</code>. | {{nbsp|5}}Returns <code>true</code> if sound was registered successfully, otherwise <code>false</code>. | ||
| Line 55: | Line 55: | ||
! 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 65: | Line 65: | ||
==== {{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 <code>true</code> if sound was played successfully, otherwise <code>false</code>. | {{nbsp|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>. | ||
| Line 81: | Line 81: | ||
! 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 91: | Line 91: | ||
==== {{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 <code>true</code> if sound was played successfully, otherwise <code>false</code>. | {{nbsp|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>. | ||
Latest revision as of 14:00, 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')