Plugin:MirLua/Module/m sounds/pl: Difference between revisions
Jump to navigation
Jump to search
(Created page with "== Funkcje ==") |
(Updating to match new version of source page) |
||
Line 10: | Line 10: | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
{| class="wikitable" | |||
: | |- | ||
! scope="col" | {{Ls|MirLua/Modules/param_name}} | |||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | |||
! scope="col" | {{Ls|MirLua/Modules/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}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
Line 39: | Line 51: | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
{| class="wikitable" | |||
: | |- | ||
! scope="col" | {{Ls|MirLua/Modules/param_name}} | |||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | |||
! scope="col" | {{Ls|MirLua/Modules/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}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== | ||
Line 56: | Line 77: | ||
==== {{Ls|MirLua/Modules/parameters}} ==== | ==== {{Ls|MirLua/Modules/parameters}} ==== | ||
{| class="wikitable" | |||
: | |- | ||
! scope="col" | {{Ls|MirLua/Modules/param_name}} | |||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | |||
! scope="col" | {{Ls|MirLua/Modules/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}} ==== | ==== {{Ls|MirLua/Modules/result}} ==== |
Revision as of 21:58, 1 June 2018
Pozwala na pracę z dźwiękami.
Dołącz moduł:: local sounds = require('m_sounds')
Funkcje
AddSound
Registers a sound.
Parametry
Nazwa parametru | Wymagany | Typ: | Opis |
---|---|---|---|
name | Tak | string
|
Unique name. |
description | Tak | string
|
Description. |
section | Nie | string
|
Section name in Miranda sound settings. By default plugin name (MirLua) is used. |
path | Nie | string
|
Path to sound file. |
Rezultat
Typ:: boolean
Returns true
if sound was registered successfully, otherwise false
.
Przykład
local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')
PlaySound
Plays sound by its unique name.
Parametry
Nazwa parametru | Wymagany | Typ: | Opis |
---|---|---|---|
name | Tak | string
|
Unique name. |
Rezultat
Typ:: boolean
Returns true
if sound was played successfully, otherwise false
.
Przykład
sounds.PlaySound('soundUniqueName')
PlayFile
Plays sound from file.
Parametry
Nazwa parametru | Wymagany | Typ: | Opis |
---|---|---|---|
path | Tak | string
|
Path to file. |
Rezultat
Typ:: boolean
Returns true
if sound was played successfully, otherwise false
.
Przykład
sounds.PlayFile('c:\\lambada.wav')