Plugin:MirLua/Module/m sounds

Allows you to work with sounds.

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

Functions

AddSound

Registers a sound.

Parameters

Parameters

Parameter name	Required	Type:	Description
name	Yes	string	Unique name.
description	Yes	string	Description.
section	No	string	Section name in Miranda sound settings. By default plugin name (MirLua) is used.
path	No	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 (Required)

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 (Required)

Type:: string

Path to file.

Result

     Type:: boolean

     Returns true if sound was played successfully, otherwise false.

Example

sounds.PlayFile('c:\\lambada.wav')