NS/main/source/includes/fmodapi375linux/documentation/HTML/FSOUND_Stream_SetPosition.html

<HTML>
<HEAD>
<META NAME="GENERATOR" Content="SOURCEDOC.EXE">
<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>FSOUND_Stream_SetPosition</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="FSOUND_Stream_SetMode.html">
<IMG SRC="u_prev.gif" WIDTH="71" HEIGHT="16"  BORDER=0 ALT="Previous Topic">
</A>
<A ID=buttonbar HREF="FSOUND.html">
<IMG SRC="u_index.gif" WIDTH="47" HEIGHT="16"  BORDER=0 ALT="Index">
</A>
<A ID=buttonbar HREF="FSOUND_Stream_SetSubStream.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="FSOUND.html#Functions"><H5>[API function]</A></H5>
<H2><A NAME="FSOUND_Stream_SetPosition">FSOUND_Stream_SetPosition</A></H2>
Sets the current stream's FILE position in BYTES.<BR>
<P>
<B>signed char F_API </B><B> </B><B>FSOUND_Stream_SetPosition</B><B>(</B><BR>
<B>FSOUND_STREAM *</B><I>stream</I><B>,</B><BR>
<B>unsigned int </B><B> </B><I>position</I><BR>
<B>);</B><BR>
<H3>Parameters</H3>
<TABLE>
<TR VALIGN=top><TD><I>stream</I></TD>
<TD>Pointer to the stream to have its position set.<BR>
</TD><TR VALIGN=top><TD><I>position</I></TD>
<TD>Offset in bytes from start of actual sound data (not including any header)<BR>
</TD></TABLE>
<H3>Return Value</H3>
On success, TRUE is returned.<BR>
On failure, FALSE is returned.<BR>
<H3>Remarks</H3>
Position functions for streams talk in bytes and NOT samples.<BR>
The reason for not taking the header into account is people usually want to know the offset	to seek to relative to the start of their data (ie as they see it in soundforge or whatever), not from offset 0 which is almost meaningless if you dont know the format.<BR>
--------------<BR>
If the stream has been opened with FSOUND_NONBLOCKING, this function will not succeed until the stream is ready.<BR>
___________________<BR>
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube<BR>
<H3>See Also</H3>
<A HREF="FSOUND_Stream_GetLength.html">FSOUND_Stream_GetLength</A>
, 
<A HREF="FSOUND_Stream_GetPosition.html">FSOUND_Stream_GetPosition</A>
, 
<A HREF="FSOUND_Stream_SetTime.html">FSOUND_Stream_SetTime</A>
<HR><BR><FONT SIZE="-2">This document copyright &copy;Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.</FONT><BR>
<FONT SIZE="-2">Generated Thu Dec 15 17:31:36 2005
 by SourceDoc v0.10, the automated source code documenter.</FONT><BR>
</BODY>
</HTML>
Update line endings Change CRLF to LF in repo. 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>FSOUND_Stream_SetPosition</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="FSOUND_Stream_SetMode.html">`
			`<IMG SRC="u_prev.gif" WIDTH="71" HEIGHT="16" BORDER=0 ALT="Previous Topic">`
			`</A>`
			`<A ID=buttonbar HREF="FSOUND.html">`
			`<IMG SRC="u_index.gif" WIDTH="47" HEIGHT="16" BORDER=0 ALT="Index">`
			`</A>`
			`<A ID=buttonbar HREF="FSOUND_Stream_SetSubStream.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="FSOUND.html#Functions"><H5>[API function]</A></H5>`
			`<H2><A NAME="FSOUND_Stream_SetPosition">FSOUND_Stream_SetPosition</A></H2>`
			`Sets the current stream's FILE position in BYTES.<BR>`
			`<P>`
			`<B>signed char F_API </B><B> </B><B>FSOUND_Stream_SetPosition</B><B>(</B><BR>`
			`<B>FSOUND_STREAM *</B><I>stream</I><B>,</B><BR>`
			`<B>unsigned int </B><B> </B><I>position</I><BR>`
			`<B>);</B><BR>`
			`<H3>Parameters</H3>`
			`<TABLE>`
			`<TR VALIGN=top><TD><I>stream</I></TD>`
			`<TD>Pointer to the stream to have its position set.<BR>`
			`</TD><TR VALIGN=top><TD><I>position</I></TD>`
			`<TD>Offset in bytes from start of actual sound data (not including any header)<BR>`
			`</TD></TABLE>`
			`<H3>Return Value</H3>`
			`On success, TRUE is returned.<BR>`
			`On failure, FALSE is returned.<BR>`
			`<H3>Remarks</H3>`
			`Position functions for streams talk in bytes and NOT samples.<BR>`
			`The reason for not taking the header into account is people usually want to know the offset to seek to relative to the start of their data (ie as they see it in soundforge or whatever), not from offset 0 which is almost meaningless if you dont know the format.<BR>`
			`--------------<BR>`
			`If the stream has been opened with FSOUND_NONBLOCKING, this function will not succeed until the stream is ready.<BR>`
			`___________________<BR>`
			`Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube<BR>`
			`<H3>See Also</H3>`
			`<A HREF="FSOUND_Stream_GetLength.html">FSOUND_Stream_GetLength</A>`
			`,`
			`<A HREF="FSOUND_Stream_GetPosition.html">FSOUND_Stream_GetPosition</A>`
			`,`
			`<A HREF="FSOUND_Stream_SetTime.html">FSOUND_Stream_SetTime</A>`
			`<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:36 2005`
			`by SourceDoc v0.10, the automated source code documenter.</FONT><BR>`
			`</BODY>`
			`</HTML>`