shot

Go to: Synopsis. Return value. Keywords. Flags. Python examples.

Synopsis

shot([audio=string], [clip=string], [clipDuration=time], [clipOpacity=float], [clipSyncState=boolean], [clipZeroOffset=time], [copy=boolean], [createCustomAnim=boolean], [currentCamera=string], [customAnim=boolean], [deleteCustomAnim=boolean], [determineTrack=boolean], [endTime=time], [favorite=boolean], [flag1=boolean], [flag10=boolean], [flag11=boolean], [flag12=boolean], [flag2=boolean], [flag3=boolean], [flag4=boolean], [flag5=boolean], [flag6=boolean], [flag7=boolean], [flag8=boolean], [flag9=boolean], [hasCameraSet=boolean], [hasStereoCamera=boolean], [linkAudio=string], [lock=boolean], [mute=boolean], [paste=boolean], [pasteInstance=boolean], [postHoldTime=time], [preHoldTime=time], [scale=float], [sequenceDuration=time], [sequenceEndTime=time], [sequenceStartTime=time], [shotName=string], [sourceDuration=time], [startTime=time], [track=int], [transitionInLength=time], [transitionInType=int], [transitionOutLength=time], [transitionOutType=int], [unlinkAudio=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

shot is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Keywords

Flags

Long name (short name)	Argument types	Properties
startTime(st)	time
The shot start time in the Maya timeline. Changing the startTime will extend the duration of a shot.
endTime(et)	time
The shot end time in the Maya timeline. Changing the startTime will extend the duration of a shot.
sequenceStartTime(sst)	time
The shot start in the sequence timeline. Changing the startTime of a shot will shift it in sequence time.
sequenceEndTime(set)	time
The shot end in the sequence timeline. Changing the endTime of a shot will scale it in sequence time.
preHoldTime(prt)	time
Specify the time length to prepend to the shot in the sequence timeline. This repeats the first frame of the shot, in sequence time, over the specified duration.
postHoldTime(pst)	time
Specify the time length to append to the shot in the sequence timeline. This repeats the last frame of the shot, in sequence time, over the specified duration.
scale(s)	float
Specify an amount to scale the Maya frame range of the shot. This will affect the sequenceEndFrame, leaving the sequenceStartFrame unchanged.
sourceDuration(sd)	time
Return the number of source frames in the shot. This flag can only be queried.
sequenceDuration(sqd)	time
Return the sequence duration of the shot, which will include the holds and scale. This flag can only be queried.
currentCamera(cc)	string
The camera associated with this shot. Refer to the shot node's documentation for details on how cameras are used by shots and the Sequencer.
hasStereoCamera(hsc)	boolean
Returns true if the camera associated with this shot is a stereo camera.
hasCameraSet(hcs)	boolean
Returns true if the camera associated with this shot is a camera set.
track(trk)	int
Specify the track in which this shot resides.
clip(cl)	string
The clip associated with this shot. This clip will be posted to the currentCamera's imagePlane. Refer to the shot node's documentation for details on how cameras are used by shots and the Sequencer.
clipOpacity(co)	float
Opacity for the shot's clip, this value is assigned to the currentCamera's imagePlane. Refer to the shot node's documentation for details on how cameras are used by shots and the Sequencer.
clipDuration(cd)	time
Length of clip. This is used for the display of the clip indicator bar in the Sequencer.
clipZeroOffset(czo)	time
Specify which time of the clip corresponds to the beginning of the shot. This is used to properly align splitted clips.
clipSyncState(css)	boolean
The viewport synchronization status of the clip associated with this shot. Return values are, 0 = no clip associated with this shot 1 = clip is fully in sync with viewport, and frames are 1:1 with sequencer 2 = clip is partially in sync with viewport, movie may be scaled to match sequencer 3 = clip not in sync with viewport (i.e. could have scale/time/camera differences)
audio(aud)	string
Specify the audio clip for this shot. Audio can be linked to a shot to allow playback of specific sounds when that shot is being displayed in the Sequencer. Refer to the shot node's documentation for details on how audio is used by shots and the Sequencer.
favorite(fav)	boolean
Make the shot a favorite. This is a UI indicator only to streamline navigation in the Sequencer panel
lock(lck)	boolean
Lock a specific shot. This is different than locking an entire track, which is done via the shotTrack command
mute(m)	boolean
Mute a specific shot. This is different than muting an entire track, which is done via the shotTrack command
shotName(sn)	string
Specify a user-defined name for this shot. This allows the assignment of names that are not valid as node names within Maya. Whenever the shotName attribute is defined its value is used in the UI.
copy(c)	boolean
This flag is used to copy a shot to the clipboard. In query mode, this flag allows you to query what, if anything, has been copied into the shot clipboard.
paste(p)	boolean
This flag is used to paste a shot or shots from the clipboard to the sequence timeline. Shots are added to the clipboard using the c/copy flag.
pasteInstance(pi)	boolean
This flag is used to paste an instance of a shot or shots from the clipboard to the sequence timeline. Unlike the p/paste flag, which duplicates the camera and image plane from the original source shot, the pi/pasteInstance flag shares the camera and image plane from the source shot. The audio node is duplicated.
linkAudio(la)	string
Specify an audio clip to link to this shot. Any currently linked audio will be unlinked.
unlinkAudio(ula)	boolean
COMMENT Unlinks any currently linked audio.
determineTrack(dt)	boolean
Determines an available track for the shot. Returns a new track number or the existing track number if the current track is available.
createCustomAnim(cca)	boolean
Creates an animation layer and links the shot node's customAnim attr to the weight attr of the animation layer
deleteCustomAnim(dca)	boolean
Disconnects the animation layer from this shot's customAnim attr and deletes the animation layer node
customAnim(ca)	boolean
Returns the name of the animation layer node linked to this shot node's customAnim attr
flag1(f1)	boolean
User specified state flag 1/12 for this shot
flag2(f2)	boolean
User specified state flag 2/12 for this shot
flag3(f3)	boolean
User specified state flag 3/12 for this shot
flag4(f4)	boolean
User specified state flag 4/12 for this shot
flag5(f5)	boolean
User specified state flag 5/12 for this shot
flag6(f6)	boolean
User specified state flag 6/12 for this shot
flag7(f7)	boolean
User specified state flag 7/12 for this shot
flag8(f8)	boolean
User specified state flag 8/12 for this shot
flag9(f9)	boolean
User specified state flag 9/12 for this shot
flag10(f10)	boolean
User specified state flag 10/12 for this shot
flag11(f11)	boolean
User specified state flag 11/12 for this shot
flag12(f12)	boolean
User specified state flag 12/12 for this shot
transitionInType(tit)	int
Specify the the type of transition for the transition into the shot. 0 = Fade 1 = Dissolve
transitionOutType(tot)	int
Specify the the type of transition for the transition out of the shot. 0 = Fade 1 = Dissolve
transitionInLength(til)	time
Length of the transtion into the shot.
transitionOutLength(tol)	time
Length of the transtion out of the shot.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

myShot = cmds.shot('myShot', st=10, et=19);
cmds.shot(myShot, e=True, sst=100, set=119);
cmds.shot(myShot, q=True, st=True);
# Result: 10.0 #
cmds.shot(myShot, q=True, sst=True);
# Result: 100.0 #
cmds.shot(myShot, e=True, pst=10);
cmds.shot(myShot, q=True, set=True);
# Result: 119.0 #
cmds.shot(myShot, e=True, prt=5);
cmds.shot(myShot, q=True, set=True);
# Result: 124.0 #
cmds.shot(myShot, q=True, sd=True);
# Result: 25.0 #