pymel.core.nodetypes.Shot

Inheritance diagram of Shot

class Shot(*args, **kwargs)

class counterpart of mel function shot

Use this command to create a shot node or manipulate that node.

getAudio(**kwargs)

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.

Derived from mel command maya.cmds.shot

getClip(**kwargs)

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.

Derived from mel command maya.cmds.shot

getClipDuration(**kwargs)

Length of clip. This is used for the display of the clip indicator bar in the Sequencer.

Derived from mel command maya.cmds.shot

getClipOpacity(**kwargs)

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.

Derived from mel command maya.cmds.shot

getClipSyncState(**kwargs)

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)

Derived from mel command maya.cmds.shot

getClipZeroOffset(**kwargs)

Specify which time of the clip corresponds to the beginning of the shot. This is used to properly align splitted clips.

Derived from mel command maya.cmds.shot

getCopy(**kwargs)

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.

Derived from mel command maya.cmds.shot

getCurrentCamera(**kwargs)

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.

Derived from mel command maya.cmds.shot

getDetermineTrack(**kwargs)

Determines an available track for the shot. Returns a new track number or the existing track number if the current track is available.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.shot

getEndTime(**kwargs)

The shot end time in the Maya timeline. Changing the startTime will extend the duration of a shot.

Derived from mel command maya.cmds.shot

getFavorite(**kwargs)

Make the shot a favorite. This is a UI indicator only to streamline navigation in the Sequencer panel

Derived from mel command maya.cmds.shot

getLinkAudio(**kwargs)

Specify an audio clip to link to this shot. Any currently linked audio will be unlinked.

Derived from mel command maya.cmds.shot

getLock(**kwargs)

Lock a specific shot. This is different than locking an entire track, which is done via the shotTrack command

Derived from mel command maya.cmds.shot

getMute(**kwargs)

Mute a specific shot. This is different than muting an entire track, which is done via the shotTrack command

Derived from mel command maya.cmds.shot

getPaste(**kwargs)

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.

Derived from mel command maya.cmds.shot

getPasteInstance(**kwargs)

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.

Derived from mel command maya.cmds.shot

getPostHoldTime(**kwargs)

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.

Derived from mel command maya.cmds.shot

getPreHoldTime(**kwargs)

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.

Derived from mel command maya.cmds.shot

getScale(**kwargs)

Specify an amount to scale the Maya frame range of the shot. This will affect the sequenceEndFrame, leaving the sequenceStartFrame unchanged.

Derived from mel command maya.cmds.shot

getSequenceDuration(**kwargs)

Return the sequence duration of the shot, which will include the holds and scale. This flag can only be queried.

Derived from mel command maya.cmds.shot

getSequenceEndTime(**kwargs)

The shot end in the sequence timeline. Changing the endTime of a shot will scale it in sequence time.

Derived from mel command maya.cmds.shot

getSequenceStartTime(**kwargs)

The shot start in the sequence timeline. Changing the startTime of a shot will shift it in sequence time.

Derived from mel command maya.cmds.shot

getShotName(**kwargs)

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.

Derived from mel command maya.cmds.shot

getSourceDuration(**kwargs)

Return the number of source frames in the shot. This flag can only be queried.

Derived from mel command maya.cmds.shot

getStartTime(**kwargs)

The shot start time in the Maya timeline. Changing the startTime will extend the duration of a shot.

Derived from mel command maya.cmds.shot

getTrack(**kwargs)

Specify the track in which this shot resides.

Derived from mel command maya.cmds.shot

getUnlinkAudio(**kwargs)

COMMENT Unlinks any currently linked audio.

Derived from mel command maya.cmds.shot

setAudio(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shot

setClip(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shot

setClipDuration(val=True, **kwargs)

Length of clip. This is used for the display of the clip indicator bar in the Sequencer.

Derived from mel command maya.cmds.shot

setClipOpacity(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shot

setClipSyncState(val=True, **kwargs)

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)

Derived from mel command maya.cmds.shot

setClipZeroOffset(val=True, **kwargs)

Specify which time of the clip corresponds to the beginning of the shot. This is used to properly align splitted clips.

Derived from mel command maya.cmds.shot

setCopy(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shot

setCurrentCamera(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shot

setDetermineTrack(val=True, **kwargs)

Determines an available track for the shot. Returns a new track number or the existing track number if the current track is available.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.shot

setEndTime(val=True, **kwargs)

The shot end time in the Maya timeline. Changing the startTime will extend the duration of a shot.

Derived from mel command maya.cmds.shot

setFavorite(val=True, **kwargs)

Make the shot a favorite. This is a UI indicator only to streamline navigation in the Sequencer panel

Derived from mel command maya.cmds.shot

setLinkAudio(val=True, **kwargs)

Specify an audio clip to link to this shot. Any currently linked audio will be unlinked.

Derived from mel command maya.cmds.shot

setLock(val=True, **kwargs)

Lock a specific shot. This is different than locking an entire track, which is done via the shotTrack command

Derived from mel command maya.cmds.shot

setMute(val=True, **kwargs)

Mute a specific shot. This is different than muting an entire track, which is done via the shotTrack command

Derived from mel command maya.cmds.shot

setPaste(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shot

setPasteInstance(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shot

setPostHoldTime(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shot

setPreHoldTime(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shot

setScale(val=True, **kwargs)

Specify an amount to scale the Maya frame range of the shot. This will affect the sequenceEndFrame, leaving the sequenceStartFrame unchanged.

Derived from mel command maya.cmds.shot

setSequenceDuration(val=True, **kwargs)

Return the sequence duration of the shot, which will include the holds and scale. This flag can only be queried.

Derived from mel command maya.cmds.shot

setSequenceEndTime(val=True, **kwargs)

The shot end in the sequence timeline. Changing the endTime of a shot will scale it in sequence time.

Derived from mel command maya.cmds.shot

setSequenceStartTime(val=True, **kwargs)

The shot start in the sequence timeline. Changing the startTime of a shot will shift it in sequence time.

Derived from mel command maya.cmds.shot

setShotName(val=True, **kwargs)

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.

Derived from mel command maya.cmds.shot

setSourceDuration(val=True, **kwargs)

Return the number of source frames in the shot. This flag can only be queried.

Derived from mel command maya.cmds.shot

setStartTime(val=True, **kwargs)

The shot start time in the Maya timeline. Changing the startTime will extend the duration of a shot.

Derived from mel command maya.cmds.shot

setTrack(val=True, **kwargs)

Specify the track in which this shot resides.

Derived from mel command maya.cmds.shot

setUnlinkAudio(val=True, **kwargs)

COMMENT Unlinks any currently linked audio.

Derived from mel command maya.cmds.shot

Previous topic

pymel.core.nodetypes.ShellTessellate

Next topic

pymel.core.nodetypes.SimpleTestNode

Core

Core Modules

Other Modules

This Page