org.jouvieje.fmodex.enumerations
Class FMOD_OPENSTATE

java.lang.Object
  extended byorg.jouvieje.fmodex.enumerations.FMOD_OPENSTATE
All Implemented Interfaces:
java.lang.Comparable, org.jouvieje.fmodex.enumerations.Enumeration

public class FMOD_OPENSTATE
extends java.lang.Object
implements org.jouvieje.fmodex.enumerations.Enumeration, java.lang.Comparable



These values describe what state a sound is in after FMOD_NONBLOCKING has been used to open it.

Remarks

With streams, if you are using FMOD_NONBLOCKING, note that if the user calls Sound::getSubSound, a stream will go into FMOD_OPENSTATE_SEEKING state and sound related commands will return FMOD_ERR_NOTREADY.
With streams, if you are using FMOD_NONBLOCKING, note that if the user calls Channel::getPosition, a stream will go into FMOD_OPENSTATE_SETPOSITION state and sound related commands will return FMOD_ERR_NOTREADY.

Platforms Supported

Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation 2, PlayStation Portable, PlayStation 3, Wii, Solaris, iPhone

See Also

Sound::getOpenState
FMOD_MODE


Field Summary
static FMOD_OPENSTATE FMOD_OPENSTATE_BUFFERING
           
static FMOD_OPENSTATE FMOD_OPENSTATE_CONNECTING
           
static FMOD_OPENSTATE FMOD_OPENSTATE_ERROR
           
static FMOD_OPENSTATE FMOD_OPENSTATE_FORCEINT
           
static FMOD_OPENSTATE FMOD_OPENSTATE_LOADING
           
static FMOD_OPENSTATE FMOD_OPENSTATE_MAX
           
static FMOD_OPENSTATE FMOD_OPENSTATE_READY
           
static FMOD_OPENSTATE FMOD_OPENSTATE_SEEKING
           
static FMOD_OPENSTATE FMOD_OPENSTATE_SETPOSITION
           
static FMOD_OPENSTATE FMOD_OPENSTATE_STREAMING
           
 
Method Summary
 int asInt()
           
 int compareTo(java.lang.Object object)
           
 boolean equals(java.lang.Object object)
           
static FMOD_OPENSTATE get(int nativeValue)
          Retrieve a FMOD_OPENSTATE enum field with his integer value
static FMOD_OPENSTATE get(Pointer pointer)
          Retrieve a FMOD_OPENSTATE enum field from a Pointer
static java.util.Iterator iterator()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FMOD_OPENSTATE_READY

public static final FMOD_OPENSTATE FMOD_OPENSTATE_READY

FMOD_OPENSTATE_LOADING

public static final FMOD_OPENSTATE FMOD_OPENSTATE_LOADING

FMOD_OPENSTATE_ERROR

public static final FMOD_OPENSTATE FMOD_OPENSTATE_ERROR

FMOD_OPENSTATE_CONNECTING

public static final FMOD_OPENSTATE FMOD_OPENSTATE_CONNECTING

FMOD_OPENSTATE_BUFFERING

public static final FMOD_OPENSTATE FMOD_OPENSTATE_BUFFERING

FMOD_OPENSTATE_SEEKING

public static final FMOD_OPENSTATE FMOD_OPENSTATE_SEEKING

FMOD_OPENSTATE_STREAMING

public static final FMOD_OPENSTATE FMOD_OPENSTATE_STREAMING

FMOD_OPENSTATE_SETPOSITION

public static final FMOD_OPENSTATE FMOD_OPENSTATE_SETPOSITION

FMOD_OPENSTATE_MAX

public static final FMOD_OPENSTATE FMOD_OPENSTATE_MAX

FMOD_OPENSTATE_FORCEINT

public static final FMOD_OPENSTATE FMOD_OPENSTATE_FORCEINT
Method Detail

asInt

public int asInt()
Specified by:
asInt in interface org.jouvieje.fmodex.enumerations.Enumeration
Returns:
the integer value of the enumeration constant.

toString

public java.lang.String toString()

equals

public boolean equals(java.lang.Object object)

compareTo

public int compareTo(java.lang.Object object)
Specified by:
compareTo in interface java.lang.Comparable

get

public static FMOD_OPENSTATE get(int nativeValue)
Retrieve a FMOD_OPENSTATE enum field with his integer value

Parameters:
nativeValue - the integer value of the field to retrieve
Returns:
the FMOD_OPENSTATE enum field that correspond to the integer value

get

public static FMOD_OPENSTATE get(Pointer pointer)
Retrieve a FMOD_OPENSTATE enum field from a Pointer

Parameters:
pointer - a pointer holding an FMOD_OPENSTATE enum field
Returns:
the FMOD_OPENSTATE enum field that correspond to the enum field in the pointer

iterator

public static java.util.Iterator iterator()
Returns:
an Iterator over the elements in this enumeration.
Can be cast to Iterator in Java 1.5.


NativeFmodEx Project - © Copyright 2005-2010 - Jérôme Jouvie (Jouvieje)
NativeFmodEx is an Open Source Project under GNU LGPL License
My sites : http://jerome.jouvie.free.fr/

(Documentation Copyright © Firelight Technologies - FMOD Ex - http://www.fmod.org)