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/obligatory_param}})}}
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/required_param}})}}
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
:: Unique name.
:: Unique name.


; {{nbsp|5}}''description'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
; {{nbsp|5}}''description'' {{Nobold|({{Ls|MirLua/Modules/required_param}})}}
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
:: Description.
:: Description.
Line 39: Line 39:


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/required_param}})}}
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
:: Unique name.
:: Unique name.
Line 56: Line 56:


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/required_param}})}}
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
:: Path to file.
:: Path to file.

Revision as of 19:20, 17 April 2018

Other languages:

Allows you to work with sounds.

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

Functions

AddSound

Registers a sound.

Параметры

     name (Required)
Тип:: string
Unique name.
     description (Required)
Тип:: 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.

Параметры

     name (Required)
Тип:: string
Unique name.

Результат

     Тип:: boolean

     Returns true if sound was played successfully, otherwise false.

Пример

sounds.PlaySound('soundUniqueName')

PlayFile

Plays sound from file.

Параметры

     path (Required)
Тип:: 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=28807"