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

From Miranda NG
Jump to navigation Jump to search
(Created page with "== Funktionen ==")
No edit summary
 
(16 intermediate revisions by 2 users not shown)
Line 2: Line 2:
Erlaubt es Ihnen mit Sounds zu arbeiten.
Erlaubt es Ihnen mit Sounds zu arbeiten.


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


__TOC__
__TOC__
== Funktionen ==
== Funktionen ==
=== AddSound ===
=== AddSound ===
Registers a sound.
Registriert einen Sound


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
{| class="wikitable"
:: {{Ls|MirLua/Modules/type}}: '''string'''
|-
:: Unique name.
! scope="col" | {{Ls|MirLua/Modules/param_name}}
 
! scope="col" | {{Ls|MirLua/Modules/required_param}}
; {{nbsp|5}}''description'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
:: {{Ls|MirLua/Modules/type}}: '''string'''
! scope="col" | {{Ls|Content/TableHeaders/description}}
:: Description.
|-
 
! scope="row" class="MirLuaParametersTable-parameter" | name
; {{nbsp|5}}''section''
| style="text-align:center" | {{Ls|YesNo/yes}}
:: {{Ls|MirLua/Modules/type}}: '''string'''
| style="text-align:center" | <code>string</code>
:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
| Eindeutiger Name.
 
|-
; {{nbsp|5}}''path''
! scope="row" class="MirLuaParametersTable-parameter" | description
:: {{Ls|MirLua/Modules/type}}: '''string'''
| style="text-align:center" | {{Ls|YesNo/yes}}
:: Path to sound file.
| 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}} ====
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: '''boolean'''
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>


{{nbsp|5}}Returns '''true''' if sound was registered successfully, otherwise '''false'''.
{{nbsp|5}}Gibt <code>true</code> zurück wenn der Sound erfolgreich registriert wurde, anderenfalls <code>false</code>.


==== {{Ls|MirLua/Modules/example}} ====
==== {{Ls|MirLua/Modules/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 ===
=== PlaySound ===
Plays sound by its unique name.
Spielt den Sound zum eindeutigen Namen.


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''name'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
{| class="wikitable"
:: {{Ls|MirLua/Modules/type}}: '''string'''
|-
:: Unique name.
! 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}} ====
==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}}: '''boolean'''
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>


{{nbsp|5}}Returns '''true''' if sound was played successfully, otherwise '''false'''.
{{nbsp|5}}Gibt <code>true</code> zurück wenn der Sound erfolgreich abgespielt wurde, anderenfalls <code>false</code>.


==== {{Ls|MirLua/Modules/example}} ====
==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}
{{Content:MirLua/Example|code=sounds.PlaySound('soundUniqueName')}}
----


=== PlayFile ===
=== PlayFile ===
Plays sound from file.
Spielt Sound aus einer Datei.


==== {{Ls|MirLua/Modules/parameters}} ====
==== {{Ls|MirLua/Modules/parameters}} ====
; {{nbsp|5}}''path'' {{Nobold|({{Ls|MirLua/Modules/obligatory_param}})}}
{| class="wikitable"
:: {{Ls|MirLua/Modules/type}}: '''string'''
|-
:: Path to file.
! 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.
|}


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


{{nbsp|5}}Returns '''true''' if sound was played successfully, otherwise '''false'''.
{{nbsp|5}}Gibt <code>true</code> zurück wenn der Sound erfolgreich abgespielt wurde, anderenfalls <code>false</code>.


==== {{Ls|MirLua/Modules/example}} ====
==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}

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')
Retrieved from "https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/Module/m_sounds/de&oldid=30488"