Plugin:MirLua/Module/m sounds/ru: Difference between revisions

From Miranda NG
Jump to navigation Jump to search
(Created page with "Тип: $type_string_required")
 
(Updating to match new version of source page)
 
(7 intermediate revisions by the same user not shown)
Line 2: Line 2:
Allows you to work with sounds.
Allows you to work with sounds.


Include module: <code>local sounds = require('m_sounds')</code>
{{Ls|MirLua/Modules/include_info}} <code>local sounds = require('m_sounds')</code>


{{Note|Parameters written in '''''bold italics''''' are obligatory.}}
__TOC__
== Functions ==
=== AddSound ===
Registers a sound.
 
==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Unique name.
|-
! scope="row" class="MirLuaParametersTable-parameter" | description
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Description.
|-
! scope="row" class="MirLuaParametersTable-parameter" | section
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>string</code>
| Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
|-
! scope="row" class="MirLuaParametersTable-parameter" | path
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>string</code>
| Path to sound file.
|}


==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>


__TOC__
{{nbsp|5}}Returns <code>true</code> if sound was registered successfully, otherwise <code>false</code>.


=== AddSound ===
==== {{Ls|MirLua/Modules/example}} ====
Registers a sound.
;Parameters
: '''''name'''''
:: Тип: '''string'''
:: Unique name.
: '''''description'''''
:: Type: '''string'''
:: Description.
: ''section''
:: Type: '''string'''
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
: ''path''
:: Type: '''string'''
:: Path to sound file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was registered successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}
{{Content:MirLua/Example|code=local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')}}
 
----


=== PlaySound ===
=== PlaySound ===
Plays sound by its unique name.
Plays sound by its unique name.


;Parameters
==== {{Ls|MirLua/Modules/parameters}} ====
: '''''name'''''
{| class="wikitable"
:: Type: '''string'''
|-
:: Unique name.
! scope="col" | {{Ls|MirLua/Modules/param_name}}
;Result
! scope="col" | {{Ls|MirLua/Modules/required_param}}
: Type: '''boolean'''
! scope="col" | {{Ls|Content/TableHeaders/type}}
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
! scope="col" | {{Ls|Content/TableHeaders/description}}
;Example
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Unique name.
|}
 
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>
 
{{nbsp|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>.
 
==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}
 
----


=== PlayFile ===
=== PlayFile ===
Plays sound from file.
Plays sound from file.


;Parameters
==== {{Ls|MirLua/Modules/parameters}} ====
: '''''path'''''
{| class="wikitable"
:: Type: '''string'''
|-
:: Path to file.
! scope="col" | {{Ls|MirLua/Modules/param_name}}
;Result
! scope="col" | {{Ls|MirLua/Modules/required_param}}
: Type: '''boolean'''
! scope="col" | {{Ls|Content/TableHeaders/type}}
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
! scope="col" | {{Ls|Content/TableHeaders/description}}
;Example
|-
! scope="row" class="MirLuaParametersTable-parameter" | path
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Path to file.
|}
 
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>
 
{{nbsp|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>.
 
==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}
[[Category:Tutorials (en)]]

Latest revision as of 14:00, 2 June 2018

Other languages:

Allows you to work with sounds.

Include module: local sounds = require('m_sounds')

Functions

AddSound

Registers a sound.

Параметры

Имя параметра Required Тип Описание
name Да string Unique name.
description Да 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.

Параметры

Имя параметра Required Тип Описание
name Да string Unique name.

Результат

     Тип: boolean

     Returns true if sound was played successfully, otherwise false.

Пример

sounds.PlaySound('soundUniqueName')

PlayFile

Plays sound from file.

Параметры

Имя параметра Required Тип Описание
path Да string Path to file.

Результат

     Тип: boolean

     Returns true if sound was played successfully, otherwise false.

Пример

sounds.PlayFile('c:\\lambada.wav')
Retrieved from "https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_sounds/ru&oldid=30483"