Plugin:MirLua/Module/m sounds

Allows you to work with sounds.

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

<translate> Note</translate>
Parameters written in bold italics are obligatory.

Functions

AddSound

Registers a sound.

Parameters

      name (Translations:L10n:MirLua/Modules/obligatory param/en)

Type:: string

Unique name.

      description (Translations:L10n:MirLua/Modules/obligatory param/en)

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 (Translations:L10n:MirLua/Modules/obligatory param/en)

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 (Translations:L10n:MirLua/Modules/obligatory param/en)

Type:: string

Path to file.

Result

Type:: boolean

Returns true if sound was played successfully, otherwise false.

Example

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