User:Unsane/MirLua/m sounds

From Miranda NG
Jump to navigation Jump to search

Предоставляет функциональность для работы со звуками.
Подключение модуля: local sounds = require('m_sounds')

AddSound

Регистрирует звук

Параметры
name
Тип: string
Уникальное название
description
Тип: string
Описание
section
Тип: string
Название секции для группировки в настройках. По умолчанию, в качестве секции используется название плагина (MirLua)
path
Тип: string
Путь к звуковому файлу
Результат
Тип: boolean
Возвращает true, если звук был успешно зарегистрирована, иначе false
Пример
local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')

PlaySound

Воcпроизводит звук по уникальному названию

Параметры
name
Тип: string
Уникальное название
Результат
Тип: boolean
Возвращает true в случае успешного воспроизведения звука, иначе false
Пример
sounds.PlaySound('soundUniqueName')

PlayFile

Воcпроизводит звук из файла

Параметры
path
Тип: string
Путь к файлу
Результат
Тип: boolean
Возвращает true в случае успешного воспроизведения звука, иначе false
Пример
sounds.PlayFile('c:\\lambada.wav')