org.bytedeco.ale

Class Sound

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.ale.Sound

All Implemented Interfaces:

AutoCloseable

@NoOffset
 @Properties(inherit=ale.class)
public class Sound
extends Pointer

This class is an abstract base class for the various sound objects. It has no functionality whatsoever.

Version:

$Id: Sound.hxx,v 1.23 2007/01/01 18:04:50 stephena Exp $

Author:

Stephen Anthony

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Sound(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
void	_close() Should be called to close the sound device.
void	adjustCycleCounter(int amount) The system cycle counter is being adjusting by the specified amount.
void	adjustVolume(byte direction) Adjusts the volume of the sound device based on the given direction.
void	initialize() Initializes the sound device.
boolean	isSuccessfullyInitialized() Return true iff the sound device was successfully initialized.
boolean	load(Deserializer in) Loads the current state of this device from the given Deserializer.
void	mute(boolean state) Set the mute state of the sound object.
void	recordNextFrame() Tells the sound engine to record one frame's worth of sound.
void	reset() Reset the sound device.
boolean	save(Serializer out) Saves the current state of this device to the given Serializer.
void	set(short addr, byte value, int cycle) Sets the sound register to a given value.
void	setChannels(int channels) Sets the number of channels (mono or stereo sound).
void	setEnabled(boolean enable) Enables/disables the sound subsystem.
void	setFrameRate(int framerate) Sets the display framerate.
void	setVolume(int percent) Sets the volume of the sound device to the specified level.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Sound

public Sound(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

setEnabled

public void setEnabled(@Cast(value="bool")
                       boolean enable)

Enables/disables the sound subsystem.

Parameters:

enable - Either true or false, to enable or disable the sound system

adjustCycleCounter

public void adjustCycleCounter(@Cast(value="Int32")
                               int amount)

The system cycle counter is being adjusting by the specified amount. Any members using the system cycle counter should be adjusted as needed.

Parameters:

amount - The amount the cycle counter is being adjusted by

setChannels

public void setChannels(@Cast(value="uInt32")
                        int channels)

Sets the number of channels (mono or stereo sound).

Parameters:

channels - The number of channels

setFrameRate

public void setFrameRate(@Cast(value="uInt32")
                         int framerate)

Sets the display framerate. Sound generation for NTSC and PAL games depends on the framerate, so we need to set it here.

Parameters:

framerate - The base framerate depending on NTSC or PAL ROM

initialize

public void initialize()

Initializes the sound device. This must be called before any calls are made to derived methods.

_close

@Name(value="close")
public void _close()

Should be called to close the sound device. Once called the sound device can be started again using the initialize method.

isSuccessfullyInitialized

@Cast(value="bool")
public boolean isSuccessfullyInitialized()

Return true iff the sound device was successfully initialized.

Returns:

true iff the sound device was successfully initialized.

mute

public void mute(@Cast(value="bool")
                 boolean state)

Set the mute state of the sound object. While muted no sound is played.

Parameters:

state - Mutes sound if true, unmute if false

reset

public void reset()

Reset the sound device.

set

public void set(@Cast(value="uInt16")
                short addr,
                @Cast(value="uInt8")
                byte value,
                @Cast(value="Int32")
                int cycle)

Sets the sound register to a given value.

Parameters:

addr - The register address

value - The value to save into the register

cycle - The system cycle at which the register is being updated

setVolume

public void setVolume(@Cast(value="Int32")
                      int percent)

Sets the volume of the sound device to the specified level. The volume is given as a percentage from 0 to 100. Values outside this range indicate that the volume shouldn't be changed at all.

Parameters:

percent - The new volume percentage level for the sound device

adjustVolume

public void adjustVolume(@Cast(value="Int8")
                         byte direction)

Adjusts the volume of the sound device based on the given direction.

Parameters:

direction - Increase or decrease the current volume by a predefined amount based on the direction (1 = increase, -1 =decrease)

recordNextFrame

public void recordNextFrame()

Tells the sound engine to record one frame's worth of sound.

load

@Cast(value="bool")
public boolean load(@ByRef
                                         Deserializer in)

Loads the current state of this device from the given Deserializer.

Parameters:

in - The deserializer device to load from.

Returns:

The result of the load. True on success, false on failure.

save

@Cast(value="bool")
public boolean save(@ByRef
                                         Serializer out)

Saves the current state of this device to the given Serializer.

Parameters:

out - The serializer device to save to.

Returns:

The result of the save. True on success, false on failure.