Plugin:MirLua/Module/m sounds: Difference between revisions
Jump to navigation
Jump to search
(use localized yes/no in parameters table) |
(turning AddSound parameters into table - fully localize headers, use CSS class for parameters (final iteration)) |
||
| Line 21: | Line 21: | ||
! scope="col" | {{Ls|MirLua/Modules/required_param}} | ! scope="col" | {{Ls|MirLua/Modules/required_param}} | ||
! scope="col" | {{Ls|MirLua/Modules/type}} | ! scope="col" | {{Ls|MirLua/Modules/type}} | ||
! scope="col" | | ! scope="col" | {{Ls|Content/TableHeaders/description}} | ||
|- | |- | ||
! scope="row" | ! scope="row" class="MirLuaParametersTable-parameter" | name | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>string</code> | | style="text-align:center" | <code>string</code> | ||
| <translate><!--T:4--> Unique name.</translate> | | <translate><!--T:4--> Unique name.</translate> | ||
|- | |- | ||
! scope="row" | ! scope="row" class="MirLuaParametersTable-parameter" | description | ||
| style="text-align:center" | {{Ls|YesNo/yes}} | | style="text-align:center" | {{Ls|YesNo/yes}} | ||
| style="text-align:center" | <code>string</code> | | style="text-align:center" | <code>string</code> | ||
| <translate><!--T:5--> Description.</translate> | | <translate><!--T:5--> Description.</translate> | ||
|- | |- | ||
! scope="row" | ! scope="row" class="MirLuaParametersTable-parameter" | section | ||
| style="text-align:center" | {{Ls|YesNo/no}} | | style="text-align:center" | {{Ls|YesNo/no}} | ||
| style="text-align:center" | <code>string</code> | | style="text-align:center" | <code>string</code> | ||
| <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar|default_name>''MirLua''</>) is used.</translate> | | <translate><!--T:6--> Section name in Miranda sound settings. By default plugin name (<tvar|default_name>''MirLua''</>) is used.</translate> | ||
|- | |- | ||
! scope="row" | ! scope="row" class="MirLuaParametersTable-parameter" | path | ||
| style="text-align:center" | {{Ls|YesNo/no}} | | style="text-align:center" | {{Ls|YesNo/no}} | ||
| style="text-align:center" | <code>string</code> | | style="text-align:center" | <code>string</code> | ||
Revision as of 21:32, 1 June 2018
Allows you to work with sounds.
Include module:: local sounds = require('m_sounds')
Functions
AddSound
Registers a sound.
Parameters
| Parameter name | Required | Type: | Description |
|---|---|---|---|
| name | Yes | string
|
Unique name. |
| description | Yes | string
|
Description. |
| section | No | string
|
Section name in Miranda sound settings. By default plugin name (MirLua) is used. |
| path | No | string
|
Path to sound file. |
Result
Type:: boolean
Returns true if sound was registered successfully, otherwise false.
Example
local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')PlaySound
Plays sound by its unique name.
Parameters
- name (Required)
-
- Type::
string - Unique name.
- Type::
Result
Type:: boolean
Returns true if sound was played successfully, otherwise false.
Example
sounds.PlaySound('soundUniqueName')PlayFile
Plays sound from file.
Parameters
- path (Required)
-
- Type::
string - Path to file.
- Type::
Result
Type:: boolean
Returns true if sound was played successfully, otherwise false.
Example
sounds.PlayFile('c:\\lambada.wav')