NS/main/source/includes/fmodapi375linux/documentation/HTML/FSOUND_SetSpeakerMode.html
2014-12-16 14:36:27 +01:00

83 lines
3.7 KiB
HTML

<HTML>
<HEAD>
<META NAME="GENERATOR" Content="SOURCEDOC.EXE">
<META HTTP-EQUIV="Content-Type" content="text/html; charset=iso-8859-1">
<TITLE>FSOUND_SetSpeakerMode</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_SetSFXMasterVolume.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_SetSurround.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_SetSpeakerMode">FSOUND_SetSpeakerMode</A></H2>
Sets the mode for the users speaker setup.<BR>
<P>
<B>void F_API </B><B> </B><B>FSOUND_SetSpeakerMode</B><B>(</B><BR>
<B>unsigned int </B><B> </B><I>speakermode</I><BR>
<B>);</B><BR>
<H3>Parameters</H3>
<TABLE>
<TR VALIGN=top><TD><I>speakermode</I></TD>
<TD>This is an enum describing the users speaker setup.<BR>
</TD></TABLE>
<H3>Return Value</H3>
void<BR>
<H3>Remarks</H3>
Note - Only reliably works with FSOUND_OUTPUT_DSOUND on windows, or consoles such as PlayStation 2, GameCube and XBox.<BR>
For other output types speaker mode only interprets FSOUND_SPEAKERMODE_MONO, everything else is interpreted as stere.<BR>
----------------------------------<BR>
To get true 5.1 dolby digital or DTS output you will need a soundcard that can encode it, and a receiver that can decode it. <BR>
----------------------------------<BR>
Calling this will reset the pan separation setting. It sets it to 0 if FSOUND_SPEAKERMODE_MONO is chosen, and 1 otherwise. <BR>
You will need to reset the pan separation if required afterwards.<BR>
----------------------------------<BR>
XBOX <BR>
This function must be called before FSOUND_Init to change the default speaker mode. To change on the fly, you must close down FMOD with FSOUND_Close then re-initialize it with FSOUND_Init.<BR>
If it is called after FSOUND_Init, only headphone speakermode is interpreted to switch headphone mode on and off.<BR>
By default the dashboard setting is used for the speakermode. It is not recommend you change this mode unless you let the user change it in-game.<BR>
----------------------------------<BR>
PlayStation 2.<BR>
Only mono/stereo and prologic 2 modes are interpreted. Dolby digital or DTS are not supported.<BR>
This function must be called before playing sounds. Calling this after playing a sound will not make that existing sound work in Prologic 2.<BR>
___________________<BR>
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube<BR>
<H3>See Also</H3>
<A HREF="FSOUND_Close.html">FSOUND_Close</A>
,
<A HREF="FSOUND_GetSpeakerMode.html">FSOUND_GetSpeakerMode</A>
,
<A HREF="FSOUND_Init.html">FSOUND_Init</A>
,
<A HREF="FSOUND_SetPanSeperation.html">FSOUND_SetPanSeperation</A>
,
<A HREF="FSOUND_SPEAKERMODES.html">FSOUND_SPEAKERMODES</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:34 2005
by SourceDoc v0.10, the automated source code documenter.</FONT><BR>
</BODY>
</HTML>