1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<HTML> 3 <HEAD> 4 <META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 5 <title>SNDEX_ResetIgnoreHWVolume</title> 6 <link rel="stylesheet" href="../../css/nitro.css" type="text/css"> 7 </HEAD> 8 <BODY> 9 <H1>SNDEX_ResetIgnoreHWVolume <IMG src="../../image/TWL.gif" width="24" height="12" border="0" align=middle></H1> 10 11 <H2>Syntax</H2> 12 <DL> 13 <DD><CODE>#include <twl/snd.h></CODE></DD> 14 <DD><PRE><CODE>SNDEXResult SNDEX_ResetIgnoreHWVolume( void );</CODE></PRE></DD> 15 </DL> 16 17 <H2>Arguments</H2> 18 <P>None.</P> 19 20 <H2>Return Values</H2> 21 <TABLE> 22 <TBODY> 23 <TR> 24 <TH width="25%"><CODE>SNDEX_RESULT_SUCCESS</CODE></TH> 25 <TD width="75%">The whole series of operations completed successfully.</TD> 26 </TR> 27 <TR> 28 <TH width="25%"><CODE>SNDEX_RESULT_ILLEGAL_STATE</CODE></TH> 29 <TD width="75%">This function has been called on the NITRO platform or from an exception handler.</TD> 30 </TR> 31 <TR> 32 <TH width="25%"><CODE>SNDEX_RESULT_BEFORE_INIT</CODE></TH> 33 <TD width="75%">Extended sound features have not been initialized by the <A href="SNDEX_Init.html"><CODE>SNDEX_Init</CODE></A> function.</TD> 34 </TR> 35 <TR> 36 <TH width="25%"><CODE>SNDEX_RESULT_EXCLUSIVE</CODE></TH> 37 <TD width="75%">Processing for other extended sound features is running. Note that mutexes are used for each of the extended sound features, so they cannot be used simultaneously.<BR> This is also returned when a mutex error occurred in the ARM7. When this is the case, the situation may improve on a retry because the error is dependent on the progress of processing in ARM7.<BR> As mentioned in the <A href="./doc/aboutSNDEX.html">SNDEX Library Overview</A>, the error also returns during processing of shutter sound playback.</TD> 38 </TR> 39 <TR> 40 <TH width="25%"><CODE>SNDEX_RESULT_PXI_SEND_ERROR</CODE></TH> 41 <TD width="75%">A PXI command failed to be sent to the ARM7. This error occurs when the PXI send queue for the ARM7 has filled up or when the hardware has detected an error. As a result, the state may improve when a retry is made.</TD> 42 </TR> 43 <TR> 44 <TH width="25%"><CODE>SNDEX_RESULT_DEVICE_ERROR</CODE></TH> 45 <TD width="75%">The ARM7 failed to change the speaker volume for an external device. Conditions may improve on a retry, but continued failures after multiple retries could indicate that the external device is not responding, so you may handle this as if it were a return value indicating success.</TD> 46 </TR> 47 <TR> 48 <TH width="25%"><CODE>SNDEX_RESULT_FATAL_ERROR</CODE></TH> 49 <TD width="75%">This error should not ordinarily occur. This may occur when an illegal PXI command was sent directly, ignoring library state management; when the ARM7 component and the extended sound feature library have different versions; when library state management has fallen into an abnormal state due to memory corruption; or when other such conditions arise. There is no way to recover from this at run time. 50 </TD> 51 </TR> 52 </TBODY> 53 </TABLE> 54 55 <H2>Description</H2> 56 <P> 57 Synchronously changes the speaker volume to the value stored by the <A href="SNDEX_SetIgnoreHWVolume.html"><CODE>SNDEX_SetIgnoreHWVolume</CODE></A> function. <FONT color="red">The change is not necessarily applied immediately. </FONT>For more information, see <B>Note</B>, below. 58 </P> 59 <P> 60 This function calls the <A href="SNDEX_SetVolume.html"><CODE>SNDEX_SetVolume</CODE></A> function internally and stops its own calling thread until the processing has completed. This function expects to be called from a thread, so it fails if it is called from an exception handler. Note that this function continues to block internally if PXI receive interrupts are prohibited, because PXI receive interrupts are used to detect the processing's completion. 61 </P> 62 63 <H2>Note</H2> 64 <P> 65 Be sure that your method for changing the volume adheres to the <I>Programming Guidelines</I>.<BR> 66 </P> 67 <P> 68 If the <A href="SNDEX_SetIgnoreHWVolume.html"><CODE>SNDEX_SetIgnoreHWVolume</CODE></A> function has never been called when this function executes, the speaker volume is changed to 0.<BR> 69 </P> 70 <P> 71 The speaker volume is saved in dedicated nonvolatile memory each time it is changed. It consequently cannot be modified an infinite number of times. <FONT color="red">Avoid frequent changes to the speaker volume from the program. </FONT><BR>For more information, see the <B>Note</B> section for the <A href="SNDEX_SetVolume.html"><CODE>SNDEX_SetVolume</CODE></A> function. 72 </P> 73 <H2>See Also</H2> 74 <P> 75 <A href="SNDEX_SetVolume.html"><CODE>SNDEX_SetVolume</CODE></A><BR> <A href="SNDEX_SetIgnoreHWVolume.html"><CODE>SNDEX_SetIgnoreHWVolume</CODE></A> 76 </P> 77 <H2>Revision History</H2> 78 <P> 79 2009/02/02 Initial version. 80 </P> 81 <hr><p>CONFIDENTIAL</p></body> 82</HTML> 83
