Storyboard Messages

Action Messages

  • COMPARISON_UI_SET_MODE - Shows or hides the Comparison interface.

    Parameters:

    • visible (int) - 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 (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.

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

    • slides (tuple) - The list of slide names to save.

    • 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

  • SLIDE_CREATE - Creates an empty slide. This message is undoable and broadcastable. This message will trigger the following response messages: SLIDE_CREATED. This default maximum wait time for this message is 10.

    Parameters:

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

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

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

  • SLIDE_DELETE - Deletes slides. This message is undoable and broadcastable. This message will trigger the following response messages: SLIDE_DELETED. This default maximum wait time for this message is 10.

    Parameters:

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

  • SLIDE_DUPLICATE - Duplicates slides. This message is undoable and broadcastable. This message will trigger the following response messages: SLIDE_DUPLICATED. This default maximum wait time for this message is 10.

    Parameters:

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

  • SLIDE_DURATION_CHANGE - Renames a slide. This message is undoable and broadcastable.

    Parameters:

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

    • newSlideDuration (unicode) - The new durtaion of the slide.

  • SLIDE_ITEM_ADD - Adds an item to a slide. This message is undoable and broadcastable. This message will trigger the following response messages: SLIDE_ITEM_ADDED. This default maximum wait time for this message is 10.

    Parameters:

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

    • slideId (unicode) - The identifier of the slide to change.

    • type (unicode) - The type of the item.

    • values (tuple) - The ID or IDs representing the item.

  • SLIDE_ITEM_POSITION_CHANGE - Changes the position of a slide item. This message is undoable and broadcastable. This message will trigger the following response messages: SLIDE_ITEM_POSITION_CHANGED. This default maximum wait time for this message is 10.

    Parameters:

    • slideId (unicode) - The slide identifier.

    • type (unicode) - The type of the item.

    • values (tuple) - The values of the item.

    • position (int) - A 0-based integer identifying the slide item's new position (left to right, top to bottom, starting from the top left).

  • SLIDE_ITEM_REMOVE - Removes an item from a slide. This message is undoable and broadcastable. This message will trigger the following response messages: SLIDE_ITEM_REMOVED. This default maximum wait time for this message is 10.

    Parameters:

    • slideId (unicode) - The identifier of the slide to change.

    • type (unicode) - The type of the item.

    • values (tuple) - The values of the item.

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

    Parameters:

    • slideIds (tuple) - 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 (tuple) - Slide labels.

  • 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_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_STOP - Stops playing slides.

  • SLIDE_POSITION_CHANGE - Changes the position of a slide. This message is undoable and broadcastable. This message will trigger the following response messages: SLIDE_POSITION_CHANGED. This default maximum wait time for this message is 10.

    Parameters:

    • slideId (unicode) - The slide identifier.

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

  • SLIDE_RENAME - Renames a slide. This message is undoable and broadcastable. This message will trigger the following response messages: SLIDE_RENAMED. This default maximum wait time for this message is 10.

    Parameters:

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

    • newSlideName (unicode) - The new name of the slide.

  • SLIDE_THUMBNAIL_SAVE - Saves a thumbnail image for a slide. This message will trigger the following response messages: SLIDE_THUMBNAIL_SAVED. This default maximum wait time for this message is 10.

    Parameters:

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

  • SLIDE_THUMBNAIL_SET - Sets a thumbnail image for a slide.

    Parameters:

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

    • thumbnail (unicode) - The thumbnail file.

  • STORYBOARD_LOOP - Change the storyboard loop setting. This message is undoable and broadcastable.

    Parameters:

    • loop (bool) - True if you want to loop.

  • STORYBOARD_UI_SET_MODE - Shows or hides the Storyboard interface.

    Parameters:

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

Information Messages

  • SLIDE_CREATED - Indicates that a slide was created.

    Parameters:

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

    • slideId (unicode) - The identifier of the new slide.

  • SLIDE_DELETED - Indicates that slides were deleted.

    Parameters:

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

  • SLIDE_DURATION_CHANGED - Indicates that a slide was renamed.

    Parameters:

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

    • newSlideDuration (unicode) - The new durtaion of the slide.

  • SLIDE_ITEM_CHANGE - Changes a slide item's values (but not the type). This message is undoable and broadcastable.

    Parameters:

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

    • type (unicode) - The type of the item.

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

    • newValues (tuple) - 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 (unicode) - The identifier of the slide that was changed.

    • type (unicode) - The type of the item.

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

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

  • SLIDE_PLAY_ENDED - Indicates that a slide has ended playing.

    Parameters:

    • slideId (unicode) - Identifier of the slide that ended playing.

  • SLIDE_PLAY_PAUSED - Indicates that playing slides has been paused.

  • SLIDE_PLAY_RESUMED - Indicates that playing slides has been resumed.

  • SLIDE_PLAY_STARTED - Indicates that a slide has started playing.

    Parameters:

    • slideId (unicode) - Identifier of the slide that started playing.

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

    Parameters:

    • loop (bool) - True if you want to loop.

Response Messages

  • SLIDE_DUPLICATED - Indicates that slides were duplicated.

    Parameters:

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

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

    Parameters:

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

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

    • type (unicode) - The type of the item.

    • values (tuple) - The ID or IDs representing the item.

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

    Parameters:

    • slideId (unicode) - The slide identifier.

    • type (unicode) - The type of the item.

    • values (tuple) - The values of the item.

    • newPosition (int) - A 0-based integer identifying the slide item's new position.

    • oldPosition (int) - A 0-based integer identifying the slide item's old position.

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

    Parameters:

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

    • type (unicode) - The type of the item.

    • values (tuple) - The values of the item.

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

    Parameters:

    • slideId (unicode) - The slide identifier.

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

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

  • SLIDE_RENAMED - Indicates that a slide was renamed.

    Parameters:

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

    • newSlideName (unicode) - The new name of the slide.

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

    Parameters:

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

Generated on Fri Mar 11 2011 19:56:11 by doxygen 1.7.3
Please send us your comment about this page