1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3
4<HEAD>
5    <META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6    <META http-equiv="Content-Style-Type" content="text/css">
7
8    <LINK rel="stylesheet" href="./css/revolution.css" type="text/css">
9
10    <TITLE>HBMSoundCallback Type</TITLE>
11<style type="text/css" media="all">
12<!--
13@import url("css/hbm_common.css");
14-->
15</style>
16</HEAD>
17<BODY>
18
19
20<H1>HBMSoundCallback Type</H1>
21
22<H2>Syntax</H2>
23<dl><dd><pre><code>
24#include &lt;revolution/hbm.h&gt;
25
26/* Declaration of callback function for sound */
27typedef int (*HBMSoundCallback)( int evt, int num );
28</code></pre></dd></dl>
29
30<H2>Arguments</H2>
31<TABLE border="1" >
32  <tr>
33    <TD valign="top" width="120" bgcolor="#ffffe8"><CODE><STRONG><EM>evt</EM></STRONG></CODE></TD>
34    <TD width="520">Value that indicates the event that called the callback function.</TD>
35  </tr>
36  <tr>
37    <TD valign="top" width="120" bgcolor="#ffffe8"><CODE><STRONG><EM>num</EM></STRONG></CODE></TD>
38    <TD width="520">Value that indicates which button sound to play.</TD>
39  </tr>
40</TABLE>
41
42<H2>Return Values</H2>
43<P>
44Returns <A href="hbm_HBMSEV_RET_XXX.html"><CODE>HBMSEV_RET_XXX</CODE> enumerator</A> value for sound callback function call.
45</P>
46
47<H2>Description</H2>
48<P>
49This is the callback function declaration used when playing sound effects for an application. It is called by the library at the time the sound effect is played. The value of the <A href="hbm_HBMSEV_XXX.html"><CODE>HBMSEV_XXX</CODE> enumerator</A> passed using <I><B><CODE>evt</CODE></B></I> indicates which event caused the call.<BR>The following values are passed in <I><B><CODE>num</CODE></B></I> depending on the value of <B><I><CODE>evt</CODE></I></B>.<BR> <BR>
50<TABLE class="arguments">
51    <TR>
52        <th>HBMSEV_BEFORE_INIT_SOUND<BR>HBMSEV_INIT_SOUND<BR>HBMSEV_END_MENU</th>
53        <TD>Always passes zero.</TD>
54    </TR>
55    <TR>
56        <th>HBMSEV_BEGIN_EXIT_ANIM<BR>HBMSEV_BEGIN_BLACKOUT<BR>HBMSEV_BEGIN_BLACKOUT_TO_MANUAL</th>
57        <TD>Passes the number of frames required to black out the HOME Menu.</TD>
58    </TR>
59    <TR>
60        <th>HBMSEV_PLAY_SOUND</th>
61        <TD>Passes the type of sound effect to be played by the application according to the value of the <A href="hbm_HBMSE_XXX.html"><CODE>HBMSE_XXX</CODE> enumerator</A>.</TD>
62    </TR>
63</TABLE>
64</P>
65
66<H2>See Also</H2>
67<p>
68<code><A href="hbm_HBMCreate.html">HBMCreate</A></code>, <code><A href="hbm_HBMDataInfo.html">HBMDataInfo Structure</A></code>, <code><A href="hbm_HBMSE_XXX.html">HBMSE_XXX Enumerator</A></code>, <code><A href="hbm_HBMSEV_XXX.html">HBMSEV_XXX Enumerator</A></code>, <code><A href="hbm_HBMSEV_RET_XXX.html">HBMSEV_RET_XXX Enumerator</A></code>
69</P>
70
71<H2>Revision History</H2>
72<DL class="history">
73    <DT>2007/10/26<DD>Revised the header explanation.
74    <DT>2006/10/19<DD>Added <CODE>HBMSEV_BEGIN_BLACKOUT_TO_MANUAL</CODE> to Description.
75    <DT>2006/10/06<DD>Changed the return values.
76    <DT>2006/10/02<DD>Changed the arguments.
77    <DT>2006/09/25<DD>Initial version.
78</DL>
79
80<hr><p>CONFIDENTIAL</p></body>
81</HTML>