User:Unsane/MirLua/m sounds: Difference between revisions

From Miranda NG
Jump to navigation Jump to search
mNo edit summary
Line 14: Line 14:
: ''section''
: ''section''
:: Тип: '''string'''
:: Тип: '''string'''
:: Название секции для группировки в настройках. По умолчанию, в качестве секции используется название плагина (MirLua)
:: Название секции для группировки в настройках. По умолчанию, в качестве секции используется название плагина (''MirLua'')
: ''path''
: ''path''
:: Тип: '''string'''
:: Тип: '''string'''

Revision as of 00:43, 26 December 2015

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

AddSound

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

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

PlaySound

Воcпроизводит звук

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

PlayFile

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

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