pymel.core.animation.recordDevice

static animation.recordDevice(*args, **kwargs)

Starts and stops server side device recording. The data is recorded at the device rate. Once recorded, the data may be brought into Maya with the applyTake command. See also: enableDevice, applyTake, readTake, writeTake In query mode, return type is based on queried flag.

Flags:
Long name (short name) Argument Types Properties
cleanup (c) bool ../../../_images/create.gif
 
Removes the recorded data from the device. Flag can have multiple arguments, passed either as a tuple or a list.
data (da) bool ../../../_images/query.gif
 
Specifies if the device has recorded data. If the device is recording at the time of query, the flag will return false. Q: When queried, this flag returns an int.
device (d) unicode ../../../_images/create.gif
 

Specifies which device(s) to start record recording. The listed device(s) will start recording regardless of their record enable state. C: The default is to start recording all devices that are record enabled.

duration (dr) int ../../../_images/create.gif ../../../_images/query.gif
 

Duration (in seconds) of the recording. When the duration expires, the device will still be in a recording state and must be told to stop recording. C: The default is 60. Q: When queried, this flag returns an int.

playback (p) bool ../../../_images/create.gif ../../../_images/query.gif
 

If any attribute is connected to an animation curve, the animation curve will play back while recording the device(s) including any animation curves attached to attributes being recorded. C: The default is false. Q: When queried, this flag returns an int.

state (st) bool ../../../_images/create.gif ../../../_images/query.gif
 
Start or stop device recording. C: The default is true. Q: When queried, this flag returns an int.
wait (w) bool ../../../_images/create.gif
 
If -p/playback specified, wait until playback completion before returning control to the user. This flag is ignored if -p is not used.

Derived from mel command maya.cmds.recordDevice

Example:

import pymel.core as pm

#    Record the clock device for 30 seconds and apply the data.
#
import time
pm.recordDevice( device='clock', duration=30 )
time.sleep( 30 )
pm.recordDevice( device='clock', state=False )
pm.applyTake( device='clock' )

Previous topic

pymel.core.animation.readTake

Next topic

pymel.core.animation.removeJoint

Core

Core Modules

Other Modules

This Page