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

From Miranda NG
Jump to navigation Jump to search
← Older edit
Goraf (talk | contribs)
Bureaucrats, Administrators, trusted
10,022 edits
turning AddSound parameters into table - first iteration
Goraf (talk | contribs)
Bureaucrats, Administrators, trusted
10,022 edits
import correct table headers; remove untranslatable colons
 
(3 intermediate revisions by the same user not shown)
Line 5: Line 5:
</translate>
</translate>


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


__TOC__
__TOC__
Line 16: Line 16:
==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
{| class="wikitable"
|+ {{Ls|MirLua/Modules/parameters}}
|-
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|MirLua/Modules/type}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | Description
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
|-
! scope="row" style="text-align:left" | name
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | 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" style="text-align:left" | description
! scope="row" class="MirLuaParametersTable-parameter" | description
| style="text-align:center" | 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" style="text-align:left" | section
! scope="row" class="MirLuaParametersTable-parameter" | section
| style="text-align:center" | 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" style="text-align:left" | path
! scope="row" class="MirLuaParametersTable-parameter" | path
| style="text-align:center" | no
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>string</code>
| style="text-align:center" | <code>string</code>
| <translate><!--T:7--> Path to sound file.</translate>
| <translate><!--T:7--> Path to sound file.</translate>
Line 45: Line 44:


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


{{nbsp|5}}<translate><!--T:8--> Returns <tvar|return_on_success><code>true</code></> if sound was registered successfully, otherwise <tvar|return_on_fail><code>false</code></>.</translate>
{{nbsp|5}}<translate><!--T:8--> Returns <tvar|return_on_success><code>true</code></> if sound was registered successfully, otherwise <tvar|return_on_fail><code>false</code></>.</translate>
Line 57: Line 56:


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/required_param}})}}
{| class="wikitable"
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
|-
:: <translate><!--T:10--> Unique name.</translate>
! 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>
| <translate><!--T:10--> Unique name.</translate>
|}


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


{{nbsp|5}}<translate><!--T:11--> Returns <tvar|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar|return_on_fail><code>false</code></>.</translate>
{{nbsp|5}}<translate><!--T:11--> Returns <tvar|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar|return_on_fail><code>false</code></>.</translate>
Line 74: Line 82:


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/required_param}})}}
{| class="wikitable"
:: {{Ls|MirLua/Modules/type}}: <code>string</code>
|-
:: <translate><!--T:13--> Path to file.</translate>
! 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" | path
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| <translate><!--T:13--> Path to file.</translate>
|}


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


{{nbsp|5}}<translate><!--T:14--> Returns <tvar|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar|return_on_fail><code>false</code></>.</translate>
{{nbsp|5}}<translate><!--T:14--> Returns <tvar|return_on_success><code>true</code></> if sound was played successfully, otherwise <tvar|return_on_fail><code>false</code></>.</translate>

Latest revision as of 13:59, 2 June 2018

Other languages:

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

Parameter name Required Type Description
name Yes string Unique name.

Result

     Type: boolean

     Returns true if sound was played successfully, otherwise false.

Example

sounds.PlaySound('soundUniqueName')

PlayFile

Plays sound from file.

Parameters

Parameter name Required Type Description
path Yes string Path to file.

Result

     Type: boolean

     Returns true if sound was played successfully, otherwise false.

Example

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