Plugin:MirLua/Module/m sounds: Difference between revisions
Jump to navigation
Jump to search
(general cleaning; remove most of the translation units) |
(Introduce/add reusable localized strings) |
||
| Line 5: | Line 5: | ||
</translate> | </translate> | ||
{{Ls|MirLua/Modules/include_info}}: <code>local sounds = require('m_sounds')</code> | |||
{{Note|Parameters written in '''''bold italics''''' are obligatory.}} | {{Note|Parameters written in '''''bold italics''''' are obligatory.}} | ||
| Line 17: | Line 17: | ||
; {{Ls|MirLua/Modules/parameters}} | ; {{Ls|MirLua/Modules/parameters}} | ||
: '''''name''''' | : '''''name''''' | ||
:: | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Unique name. | :: Unique name. | ||
: '''''description''''' | : '''''description''''' | ||
:: | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Description. | :: Description. | ||
: ''section'' | : ''section'' | ||
:: | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used. | :: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used. | ||
: ''path'' | : ''path'' | ||
:: | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Path to sound file. | :: Path to sound file. | ||
; | ; {{Ls|MirLua/Modules/result}} | ||
: | : {{Ls|MirLua/Modules/type}}: '''boolean''' | ||
: Returns '''true''' if sound was registered successfully, otherwise '''false'''. | : Returns '''true''' if sound was registered successfully, otherwise '''false'''. | ||
; | ; {{Ls|MirLua/Modules/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')}} | ||
| Line 39: | Line 39: | ||
Plays sound by its unique name. | Plays sound by its unique name. | ||
; | ; {{Ls|MirLua/Modules/parameters}} | ||
: '''''name''''' | : '''''name''''' | ||
:: | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Unique name. | :: Unique name. | ||
; | ; {{Ls|MirLua/Modules/result}} | ||
: | : {{Ls|MirLua/Modules/type}}: '''boolean''' | ||
: Returns '''true''' if sound was played successfully, otherwise '''false'''. | : Returns '''true''' if sound was played successfully, otherwise '''false'''. | ||
; | ; {{Ls|MirLua/Modules/example}} | ||
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}} | {{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}} | ||
| Line 54: | Line 54: | ||
Plays sound from file. | Plays sound from file. | ||
; | ; {{Ls|MirLua/Modules/parameters}} | ||
: '''''path''''' | : '''''path''''' | ||
:: | :: {{Ls|MirLua/Modules/type}}: '''string''' | ||
:: Path to file. | :: Path to file. | ||
; | ; {{Ls|MirLua/Modules/result}} | ||
: | : {{Ls|MirLua/Modules/type}}: '''boolean''' | ||
: Returns '''true''' if sound was played successfully, otherwise '''false'''. | : Returns '''true''' if sound was played successfully, otherwise '''false'''. | ||
; | ; {{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 15:39, 15 April 2018
Allows you to work with sounds.
Include module:: local sounds = require('m_sounds')
<translate> Note</translate>
Parameters written in bold italics are obligatory.
Parameters written in bold italics are obligatory.
AddSound
Registers a sound.
- Parameters
- name
- Type:: 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
local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')PlaySound
Plays sound by its unique name.
- Parameters
- name
- 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
- Type:: string
- Path to file.
- Result
- Type:: boolean
- Returns true if sound was played successfully, otherwise false.
- Example
sounds.PlayFile('c:\\lambada.wav')