Plugin:MirLua/Module/m sounds/ru: 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)
Line 10: Line 10:


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/required_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/required_param}})}}
! scope="col" | {{Ls|MirLua/Modules/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}} ====
Line 39: Line 51:


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/required_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|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}} ====
; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/required_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|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:56, 1 June 2018

Other languages:

Allows you to work with sounds.

Include module:: local sounds = require('m_sounds')

Functions

AddSound

Registers a sound.

Параметры

Имя параметра Required Тип: Описание
name Да string Unique name.
description Да string Description.
section Нет string Section name in Miranda sound settings. By default plugin name (MirLua) is used.
path Нет string Path to sound file.

Результат

     Тип:: boolean

     Returns true if sound was registered successfully, otherwise false.

Пример

local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')

PlaySound

Plays sound by its unique name.

Параметры

Имя параметра Required Тип: Описание
name Да string Unique name.

Результат

     Тип:: boolean

     Returns true if sound was played successfully, otherwise false.

Пример

sounds.PlaySound('soundUniqueName')

PlayFile

Plays sound from file.

Параметры

Имя параметра Required Тип: Описание
path Да string Path to file.

Результат

     Тип:: boolean

     Returns true if sound was played successfully, otherwise false.

Пример

sounds.PlayFile('c:\\lambada.wav')
Retrieved from "https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_sounds/ru&oldid=30210"