2018-04-22 15:55:55 +00:00
< HTML >
< HEAD >
< META NAME = "GENERATOR" Content = "SOURCEDOC.EXE" >
< META HTTP-EQUIV = "Content-Type" content = "text/html; charset=iso-8859-1" >
< TITLE > FMUSIC_GetTime< / TITLE >
< STYLE >
#flush {margin-left: -10p; margin-right: -0p}
#buttonbar {color: white}
< / STYLE >
< / HEAD >
< BODY TOPMARGIN = 0 BGPROPERTIES = "FIXED" BGCOLOR = "white" >
< FONT FACE = "ARIAL" >
< SPAN ID = "flush" >
< A NAME = "SEE ALSO" >
< TABLE WIDTH = "100%" COLS = 2 BORDER = 0 BGCOLOR = "#000000" >
< TR ALIGN = RIGHT >
< TD ALIGN = LEFT >
< IMG SRC = "banner03.gif" WIDTH = "88" HEIGHT = "31" BORDER = 0 >
< / TD >
< TD ALIGN = RIGHT VALIGN = TOP >
< FONT FACE = "ARIAL" SIZE = "2" >
< A ID = buttonbar HREF = "FMUSIC_GetSpeed.html" >
< IMG SRC = "u_prev.gif" WIDTH = "71" HEIGHT = "16" BORDER = 0 ALT = "Previous Topic" >
< / A >
< A ID = buttonbar HREF = "FMUSIC.html" >
< IMG SRC = "u_index.gif" WIDTH = "47" HEIGHT = "16" BORDER = 0 ALT = "Index" >
< / A >
< A ID = buttonbar HREF = "FMUSIC_GetType.html" >
< IMG SRC = "u_next.gif" WIDTH = "48" HEIGHT = "16" BORDER = 0 ALT = "Next Topic" >
< / A >
< / FONT > < / TD > < TD WIDTH = 15 > < / TD >
< / TR >
< / TABLE >
< / A >
< / SPAN >
< A HREF = "FMUSIC.html#Functions" > < H5 > [API function]< / A > < / H5 >
< H2 > < A NAME = "FMUSIC_GetTime" > FMUSIC_GetTime< / A > < / H2 >
Returns the time in milliseconds since the song was started. This is useful for< BR >
synchronizing purposes becuase it will be exactly the same every time, and it is < BR >
reliably retriggered upon starting the song. Trying to synchronize using other < BR >
windows timers can lead to varying results, and inexact performance. This fixes that< BR >
problem by actually using the number of samples sent to the soundcard as a reference.< BR >
< P >
< B > int F_API < / B > < B > < / B > < B > FMUSIC_GetTime< / B > < B > (< / B > < BR >
< B > FMUSIC_MODULE *< / B > < I > mod< / I > < BR >
< B > );< / B > < BR >
< H3 > Parameters< / H3 >
< TABLE >
< TR VALIGN = top > < TD > < I > mod< / I > < / TD >
< TD > Pointer to the song to get time from.< BR >
< / TD > < / TABLE >
< H3 > Return Value< / H3 >
On success, the time played in milliseconds is returned.< BR >
On failure, -1 is returned.< BR >
< H3 > Remarks< / H3 >
This value is latency adjusted by default, and returns the number you are hearing, not the 'mix-time' value.< BR >
Use FSOUND_INIT_DONTLATENCYADJUST if you want the value at mix time, which is useful if you want to control the music interactively, or from a DSP callback.< BR >
___________________< BR >
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube< BR >
< HR > < BR > < FONT SIZE = "-2" > This document copyright © Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.< / FONT > < BR >
< FONT SIZE = "-2" > Generated Thu Dec 15 17:31:26 2005
by SourceDoc v0.10, the automated source code documenter.< / FONT > < BR >
< / BODY >
< / HTML >
