|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Fade
Specifies a value that describes an audio fade operation
associated with a source clip in terms of its fade in and out
lengths and types. This interface was introduced as part of the port of the MAJ API to collect together
return values from SourceClip.getFade()
.
Properties for a fade in operation are optional. Either both values for a fade in length and type are present or both are omitted. Similarly for fade out parameters.
FadeType
,
SourceClip
,
Fade
Method Summary | |
---|---|
long |
getFadeInLength()
Returns the fade in length of the fade. |
FadeType |
getFadeInType()
Returns the fade in type of the fade. |
long |
getFadeOutLength()
Returns the fade out length of the fade. |
FadeType |
getFadeOutType()
Returns the fade out type of the fade. |
boolean |
isFadeInPresent()
Returns true if details of a fade in are
present in the fade; otherwise false . |
boolean |
isFadeOutPresent()
Returns true if details of a fade out
are present in the fade; otherwise false . |
void |
setFadeInLength(long fadeInLength)
Sets the fade in length of the fade. |
void |
setFadeInType(FadeType fadeInType)
Sets the fade in type of the fade. |
void |
setFadeOutLength(long fadeOutLength)
Sets the fade out length of the fade. |
void |
setFadeOutType(FadeType fadeOutType)
Sets the fade out type of the fade. |
Method Detail |
---|
void setFadeInLength(@LengthType long fadeInLength) throws BadLengthException
Sets the fade in length of the fade. This is an optional property that can be omitted
by calling setFadeInType(null)
.
fadeInLength
- Fade in length of the fade.
BadLengthException
- Cannot set the fade in length to a negative value.@LengthType long getFadeInLength() throws PropertyNotPresentException
Returns the fade in length of the fade. This is an optional property.
PropertyNotPresentException
- This optional property is not present in the fade.void setFadeInType(FadeType fadeInType)
Sets the fade in type of the fade. Set to null
to omit both this optional
property and the associated fade in length property.
fadeInType
- Fade in type of the fade.FadeType getFadeInType() throws PropertyNotPresentException
Returns the fade in type of the fade. This is an optional property.
PropertyNotPresentException
- This optional property
is not present in the fade.boolean isFadeInPresent()
Returns true
if details of a fade in are
present in the fade; otherwise false
.
void setFadeOutLength(@LengthType long fadeOutLength) throws BadLengthException
Sets the fade out length of the fade. This is an optional property that can be omitted
by calling setFadeOutType(null)
.
fadeOutLength
- Fade out length of the fade.
BadLengthException
- Cannot set the fade out length to a negative value.@LengthType long getFadeOutLength() throws PropertyNotPresentException
Returns the fade out length of the fade. This is an optional property.
PropertyNotPresentException
- This optional property
is not present in the fade.void setFadeOutType(FadeType fadeOutType)
Sets the fade out type of the fade. Set to null
to omit both this optional
property and the associated fade out length property.
fadeOutType
- Fade out type of the fade.FadeType getFadeOutType() throws PropertyNotPresentException
Returns the fade out type of the fade. This is an optional property.
PropertyNotPresentException
- This optional property
is not present in the fade.boolean isFadeOutPresent()
Returns true
if details of a fade out
are present in the fade; otherwise false
.
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |