|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecttv.amwa.maj.argument.DefaultFade
public class DefaultFade
Implementation of a default fade to be applied to source clips in a composition mob that do not specify their own fade properties. The structure consists of the fade length, edit units to which the fade is specified and the fade type.
It is useful to manage default fade properties together as they are either all present or all omitted from a CompositionMob (conditional rule 1).
CompositionMob.getDefaultFade()
,
Serialized FormConstructor Summary | |
---|---|
DefaultFade()
Create a default fade value with its parameters initialised to basic values. |
|
DefaultFade(long fadeLength,
FadeType fadeType,
Rational fadeEditUnit)
Create a default fade description. |
Method Summary | |
---|---|
DefaultFade |
clone()
|
boolean |
equals(Object o)
|
Rational |
getFadeEditUnit()
Returns the edit units used to specify the default fade length. |
long |
getFadeLength()
Returns the length of this default audio fade, measured in this fade's edit units. |
FadeType |
getFadeType()
Returns the type of this default audio fade. |
int |
hashCode()
|
void |
setFadeEditUnit(Rational fadeEditUnit)
Sets the edit units used to specify the default fade length |
void |
setFadeLength(long fadeLength)
Sets the length of this default audio fade, measured in this fade's edit unit. |
void |
setFadeType(FadeType fadeType)
Sets the type of this default audio fade. |
String |
toString()
Creates a pseudo-XML representation of this default fade value. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DefaultFade(@LengthType long fadeLength, FadeType fadeType, Rational fadeEditUnit) throws NullPointerException, BadLengthException
Create a default fade description.
fadeLength
- Specifies the default length of the audio fade-in and fade-out.fadeType
- Specifies the default type of audio fade.fadeEditUnit
- Specifies the edit units in which the default fade length is specified.
NullPointerException
- One or both of the given fade type and/or fade edit unit values
is null
.
BadLengthException
- The default fade length is negative.public DefaultFade()
Create a default fade value with its parameters initialised to basic values. These
are a fade length of 0
, a fade type of FadeType.None
and a fade edit unit of 0/1
.
Method Detail |
---|
public Rational getFadeEditUnit()
DefaultFade
Returns the edit units used to specify the default fade length.
getFadeEditUnit
in interface DefaultFade
public void setFadeEditUnit(Rational fadeEditUnit) throws NullPointerException
DefaultFade
Sets the edit units used to specify the default fade length
setFadeEditUnit
in interface DefaultFade
fadeEditUnit
- Edit units used to specify the fade length.
NullPointerException
- The given edit units for the default fade length are null
.@LengthType public long getFadeLength()
DefaultFade
Returns the length of this default audio fade, measured in this fade's edit units.
getFadeLength
in interface DefaultFade
DefaultFade.getFadeEditUnit()
public void setFadeLength(@LengthType long fadeLength) throws BadLengthException
DefaultFade
Sets the length of this default audio fade, measured in this fade's edit unit.
setFadeLength
in interface DefaultFade
fadeLength
- Length of the default audio fade.
BadLengthException
- Length of the default fade is negative.DefaultFade.getFadeEditUnit()
,
DefaultFade.setFadeEditUnit(Rational)
public FadeType getFadeType()
DefaultFade
Returns the type of this default audio fade.
getFadeType
in interface DefaultFade
public void setFadeType(FadeType fadeType) throws NullPointerException
DefaultFade
Sets the type of this default audio fade.
setFadeType
in interface DefaultFade
fadeType
- Type of this default audio fade.
NullPointerException
- The given fade type for the default fade is null
.public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String toString()
Creates a pseudo-XML representation of this default fade value. The format is loosely based on the XML element representing a composition mob but is not itself defined by an XML schema or DTD. For example:
<DefaultFade> <DefaultFadeLength>1000</DefaultFadeLength> <DefFadeType>FadeLinearAmp</DefFadeType> <DefFadeEditUnit>25/1</DefFadeEditUnit> </DefaultFade>
toString
in class Object
public DefaultFade clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |