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

From Miranda NG
Jump to navigation Jump to search
(Created page with "Тип: $type_string_required")
 
(Updating to match new version of source page)
Line 11: Line 11:
=== AddSound ===
=== AddSound ===
Registers a sound.
Registers a sound.
;Parameters
;{{Ls|MirLua/Modules/parameters}}
: '''''name'''''
: '''''name'''''
:: Тип: '''string'''
:: Тип: '''string'''

Revision as of 23:57, 14 April 2018

Other languages:

Allows you to work with sounds.

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

<translate> Note</translate>
Parameters written in bold italics are obligatory.


AddSound

Registers a sound.

Параметры
name
Тип: string
Unique name.
description
Type: string
Description.
section
Type: string
Section name in Miranda sound settings. By default plugin name (MirLua) is used.
path
Type: 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
name
Type: 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
path
Type: string
Path to file.
Result
Type: boolean
Returns true if sound was played successfully, otherwise false.
Example
sounds.PlayFile('c:\\lambada.wav')
Retrieved from "https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_sounds/ru&oldid=28605"