-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathFMOD_OUTPUT_LOCK_CALLBACK.html
51 lines (51 loc) · 2.43 KB
/
FMOD_OUTPUT_LOCK_CALLBACK.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
<LINK REL="stylesheet" HREF="../static/styles.css">
<HTML>
<HEAD>
<TITLE>FMOD_OUTPUT_LOCK_CALLBACK</TITLE>
</HEAD>
<BODY TOPMARGIN="0" class="api_reference">
<p class="header">Firelight Technologies FMOD Studio API</p>
<H1>FMOD_OUTPUT_LOCK_CALLBACK</H1>
<P>
<p>Called from the mixer thread, only when the 'polling' member of <A HREF="FMOD_OUTPUT_DESCRIPTION.html">FMOD_OUTPUT_DESCRIPTION</A> is set to true.</p>
</P>
<h3>C/C++ Syntax</h3>
<PRE class=syntax><CODE>FMOD_RESULT F_CALLBACK FMOD_OUTPUT_LOCK_CALLBACK(
FMOD_OUTPUT_STATE *<I>output_state</I>,
unsigned int <I>offset</I>,
unsigned int <I>length</I>,
void **<I>ptr1</I>,
void **<I>ptr2</I>,
unsigned int *<I>len1</I>,
unsigned int *<I>len2</I>
);
</CODE></PRE>
<h2>Parameters</h2>
<P class=dt><I>output_state</I></P>
<P class=indent>Pointer to the plugin state. The user can use this variable to access runtime plugin specific variables and plugin writer user data.</P>
<P class=dt><I>offset</I></P>
<P class=indent>Offset in <em>bytes</em> to the position the caller wants to lock in the sample buffer.</P>
<P class=dt><I>length</I></P>
<P class=indent>Number of <em>bytes</em> the caller want to lock in the sample buffer.</P>
<P class=dt><I>ptr1</I></P>
<P class=indent>Address of a pointer that will point to the first part of the locked data.</P>
<P class=dt><I>ptr2</I></P>
<P class=indent>Address of a pointer that will point to the second part of the locked data. This will be null if the data locked hasn't wrapped at the end of the buffer.</P>
<P class=dt><I>len1</I></P>
<P class=indent>Length of data in <em>bytes</em> that was locked for ptr1.</P>
<P class=dt><I>len2</I></P>
<P class=indent>Length of data in <em>bytes</em> that was locked for ptr2. This will be 0 if the data locked hasn't wrapped at the end of the buffer.</P>
<h2>Return Values</h2><P>
If the function succeeds then the return value is <A HREF="fmod_result.html">FMOD_OK</A>.<BR>
If the function fails then the return value will be one of the values defined in the <A HREF="fmod_result.html">FMOD_RESULT</A> enumeration.<BR>
</P>
<h2>See Also</h2>
<UL type=disc>
<LI><A HREF="FMOD_OUTPUT_DESCRIPTION.html">FMOD_OUTPUT_DESCRIPTION</A></LI>
<LI><A HREF="FMOD_OUTPUT_UNLOCK_CALLBACK.html">FMOD_OUTPUT_UNLOCK_CALLBACK</A></LI>
<LI><A HREF="FMOD_OUTPUT_GETPOSITION_CALLBACK.html">FMOD_OUTPUT_GETPOSITION_CALLBACK</A></LI>
</UL>
<BR><BR><BR>
<P align=center><font size=-2>Version 1.03.06 Built on Apr 17, 2014</font></P>
<BR>
</HTML>