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

From Miranda NG
Jump to navigation Jump to search
mNo edit summary
Line 19: Line 19:
: Возвращает дескриптор , если иконка была успешно зарегистрирована, иначе '''nil'''
: Возвращает дескриптор , если иконка была успешно зарегистрирована, иначе '''nil'''
;Пример
;Пример
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('iconUniqueName', 'My super icon')}}
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}


===PlaySound===
===PlaySound===

Revision as of 18:50, 22 December 2015

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

AddSound

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

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

PlaySound

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

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

PlayFile

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

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