Plugin:MirLua/Module/m sounds: Difference between revisions
Jump to navigation
Jump to search
m (Goraf moved page Plugin:MirLua/m sounds to Plugin:MirLua/Module/m sounds without leaving a redirect: Part of translatable page "Plugin:MirLua/m sounds") |
(general cleaning; remove most of the translation units) |
||
| Line 5: | Line 5: | ||
</translate> | </translate> | ||
Include module: <code>local sounds = require('m_sounds')</code> | |||
{{Note|Parameters written in '''''bold italics''''' are obligatory.}} | {{Note|Parameters written in '''''bold italics''''' are obligatory.}} | ||
| Line 13: | Line 13: | ||
=== AddSound === | === AddSound === | ||
Registers a sound. | Registers a sound. | ||
;{{Ls|MirLua/Modules/parameters}} | ; {{Ls|MirLua/Modules/parameters}} | ||
: '''''name''''' | : '''''name''''' | ||
:: | :: Type: '''string''' | ||
:: | :: Unique name. | ||
: '''''description''''' | : '''''description''''' | ||
:: Type: '''string''' | :: Type: '''string''' | ||
| Line 30: | Line 28: | ||
:: Type: '''string''' | :: Type: '''string''' | ||
:: Path to sound file. | :: Path to sound file. | ||
;Result | |||
; Result | |||
: Type: '''boolean''' | : Type: '''boolean''' | ||
: Returns '''true''' if sound was registered successfully, otherwise '''false'''. | : Returns '''true''' if sound was registered successfully, otherwise '''false'''. | ||
;Example | |||
; 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 | ; Parameters | ||
: '''''name''''' | : '''''name''''' | ||
:: | :: Type: '''string''' | ||
:: Unique name. | :: Unique name. | ||
;Result | |||
; Result | |||
: Type: '''boolean''' | : Type: '''boolean''' | ||
: Returns '''true''' if sound was played successfully, otherwise '''false'''. | : Returns '''true''' if sound was played successfully, otherwise '''false'''. | ||
;Example | |||
; 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 | ; Parameters | ||
: '''''path''''' | : '''''path''''' | ||
:: Type: '''string''' | :: Type: '''string''' | ||
:: Path to file. | :: Path to file. | ||
;Result | |||
; Result | |||
: Type: '''boolean''' | : Type: '''boolean''' | ||
: Returns '''true''' if sound was played successfully, otherwise '''false'''. | : Returns '''true''' if sound was played successfully, otherwise '''false'''. | ||
;Example | |||
; Example | |||
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}} | {{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}} | ||
Revision as of 15:27, 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')