Plugin:MirLua/Module/m sounds/ru
Jump to navigation
Jump to search
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')