PL/playSound: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
ThePiotrek (talk | contribs) m (przestańcie podpisywać te artykuły!) |
||
Line 9: | Line 9: | ||
===Wymagane argumenty=== | ===Wymagane argumenty=== | ||
*'''soundPath:''' [[filepath|Ścieżka]] lub adres URL do pliku dźwiękowego, który chcesz odtworzyć. | *'''soundPath:''' [[filepath|Ścieżka]] lub adres URL do pliku dźwiękowego, który chcesz odtworzyć. | ||
* Pliki odtwarzane ze ścieżki, muszą być wcześniej zapisane w pliku [[PL/meta.xml|meta.xml]] korzystając z tagu <file />. | |||
===Opcjonalne argumenty=== | ===Opcjonalne argumenty=== | ||
{{PL/OptionalArg}} | {{PL/OptionalArg}} | ||
*'''looped:''' [[Boolean]] decydujący o tym, czy dźwięk ma zostać zapętlony. Aby tak się stało, użyj ''true''. Domyślnie ''false''. | *'''looped:''' [[Boolean]] decydujący o tym, czy dźwięk ma zostać zapętlony. Aby tak się stało, użyj ''true''. Domyślnie ''false''. | ||
* Zapętlanie nie jest możliwe w przypadku stream'ów (np. radio). | |||
{{New feature/item|3.0150|1.5|| | {{New feature/item|3.0150|1.5|| | ||
*'''throttled:''' [[Boolean]] decydujący o tym, czy dźwięk z adresu URL ma być odtwarzany z niską przepustowością łącza. Aby tak się stało, użyj ''true''. Domyślnie ''true''. | *'''throttled:''' [[Boolean]] decydujący o tym, czy dźwięk z adresu URL ma być odtwarzany z niską przepustowością łącza. Aby tak się stało, użyj ''true''. Domyślnie ''true''. | ||
* Odtwarzanie z niską przepustowością łącza dotyczy tylko plików odtwarzanych z adresów URL. | |||
}} | }} | ||
Line 37: | Line 37: | ||
<br/> | <br/> | ||
==Zobacz również== | ==Zobacz również== |
Revision as of 16:11, 22 October 2016
Funkcja ta tworzy element dźwięku oraz odtwarza go dla lokalnego gracza, od razu po wywołaniu funkcji. Akutalnie wspierane formaty audio to MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M oraz PLS.
Notatka: Ze względu na wydajność, podczas korzystania z funkcji playSound do efektów (np. dźwięki strzelania), zalecana jest konwersja pliku audio z np. MP3 (stereo) do WAV (mono) z częstotliwością 22050 Hz lub niższą. Warto również dodać limit odtwarzania dźwięku np. raz na 50ms. |
Składnia
element playSound ( string soundPath, [ bool looped = false, bool throttled = true ] )
OOP Syntax Help! I don't understand this!
- Method: Sound(...)
Wymagane argumenty
- soundPath: Ścieżka lub adres URL do pliku dźwiękowego, który chcesz odtworzyć.
- Pliki odtwarzane ze ścieżki, muszą być wcześniej zapisane w pliku meta.xml korzystając z tagu <file />.
Opcjonalne argumenty
UWAGA: Kiedy korzystasz z opcjonalnych argumentów, musisz uzupełnić wszystkie argumenty przed tym, którego chcesz użyć. Aby uzyskać więcej informacji na ten temat, zajrzyj tutaj.
- looped: Boolean decydujący o tym, czy dźwięk ma zostać zapętlony. Aby tak się stało, użyj true. Domyślnie false.
- Zapętlanie nie jest możliwe w przypadku stream'ów (np. radio).
- throttled: Boolean decydujący o tym, czy dźwięk z adresu URL ma być odtwarzany z niską przepustowością łącza. Aby tak się stało, użyj true. Domyślnie true.
- Odtwarzanie z niską przepustowością łącza dotyczy tylko plików odtwarzanych z adresów URL.
Wynik
Zwraca element dźwięku jeżeli został on pomyślnie stworzony. W przeciwnym wypadku zwraca false.
Przykłady
Click to collapse [-]
Przykład nr 1Ten przykład odtwarza graczowi po wejściu na serwer radio RMF MAXXX przez 30 sekund.
function poWejsciuNaSerwer() local radio = playSound( "http://files.kusmierz.be/rmf/rmfmaxxx.pls" ) -- odtwarzamy stream radia z adresu URL... setSoundVolume( radio, 0.5 ) -- ...i ustawiamy mu głośność na 50%, żeby nikogo nie irytowało setTimer( function() destroyElement(radio) end, 30*1000, 1 ) -- tworzymy również timer, który po 30 sekundach wyłączy radio end addEventHandler ( "onClientPlayerJoin", getRootElement(), poWejsciuNaSerwer ) -- a na koniec podłączamy funkcję pod eventHandler
Zobacz również
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd