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) |
||
(8 intermediate revisions by the same user not shown) | |||
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__ | |||
== Functions == | |||
=== AddSound === | |||
Registers a sound. | |||
==== {{Ls|MirLua/Modules/parameters}} ==== | |||
{| class="wikitable" | |||
|- | |||
! scope="col" | {{Ls|MirLua/Modules/param_name}} | |||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | |||
! scope="col" | {{Ls|Content/TableHeaders/type}} | |||
! scope="col" | {{Ls|Content/TableHeaders/description}} | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | name | |||
| style="text-align:center" | {{Ls|YesNo/yes}} | |||
| style="text-align:center" | <code>string</code> | |||
| Unique name. | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | description | |||
| style="text-align:center" | {{Ls|YesNo/yes}} | |||
| style="text-align:center" | <code>string</code> | |||
| Description. | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | section | |||
| style="text-align:center" | {{Ls|YesNo/no}} | |||
| style="text-align:center" | <code>string</code> | |||
| Section name in Miranda sound settings. By default plugin name (''MirLua'') is used. | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | path | |||
| style="text-align:center" | {{Ls|YesNo/no}} | |||
| style="text-align:center" | <code>string</code> | |||
| Path to sound file. | |||
|} | |||
==== {{Ls|MirLua/Modules/result}} ==== | |||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code> | |||
{{nbsp|5}}Returns <code>true</code> if sound was registered successfully, otherwise <code>false</code>. | |||
==== {{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 === | ||
Plays sound by its unique name. | Plays sound by its unique name. | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | |||
{| class="wikitable" | |||
:: | |- | ||
! scope="col" | {{Ls|MirLua/Modules/param_name}} | |||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | |||
! scope="col" | {{Ls|Content/TableHeaders/type}} | |||
! scope="col" | {{Ls|Content/TableHeaders/description}} | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | name | |||
| style="text-align:center" | {{Ls|YesNo/yes}} | |||
| style="text-align:center" | <code>string</code> | |||
| Unique name. | |||
|} | |||
==== {{Ls|MirLua/Modules/result}} ==== | |||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code> | |||
{{nbsp|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>. | |||
==== {{Ls|MirLua/Modules/example}} ==== | |||
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}} | {{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}} | ||
---- | |||
=== PlayFile === | === PlayFile === | ||
Plays sound from file. | Plays sound from file. | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | |||
{| class="wikitable" | |||
:: | |- | ||
! scope="col" | {{Ls|MirLua/Modules/param_name}} | |||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | |||
! scope="col" | {{Ls|Content/TableHeaders/type}} | |||
! scope="col" | {{Ls|Content/TableHeaders/description}} | |||
|- | |||
! scope="row" class="MirLuaParametersTable-parameter" | path | |||
| style="text-align:center" | {{Ls|YesNo/yes}} | |||
| style="text-align:center" | <code>string</code> | |||
| Path to file. | |||
|} | |||
==== {{Ls|MirLua/Modules/result}} ==== | |||
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code> | |||
{{nbsp|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>. | |||
==== {{Ls|MirLua/Modules/example}} ==== | |||
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}} | {{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}} | ||
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')