COSObjectable
, PDDestinationOrAction
public class PDActionSound extends PDAction
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
SUB_TYPE |
This type of action this object represents.
|
Constructor | Description |
---|---|
PDActionSound() |
Default constructor.
|
PDActionSound(COSDictionary a) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
boolean |
getMix() |
Gets the flag specifying whether to mix this sound with any other sound already playing.
|
boolean |
getRepeat() |
Gets whether to repeat the sound indefinitely.
|
java.lang.String |
getS() |
Deprecated.
|
COSStream |
getSound() |
Gets the sound object.
|
boolean |
getSynchronous() |
Gets the synchronous flag.
|
float |
getVolume() |
Sets the volume.
|
void |
setMix(boolean mix) |
The flag specifying whether to mix this sound with any other sound already playing.
|
void |
setRepeat(boolean repeat) |
A flag specifying whether to repeat the sound indefinitely.
|
void |
setS(java.lang.String s) |
Deprecated.
|
void |
setSound(COSStream sound) |
Sets the sound object.
|
void |
setSynchronous(boolean synchronous) |
A flag specifying whether to play the sound synchronously or asynchronously.
|
void |
setVolume(float volume) |
Gets the volume at which to play the sound, in the range −1.0 to 1.0.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCOSObject, getNext, getSubType, getType, setNext, setSubType, setType
public static final java.lang.String SUB_TYPE
public PDActionSound()
public PDActionSound(COSDictionary a)
a
- The action dictionary.@Deprecated public java.lang.String getS()
PDAction.getSubType()
.@Deprecated public void setS(java.lang.String s)
PDAction.setSubType(java.lang.String)
.s
- The Sound action.public void setSound(COSStream sound)
sound
- the sound object defining the sound that shall be played.public COSStream getSound()
public void setVolume(float volume)
volume
- The volume at which to play the sound, in the range −1.0 to 1.0.java.lang.IllegalArgumentException
- if the volume parameter is outside of the range −1.0 to 1.0.public float getVolume()
public void setSynchronous(boolean synchronous)
synchronous
- Whether to play the sound synchronously (true) or asynchronously (false).public boolean getSynchronous()
public void setRepeat(boolean repeat)
repeat
- Whether to repeat the sound indefinitely.public boolean getRepeat()
public void setMix(boolean mix)
mix
- whether to mix this sound with any other sound already playing. (false).public boolean getMix()
Copyright © 2002–2018. All rights reserved.