Plugin:MirLua/Module/m sounds/en - Revision history

FuzzyBot: Updating to match new version of source page

2018-06-02T11:00:17Z

Updating to match new version of source page

← Older revision		Revision as of 14:00, 2 June 2018
Line 2:		Line 2:
	Allows you to work with sounds.		Allows you to work with sounds.

	{{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__
Line 14:		Line 14:
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|~~MirLua~~/~~Modules~~/type}}		! scope="col" \| {{Ls\|Content/TableHeaders/type}}
	! scope="col" \| {{Ls\|Content/TableHeaders/description}}		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
Line 39:		Line 39:

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

	{{nbsp\|5}}Returns <code>true</code> if sound was registered successfully, otherwise <code>false</code>.		{{nbsp\|5}}Returns <code>true</code> if sound was registered successfully, otherwise <code>false</code>.
Line 55:		Line 55:
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|~~MirLua~~/~~Modules~~/type}}		! scope="col" \| {{Ls\|Content/TableHeaders/type}}
	! scope="col" \| {{Ls\|Content/TableHeaders/description}}		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
Line 65:		Line 65:

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

	{{nbsp\|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>.		{{nbsp\|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>.
Line 81:		Line 81:
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|~~MirLua~~/~~Modules~~/type}}		! scope="col" \| {{Ls\|Content/TableHeaders/type}}
	! scope="col" \| {{Ls\|Content/TableHeaders/description}}		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
Line 91:		Line 91:

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

	{{nbsp\|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>.		{{nbsp\|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>.

FuzzyBot: Updating to match new version of source page

2018-06-01T18:56:52Z

Updating to match new version of source page

← Older revision		Revision as of 21:56, 1 June 2018
Line 10:		Line 10:

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

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
Line 39:		Line 51:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{~~nbsp~~\|5}}~~''name''~~ {{~~Nobold~~\|({{Ls\|MirLua/Modules/~~required_param~~}})}}		{\| class="wikitable"
	:: {{Ls\|~~MirLua/Modules~~/~~type~~}}: <code>string</code>		\|-
	:: Unique name.		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
			! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
			! scope="col" \| {{Ls\|MirLua/Modules/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>
			\| Unique name.
			\|}

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
Line 56:		Line 77:

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

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====

FuzzyBot: Updating to match new version of source page

2018-04-17T16:19:10Z

Updating to match new version of source page

← Older revision		Revision as of 19:19, 17 April 2018
Line 10:		Line 10:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/~~obligatory_param~~}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/required_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Unique name.		:: Unique name.

	; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/~~obligatory_param~~}})}}		; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/required_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Description.		:: Description.
Line 39:		Line 39:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/~~obligatory_param~~}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/required_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Unique name.		:: Unique name.
Line 56:		Line 56:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/~~obligatory_param~~}})}}		; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/required_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Path to file.		:: Path to file.

FuzzyBot: Updating to match new version of source page

2018-04-15T15:52:46Z

Updating to match new version of source page

← Older revision		Revision as of 18:52, 15 April 2018
Line 11:		Line 11:
	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Unique name.		:: Unique name.

	; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Description.		:: Description.

	; {{nbsp\|5}}''section''		; {{nbsp\|5}}''section''
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.		:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.

	; {{nbsp\|5}}''path''		; {{nbsp\|5}}''path''
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Path to sound file.		:: Path to sound file.

	==== {{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}}Returns <code>true</code> if sound was registered successfully, otherwise <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 ===
Line 39:		Line 40:
	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Unique name.		:: Unique 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}}Returns <code>true</code> if sound was played successfully, otherwise <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 ===
Line 55:		Line 57:
	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Path to file.		:: Path to file.

	==== {{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}}Returns <code>true</code> if sound was played successfully, otherwise <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')}}

FuzzyBot: Updating to match new version of source page

2018-04-15T15:28:01Z

Updating to match new version of source page

← Older revision		Revision as of 18:28, 15 April 2018
Line 2:		Line 2:
	Allows you to work with sounds.		Allows you to work with sounds.

	~~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__		__TOC__
			== Functions ==
	=== AddSound ===		=== AddSound ===
	Registers a sound.		Registers a sound.

	; {{Ls\|MirLua/Modules/parameters}}		==== {{Ls\|MirLua/Modules/parameters}} ====
	~~: '''~~''name''~~'''~~		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: ~~Type~~: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: Unique name.		:: Unique name.
	~~: '''~~''description''~~'''~~
	:: ~~Type~~: '''string'''		; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
			:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: Description.		:: Description.
	: ''section''
	:: ~~Type~~: '''string'''		; {{nbsp\|5}}''section''
			:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.		:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.
	: ''path''
	:: ~~Type~~: '''string'''		; {{nbsp\|5}}''path''
			:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: Path to sound file.		:: Path to sound file.

	~~; Result~~		==== {{Ls\|MirLua/Modules/result}} ====
	~~: Type~~: '''boolean'''		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''
	: Returns '''true''' if sound was registered successfully, otherwise '''false'''.
			{{nbsp\|5}}Returns '''true''' if sound was registered successfully, otherwise '''false'''.

	~~; 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')}}

Line 36:		Line 37:
	Plays sound by its unique name.		Plays sound by its unique name.

	; ~~Parameters~~		==== {{Ls\|MirLua/Modules/parameters}} ====
	~~: '''~~''name''~~'''~~		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: ~~Type~~: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: Unique name.		:: Unique name.

	~~; Result~~		==== {{Ls\|MirLua/Modules/result}} ====
	~~: Type~~: '''boolean'''		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''
	: Returns '''true''' if sound was played successfully, otherwise '''false'''.
			{{nbsp\|5}}Returns '''true''' if sound was played successfully, otherwise '''false'''.

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

Line 51:		Line 53:
	Plays sound from file.		Plays sound from file.

	; ~~Parameters~~		==== {{Ls\|MirLua/Modules/parameters}} ====
	~~: '''~~''path''~~'''~~		; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: ~~Type~~: '''string'''		:: {{Ls\|MirLua/Modules/type}}: '''string'''
	:: Path to file.		:: Path to file.

	~~; Result~~		==== {{Ls\|MirLua/Modules/result}} ====
	~~: Type~~: '''boolean'''		{{nbsp\|5}}{{Ls\|MirLua/Modules/type}}: '''boolean'''
	: Returns '''true''' if sound was played successfully, otherwise '''false'''.
			{{nbsp\|5}}Returns '''true''' if sound was played successfully, otherwise '''false'''.

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

FuzzyBot: Updating to match new version of source page

2018-04-15T12:27:35Z

Updating to match new version of source page

← Older revision		Revision as of 15:27, 15 April 2018
Line 11:		Line 11:
	=== AddSound ===		=== AddSound ===
	Registers a sound.		Registers a sound.
	;{{Ls\|MirLua/Modules/parameters}}
			; {{Ls\|MirLua/Modules/parameters}}
	: '''''name'''''		: '''''name'''''
	:: Type: '''string'''		:: Type: '''string'''
Line 24:		Line 25:
	:: Type: '''string'''		:: Type: '''string'''
	:: Path to sound file.		:: Path to sound file.
	;Result
			; Result
	: Type: '''boolean'''		: Type: '''boolean'''
	: Returns '''true''' if sound was registered successfully, otherwise '''false'''.		: Returns '''true''' if sound was registered successfully, otherwise '''false'''.
	;Example
			; 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.		Plays sound by its unique name.

	;Parameters		; Parameters
	: '''''name'''''		: '''''name'''''
	:: Type: '''string'''		:: Type: '''string'''
	:: Unique name.		:: Unique name.
	;Result
			; Result
	: Type: '''boolean'''		: Type: '''boolean'''
	: Returns '''true''' if sound was played successfully, otherwise '''false'''.		: Returns '''true''' if sound was played successfully, otherwise '''false'''.
	;Example
			; Example
	{{Content:MirLua/Example\|code=sounds.PlaySound('soundUniqueName')}}		{{Content:MirLua/Example\|code=sounds.PlaySound('soundUniqueName')}}


	=== PlayFile ===		=== PlayFile ===
	Plays sound from file.		Plays sound from file.

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

	~~[[Category:Tutorials (en)]]~~

FuzzyBot: FuzzyBot moved page Plugin:MirLua/m sounds/en to Plugin:MirLua/Module/m sounds/en without leaving a redirect: Part of translatable page "Plugin:MirLua/m sounds"

2018-04-15T12:16:34Z

FuzzyBot moved page Plugin:MirLua/m sounds/en to Plugin:MirLua/Module/m sounds/en without leaving a redirect: Part of translatable page "Plugin:MirLua/m sounds"

← Older revision	Revision as of 15:16, 15 April 2018
(No difference)

FuzzyBot: Updating to match new version of source page

2018-04-14T20:57:18Z

Updating to match new version of source page

← Older revision		Revision as of 23:57, 14 April 2018
Line 11:		Line 11:
	=== AddSound ===		=== AddSound ===
	Registers a sound.		Registers a sound.
	;~~Parameters~~		;{{Ls\|MirLua/Modules/parameters}}
	: '''''name'''''		: '''''name'''''
	:: Type: '''string'''		:: Type: '''string'''

FuzzyBot: Updating to match new version of source page

2018-04-13T22:21:25Z

Updating to match new version of source page

← Older revision		Revision as of 01:21, 14 April 2018
Line 11:		Line 11:
	=== AddSound ===		=== AddSound ===
	Registers a sound.		Registers a sound.

	;Parameters		;Parameters
	: '''''name'''''		: '''''name'''''

FuzzyBot: Updating to match new version of source page

2018-04-13T22:13:36Z

Updating to match new version of source page

New page

<languages/>
Allows you to work with sounds.

Include module: <code>local sounds = require('m_sounds')</code>

{{Note|Parameters written in '''''bold italics''''' are obligatory.}}

__TOC__

=== 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
{{Content:MirLua/Example|code=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
{{Content:MirLua/Example|code=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
{{Content:MirLua/Example|code=sounds.PlayFile('c:\\lambada.wav')}}

[[Category:Tutorials (en)]]

← Older revision		Revision as of 14:00, 2 June 2018
Line 2:		Line 2:
	Allows you to work with sounds.		Allows you to work with sounds.

	{{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__
Line 14:		Line 14:
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|~~MirLua~~/~~Modules~~/type}}		! scope="col" \| {{Ls\|Content/TableHeaders/type}}
	! scope="col" \| {{Ls\|Content/TableHeaders/description}}		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
Line 39:		Line 39:

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

	{{nbsp\|5}}Returns <code>true</code> if sound was registered successfully, otherwise <code>false</code>.		{{nbsp\|5}}Returns <code>true</code> if sound was registered successfully, otherwise <code>false</code>.
Line 55:		Line 55:
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|~~MirLua~~/~~Modules~~/type}}		! scope="col" \| {{Ls\|Content/TableHeaders/type}}
	! scope="col" \| {{Ls\|Content/TableHeaders/description}}		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
Line 65:		Line 65:

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

	{{nbsp\|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>.		{{nbsp\|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>.
Line 81:		Line 81:
	! scope="col" \| {{Ls\|MirLua/Modules/param_name}}		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
	! scope="col" \| {{Ls\|MirLua/Modules/required_param}}		! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
	! scope="col" \| {{Ls\|~~MirLua~~/~~Modules~~/type}}		! scope="col" \| {{Ls\|Content/TableHeaders/type}}
	! scope="col" \| {{Ls\|Content/TableHeaders/description}}		! scope="col" \| {{Ls\|Content/TableHeaders/description}}
	\|-		\|-
Line 91:		Line 91:

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

	{{nbsp\|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>.		{{nbsp\|5}}Returns <code>true</code> if sound was played successfully, otherwise <code>false</code>.

← Older revision		Revision as of 21:56, 1 June 2018
Line 10:		Line 10:

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

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
Line 39:		Line 51:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{~~nbsp~~\|5}}~~''name''~~ {{~~Nobold~~\|({{Ls\|MirLua/Modules/~~required_param~~}})}}		{\| class="wikitable"
	:: {{Ls\|~~MirLua/Modules~~/~~type~~}}: <code>string</code>		\|-
	:: Unique name.		! scope="col" \| {{Ls\|MirLua/Modules/param_name}}
			! scope="col" \| {{Ls\|MirLua/Modules/required_param}}
			! scope="col" \| {{Ls\|MirLua/Modules/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>
			\| Unique name.
			\|}

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====
Line 56:		Line 77:

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

	==== {{Ls\|MirLua/Modules/result}} ====		==== {{Ls\|MirLua/Modules/result}} ====

← Older revision		Revision as of 19:19, 17 April 2018
Line 10:		Line 10:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/~~obligatory_param~~}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/required_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Unique name.		:: Unique name.

	; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/~~obligatory_param~~}})}}		; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/required_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Description.		:: Description.
Line 39:		Line 39:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/~~obligatory_param~~}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/required_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Unique name.		:: Unique name.
Line 56:		Line 56:

	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/~~obligatory_param~~}})}}		; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/required_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: <code>string</code>		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Path to file.		:: Path to file.

← Older revision		Revision as of 18:52, 15 April 2018
Line 11:		Line 11:
	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Unique name.		:: Unique name.

	; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''description'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Description.		:: Description.

	; {{nbsp\|5}}''section''		; {{nbsp\|5}}''section''
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.		:: Section name in Miranda sound settings. By default plugin name (''MirLua'') is used.

	; {{nbsp\|5}}''path''		; {{nbsp\|5}}''path''
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Path to sound file.		:: Path to sound file.

	==== {{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}}Returns <code>true</code> if sound was registered successfully, otherwise <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 ===
Line 39:		Line 40:
	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''name'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Unique name.		:: Unique 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}}Returns <code>true</code> if sound was played successfully, otherwise <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 ===
Line 55:		Line 57:
	==== {{Ls\|MirLua/Modules/parameters}} ====		==== {{Ls\|MirLua/Modules/parameters}} ====
	; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}		; {{nbsp\|5}}''path'' {{Nobold\|({{Ls\|MirLua/Modules/obligatory_param}})}}
	:: {{Ls\|MirLua/Modules/type}}: ~~'''~~string~~'''~~		:: {{Ls\|MirLua/Modules/type}}: <code>string</code>
	:: Path to file.		:: Path to file.

	==== {{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}}Returns <code>true</code> if sound was played successfully, otherwise <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')}}