pymel.core.animation.timeEditorClip¶

timeEditorClip(*args, **kwargs)¶

This command edits/queries Time Editor clips.

Flags:

Long Name / Short Name		Argument Types	Properties
absolute / abs		bool
	This flag is used in conjunction with other timing flags like -s/start, -d/duration, -ed/end, etc. to query (global) absolute time.
addAttribute / aa		unicode
	Add new attribute to the clip.
addObjects / ao		unicode
	Populate the given object(s) and their attributes to anim source to Time Editor. For multiple object, pass each name separated by semicolon. In query mode, return the number of attributes that will be populated given the flags, along with the animation’s first and last frames for the given object(s). Similar to -addSelectedObjectsflag but acts on given object(s) instead. This flag will override the flag -addSelectedObjects.
addRelatedKG / akg		bool
	During population, determine if associated keying groups should be populated or not. Normally used for populating HIK. By default the value is false.
addSelectedObjects / aso		bool
	Populate the currently selected objects and their attributes to anim source or Time Editor. In query mode, return the number of attributes that will be populated given the flags, along with the animation’s first and last frames.
allowShrinking / eas		bool
	When extending clip, allow shrinking.
animSource / asr		unicode
	Populate based on animation source.
attribute / at		unicode
	Populate a specific attribute on a object.
audio / au		unicode
	Create a clip with audio inside.
children / chl		int
	Get children clip IDs.
clipAfter / ca		bool
	Get the clip ID of the next clip.
clipBefore / cb		bool
	Get the clip ID of the previous clip.
clipDataType / cdt		bool
	Query the type of data being driven by the given clip ID. Return values are: 0 : Animation - Clip drives animation curves1 : Audio - Clip drives audio3 : Group - Clip is a group
clipId / id		int
	ID of the clip to be edited.
clipIdFromNodeName / idn		int
	Get clip ID from clip node name.
clipIdFromPath / idp		bool
	Flag for querying the clip ID given the path. Clip path is a vertical-bar-delimited string to indicate a hierarchical structure of a clip. Please refer to the hierarchical path in outliner to see how it is represented. For example: composition1|track1|clip1 Note: To specify the path, this flag must appear before -query flag.
clipNode / cln		bool
	Flag for querying the name of the clip node.
clipPath / clp		bool
	Flag for querying the path given the clip ID. Clip path is a vertical bar delimited string to indicate a hierarchical structure of a clip. Please refer to the hierarchical path in outliner to see how it is represented. For example: composition1|track1|clip1. Note: If the clip is not connected to any track, it will return empty string.
copyClip / ccl		bool
	Get the selected clip IDs and store them in a list that could be used for pasting.
crossfadeMode / cfm		int
	Set the crossfading mode between two clips that lie on the same track, and that are specified with the -clipId flags: 0 : linear - Two clips are blended with a constant ratio1 : step - Left clip keeps its value until the middle of the crossfading region and then right clip’s value is used2 : hold left - Use only left clip’s value3 : hold right - Use only right clip’s value4 : custom - User defined crossfade curve5 : custom (spline) - User defined crossfade curve with spline preset
crossfadePlug / cfp		bool
	Get plug path for a custom crossfade curve between 2 clips.
curveTime / cvt		time
	Query the curve local time in relation to the given clip.
defaultGhostRoot / dgr		bool
	Edit or query default ghost root variable. Determine whether to use the default ghost root (object driven by clip).
drivenAttributes / dat		bool
	Return a list of attributes driven by a clip.
drivenClipsBySource / dcs		unicode
	Returns the clips driven by the given source. Can filter the return result by the specified type, like animCurve, expression, constraint, etc. This flag must come before the -query flag.
drivenObjects / dos		bool
	Return an array of strings consisting of the names of all objects driven by the current clip and its children clips.
drivenRootObjects / dro		bool
	Return an array of strings consisting of the names of all root objects driven by this clip and its children clips.
drivingSources / dsc		unicode
	Return all sources driving the given clip. Can filter the return result by the specified type, like animCurve, expression, constraint, etc. If used after the -query flag (without an argument), the command returns all sources driving the given clip. To specify the type, this flag must appear before the -query flag. In query mode, this flag can accept a value.
duplicateClip / dcl		bool
	Duplicate clip into two clips with the same timing info.
duration / d		time
	Relative duration of the new clip.
emptySource / ems		bool
	Create a clip with an empty source.
endTime / et		time
	Query the relative end time of the clip.
exclusive / exc		bool
	Populate all types of animation sources which are not listed by typeFlag.
existingOnly / exo		bool
	This flag can only be used in edit mode, in conjunction with the animSource flag. Retain the animSource flag functionality but only bind attributes that are already part of the clip. It does not attempt to populate unbound source attributes to their default destination.
exists / exs		bool
	Return true if the specified clip exists.
explode / epl		int
	Reparent all tracks and their clips within a group out to its parent track node and remove the group.
exportAllClips / eac		bool
	When used with the ef/exportFbxflag, export all clips.
exportFbx / ef		unicode
	Export currently selected clips to FBX files.
extend / ex		bool
	Extend the clip to encompass all children.
extendParent / exp		bool
	Extend parent to fit this clip.
ghost / gh		bool
	Enable/disable ghosting for the specified clip.
ghostRootAdd / gra		unicode
	Add path to specified node as a custom ghost root.
ghostRootRemove / grr		unicode
	Remove path to specified node as a custom ghost root.
group / grp		bool
	Specify if the new container should be created as a group, containing other specified clips.
holdEnd / he		time
	Hold clip’s end to time.
holdStart / hs		time
	Hold clip’s start to time.
importAllFbxTakes / aft		bool
	Import all FBX takes into the new anim sources (for timeEditorAnimSource command) or new containers (for timeEditorClip command).
importFbx / fbx		unicode
	Import an animation from FBX file into the new anim source (for timeEditorAnimSource command) or new container (for timeEditorClip command).
importFbxTakes / ft		unicode
	Import multiple FBX takes (separated by semicolons) into the new anim sources (for timeEditorAnimSource command) or new containers (for timeEditorClip command).
importMayaFile / mf		unicode
	Import an animation from Maya file into the new anim sources (for timeEditorAnimSource command) or new containers (for timeEditorClip command).
importOption / io		unicode
	Option for importing animation source. Specify either ‘connect’ or ‘generate’. connect: Only connect with nodes already existing in the scene. Importing an animation source that does not match with any element of the current scene will not create any clip. (connect is the default mode). generate: Import everything and generate new nodes for items not existing in the scene.
importPopulateOption / ipo		unicode
	Option for population when importing.
importTakeDestination / itd		int
	Specify how to organize imported FBX takes: 0 - Import takes into a group (default) 1 - Import takes into multiple compositions 2 - Import takes as a sequence of clips
importedContainerNames / icn		unicode
	Internal use only. To be used along with populateImportedAnimSourcesto specify names for the created containers.
includeRoot / irt		bool
	Populate transform (Translate, Rotate, Scale) of hierarchy root nodes.
isContainer / ict		bool
	Indicate if given clip ID is a container.
listUserGhostRoot / lug		bool
	Get user defined ghost root object for indicated clips.
loopEnd / le		time
	Loop clip’s end to time.
loopStart / ls		time
	Loop clip’s start to time.
minClipDuration / mcd		bool
	Returns the minimum allowed clip duration.
modifyAnimSource / mas		bool
	When populating, automatically modify Anim Source without asking the user.
moveClip / mcl		time
	Move clip by adding delta to its start time.
mute / m		bool
	Mute/Unmute the clip given a clip ID. In query mode, return the muted state of the clip. Clips muted by soloing are not affected by this flag.
name / n		unicode
	Name of the clip. A clip will never have an empty name. If an empty string is provided, it will be replaced with _.
parent / p		int
	Specify group/object parent ID.
parentClipId / pid		int
	Specify the parent clip ID of a clip to be created.
parentGroupId / pgd		bool
	Return the parent group ID of the given clip.
pasteClip / pcl		time
	Paste clip to the given time and track. Destination track is required to be specified through the track flag in the format tracksNode:trackIndex. A trackIndex of -1 indicates that a new track will be created.
path / pt		unicode
	Full path of the clip to be edited. For example: composition1|track1|clip1. In query mode, this flag can accept a value.
populateImportedAnimSources / pia		unicode
	Internal use only. Populate the Time Editor with clips using the Animation Sources specified (use ; as a delimiter for multiple anim sources).
poseClip / poc		bool
	Populate as pose clip with current attribute values.
preserveAnimationTiming / pat		bool
	When used with the population command, it ensures the animation is offset within a clip in such way that it matches its original scene timing, regardless of the new clip’s position.
razorClip / rcl		time
	Razor clip into two clips at the specified time.
recursively / rec		bool
	Populate selection recursively, adding all the children.
remap / rmp		unicode, unicode
	Change animation source for a given clip item to a new one, specified by the target path. This removes all clips for the roster item and creates new clips from the Anim Source for the new target path.
remapSource / rs		unicode, unicode
	Set animation source to be remapped for a given clip item to new one, specified by the target path.
remappedSourceAttrs / rms		bool
	Return an array of attribute indices and names of the source attributes of a remapped clip.
remappedTargetAttrs / rmt		bool
	Return an array of attribute indices and names of the target attributes of a remapped clip.
removeAttribute / ra		unicode
	Remove attribute from the clip.
removeClip / rmc		bool
	Remove clip of specified ID.
removeCrossfade / rcf		bool
	Remove custom crossfade between two clips specified by -clipId flags.
removeSceneAnimation / rsa		bool
	If true, remove animation from scene when creating clips or anim sources. Only Time Editor will drive the removed scene animation.
removeWeightCurve / rwc		bool
	Remove the weight curve connected to the clip.
resetTiming / rt		bool
	Reset start and duration of a clip with the given clip ID to the values stored in its Anim Source.
resetTransition / rtr		bool
	Reset transition intervals between specified clips.
ripple / rpl		bool
	Apply rippling to a clip operation.
rootClipId / rti		int
	ID of the root clip. It is used together with various clip editing flags. When used, the effect of clip editing and its parameters will be affected by the given root clip. For example, moving a clip under the group root (usually in group tab view) will be performed in the local time space of the group root.
rootPath / rpt		unicode
	Path of the root clip. It is used together with various clip editing flags. When used, the effect of clip editing and its parameters will be affected by the given root clip. For example, moving a clip under the group root (usually in group tab view) will be performed in the local time space of the group root.
scaleEnd / sce		time
	Scale the end time of the clip to the given time.
scalePivot / scp		time
	Scale the time of the clip based on the pivot. This should be used together with -scs/scaleStartor -sce/scaleEnd.
scaleStart / scs		time
	Scale the start time of the clip to the given time.
setKeyframe / k		unicode
	Set keyframe on a specific clip for a specified attribute.
showAnimSourceRemapping / sar		bool
	Show a remapping dialog when the imported anim source attributes do not match the scene attributes.
speedRamping / src		int
	To control the playback speed of the clip by animation curve: 1 : create - Attach a speed curve and a time warp curve to the clip to control the playback speed2 : edit - Open the Graph editor to edit the speed curve3 : enable - Create a time warp curve from current speed curve and attach to clip4 : disable - Remove the time warp curve from clip5 : delete - Delete the attached speed curve and time warp curve6 : reset - Reset the speed curve back to the default7 : convert to speed curve from time warp8 : convert to time warp from speed curveIn query mode, return true if a speed curve is attached to the clip.
startTime / s		time
	Relative start time of the new clip.
takeList / tl		unicode
	Internal use only. To be used along with populateImportedAnimSourcesto specify the imported take names.
takesToImport / toi		unicode
	Internal use only. To be used along with populateImportedAnimSourcesto specify the imported take indices.
timeWarp / tw		bool
	Return true if the clip is being warped by the speed curve. If no speed curve is attached to the clip, it will always return false.
timeWarpCurve / twc		bool
	Returns the name of the time warp curve connected to the clip.
timeWarpType / twt		int
	Time warp mode: 0: remapping - Connected time warp curve performs frame by frame remapping1: speed curve - Connected time warp curve acts as a speed curveIn query mode, return time warp mode of a clip.
track / trk		unicode
	The new clip container will be created on the track in the format trackNode:trackNumber, or on a track path, for example composition1|track1. In query mode, return a string containing the track number and tracks node of the given clip ID. In create mode, if the track number is ‘-1’ or not given at all, then a new track will be created. For example: trackNode:-1; composition1|.
tracksNode / trn		bool
	Get tracks node if specified clip is a group clip.
transition / tra		bool
	Create transition intervals between specified clips.
trimEnd / tre		time
	Trim the end time of the clip to the given time.
trimStart / trs		time
	Trim the start time of the clip to the given time.
truncated / trc		bool
	This flag is used in conjunction with other timing flags like -s/start, -d/duration, -ed/end, etc. to query (global) truncated time.
type / typ		unicode
	Only populate the specified type of animation source. Flag can have multiple arguments, passed either as a tuple or a list.
uniqueAnimSource / uas		bool
	If a given clip is sharing its Anim Source node with another clip, make the Anim Source of this clip unique.
userGhostRoot / ugr		bool
	Edit or query custom ghost root variable. Determine whether to use user defined ghost root.
weightCurve / wc		bool
	In edit mode, create a weight curve and connect it to the clip. In query mode, return the name of the weight curve connected to the clip.
zeroKeying / zk		bool
	A toggle flag to use in conjunction with k/setKeyframe, set the value of the key frame(s) to be keyed to zero.

Derived from mel command maya.cmds.timeEditorClip

Example:

::

import pymel.core as pm

# Move clips 1 and 2 pm.timeEditorClip(edit=True, moveClip=20, clipId=[1,2])

# Create new container clip on track 4 of Container_A tracks pm.timeEditorClip(“ClipNodeName”, track=”Container_A_Tracks:4”)

# Create new container clip on track path pm.timeEditorClip(“ClipNodeName”, track=”composition1|track1”)

# Populate selected objects with attributes driven by specific types of animation sources pm.timeEditorClip(“teClip1”, addSelectedObjects=True, type=[“animCurveTL”,”animCurveTA”], track=”Composition1:1”)

# Populate selected objects and their associated keying groups (normally used for populating complete HIK rig) pm.timeEditorClip(“teClip1”, addSelectedObjects=True, addRelatedKG=True, track=”Composition1:1”)

# Populate selected objects into a newly created container pm.timeEditorClip(“ContainerName”, track=”Container_A_Tracks:0”, addSelectedObjects=True)

# Move a container(s) to a different track # The “New_Track:2” has the same format as when creating a new clip, # where “New_Track” is the TimeEditor “Tracks node” and “2” is the track index in that node. # A “Tracks” node maintains a list of tracks at a given level in the TimeEditor hierarchy # and is either a composition or a group clip. pm.timeEditorClip(edit=True, track=”New_Track:2”, clipId=[1,2,3])

# Move a container(s) to a different track by clip path pm.timeEditorClip(edit=True, track=”composition1|track1”, path=[“composition1|track2|clip1”,”composition1|track2|clip2”,”composition1|track2|clip3”])

# Create a group from specified containers pm.timeEditorClip(“GroupName”, track=”New_Track:1”, group=True, clipId=[1,2,3])

# Import animation from selected object into the TimeEditor. pm.timeEditorClip(“container_A”, aso=True, track=”composition1|track1”)

# Return the Anim Source for a given clip ID 1 pm.timeEditorClip(1, query=True, animSource=True)

# Create a clip from an Anim Source starting at frame 30 into track2 of composition1 pm.timeEditorClip(“Container_B”, track=”composition1|track2”, animSource=”someAnimSourceName”, startTime=30)

# Return the start time of the clip with clip ID 1 pm.timeEditorClip(1, query=True, startTime=True, absolute=True)

# Return the duration of the clip with clip ID 1 pm.timeEditorClip(1, query=True, duration=True, absolute=True)

# Remap cube 1 translate X attribute to cube 1 translate Y attribute pm.timeEditorClip(edit=True, remapSource=[“cube1.translateY”, “cube1.translateX”], clipId=1) pm.timeEditorClip(edit=True, animSource=”AnimSourceName”, clipId=1)

# Setup the crossfading mode between 2 clips to linear pm.timeEditorClip(edit=True, crossfadeMode=-1, clipId=[1,2])

# Remove clips with clip ID 1 and 2. pm.timeEditorClip(edit=True, removeClip=True, clipId=[1,2])