Class Overview
The AudioFormat class is used to access a number of audio format and
 channel configuration constants. They are for instance used
 in AudioTrack and AudioRecord.
 
Summary
| Nested Classes | 
  
    
      | 
        
         
         
        
        class | 
      AudioFormat.Builder | 
      
        Builder class for AudioFormat objects. 
        
    
       | 
    
    
    
| 
  [Expand]
   Inherited Methods  | 
   
From class
  java.lang.Object
  
   
  
    
    
	 
    
        | 
            
            
            
            
            
            Object
         | 
        
        clone()
        
         
          Creates and returns a copy of this Object.
          
    
         
  
   |  
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        equals(Object o)
        
         
          Compares this instance with the specified object and indicates if they
 are equal.
          
    
         
  
   |  
	 
    
        | 
            
            
            
            
            
            void
         | 
        
        finalize()
        
         
          Invoked when the garbage collector has detected that this instance is no longer reachable.
          
    
         
  
   |  
	 
    
        | 
            
            
            final
            
            
            Class<?>
         | 
        
        getClass()
        
        
          Returns the unique instance of  Class that represents this
 object's class.
          
    
          
  
   |  
	 
    
        | 
            
            
            
            
            
            int
         | 
        
        hashCode()
        
         
          Returns an integer hash code for this object.
          
    
         
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        notify()
        
         
          Causes a thread which is waiting on this object's monitor (by means of
 calling one of the wait() methods) to be woken up.
          
    
         
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        notifyAll()
        
         
          Causes all threads which are waiting on this object's monitor (by means
 of calling one of the wait() methods) to be woken up.
          
    
         
  
   |  
	 
    
        | 
            
            
            
            
            
            String
         | 
        
        toString()
        
         
          Returns a string containing a concise, human-readable description of this
 object.
          
    
         
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        wait()
        
         
          Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.
          
    
         
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        wait(long millis, int nanos)
        
         
          Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
 specified timeout expires.
          
    
         
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        wait(long millis)
        
         
          Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
 specified timeout expires.
          
    
         
  
   |  
 
   
 
 | 
Constants
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_CONFIGURATION_DEFAULT
    
      
    
      
    
      
  
      This constant was deprecated
      in API level 5.
    use CHANNEL_OUT_DEFAULT or CHANNEL_IN_DEFAULT instead  
  
  
    
        
        Constant Value: 
        
            
                1
                (0x00000001)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_CONFIGURATION_INVALID
    
      
    
      
    
      
  
      This constant was deprecated
      in API level 5.
    use CHANNEL_INVALID instead  
  
  
    
        
        Constant Value: 
        
            
                0
                (0x00000000)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_CONFIGURATION_MONO
    
      
    
      
    
      
  
      This constant was deprecated
      in API level 5.
    use CHANNEL_OUT_MONO or CHANNEL_IN_MONO instead  
  
  
    
        
        Constant Value: 
        
            
                2
                (0x00000002)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_CONFIGURATION_STEREO
    
      
    
      
    
      
  
      This constant was deprecated
      in API level 5.
    use CHANNEL_OUT_STEREO or CHANNEL_IN_STEREO instead  
  
  
    
        
        Constant Value: 
        
            
                3
                (0x00000003)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_INVALID
    
      
    
      
    
      
  Invalid audio channel mask 
 
    
        
        Constant Value: 
        
            
                0
                (0x00000000)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_BACK
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                32
                (0x00000020)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_BACK_PROCESSED
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                512
                (0x00000200)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_DEFAULT
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                1
                (0x00000001)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_FRONT
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                16
                (0x00000010)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_FRONT_PROCESSED
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                256
                (0x00000100)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_LEFT
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                4
                (0x00000004)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_LEFT_PROCESSED
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                64
                (0x00000040)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_MONO
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                16
                (0x00000010)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_PRESSURE
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                1024
                (0x00000400)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_RIGHT
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                8
                (0x00000008)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_RIGHT_PROCESSED
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                128
                (0x00000080)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_STEREO
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                12
                (0x0000000c)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_VOICE_DNLINK
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                32768
                (0x00008000)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_VOICE_UPLINK
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                16384
                (0x00004000)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_X_AXIS
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                2048
                (0x00000800)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_Y_AXIS
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                4096
                (0x00001000)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_IN_Z_AXIS
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                8192
                (0x00002000)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_5POINT1
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                252
                (0x000000fc)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_7POINT1
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                1020
                (0x000003fc)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_BACK_CENTER
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                1024
                (0x00000400)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_BACK_LEFT
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                64
                (0x00000040)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_BACK_RIGHT
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                128
                (0x00000080)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_DEFAULT
    
      
    
      
    
      
  Default audio channel mask 
 
    
        
        Constant Value: 
        
            
                1
                (0x00000001)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_FRONT_CENTER
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                16
                (0x00000010)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_FRONT_LEFT
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                4
                (0x00000004)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_FRONT_LEFT_OF_CENTER
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                256
                (0x00000100)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_FRONT_RIGHT
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                8
                (0x00000008)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_FRONT_RIGHT_OF_CENTER
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                512
                (0x00000200)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_LOW_FREQUENCY
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                32
                (0x00000020)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_MONO
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                4
                (0x00000004)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_QUAD
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                204
                (0x000000cc)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_SIDE_LEFT
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                2048
                (0x00000800)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_SIDE_RIGHT
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                4096
                (0x00001000)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_STEREO
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                12
                (0x0000000c)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        CHANNEL_OUT_SURROUND
    
      
    
      
    
      
  
    
        
        Constant Value: 
        
            
                1052
                (0x0000041c)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        ENCODING_AC3
    
      
    
      
    
      
  Audio data format: AC-3 compressed 
 
    
        
        Constant Value: 
        
            
                5
                (0x00000005)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        ENCODING_DEFAULT
    
      
    
      
    
      
  Default audio data format 
 
    
        
        Constant Value: 
        
            
                1
                (0x00000001)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        ENCODING_E_AC3
    
      
    
      
    
      
  Audio data format: E-AC-3 compressed 
 
    
        
        Constant Value: 
        
            
                6
                (0x00000006)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        ENCODING_INVALID
    
      
    
      
    
      
  Invalid audio data format 
 
    
        
        Constant Value: 
        
            
                0
                (0x00000000)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        ENCODING_PCM_16BIT
    
      
    
      
    
      
  Audio data format: PCM 16 bit per sample. Guaranteed to be supported by devices. 
 
    
        
        Constant Value: 
        
            
                2
                (0x00000002)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        ENCODING_PCM_8BIT
    
      
    
      
    
      
  Audio data format: PCM 8 bit per sample. Not guaranteed to be supported by devices. 
 
    
        
        Constant Value: 
        
            
                3
                (0x00000003)
            
        
        
    
     
 
 
    
      
        public 
        static 
        final 
        int
      
        ENCODING_PCM_FLOAT
    
      
    
      
    
      
  Audio data format: single-precision floating-point per sample 
 
    
        
        Constant Value: 
        
            
                4
                (0x00000004)
            
        
        
    
     
 
Public Methods
 
    
      
        public 
         
         
         
         
        int
      
      getChannelMask
      ()
    
      
    
 
 
    
      
        public 
         
         
         
         
        int
      
      getEncoding
      ()
    
      
    
 
 
    
      
        public 
         
         
         
         
        int
      
      getSampleRate
      ()
    
      
    
 
 
    
      
        public 
         
         
         
         
        String
      
      toString
      ()
    
      
    
      
    
      
  Returns a string containing a concise, human-readable description of this
 object. Subclasses are encouraged to override this method and provide an
 implementation that takes into account the object's type and data. The
 default implementation is equivalent to the following expression:
 
   getClass().getName() + '@' + Integer.toHexString(hashCode())
 See Writing a useful
 toString method
 if you intend implementing your own toString method.
 
  
      Returns
      - a printable representation of this object.