Plugin:MirLua/Module/m sounds/de: Difference between revisions

From Miranda NG
Jump to navigation Jump to search
(Created page with "Eindeutiger Name.")
No edit summary
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
Allows you to work with sounds.
Erlaubt es Ihnen mit Sounds zu arbeiten.


Include module: <code>local sounds = require('m_sounds')</code>
{{Ls|MirLua/Modules/include_info}} <code>local sounds = require('m_sounds')</code>


{{Note|Parameters written in '''''bold italics''''' are obligatory.}}
__TOC__
== Funktionen ==
=== AddSound ===
Registriert einen Sound
 
==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Eindeutiger Name.
|-
! scope="row" class="MirLuaParametersTable-parameter" | description
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Beschreibung.
|-
! scope="row" class="MirLuaParametersTable-parameter" | section
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>string</code>
| Name der Gruppe in den Miranda-Sound-Einstellungen. Standardmäßig wird der Name des Plugins (''MirLua'') verwendet.
|-
! scope="row" class="MirLuaParametersTable-parameter" | path
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>string</code>
| Pfad zur Sounddatei.
|}


==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>


__TOC__
{{nbsp|5}}Gibt <code>true</code> zurück wenn der Sound erfolgreich registriert wurde, anderenfalls <code>false</code>.


=== AddSound ===
==== {{Ls|MirLua/Modules/example}} ====
Registers a sound.
;Parameters
: '''''name'''''
:: Typ: '''string'''
:: Eindeutiger 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
{{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 ===
Spielt den Sound zum eindeutigen Namen.
==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Eindeutiger Name.
|}


==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>


=== PlaySound ===
{{nbsp|5}}Gibt <code>true</code> zurück wenn der Sound erfolgreich abgespielt wurde, anderenfalls <code>false</code>.
Plays sound by its unique name.


;Parameters
==== {{Ls|MirLua/Modules/example}} ====
: '''''name'''''
:: Type: '''string'''
:: Unique name.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}
----
=== PlayFile ===
Spielt Sound aus einer Datei.


==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | path
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Pfad zur Datei.
|}


=== PlayFile ===
==== {{Ls|MirLua/Modules/result}} ====
Plays sound from file.
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>
 
{{nbsp|5}}Gibt <code>true</code> zurück wenn der Sound erfolgreich abgespielt wurde, anderenfalls <code>false</code>.


;Parameters
==== {{Ls|MirLua/Modules/example}} ====
: '''''path'''''
:: Type: '''string'''
:: Path to file.
;Result
: Type: '''boolean'''
: Returns '''true''' if sound was played successfully, otherwise '''false'''.
;Example
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}
[[Category:Tutorials (en)]]

Latest revision as of 14:02, 2 June 2018

Other languages:

Erlaubt es Ihnen mit Sounds zu arbeiten.

Inkludieren Sie folgendes Modul: local sounds = require('m_sounds')

Funktionen

AddSound

Registriert einen Sound

Parameter

Parametername Benötigt Typ Beschreibung
name Ja string Eindeutiger Name.
description Ja string Beschreibung.
section Nein string Name der Gruppe in den Miranda-Sound-Einstellungen. Standardmäßig wird der Name des Plugins (MirLua) verwendet.
path Nein string Pfad zur Sounddatei.

Ergebnis

     Typ: boolean

     Gibt true zurück wenn der Sound erfolgreich registriert wurde, anderenfalls false.

Beispiel

local hIcon = sounds.AddSound('soundUniqueName', 'My super icon')

PlaySound

Spielt den Sound zum eindeutigen Namen.

Parameter

Parametername Benötigt Typ Beschreibung
name Ja string Eindeutiger Name.

Ergebnis

     Typ: boolean

     Gibt true zurück wenn der Sound erfolgreich abgespielt wurde, anderenfalls false.

Beispiel

sounds.PlaySound('soundUniqueName')

PlayFile

Spielt Sound aus einer Datei.

Parameter

Parametername Benötigt Typ Beschreibung
path Ja string Pfad zur Datei.

Ergebnis

     Typ: boolean

     Gibt true zurück wenn der Sound erfolgreich abgespielt wurde, anderenfalls false.

Beispiel

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