Package com.craftmend.openaudiomc.api.speakers

Enum ExtraSpeakerOptions

java.lang.Object

java.lang.Enum<ExtraSpeakerOptions>

com.craftmend.openaudiomc.api.speakers.ExtraSpeakerOptions

All Implemented Interfaces:

Serializable, Comparable<ExtraSpeakerOptions>, java.lang.constant.Constable

public enum ExtraSpeakerOptions
extends Enum<ExtraSpeakerOptions>

Represents extra options for a speaker

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IGNORE_SYNCHRONIZATION	This option will ignore audio synchronization for this speaker specifically
OVERWRITE_REGIONS	This setting will mute all the regions for the player as long as they are in range of this speaker
PLAY_ONCE	This setting will make the speaker play once, and then never again until the player leaves the area and re-enters
PROCESS_OBSTRUCTIONS	Deprecated.
REQUIRES_REDSTONE	This setting will only make the speaker active/discoverable when its directly powered by redstone
RESET_PLAYTHROUGH_ON_REDSTONE_LOSS	This setting will make the media timestamp reset once it loses redstone power

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getTitle()
boolean	isCompatibleWith(BasicSpeaker speaker)
boolean	isDisplay()
boolean	isEnabledFor(BasicSpeaker speaker)
static ExtraSpeakerOptions	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ExtraSpeakerOptions[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IGNORE_SYNCHRONIZATION

public static final ExtraSpeakerOptions IGNORE_SYNCHRONIZATION

This option will ignore audio synchronization for this speaker specifically

PROCESS_OBSTRUCTIONS

@Deprecated
public static final ExtraSpeakerOptions PROCESS_OBSTRUCTIONS

Deprecated.

PLAY_ONCE

public static final ExtraSpeakerOptions PLAY_ONCE

This setting will make the speaker play once, and then never again until the player leaves the area and re-enters

REQUIRES_REDSTONE

public static final ExtraSpeakerOptions REQUIRES_REDSTONE

This setting will only make the speaker active/discoverable when its directly powered by redstone

RESET_PLAYTHROUGH_ON_REDSTONE_LOSS

public static final ExtraSpeakerOptions RESET_PLAYTHROUGH_ON_REDSTONE_LOSS

This setting will make the media timestamp reset once it loses redstone power

OVERWRITE_REGIONS

public static final ExtraSpeakerOptions OVERWRITE_REGIONS

This setting will mute all the regions for the player as long as they are in range of this speaker

Method Details

values

public static ExtraSpeakerOptions[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExtraSpeakerOptions valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isCompatibleWith

public boolean isCompatibleWith(BasicSpeaker speaker)

isEnabledFor

public boolean isEnabledFor(BasicSpeaker speaker)

isDisplay

public boolean isDisplay()

getTitle

public String getTitle()

getDescription

public String getDescription()