GetSoundBufferLength: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added polish translation, did a little cleanup)
(Undo revision 76402 - Whoopsie, wrong page to modify)
Tag: Undo
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{PL/Client function}}
{{Client function}}
{{PL/New feature/item|3.0157|1.5.6|16216|
{{New feature/item|3.0157|1.5.6|16216|This function gets the buffer playback length of the specified [[sound]]. Works only with streams.}}
This function gets the buffer playback length of the specified [[sound]]. Works only with streams.
==Syntax==
}}
<syntaxhighlight lang="lua">float getSoundBufferLength ( element theSound )</syntaxhighlight>
{{OOP||[[sound]]:getBufferLength|bufferLength}}
===Required Arguments===
*'''theSound:''' the [[sound]] element which buffer length you want to get.


==Składnia==
===Returns===
<syntaxhighlight lang="lua">
* A [[float]] value indicating the buffer playback length of the [[sound]] in seconds.
float getSoundBufferLength ( element theSound )
* ''false'' if the sound is not a stream.
</syntaxhighlight>
* ''nil'' if the sound is invalid.
{{PL/OOP||[[sound]]:getBufferLength|bufferLength}}


===Wymagane argumenty===
==Example==  
*'''sound:''' element dźwięku, którego długość chcesz pozyskać.
This example draws a simple player that shows the length of the downloaded part of the song.
 
===Zwraca===
* [[PL/Float|Wartość zmiennoprzecinkową]], która zawiera długość dźwięku w sekundach.
* ''fałsz'' jeżeli dźwięk nie jest strumieniem.
* ''nil'' jeżeli dźwięk jest nieprawidłowy.
 
==Przykłady==
Ten przykład rysuje prosty odtwarzacz, który pokazuje długość pobranej części utworu.
<!--
TODO: Przetłumaczyć przykład
-->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local screenSize = Vector2(guiGetScreenSize())
local screenSize = Vector2(guiGetScreenSize())
Line 82: Line 73:


==See Also==
==See Also==
{{PL/Client_audio_functions}}
{{Client_audio_functions}}
 
[[AR:getSoundBufferLength]]
[[AR:getSoundBufferLength]]
[[PT-BR:getSoundBufferLength]]
[[PT-BR:getSoundBufferLength]]
[[en:getSoundBufferLength]]
[[Category:PL/Client functions]]

Revision as of 20:08, 6 April 2023

This function gets the buffer playback length of the specified sound. Works only with streams.

Syntax

float getSoundBufferLength ( element theSound )

OOP Syntax Help! I don't understand this!

Method: sound:getBufferLength(...)
Variable: .bufferLength


Required Arguments

  • theSound: the sound element which buffer length you want to get.

Returns

  • A float value indicating the buffer playback length of the sound in seconds.
  • false if the sound is not a stream.
  • nil if the sound is invalid.

Example

This example draws a simple player that shows the length of the downloaded part of the song. 

local screenSize = Vector2(guiGetScreenSize())
local BOX_SIZE = Vector2(300, 100)
local LINE_SIZE = Vector2(BOX_SIZE.x, 10)
local BOX_POSITION = screenSize / 2 - BOX_SIZE / 2
local TITLE_POSITION = BOX_POSITION + Vector2(8, 8)
local ARTIST_POSITION = BOX_POSITION + Vector2(8, 32)

local sound

addCommandHandler("playsound", function ()
    if isElement(sound) then
        destroyElement(sound)
    end
    sound = playSound("https://example.com/song.mp3")
end)

addCommandHandler("stopsound", function ()
    if isElement(sound) then
        destroyElement(sound)
    end
end)

addEventHandler("onClientRender", root, function ()
    if isElement(sound) then
        local soundLength = getSoundLength(sound)
        local soundPosition = getSoundPosition(sound)
        local soundBufferLength = getSoundBufferLength(sound)

        local meta = getSoundMetaTags(sound)

        dxDrawRectangle(BOX_POSITION, BOX_SIZE, tocolor(20, 20, 20, 255), false, false)

        if meta.title then
            dxDrawText(meta.title, TITLE_POSITION, 0, 0, tocolor(255, 255, 255, 255), 1.5, 1.5, "clear")
        end
        if meta.artist then
            dxDrawText(meta.artist, ARTIST_POSITION, 0, 0, tocolor(255, 255, 255, 255), 1.0, 1.0, "clear")
        end

        dxDrawText(("%d:%02d"):format(soundPosition / 60, soundPosition % 60), BOX_POSITION + Vector2(8, BOX_SIZE.y - 32), BOX_POSITION + BOX_SIZE - Vector2(8, 0), tocolor(255, 255, 255, 255), 1.0, 1.0, "clear", "left", "top")
        dxDrawText(("%d:%02d"):format(soundLength / 60, soundLength % 60), BOX_POSITION + Vector2(8, BOX_SIZE.y - 32), BOX_POSITION + BOX_SIZE - Vector2(8, 0), tocolor(255, 255, 255, 255), 1.0, 1.0, "clear", "right", "top")
        
        -- draw seek bar
        local linePosition = Vector2(BOX_POSITION.x, BOX_POSITION.y + BOX_SIZE.y - LINE_SIZE.y)
        dxDrawRectangle(linePosition, LINE_SIZE, tocolor(255, 255, 255, 128), false, false)

        -- draw buffer length
        if soundBufferLength then
            dxDrawRectangle(linePosition, Vector2(LINE_SIZE.x * (soundBufferLength / soundLength), LINE_SIZE.y), tocolor(255, 255, 255, 96), false, false)
        end
        -- draw current position
        dxDrawRectangle(linePosition, Vector2(LINE_SIZE.x * (soundPosition / soundLength), LINE_SIZE.y), tocolor(255, 255, 255, 255), false, false)
    end
end)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetSoundBufferLength?oldid=76403"