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

From Miranda NG
Jump to navigation Jump to search
No edit summary
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
Предоставляет функционал для работы со звуками. <br/>
Предоставляет функциональность для работы со звуками. <br/>
Подключение модуля: <code>local sounds = require('m_sounds')</code>
Подключение модуля: <code>local sounds = require('m_sounds')</code>


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


;Параметры
;Параметры
Line 14: Line 14:
: ''section''
: ''section''
:: Тип: '''string'''
:: Тип: '''string'''
:: Название секции для группировки в настройках. По умолчанию, в качестве секции используется название плагина (MirLua)
:: Название секции для группировки в настройках. По умолчанию, в качестве секции используется название плагина (''MirLua'')
: ''path''
:: Тип: '''string'''
:: Путь к звуковому файлу
;Результат
;Результат
: Тип: '''light userdata'''
: Тип: '''boolean'''
: Возвращает дескриптор , если иконка была успешно зарегистрирована, иначе '''nil'''
: Возвращает '''true''', если звук был успешно зарегистрирована, иначе '''false'''
;Пример
;Пример
{{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===
Возпроизводит звук
Воcпроизводит звук по уникальному названию


;Параметры
;Параметры
Line 29: Line 32:
:: Уникальное название
:: Уникальное название
;Результат
;Результат
: Тип: '''light userdata'''
: Тип: '''boolean'''
: Возвращает дескриптор , если иконка была успешно зарегистрирована, иначе '''nil'''
: Возвращает '''true''' в случае успешного воспроизведения звука, иначе '''false'''
;Пример
;Пример
{{Content:MirLua/Example|code=sounds.PlaySound('iconUniqueName')}}
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}


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


;Параметры
;Параметры
Line 42: Line 45:
:: Путь к файлу
:: Путь к файлу
;Результат
;Результат
: Тип: '''light userdata'''
: Тип: '''boolean'''
: Возвращает дескриптор , если иконка была успешно зарегистрирована, иначе '''nil'''
: Возвращает '''true''' в случае успешного воспроизведения звука, иначе '''false'''
;Пример
;Пример
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}

Latest revision as of 00:21, 6 November 2021

Предоставляет функциональность для работы со звуками.
Подключение модуля: 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')
Retrieved from "https://wiki.miranda-ng.org/index.php?title=User:Unsane/MirLua/m_sounds&oldid=40568"