SoundInformation (Rising World Plugin API)

java.lang.Object
- net.risingworld.api.utils.SoundInformation

public final class SoundInformation
extends java.lang.Object

Represents a custom audio file (this could either be a sound effect or a music track).
It's highly recommended to create an SoundInformation object only once and reuse it every time you need it. It's safe to use the same SoundInformation reference for several players and in multiple threads.

Supported file formats: ogg, mp2, mp3, midi/mid, wav

Example: Create a SoundInformation (reusable) and play it for every player who joins the game

1	public class MyPlugin extends Plugin implements Listener{
2	//Our reusable SoundInformation
3	public SoundInformation welcomeSound;
4
5	`@`Override
6	public void onEnable(){
7	//We only create the SoundInformation once and reuse it for every player
8	welcomeSound = new SoundInformation(getPath() + "/welcome.ogg");
9
10	//Remember to register the event listener
11	registerEventListener(this);
12	}
13
14	`@`Override
15	public void onDisable(){
16	//...
17	}
18
19	`@`EventMethod
20	public void onPlayerSpawn(PlayerSpawnEvent event){
21	Player player = event.getPlayer();
22	player.playSound(welcomeSound, player.getPosition());
23	}
24
25	}

Constructor Summary

Constructors
Constructor and Description
`SoundInformation(java.io.File file)` Creates a new sound information object and loads a sound from a file.
`SoundInformation(Plugin plugin, java.lang.String resource)` Creates a new sound information object and loads a sound from the plugin jar file.
`SoundInformation(java.lang.String filepath)` Creates a new sound information object and loads a sound from a file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getChecksum()` Gets the MD5 checksum of this file.
`byte[]`	`getData()` Gets the byte data of the file.
`java.lang.String`	`getExtension()` Gets the file extension.
`java.lang.String`	`getFilename()` Gets the filename.
`int`	`hashCode()`
`boolean`	`isCached()`
`boolean`	`isStreamed()` Determines if the sound is streamed or not.
`void`	`setCached(boolean cached)`
`void`	`setStreamed(boolean stream)` Determines if the sound should be streamed or not.

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

- Constructor Detail
  - SoundInformation
```
public SoundInformation(Plugin plugin,
                        java.lang.String resource)
```
    Creates a new sound information object and loads a sound from the plugin jar file.
    
    Parameters:
    
    plugin - a reference to the plugin. This is required to make sure the game loads the resource from the correct plugin jar.
    
    resource - the path to the resource (inside the jar file).
    
    Example: Load sound "explosion.ogg" from jar file (in package rw.plugin.sounds)
    1 // if SoundInformation is created in "Plugin" class
    2 SoundInformation info = new SoundInformation(this, "/rw/plugin/sounds/explosion.ogg");
    3 // do something with the sound info
  - SoundInformation
```
public SoundInformation(java.lang.String filepath)
```
    Creates a new sound information object and loads a sound from a file.
    
    Parameters:
    
    filepath - the path to the sound file on the harddrive.
    
    See Also:
    
    SoundInformation(java.io.File)
    
    Example: Load sound "explosion.ogg" from "assets" subfolder in plugin directory
    1 SoundInformation info = new SoundInformation(getPath() + "/assets/explosion.ogg");
    2 // do something with the sound info
  - SoundInformation
```
public SoundInformation(java.io.File file)
```
    Creates a new sound information object and loads a sound from a file.
    
    Parameters:
    
    file - the file representing the path to the sound on the harddrive.
    
    See Also:
    
    SoundInformation(java.lang.String)
- Method Detail
  - setStreamed
```
public void setStreamed(boolean stream)
```
    Determines if the sound should be streamed or not. Usually the whole sound file is loaded into memory before playing it, but if streaming is enabled, the game reads the sound while playing. This reduces memory consumption, but increases cpu load. By default, streaming is disabled.
    
    Important: It only makes sense to stream large sound files, e.g. music etc.
    
    Parameters:
    
    stream - true to enable streaming, false to disable it (default).
  - isStreamed
```
public boolean isStreamed()
```
    Determines if the sound is streamed or not.
    
    Returns:
    
    true if this sound will be streamed, false if not.
  - setCached
```
public void setCached(boolean cached)
```
  - isCached
```
public boolean isCached()
```
  - getData
```
public byte[] getData()
```
    Gets the byte data of the file.
    
    Returns:
    
    a byte array representing the file, or null if no data is set.
  - getFilename
```
public java.lang.String getFilename()
```
    Gets the filename.
    
    Returns:
    
    the filename.
  - getExtension
```
public java.lang.String getExtension()
```
    Gets the file extension.
    
    Returns:
    
    the file extension.
  - getChecksum
```
public java.lang.String getChecksum()
```
    Gets the MD5 checksum of this file.
    
    Returns:
    
    the MD5 checksum, as a String.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

1	// if SoundInformation is created in "Plugin" class
2	SoundInformation info = new SoundInformation(this, "/rw/plugin/sounds/explosion.ogg");
3	// do something with the sound info

Class SoundInformation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SoundInformation

SoundInformation

SoundInformation

Method Detail

setStreamed

isStreamed

setCached

isCached

getData

getFilename

getExtension

getChecksum

equals

hashCode