Plugin:MirLua/Module/m sounds/ru

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