Shot Messages

Action Messages

• SAVE_SHOT_AS_MOVIE_AT_RESOLUTION - Save a movie to the specified location from a specified shot. If the shot is not specified, save them all.

  Parameters:

  • width (int) - The width of the image.

  • height (int) - The height of the image.

  • frames per second (int) - The number of frames per second of the movie.

  • output file type (int) - The output file type. 0 - AVI Movie; 1 - JPEG Image Sequence; 2 - TIFF Image Sequence.

  • antialiasing (int) - The anti-aliasing level. 0 - 9.

  • separate (bool) - If all shots are saved, setting this to False would produce a single movie, setting it to True would produce separate movies.

  • filename (unicode) - The name of the destination movie file.

  • shot (unicode) - The name of the shot to save or empty for all.

  • Tuple compression (tuple) - The tuple of items to be set the compressor, which is in the form (compressionName, quality): "compressionName" can be empty for full frame with uncompressed; "quality" is the compression level. 0 - 10000.

  • rtquality (tuple) - Raytraced quality level. 0 is one ray per pixel

• SHOT_CHANGE_TYPE - Changes the type of the shot to be newType carrying over as many common parameters as possible. This message is undoable and broadcastable.

  Parameters:

  • name (unicode) - The name of the shot to modify.

  • newType (unicode) - The type to change the shot to: 'ShotStill', 'ShotRecorder', 'ShotParametric', or 'ShotKeyframed'. (See "Module Shot" in the Showcase API Reference documentation.

  • motion (unicode) - The filename for the motion, if the shot type is parametric.

• SHOT_CREATE - Creates a named shot of the specified type with default parameters. This message is undoable and broadcastable. This message will trigger the following response messages: SHOT_CREATED. This default maximum wait time for this message is 10.

  Parameters:

  • type (unicode) - The type of shot to create: 'ShotStill', 'ShotParametric', 'ShotKeyframed', or 'ShotRecorded'. (See "Module Shot" in the Showcase API Reference documentation.

  • name (unicode) - A name for the new shot. Pass an empty string to get a generated name.

  • label (unicode) - A label for the new shot. Pass an empty string to get a generated label.

  • motionFilename (unicode) - Maya motion file. Required for recorded shots, unused for all other shot types.

  • showProperties (bool) - True to show the shot's properties after creation.

  • imageName (unicode) - The name of the image to use, or an empty string if one is to be generated.

  • hotkeyTrigger (object) - Hotkey trigger associated with shot. May also be None.

  • viewMode (bool) - True if the shot is created in viewing mode.

  • position (int) - The position of the shot in the Shots UI.

• SHOT_DELETE - Deletes the named shot. This message is undoable and broadcastable.

  Parameters:

  • name (unicode) - The name of the shot to delete.

• SHOT_EDIT - Opens the Shot Properties dialog for the named shot. This message is undoable.

  Parameters:

  • name (unicode) - The name of the shot to edit.

• SHOT_MOVE_TO_KEYFRAME - Moves the current view to the keyframe of the named shot.

  Parameters:

  • name (unicode) - The name of the shot.

• SHOT_PAUSE_PLAYBACK - Pauses playback of queued shots.

• SHOT_PLAY - Begins playback of a series of named shots.

  Parameters:

  • shotNames (tuple) - A tuple of shot names.

  • restoreState (bool) - True to restore the camera state after playing the shot.

• SHOT_PLAY_ALL - Begins playback of all the shots in the scene.

  Parameters:

  • restoreState (bool) - True to restore the camera state after playing the shots.

• SHOT_PLAY_BYLABEL - Allows a SHOT_PLAY message to be issued by specifying labels instead of names. Since labels need not be unique, and since wildcards are allowed, more than one shot may match each label.

  Parameters:

  • labels (tuple) - A tuple of shot labels.

  • restoreState (bool) - True to restore the camera state after playing the shot.

• SHOT_PLAY_SINGLE - Begins playback of a single named shot. This message will trigger the following response messages: SHOT_PLAYING_DONE. This default maximum wait time for this message is 10.

  Parameters:

  • name (unicode) - The name of the shot to play.

  • restoreState (bool) - True to restore the camera state after playing the shot.

• SHOT_PLAY_SINGLE_BYLABEL - Allows a SHOT_PLAY_SINGLE message to be issued by specifying a label instead of a name. Since labels need not be unique, and since wildcards are allowed, more than one shot may match; in that case only one SHOT_PLAY_SINGLE message will be issued. If you want to play several shots, see SHOT_PLAY.

  Parameters:

  • label (unicode) - Shot label.

  • restoreState (bool) - True to restore the camera state after playing the shot.

• SHOT_POSITION_AFTER - Places the named shot after prevShotName in the shot list.

  Parameters:

  • name (unicode) - The name of the shot to be moved.

  • prevShotName (unicode) - The shot to place it after. If this is an empty string the shot is placed at the front of list.

• SHOT_REFRESH_THUMBNAIL - Resnaps and saves the thumbnail image at the original snap location.

  Parameters:

  • name (unicode) - The name of the shot that will have its thumbnail refreshed.

• SHOT_RENAME - Changes the label of an existing shot. This message is undoable and broadcastable.

  Parameters:

  • name (unicode) - The name of the shot.

  • newLabel (unicode) - The new label for the shot.

• SHOT_REQUEST_LIST - Requests that a new SHOT_LIST message be issued.

• SHOT_REQUEST_LOOP_MODE - Requests a SHOT_LOOP_MODE notification message.

• SHOT_RESUME_PLAYBACK - Resumes playback of queued shots after pause.

• SHOT_SAVE_THUMBNAIL - Saves a thumbnail image of a Shot-parameter pair.

  Parameters:

  • shotName (unicode) - The name of the shot.

  • parameterName (unicode) - The name of the Shot parameter: 'Keyframe' or 'Keyframe2'. 'Keyframe' captures the thumbnail at the start of the shot, 'Keyframe2' captures it at the end of the shot.

• SHOT_SET_LOOP_MODE - Sets the loop mode. This message is broadcastable.

  Parameters:

  • isLoop (bool) - True to enable looping, False to disable.

• SHOT_SET_PARAMETERS - Modifies the parameters of the named shot. This message is undoable and broadcastable.

  Parameters:

  • name (unicode) - The name of the shot to modify.

  • params (dict) - A dictionary of parameter name/value pairs. (See "Shot" in the Showcase API Reference documentation.)

  • createThumbnail (bool) - True if a thumbnail should be created.

• SHOT_SHOW_STAGESHOTS - Shows shots based on the specified stage (compare scene view) ID. If the stage ID is empty, all shots in scene will be shown.

  Parameters:

  • id (unicode) - The ID of the stage. (To get the stage ID, create a custom script that listens to the STAGE_REQUEST_ACTIVE_LIST message.)

• SHOT_START_PLAYING - Initiates the playback of the queued list of shots to play.

• SHOT_START_TRANSITION - Initiates a cinematic transition of the specified type for the specified duartion. This message is broadcastable.

  Parameters:

  • type (unicode) - The kind of cinematic transition (for example, 'Fade from Black into shot'). (See "Shot" in the Showcase API Reference documentation.)

  • duration (float) - The duration of the cinematic transition in seconds.

• SHOT_STOP_PLAYING - Stops the playback of shots. No effect if no shots playing.

• SHOT_UI_SET_MODE - Shows or hides the Shot user interface.

  Parameters:

  • visible (bool) - True to show the Shot user interface, False to hide it.

• SHOT_UPDATE_DIALOG_DATA - Updates the Shot Properties dialog with data from the named shot.

  Parameters:

  • name (unicode) - The name of the shot.

Information Messages

• SHOT_LIST - Lists all shots in the scene.

  Parameters:

  • shotList (list) - List of shots in the scene.

• SHOT_LOOP_MODE - Indicates that the loop mode has changed.

  Parameters:

  • isLoop (bool) - True if looping is enabled, False otherwise.

• SHOT_PARAMETERS_CHANGED - Indicates that a shot's parameters have changed.

  Parameters:

  • name (unicode) - The name of the shot that changed.

  • params (dict) - A dictionary of parameter name/value pairs. (See "Shot" in the Showcase API Reference documentation.)

• SHOT_PLAYBACK_PAUSED - Indicates that playback of queued shots has been paused.

• SHOT_PLAYBACK_RESUMED - Indicates that playback of queued shots has been resumed after pause.

• SHOT_PLAYING_DONE - Indicates that shot playing has finished.

• SHOT_RENAMED - Indicates that the label of a shot was changed.

  Parameters:

  • name (unicode) - The name of the shot.

  • newLabel (unicode) - The new label for the shot.

• SHOT_STARTED - Indicates that the named shot has started to play.

  Parameters:

  • name (unicode) - The name of the shot that has started to play.

• SHOT_THUMBNAIL_SAVED - Indicates that a SHOT_SAVE_THUMBNAIL action message has finished saving a Shot thumbnail.

  Parameters:

  • shotName (unicode) - The name of the shot.

  • parameterName (unicode) - The name of the Shot parameter. 'Keyframe' or 'Keyframe2'. 'Keyframe' captures the thumbnail at the start of the shot, 'Keyframe2' captures it at the end of the shot.

• SHOT_TRANSITION_DONE - Indicates that a cinematic transition has completed.

• SHOT_TYPE_CHANGED - Indicates that the shot has changed type.

  Parameters:

  • name (unicode) - The name of the shot that changed type.

Response Messages

• SHOT_CREATED - Indicates that a named shot of the specified type has been created.

  Parameters:

  • type (unicode) - The type of shot that was created: ShotStill, ShotParametric, ShotKeyframed, or ShotRecorded.

  • name (unicode) - The name of the new shot.

  • label (unicode) - The label of the new shot.

  • hotkeyTrigger (object) - Hotkey trigger assigned to the shot.

  • hotkeyAssigned (bool) - True if the hotkey trigger was successfully assigned to the shot.

• SHOT_DELETED - Indicates that a shot was deleted.

  Parameters:

  • name (unicode) - The name of the shot that was deleted.