Storyboard Messages

  • COMPARISON_UI_SET_MODE - Shows or hides the Comparison interface.

    Parameters:

    • visible - True to show the interface, False to hide it.

  • SAVE_SLIDE_AS_MOVIE_AT_RESOLUTION - Save a movie to the specified location from a specified storyboard slide.

    Parameters:

    • width - The width of the image.

    • height - The height of the image.

    • frames per second - The number of frames per second of the movie.

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

    • antialiasing - The anti-aliasing level. 0 - 9.

    • splitSlides - True if each slide is to be saved to a separate movei, False if all slides are to be saved to one movie.

    • filename - The name of the destination movie file.

    • slides - The list of slide names to save.

    • compression - 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 - The tuple of items to be set the raytracer, which is in the form (dummyValue, sampleQuality, presetTuple): "dummyValue" is a legacy dummy value. -1. "sampleQuality" defines the sample quality level. 0 - 100. 0 : 1 sample /primary ray 1 - 24: 4 samples/primary ray 25 - 49: 8 samples/primary ray 50 - 74: 16 samples/primary ray 75 - 99: 32 samples/primary ray 100 : 64 samples/primary ray "presetTuple" defines the overall quality preset, which is in the form (file, name, pos): "file" is the name of an XML file which defines a set of raytracing quality parameters. "name" is the name of the preset tag in the XML file. "pos" is the position of the preset_group tag in the XML file.

  • SLIDE_CREATE - Creates an empty slide.

    Parameters:

    • index - The index where the slide is to be inserted into the storyboard, -1 to append.

    • slideId - (Optional) The identifier of the slide to be created.

    • slideName - (Optional) The name of the slide to be created.

  • SLIDE_CREATED - Indicates that a slide was created.

    Parameters:

    • index - The index where the slide was inserted into the storyboard.

    • slideId - The identifier of the new slide.

  • SLIDE_DELETE - Deletes slides.

    Parameters:

    • slideIds - The identifiers of the slides to be deleted.

  • SLIDE_DELETED - Indicates that slides were deleted.

    Parameters:

    • slideIds - The identifiers of the slides that were deleted.

  • SLIDE_DELETE_BYLABEL - Deletes slides.

    Parameters:

    • slideIds - The identifiers of the slides to be deleted.

  • SLIDE_DUPLICATE - Duplicates slides.

    Parameters:

    • slideIds - The identifiers of the slides to be duplicated.

  • SLIDE_DUPLICATED - Indicates that slides were duplicated.

    Parameters:

    • slideIds - A tuple of 2-tuples, each containing an original slide ID and the duplicated slide ID.

  • SLIDE_DUPLICATE_BYLABEL - Duplicates slides.

    Parameters:

    • slideIds - The identifiers of the slides to be duplicated.

  • SLIDE_DURATION_CHANGE - Renames a slide.

    Parameters:

    • slideId - The identifier of the slide to change duration.

    • newSlideDuration - The new duration of the slide.

  • SLIDE_DURATION_CHANGED - Indicates that a slide was renamed.

    Parameters:

    • slideId - The identifier of the slide that had its duration changed.

    • newSlideDuration - The new duration of the slide.

  • SLIDE_ITEM_ADD - Adds an item to a slide.

    Parameters:

    • index - The index where the item is to be inserted into the slide, -1 to append.

    • slideId - The identifier of the slide to change.

    • type - The type of the item.

    • values - The ID or IDs representing the item.

  • SLIDE_ITEM_ADDED - Indicates that an item was added to a slide.

    Parameters:

    • index - The index where the item was inserted into the slide.

    • slideId - The identifier of the slide that was changed.

    • type - The type of the item.

    • values - The ID or IDs representing the item.

  • SLIDE_ITEM_ADD_BYLABEL - Adds an item to a slide.

    Parameters:

    • index - The index where the item is to be inserted into the slide, -1 to append.

    • slideId - The identifier of the slide to change.

    • type - The type of the item.

    • values - The ID or IDs representing the item.

  • SLIDE_ITEM_CHANGE - Changes a slide item's values (but not the type).

    Parameters:

    • slideId - The identifier of the slide that was changed.

    • type - The type of the item.

    • oldValues - The old ID or IDs representing the item.

    • newValues - The new ID or IDs representing the item.

  • SLIDE_ITEM_CHANGED - Indicates that a slide item's values (but not the type) have changed.

    Parameters:

    • slideId - The identifier of the slide that was changed.

    • type - The type of the item.

    • oldValues - The old ID or IDs representing the item.

    • newValues - The new ID or IDs representing the item.

  • SLIDE_ITEM_DURATION_CHANGE - Changes the duration of an item in a given slide.

    Parameters:

    • slideId - The identifier of the slide to change.

    • slideItemIds - The ids of slide items that will change their duration.

    • float - The new duration time.

  • SLIDE_ITEM_DURATION_CHANGED - Indicates that the duration time of an item in the given slide changed.

    Parameters:

    • slideId - The identifier of the slide that was changed.

    • slideItemIds - The identifier of the slide item.

    • float - The new duration.

  • SLIDE_ITEM_POSITION_CHANGE - Changes the position of a slide item.

    Parameters:

    • slideId - The slide identifier.

    • type - The type of the item.

    • values - The values of the item.

    • position - Slide item's requested position: 0 for top left, 1 for top right, 2 for bottom left, 3 for bottom right.

  • SLIDE_ITEM_POSITION_CHANGED - Indicates that the position of a slide item has changed.

    Parameters:

    • slideId - The slide identifier.

    • type - The type of the item.

    • values - The values of the item.

    • newPosition - Slide item's new position. See SLIDE_ITEM_POSITION_CHANGE.

    • oldPosition - Slide item's previous position. See SLIDE_ITEM_POSITION_CHANGE.

  • SLIDE_ITEM_POSITION_CHANGE_BYLABEL - Changes the position of a slide item.

    Parameters:

    • slideId - The slide identifier.

    • type - The type of the item.

    • values - The values of the item.

    • position - Slide item's requested position: 0 for top left, 1 for top right, 2 for bottom left, 3 for bottom right.

  • SLIDE_ITEM_REMOVE - Removes an item from a slide.

    Parameters:

    • slideId - The identifier of the slide to change.

    • type - The type of the item.

    • values - The values of the item.

  • SLIDE_ITEM_REMOVED - Indicates that an item was removed from a slide.

    Parameters:

    • slideId - The identifier of the slide that was changed.

    • type - The type of the item.

    • values - The values of the item.

  • SLIDE_ITEM_REMOVE_BYLABEL - Removes an item from a slide.

    Parameters:

    • slideId - The identifier of the slide to change.

    • type - The type of the item.

    • values - The values of the item.

  • SLIDE_ITEM_STARTTIME_CHANGE - Changes the start time of an item in a given slide. The new start time passed to this message is treated as a hint. If the item fits into that start time, it will be positioned there, otherwise, if it overlaps with another items, it will be positioned behind it or in front of it. Other items may change their positions as well so that no items overlap.

    Parameters:

    • slideId - The identifier of the slide to change.

    • slideItems - The tuple of tuples each having two members: (slideItemId, newStartTime).

  • SLIDE_ITEM_STARTTIME_CHANGED - Indicates that the start time of an item in a given slide changed.

    Parameters:

    • slideId - The identifier of the slide that was changed.

    • changedItems - The tuple of tuples each having a slide item id and a new start time for it.

  • SLIDE_ITEM_STARTTIME_EXACT_CHANGE - Changes the start time of an item in a given slide. The item will be positioned exactly at the time passed to this message. Other items in the same timeline may be pushed so that none of the items overlaps.

    Parameters:

    • slideId - The identifier of the slide to change.

    • slideItemIds - The tuple of tuples each having two members: (slideItemId, newStartTime)

  • SLIDE_PLAY - Plays slides. Plays the current slide if the argument list is empty. The last slide played becomes the current slide.

    Parameters:

    • slideIds - The slide identifiers to play.

  • SLIDE_PLAY_ALL - Plays all slides in the current stage.

  • SLIDE_PLAY_BYLABEL - Allows a SLIDE_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 slide may match each label.

    Parameters:

    • labels - Slide labels.

  • SLIDE_PLAY_ENDED - Indicates that a slide has ended playing.

    Parameters:

    • slideId - Identifier of the slide that ended playing.

  • SLIDE_PLAY_FIRST - Plays the first slide. The first slide becomes the current slide.

  • SLIDE_PLAY_LAST - Plays the last slide. The last slide becomes the current slide.

  • SLIDE_PLAY_NEXT - Plays the next slide. If the last slide is being played then the next slide becomes the first slide. The next slide also becomes the current slide.

  • SLIDE_PLAY_PAUSE - Pauses playing slides.

  • SLIDE_PLAY_PAUSED - Indicates that playing slides has been paused.

  • SLIDE_PLAY_PREVIOUS - Plays the previous slide. If the first slide is being played then the previous slide becomes the last slide. The previous slide also becomes the current slide.

  • SLIDE_PLAY_RESUME - Resumes playing paused slides.

  • SLIDE_PLAY_RESUMED - Indicates that playing slides has been resumed.

  • SLIDE_PLAY_STARTED - Indicates that a slide has started playing.

    Parameters:

    • slideId - Identifier of the slide that started playing.

  • SLIDE_PLAY_STOP - Stops playing slides.

  • SLIDE_POSITION_CHANGE - Changes the position of a slide.

    Parameters:

    • slideId - The slide identifier.

    • position - A 0-based integer identifying the slide's new position.

  • SLIDE_POSITION_CHANGED - Indicates that the position of a slide has changed.

    Parameters:

    • slideId - The slide identifier.

    • newPosition - A 0-based integer identifying the slide's new position.

    • oldPosition - A 0-based integer identifying the slide's old position.

  • SLIDE_POSITION_CHANGE_BYLABEL - Changes the position of a slide.

    Parameters:

    • slideId - The slide identifier.

    • position - A 0-based integer identifying the slide's new position.

  • SLIDE_RENAME - Renames a slide.

    Parameters:

    • slideId - The identifier of the slide to be renamed.

    • newSlideName - The new name of the slide.

  • SLIDE_RENAMED - Indicates that a slide was renamed.

    Parameters:

    • slideId - The identifier of the slide that was renamed.

    • newSlideName - The new name of the slide.

  • SLIDE_RENAME_BYLABEL - Renames a slide.

    Parameters:

    • slideId - The identifier of the slide to be renamed.

    • newSlideName - The new name of the slide.

  • SLIDE_THUMBNAIL_SAVE - Saves a thumbnail image for a slide.

    Parameters:

    • slideId - The identifier of the slide to save a thumbnail for.

  • SLIDE_THUMBNAIL_SAVED - Indicates that a thumbnail was saved for a slide.

    Parameters:

    • slideId - The identifier of the slide that had a thumbnail saved.

  • SLIDE_THUMBNAIL_SAVE_BYLABEL - Saves a thumbnail image for a slide.

    Parameters:

    • slideId - The identifier of the slide to save a thumbnail for.

  • SLIDE_THUMBNAIL_SET - Sets a thumbnail image for a slide.

    Parameters:

    • slideId - The identifier of the slide to set a thumbnail for.

    • thumbnail - The thumbnail file.

  • SLIDE_THUMBNAIL_SET_BYLABEL - Sets a thumbnail image for a slide.

    Parameters:

    • slideId - The identifier of the slide to set a thumbnail for.

    • thumbnail - The thumbnail file.

  • STORYBOARD_LOOP - Change the storyboard loop setting.

    Parameters:

    • loop - True if you want to loop.

  • STORYBOARD_LOOP_CHANGED - Indicates that the storyboard loop setting was changed.

    Parameters:

    • loop - True if you want to loop.

  • STORYBOARD_UI_SET_MODE - Shows or hides the Storyboard interface.

    Parameters:

    • visible - True to show the interface, False to hide it.

Generated on Tue Jul 10 2012 15:38:14 by doxygen 1.7.3
Please send us your comment about this page