Plugin:MirLua/Module/m sounds/pl: Difference between revisions

From Miranda NG
Jump to navigation Jump to search
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
Pozwala na pracę z dźwiękami.
Pozwala na pracę z dźwiękami.


{{Ls|MirLua/Modules/include_info}}: <code>local sounds = require('m_sounds')</code>
{{Ls|MirLua/Modules/include_info}} <code>local sounds = require('m_sounds')</code>


__TOC__
__TOC__
== Functions ==
== Funkcje ==
=== AddSound ===
=== AddSound ===
Registers a sound.
Registers a sound.


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
{| class="wikitable"
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
|-
:: Unique name.
! scope="col" | {{Ls|MirLua/Modules/param_name}}
 
! scope="col" | {{Ls|MirLua/Modules/required_param}}
; {{nbsp|5}}''description'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
! scope="col" | {{Ls|Content/TableHeaders/description}}
:: Description.
|-
 
! scope="row" class="MirLuaParametersTable-parameter" | name
; {{nbsp|5}}''section''
| style="text-align:center" | {{Ls|YesNo/yes}}
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
| style="text-align:center" | <code>string</code>
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
| Unique name.
 
|-
; {{nbsp|5}}''path''
! scope="row" class="MirLuaParametersTable-parameter" | description
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
| style="text-align:center" | {{Ls|YesNo/yes}}
:: Path to sound file.
| 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}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>boolean</code>
{{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 39: Line 51:


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
{| class="wikitable"
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
|-
:: Unique name.
! 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}} ====
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>boolean</code>
{{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 56: Line 77:


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
{| class="wikitable"
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
|-
:: Path to file.
! 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}} ====
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: <code>boolean</code>
{{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

Other languages:

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')