AAudio (The ZKoss Common Library 9.0.0 API)

java.lang.Object
- org.zkoss.sound.AAudio

All Implemented Interfaces:

Serializable, Audio, Media
```
public class AAudio
extends Object
implements Audio, Serializable
```
Represents an audio. Unlike javax.sound.AudioClip, this class is used only to hold the raw data as opaque rather than manipulate the sound.
In other words, it is used to retrieve and store the opaque data as polymorphic thru the Media interface.
AAudio is serializable, but, if you are using InputStream, you have to extend this class, and provide the implementation to serialize and deserialize _isdata. (Since 5.0.11)

Author:

tomyeh

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected InputStream`	`_isdata` The raw data in stream (or `DYNAMIC_STREAM`).
`protected static InputStream`	`DYNAMIC_STREAM` Used if you want to implement a media whose input stream is created dynamically each time `getStreamData()` is called.

Constructor Summary

Constructors
Constructor and Description
`AAudio(File file)` Constructs an audio with a file.
`AAudio(InputStream is)` Creates an instance of an audio with an input stream.
`AAudio(String filename)` Constructs an audio with a file name.
`AAudio(String name, byte[] data)`
`AAudio(String name, InputStream isdata)` Creates an instance of an audio with an input stream.
`AAudio(URL url)` Constructs an audio with an URL.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`getByteData()` Returns the raw data in byte array.
`String`	`getContentType()` Returns the content type, e.g., "image/jpeg", or null if not available.
`String`	`getFormat()` Returns the format name, e.g., "jpeg", or null if not available.
`String`	`getName()` Returns the name (usually filename) of this media, or null if not available.
`Reader`	`getReaderData()` Not supported.
`InputStream`	`getStreamData()` Returns the data in the input stream.
`String`	`getStringData()` Always throws IllegalStateException.
`boolean`	`inMemory()` Returns whether the data is cached in memory (in form of byte[] or String).
`boolean`	`isBinary()` Returns whether the format of this content is binary or text-based.
`boolean`	`isContentDisposition()` Whether to allow Content-Disposition or not when writing the media to response header.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DYNAMIC_STREAM
```
protected static final InputStream DYNAMIC_STREAM
```
    Used if you want to implement a media whose input stream is created dynamically each time getStreamData() is called.
    
    See Also:
    
    AAudio(String,,InputStream)
  - _isdata
```
protected final transient InputStream _isdata
```
    The raw data in stream (or DYNAMIC_STREAM). Exactly one of _data and _isdata is not null.
- Constructor Detail
  - AAudio
```
public AAudio(String name,
              byte[] data)
       throws IOException
```
    Throws:
    
    IOException
  - AAudio
```
public AAudio(String name,
              InputStream isdata)
       throws IOException
```
    Creates an instance of an audio with an input stream. If the stream shall be created each time getStreamData() is called, you can pass DYNAMIC_STREAM to the data argument, and then override getStreamData().
    Note: the caller of getStreamData() has to close the returned input stream.
    
    Throws:
    
    IOException
  - AAudio
```
public AAudio(URL url)
```
    Constructs an audio with an URL.
  - AAudio
```
public AAudio(File file)
```
    Constructs an audio with a file.
  - AAudio
```
public AAudio(String filename)
       throws IOException
```
    Constructs an audio with a file name.
    
    Throws:
    
    IOException
  - AAudio
```
public AAudio(InputStream is)
       throws IOException
```
    Creates an instance of an audio with an input stream. If the stream shall be created each time getStreamData() is called, you can pass DYNAMIC_STREAM to the data argument, and then override getStreamData().
    Note: the caller of getStreamData() has to close the returned input stream.
    
    Throws:
    
    IOException
- Method Detail
  - isBinary
```
public final boolean isBinary()
```
    Description copied from interface: Media
    
    Returns whether the format of this content is binary or text-based. If true, use Media.getByteData() or Media.getStreamData() to retrieve its content. If false, use Media.getStringData() or Media.getReaderData() to retrieve its content.
    
    Specified by:
    
    isBinary in interface Media
    
    See Also:
    
    Media.getStringData(), Media.getByteData(), Media.getReaderData(), Media.getStreamData()
  - inMemory
```
public final boolean inMemory()
```
    Description copied from interface: Media
    
    Returns whether the data is cached in memory (in form of byte[] or String).
    
    Specified by:
    
    inMemory in interface Media
    
    See Also:
    
    Media.getStringData(), Media.getByteData(), Media.getReaderData(), Media.getStreamData()
  - getByteData
```
public byte[] getByteData()
```
    Description copied from interface: Media
    
    Returns the raw data in byte array.
    It might not be a copy, so don't modify it directly unless you know what you are doing.
    If the data is not cached in memory (Media.inMemory() return false), the data will be read from Media.getStreamData(). Furthermore, it also implies you can not invoke this method again.
    
    Specified by:
    
    getByteData in interface Media
    
    See Also:
    
    Media.getStringData()
  - getStringData
```
public final String getStringData()
```
    Always throws IllegalStateException.
    
    Specified by:
    
    getStringData in interface Media
    
    See Also:
    
    Media.getByteData()
  - getStreamData
```
public InputStream getStreamData()
```
    Returns the data in the input stream.
    Note: the caller has to invoke InputStream.close() after using the input stream returned by getStreamData().
    
    Specified by:
    
    getStreamData in interface Media
    
    See Also:
    
    Media.getReaderData()
  - getReaderData
```
public final Reader getReaderData()
```
    Not supported. It always throws IllegalStateException.
    
    Specified by:
    
    getReaderData in interface Media
    
    See Also:
    
    Media.getStreamData()
  - getName
```
public final String getName()
```
    Description copied from interface: Media
    
    Returns the name (usually filename) of this media, or null if not available.
    
    Specified by:
    
    getName in interface Media
  - getFormat
```
public String getFormat()
```
    Description copied from interface: Media
    
    Returns the format name, e.g., "jpeg", or null if not available.
    
    Specified by:
    
    getFormat in interface Media
    
    See Also:
    
    Media.getContentType()
  - getContentType
```
public String getContentType()
```
    Description copied from interface: Media
    
    Returns the content type, e.g., "image/jpeg", or null if not available.
    
    Specified by:
    
    getContentType in interface Media
    
    See Also:
    
    Media.getFormat()
  - isContentDisposition
```
public boolean isContentDisposition()
```
    Description copied from interface: Media
    
    Whether to allow Content-Disposition or not when writing the media to response header.
    Default: true
    
    Specified by:
    
    isContentDisposition in interface Media

Class AAudio

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DYNAMIC_STREAM

_isdata

Constructor Detail

AAudio

AAudio

AAudio

AAudio

AAudio

AAudio

Method Detail

isBinary

inMemory

getByteData

getStringData

getStreamData

getReaderData

getName

getFormat

getContentType

isContentDisposition