de.humatic.dsj.edit
Class EffectDescription

java.lang.Object
  de.humatic.dsj.DSFilterInfo
      de.humatic.dsj.edit.EffectDescription

All Implemented Interfaces:

java.lang.Comparable

public class EffectDescription
extends DSFilterInfo

EffectDescription is a special descriptive form of DSFilterInfo, that is used in effect initialization. It collects initial settings for an effect's parameters and is passed to the MovieTrack.addEffect(...) method.
To alter effect paramters once the effect has been set up, use TrackEffect methods and CuePoints.

Nested Class Summary

Nested classes/interfaces inherited from class de.humatic.dsj.DSFilterInfo

DSFilterInfo.DSCrossBarInfo, DSFilterInfo.DSMediaFormat, DSFilterInfo.DSPinInfo, DSFilterInfo.DSTVTunerInfo

Field Summary

static int	ALPHA (DES) Effect types
static int	COMPOSITOR (DES) Effect types
static int	KEY (DES) Effect types
static int	SMPTE_WIPE (DES) Effect types
static int	VOLUME (DES) Effect types

Fields inherited from class de.humatic.dsj.DSFilterInfo

BFRAME, CAPTURE_AUDIO, CAPTURE_DV, CAPTURE_MPEG, CAPTURE_VIDEO, CRUNCH, DO_NOT_USE, IAMVideoCompression, isDescriptive, KEYFRAME, QUALITY, SHOW_DLG_SAVE, SHOW_USER_DIALOG

Method Summary

void	addParameter(java.lang.String pName, int value) Adds a parameter to initialize the effect with.
void	clearParameters()
static EffectDescription	createForType(int type) Creates an EffectDescription for the "built-in" DES effects, which are the ones that parameters are known for.
static EffectDescription[]	getAvailableVideoEffects() Returns all installed video effects.
static EffectDescription[]	getAvailableVideoTransitions() Returns all installed video transitions (2 source effects).
int	getMajorType()
java.lang.String[]	getParameterNames() Returns the names of available parameters for the effect or null if unknown.
java.util.Vector	getParameters()
java.lang.String	getSubGUID()
int	getSubType()
void	setSubType(int sType)
java.lang.String	toString() Returns an informative String, containing info about the described filter, its pins and their formats

Methods inherited from class de.humatic.dsj.DSFilterInfo

compareTo, createFileInfo, doNotRender, filterInfoForCLSID, filterInfoForCodecState, filterInfoForCodecState, filterInfoForDll, filterInfoForName, filterInfoForProfile, filterInfoForProfile, filterInfoForSystemProfile, getCLSID, getCrossBarInfo, getDllLocation, getDownstreamPins, getName, getPath, getPins, getPreferredFormat, getTVTunerInfo, getType, getUpstreamPins, isNullInfo, resolve, setPreferredFormat

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SMPTE_WIPE

public static final int SMPTE_WIPE

(DES) Effect types

See Also:

Constant Field Values

COMPOSITOR

public static final int COMPOSITOR

(DES) Effect types

See Also:

Constant Field Values

KEY

public static final int KEY

(DES) Effect types

See Also:

Constant Field Values

ALPHA

public static final int ALPHA

(DES) Effect types

See Also:

Constant Field Values

VOLUME

public static final int VOLUME

(DES) Effect types

See Also:

Constant Field Values

Method Detail

createForType

public static EffectDescription createForType(int type)

Creates an EffectDescription for the "built-in" DES effects, which are the ones that parameters are known for. See constants for possible values of the type parameter.

getParameterNames

public java.lang.String[] getParameterNames()

Returns the names of available parameters for the effect or null if unknown.

setSubType

public void setSubType(int sType)

getSubGUID

public java.lang.String getSubGUID()

Overrides:

getSubGUID in class DSFilterInfo

addParameter

public void addParameter(java.lang.String pName,
                         int value)

Adds a parameter to initialize the effect with. For a listing of parameters of the DES transitions see MSDN documentation at http://msdn2.microsoft.com/en-us/library/ms787805(VS.85).aspx.

clearParameters

public void clearParameters()

getSubType

public int getSubType()

getMajorType

public int getMajorType()

getParameters

public java.util.Vector getParameters()

toString

public java.lang.String toString()

Description copied from class: DSFilterInfo

Returns an informative String, containing info about the described filter, its pins and their formats

Overrides:

toString in class DSFilterInfo

getAvailableVideoEffects

public static EffectDescription[] getAvailableVideoEffects()

Returns all installed video effects. The EffectDescriptions in the returned array can be directly passed into the MovieTrack.addEffect(...) method, however most of them will have an unknown set of parameters.

getAvailableVideoTransitions

public static EffectDescription[] getAvailableVideoTransitions()

Returns all installed video transitions (2 source effects). The EffectDescriptions in the returned array can be directly passed into the MovieTrack.addEffect(...) method, however most of them will have an unknown set of parameters.