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

From Miranda NG
Jump to navigation Jump to search
(correct indentation and font style of parameters)
(mark translation units)
Line 8: Line 8:


__TOC__
__TOC__
 
<translate>
== Functions ==
== Functions ==
 
</translate>
=== AddSound ===
=== AddSound ===
Registers a sound.
<translate>Registers a sound.</translate>


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
:: {{Ls|MirLua/Modules/type}}: '''string'''
:: {{Ls|MirLua/Modules/type}}: '''string'''
:: Unique name.
:: <translate>Unique name.</translate>


; {{nbsp|5}}''description'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
; {{nbsp|5}}''description'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
:: {{Ls|MirLua/Modules/type}}: '''string'''
:: {{Ls|MirLua/Modules/type}}: '''string'''
:: Description.
:: <translate>Description.</translate>


; {{nbsp|5}}''section''
; {{nbsp|5}}''section''
:: {{Ls|MirLua/Modules/type}}: '''string'''
:: {{Ls|MirLua/Modules/type}}: '''string'''
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
:: <translate>Section name in Miranda sound settings. By default plugin name (<tvar|default_name>''MirLua''</>) is used.</translate>


; {{nbsp|5}}''path''
; {{nbsp|5}}''path''
:: {{Ls|MirLua/Modules/type}}: '''string'''
:: {{Ls|MirLua/Modules/type}}: '''string'''
:: Path to sound file.
:: <translate>Path to sound file.</translate>


==== {{Ls|MirLua/Modules/result}} ====
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: '''boolean'''
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: '''boolean'''


{{nbsp|5}}Returns '''true''' if sound was registered successfully, otherwise '''false'''.
{{nbsp|5}}<translate>Returns <tvar|return_on_success>'''true'''</> if sound was registered successfully, otherwise <tvar|return_on_fail>'''false'''</>.</translate>


==== {{Ls|MirLua/Modules/example}} ====
==== {{Ls|MirLua/Modules/example}} ====
Line 40: Line 40:


=== PlaySound ===
=== PlaySound ===
Plays sound by its unique name.
<translate>Plays sound by its unique name.</translate>


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
:: {{Ls|MirLua/Modules/type}}: '''string'''
:: {{Ls|MirLua/Modules/type}}: '''string'''
:: Unique name.
:: <translate>Unique name.</translate>


==== {{Ls|MirLua/Modules/result}} ====
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: '''boolean'''
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: '''boolean'''


{{nbsp|5}}Returns '''true''' if sound was played successfully, otherwise '''false'''.
{{nbsp|5}}<translate>Returns <tvar|return_on_success>'''true'''</> if sound was played successfully, otherwise <tvar|return_on_fail>'''false'''</>.</translate>


==== {{Ls|MirLua/Modules/example}} ====
==== {{Ls|MirLua/Modules/example}} ====
Line 56: Line 56:


=== PlayFile ===
=== PlayFile ===
Plays sound from file.
<translate>Plays sound from file.</translate>


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
:: {{Ls|MirLua/Modules/type}}: '''string'''
:: {{Ls|MirLua/Modules/type}}: '''string'''
:: Path to file.
:: <translate>Path to file.</translate>


==== {{Ls|MirLua/Modules/result}} ====
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: '''boolean'''
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: '''boolean'''


{{nbsp|5}}Returns '''true''' if sound was played successfully, otherwise '''false'''.
{{nbsp|5}}<translate>Returns <tvar|return_on_success>'''true'''</> if sound was played successfully, otherwise <tvar|return_on_fail>'''false'''</>.</translate>


==== {{Ls|MirLua/Modules/example}} ====
==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}

Revision as of 18:23, 15 April 2018

Other languages:

Allows you to work with sounds.

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

Functions

AddSound

Registers a sound.

Parameters

     name (Translations:L10n:MirLua/Modules/obligatory param/en)
Type:: string
Unique name.
     description (Translations:L10n:MirLua/Modules/obligatory param/en)
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

local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')

PlaySound

Plays sound by its unique name.

Parameters

     name (Translations:L10n:MirLua/Modules/obligatory param/en)
Type:: 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

     path (Translations:L10n:MirLua/Modules/obligatory param/en)
Type:: 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=28689"