Plugin:MirLua/Module/m sounds: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
<languages/> | <languages/> | ||
<translate> | <translate> | ||
Allows you to work with sounds. | Allows you to work with sounds. | ||
</translate> | </translate> | ||
Include module: <code>local sounds = require('m_sounds')</code> | <translate>Include module:</translate> <code>local sounds = require('m_sounds')</code> | ||
{{Note|Parameters written in '''''bold italics''''' are obligatory.}} | {{Note|Parameters written in '''''bold italics''''' are obligatory.}} | ||
Revision as of 01:02, 14 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')