Plugin:MirLua/Module/m sounds: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Dart Raiden (talk | contribs) (Marked this version for translation) |
||
| Line 14: | Line 14: | ||
=== AddSound === | === AddSound === | ||
<translate> | <translate> | ||
<!--T:3--> | |||
Registers a sound. | Registers a sound. | ||
</translate> | </translate> | ||
| Line 19: | Line 20: | ||
: '''''name''''' | : '''''name''''' | ||
:: <translate> | :: <translate> | ||
<!--T:4--> | |||
Type: <tvar|type_string_required>'''string'''</> | Type: <tvar|type_string_required>'''string'''</> | ||
</translate> | </translate> | ||
:: <translate>Unique name.</translate> | :: <translate><!--T:5--> Unique name.</translate> | ||
: '''''description''''' | : '''''description''''' | ||
:: Type: '''string''' | :: Type: '''string''' | ||
| Line 44: | Line 46: | ||
: '''''name''''' | : '''''name''''' | ||
:: <translate> | :: <translate> | ||
<!--T:6--> | |||
Type: <tvar|type_string_required>'''string'''</> | Type: <tvar|type_string_required>'''string'''</> | ||
</translate> | </translate> | ||
Revision as of 01:20, 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')