Navigation
- index
- modules |
- next |
- previous |
-
Python Dev Guide »
- API Reference »
Python Dev Guide »
Bases: Shiboken.Object
Object representing the Bin View. Passed as the sender object to the event handler callbacks registered for hiero.core.events.EventType.kShowContextMenu type events. Can also be retrieved using currentContextMenuView when active during the context menu events.
Bases: Shiboken.Object
Object to manage codec specific settings. Currently only supports quicktime settings, and only on Mac and Windows.
self.codecList() -> returns a list of available QuickTime codecs.
@return tuple of strings
self.getQuickTimeCodec(settings) -> deprecated; please use CodecSettings.quickTimeCodec instead.
@return string
self.getQuickTimeSettingsAsString(settings) -> deprecated; please use CodecSettings.quickTimeSettingsAsString instead.
@return string
self.quickTimeCodec() -> returns the human readable codec name encoded in the settings string, which will have been set with a call to showQuickTimeSettingsDialog previously.
@return string
self.quickTimeFrameRate() -> returns the frame rate setting, which will have been set with a call to showQuickTimeSettingsDialog previously.
@return float
self.quickTimeKeyFrameRate() -> returns the rate at which to encode key frames, which will have been set with a call to showQuickTimeSettingsDialog previously.
@return int
self.quickTimeQuality() -> returns the quality setting, which will have been set with a call to showQuickTimeSettingsDialog previously.
@return int
self.quickTimeSettingsAsString(settings) -> converts a QuickTime format settings string (as returned from self.showQuickTimeSettingsDialog()) into a human readable string.
@param settings: string of QuickTime encoded settings, as returned at some point in the past from CodecSettings.showQuickTimeSettingsDialog
@return human readable settings string
self.showQuickTimeSettingsDialog() -> brings up the QuickTime settings dialog box, on Mac and Windows only. Returns a string representing the settings, in a QuickTime specific (non-human-readable) format.
self.showQuickTimeSettingsDialog(settings, fps) -> same as the above, but takes in a QuickTime formatted settings string and an fps to set for the initial values in the dialog.
self.showQuickTimeSettingsDialog(settings, fps, quality, keyframerate, codec) -> same as the above, but with more parameters.
To see the return value in a human readable form, pass it to self.quickTimeSettingsAsString(settings). You can also retrieve other values set from this method, with quickTimeCodec, quickTimeKeyFrameRate and quickTimeQuality
@param settings: a settings string previously returned from this method, or a 0-length string ()
@param fps: frame rate to default the dialog to
@param quality: integer value indicating quality slider setting
@param keyframerate: integer value indicating when to generate key-frames
@param codec: string name of the codec to preselect
@return string
Bases: PySide.QtGui.QCheckBox
Bases: PySide.QtGui.QWidget
Bases: Shiboken.Object
IExporterUIRegistry provides a simple interface for our C++ Application to access the Python instance of TaskUIRegistry.
This class should not be used directly; use hiero.ui.TaskUIRegistry instead.
self.aquireProcessorUI() -> Called from Hiero Application to aquire a reference to an instance of the ProcessorUI object related to the specified hiero.core.TaskPreset.
@param preset : ITaskPreset
self.registerme() -> Called from python implimentation of TaskUIRegistry to register instance as the Application TaskUI Registry.
self.releaseProcessorUI() -> Called from Hiero Application to release the reference to a IProcessorUI object previously aquired using IExporterUIRegistry.aquireProcessorUI.
@param processorUI : IProcessorUI
Bases: Shiboken.Object
IProcessorUI provides a simple interface for our C++ Application to access Python instances of ProcessorUIBase.
This class should not be used directly; use hiero.ui.ProcessorUIBase instead.
self.displayName() -> called by Hiero to get the Display name of a task for displaying in UI.
@return: string
self.populateUI() -> called by Hiero to allow the IProcessorUI to populate a QWidget with the ui widgets neccessary to reflect the current preset.
The EditMode is used to instruct the UI generation code to build in ReadOnly mode
@param widget: PySide.QtGui.QWidget@param items: [hiero.core.ItemWrapper]@param editMode: IProcessorUI.EditMode
self.preset() -> called by Hiero to get the TaskPreset which this TaskUI is currently reflecting.
@return: ITaskPreset
self.setPreset() -> called by Hiero to set the TaskPreset which this TaskUI will reflect.
@param preset: ITaskPreset
self.toolTip() -> called by Hiero to get the desciption of a task for displaying in UI as a tooltip.
@return: string
self.validate() -> called by Hiero to get .
@param: [hiero.core.ItemWrapper,]@return: bool
Bases: Shiboken.Object
ITaskUI provides a simple interface for our C++ Application to access Python instances of TaskUIBase.
This class should not be used directly; use hiero.ui.TaskUIBase instead.
self.displayName() -> called by Hiero to get the Display name of a task for displaying in UI.
@return: string
self.ident() -> called by Hiero to get a unique identifier linking this TaskUI with a Task and TaskPreset.
@return: string
self.populateUI() -> called by Hiero to allow the TaskUI to populate a QWidget with the ui widgets neccessary to reflect the current preset.
@param widget: PySide.QtGui.QWidget@param exportTemplate: IExportStructure
self.preset() -> called by Hiero to get the TaskPreset which this TaskUI is currently reflecting.
@return: ITaskPreset
self.setPreset() -> called by Hiero to set the TaskPreset which this TaskUI will reflect.
@param preset: ITaskPreset
Bases: PySide.QtGui.QWidget
Bases: object
Bases: Shiboken.Object
Object representing a video player in Hiero. Players are used by Viewer objects, and can be retrieved using the player() method of Viewer objects.
self.LUT() -> returns the name of the LUT currently in use by the player.
@return: string
self.alphaIsTransparent() -> returns whether the player treats the alpha channel as premultiplied transparency (True) or not (False).
@return: True or False
self.centerImage() -> centers the player, resetting the pan values.
self.channels() -> returns channel(s) that the player is currently displaying.
@return: Player.Channels object
self.displayGain() -> returns the current gain of the player. Defaults to 1.0
@return: float
self.displayGamma() -> returns the current gamma of the player. Since the viewer displays pixels in linear space, this value defaults to 1.0.
@return: float
self.getSequence() -> deprecated; use self.sequence() instead.
@return Clip object or Sequence object, depending on what is currently playing
self.guideOverlay() -> returns the guide overlays displayed in the player.
@return: sequence of foundry.ui.Drawing
self.ignorePixelAspectRatio() -> returns whether the player ignores the pixel aspect ratio or not.
@return: True or False
self.maskOverlay() -> returns the drawing used as the mask overlay in the player.
@return: foundry.ui.Drawing
self.maskOverlayStyle() -> returns the current drawing style of the mask overlay used by the player.
@return: Player.MaskOverlayStyle
self.pan(dx, dy) -> pans the player by (dx, dy).
@param dx: float value to pan in x by
@param dy: float value to pan in y by
self.proxyResolution() -> get the current proxy resolution setting for the player
@return Player.ProxyResolution
self.sequence() -> returns the object currently being played.
@return Clip object or Sequence object, depending on what is currently playing
self.setAlphaIsTransparent( alphaIsTransparent ) -> sets whether the player treats the alpha channel as premultiplied transparency.
@param alphaIsTransparent: True to have the player treat alpha as premultiplied transparency, False otherwise
self.setChannels(channels) -> sets the channels to display in the player. It’s currently either one of the channels or red, green and blue.
@param channels: Player.Channels object
self.setDisplayGain(gain) -> sets the gain of the player.
@param gain: float
self.setDisplayGamma(gamma) -> sets the gamma of the player.
@param gamma: float
self.setGuideOverlay(guideOverlays) -> sets the guide overlays to display in the player.
@param guideOverlays: sequence of foundry.ui.Drawing
self.setIgnorePixelAspectRatio(ignorePixelAspectRatio) -> tells the player whether or not to display in anamorphic mode.
@param ignorePixelAspectRatio: True to have the player ignore the pixel aspect ratio, False otherwise
self.setLUT(lut) -> sets the LUT to use in the player. If the lut doesn’t exist, it will have no effect on what’s displayed by the player.
@param lut: string name of the lut to use
self.setMaskOverlay(aspect) -> sets the drawing to use for the mask overlay.
@param aspect: foundry.ui.Drawing
self.setMaskOverlayStyle(style) -> sets the drawing style of the mask overlay.
@param Player.MaskOverlayStyle style
self.setProxyResolution(resolution) -> set the player proxy resolution.
@param resolution: Player.ProxyResolution
self.setSequence(clip) -> sets the clip to be played back by the Player object.
self.setSequence(sequence) -> sets the sequence to be played back by the Player object.
@param clip: Clip object to play
@param sequence: Sequence object to play
self.setWarningOverlay(warningOverlay) -> sets the warning overlay.
@param warningOverlay: One of the following enums: eWarningNone, eWarningExposure, eWarningPAL or eWarningNTSC
self.time() -> gets the time of the playhead.
@return: frame number
self.warningOverlay() -> returns player’s warningOverlay.
@return: One of the following enums: eWarningNone, eWarningExposure, eWarningPAL or eWarningNTSC
self.zoomAbsolute(centerX, centerY, zoom) -> scales the image to an absolute value. The centerX and centerY values are currently ignored.
self.zoomAbsolute(zoom) -> scales the image to an absolute value
@param zoom: float value scale by
@param centerX: unused
@param centerY: unused
self.zoomRelative(centerX, centerY, zoomFactor) -> scales the image relatively and repositions the image.
@param centerX: new x center of the image, in image pixels
@param centerY: new y center of the image, in image pixels
@param zoom: float value scale by
self.zoomToActualSize() -> scales and centers the image to the full size of the image.
self.zoomToFill() -> scales the image so that it fills the player window.
self.zoomToFit() -> scales the image so that it fits in the player window, maintaining the pixel aspect ratio.
self.zoomToFitHeight() -> scales the image so that the height of the image fits in the player window, maintaining the pixel aspect ratio.
self.zoomToFitWidth() -> scales the image so that the width of the image fits in the player window, maintaining the pixel aspect ratio.
self.zoomToActualSize() -> scales and centers the image to half the size of the image.
Bases: ui.Hiero.Python.IProcessorUI
ProcessorUIBase is the base class from which all Processor UI components must derive. Defines the UI structure followed by the specialised processor UIs.
Check for unrendered comps selected for export and ask the user what to do.
Create the UI for processor-specific settings. To be reimplemented by subclasses.
Create a widget for selecting the version number for export.
Search for comp clips and track items in a list of ItemWrappers.
Find tags for the export items.
Check if there are transcode tasks in this export.
Callback when the tab selection changes.
Callback when the export structure is modified by the user.
Callback when the selection in the export structure viewer changes.
Callback when the export structure viewer is destroyed. Qt will delete it while we still have a reference, so reset to None when the destroyed() signal is emitted.
Callback when the version index changes.
Callback when the version padding changes.
Build the processor UI and add it to widget.
Get the export preset.
Get the label which is put on the tab for processor-specific settings. To be reimplemented by subclasses.
Save the export template to the preset.
Set the export preset.
Get the UI for a task preset and add it in the ‘Content’ tab.
Validate settings in UI. Return False for failure in order to abort export.
Bases: hiero.ui.FnExporterBaseUI.TaskUIBase
RenderTaskUIBase is a specialization of TaskUIBase which reflects the codec properties in RenderTaskPreset into UI
Populate layout with widgets reflected from the RenderPresetBase class
Bases: Shiboken.Object
self.beginSelectionUpdate() -> Call beginSelectionUpdate before, and endSelectionUpdate after, making multiple setSelection.
self.endSelectionUpdate() -> Call beginSelectionUpdate before, and endSelectionUpdate after, making multiple setSelection.
self.selectAll( )
Select All TrackItems within current sequence.
self.selectNone( )
Unselect all TrackItems.
Bases: ui.Hiero.Python.ITaskUI, PySide.QtCore.QObject
TaskUIBase is the base class from hich all TaskUI components should derrive
Exporter name to be displayed in the UI
When Parent ExportStructure is opened in the ui, initialise is called for each preset. Register any callbacks here
populateUI() Export dialog to allow the TaskUI to populate a QWidget with the ui widgets neccessary to reflect the current preset.
Return Preset currently assigned to ExporterUI
Assign Preset to ExporterUI
setTags passes the subset of tags associated with the selection for export
Bases: ui.Hiero.Python.IExporterUIRegistry
Return ProcessorUI registered at specified index
Return ProcessorUI object associated with preset type
Register TaskUI and associate with TaskPreset object
Return TaskUI registered at specified index
Return TaskUI object associated with preset type
Bases: Shiboken.Object
Object representing the Timeline Editor.
self.beginSelectionUpdate() -> Call beginSelectionUpdate before, and endSelectionUpdate after, making multiple setSelection.
self.endSelectionUpdate() -> Call beginSelectionUpdate before, and endSelectionUpdate after, making multiple setSelection.
Deprecated; please use the selection method instead.
@return: tuple of TrackItem and Transition objects
self.selectAll( )
Select All TrackItems within current sequence.
self.selectNone( )
Unselect all TrackItems and Tracks.
self.selection() -> returns a tuple with the currently selected items.
@return: tuple of TrackItem and Transition objects
self.sequence() -> returns the Sequence currently being edited in the timeline editor.
@return: Sequence object
Bases: PySide.QtGui.QWidget
A QSpinBox with buttons to increase/decrease padding of the value
Bases: Shiboken.Object
Object for manipulating viewers in Hiero. Get the currently active viewer by calling currentViewer().
self.cachedFrames() -> get the frames which are currently cached in the viewer.
@return: set containing the indices of the cached frames
self.compareMode() -> returns the compare mode for the viewer. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
@return: a Viewer.CompareMode object
self.enterFullScreen() -> puts the viewer into full screen mode. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
self.exitFullScreen() -> takes the viewer out of full screen mode. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
self.flushCache() -> flush the cache on the viewer and pause caching.
self.frameIncrement() -> returns the frame increment for the viewer. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
@return: the number of frames to skip or nudge
self.getAchievedFPS() -> returns the average fps achieved by the viewer.
@return: floating point frames per second average
self.image() -> returns the contents of the viewer as an image, including all overlays. Can only be called from the user interface thread.
@return: a PySide.QtGui.QImage object
self.isCachingPaused() -> get whether caching is paused.
@return: bool
self.layoutMode() -> returns the layout mode the viewer is currently in.
@return: a Viewer.LayoutMode object
self.overlaysShown() -> get whether overlays are shown in the viewer.
@return: bool
self.pauseCaching() -> pause caching on the viewer.
self.play() -> starts playback in the viewer in the forward direction. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
self.playBackwards() -> starts playback in the viewer in the backwards direction. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
self.playForwards() -> starts playback in the viewer in the forward direction. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
self.player(index) -> returns the player object attached to this viewer, based on the input index.
@param index: integer index of the player to retrieve
@return: Player object
self.resumeCaching() -> resume caching on the viewer.
self.setCompareMode(mode) -> changes the compare mode for the viewer. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
@param compareMode: a Viewer.CompareMode value
self.setDisplayTimecode(displayTimecode) -> Sets the viewer to display Timecode if ‘displayTimecode’ is True, or Timeline Frame otherwise
@return: None
self.setFrameIncrement(frames) -> changes the frame increment for the viewer. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
@param frames: the number of frames to skip or nudge
self.setLayoutMode(mode) -> changes the layout mode for the viewer. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
@param layoutMode: a Viewer.LayoutMode value indicating what layout to set the viewer to
self.setOverlaysShown(show) -> set whether overlays are shown in the viewer.
@param show: bool
self.setTime(time) -> seeks the play head of the viewer to the time parameter. Works the same as scrubbing the timeline in the viewer. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
@param time: frame to set the play head to
self.stop() -> stops playback in the viewer. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
self.time() -> returns the current frame of the viewer.
self.toggleFullScreen() -> toggles full screen mode for the viewer. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
self.toggleFullScreen1_1() -> toggles 1:1 full screen mode for the viewer. Can only be called from the user interface thread. Use hiero.core.executeInMainThread if you need to call it from a non-ui thread.
self.window() -> Return the viewer window
self.wipeTool() -> return the split wipe tool for this viewer.
@return: ViewerWipeTool object
Bases: Shiboken.Object
Object for manipulating the viewer wipe tool in Hiero.
self.isActive() -> returns True if the tool is active.
@param index: integer index of the player to retrieve
@return: bool
self.setActive(active) -> Make the tool active or inactive.
@param active: the active state
@return: None
Bases: Shiboken.Object
Global object to handle window management in Hiero. Use windowManager() to get the single instance of this object to use.
self.addWindow(window, section, shortcut) -> adds a window to the window manager and insert a menu item for it into the Window menu. This will also make the window dockable with Hiero’s other windows.
@param window: QWidget object for the window
@param section: section (either an int, or a WindowManager.WindowMenuSection) to insert the menu item into
@param shortcut: shortcut to apply to the menu item. See the documentation on QKeySequence for more info
self.popupWindow(window) -> Opens the window in a floating dock panel.
@param window: QWidget object for the window
self.showWindow(window) -> Opens the window in its layout position or if as a floating dock panel
@param window: QWidget object for the window
self.windows() -> Returns a list with the available widgets in WindowManager
@return: list of the available widgets in WindowManager
hiero.ui.activeSequence() -> gets the currently active sequence.
@return: a hiero.core.Sequence of the last activated hiero.ui.TimelineEditor, hiero.ui.SpreadsheetView object or hiero.ui.Viewer object
hiero.ui.activeView() -> gets the currently active view object.
@return: depending on the active view, a hiero.ui.TimelineEditor, a hiero.ui.SpreadsheetView object, a hiero.ui.Viewer object or a hiero.ui.BinView object
Add a QAction to the main menubar. The ‘path’ parameter specifies the menu to which to add the action as a ‘/’-separated string. The path may contain either internal action names or display names. e.g. ‘View/Transform’, or (better) ‘foundry.menu.view/foundry.view.transform’.” The optional ‘before’ parameter specifies the name of an item the action should be inserted before. If this is not specified, the action is appended to the menu.
browseForApplication (message, initialPath, parentWidget) -> brings up the file browser to allow the user to select an application. Allows the user to select an executable file on Windows and Linux, and to select an application bundle (*.app) directory on OSX.
@param message: prompt to display to the user in the file browser
@param initialPath: initial path to set the file browser to. Can be a zero length string
@param parentWidget: QWidget to set as the parent of the file browser. Can be None.
@return: string
Creates a menu action (QAction) for use in context menus or Main menubar. The ‘name’ parameter specifies the title of the action. @param: name - the title of the menu action @param: method - the Python method which this action triggers @param: icon (optional) - provides an icon for the action. This can be an absolute path (‘/var/tmp/myIcon.png’), or relative path (‘icons:myIcon.png’)
currentContextMenuView() -> returns the current view for the context menu. Only valid during a kShowContextMenu event callback.
@return: Viewer, TimelineEditor, BinView, depending on which window had the context menu created for it
currentViewer() -> returns the current viewer window.
@return: Viewer
hiero.ui.currentWorkspace() -> Returns the name of the current Workspace.
@return: name of current Workspace as a string
Find a QAction in the main menubar. The ‘name’ parameter specifies the name of the action. The name may be either an internal action name or a display name. e.g. ‘Cut’, or (better) ‘foundry.application.cut’.”
hiero.ui.findRegisteredAction(name) -> Find the action with the given name.
@return: a QAction, or None if not found.
hiero.ui.findRegisteredActions(pattern) -> Find the action that starts with the given pattern.
@return: a QAction list or None on an error.
self.flushAllViewersCache() -> flush the cache of all viewers and pause caching
Try to get a valid root path from the project. If the existing projectRoot() is not set or is unwritable, the user will be prompted to select one. If no path is selected, returns None.
hiero.ui.getTimelineEditor(sequence) -> Find the TimelineEditor for the given Sequence.
@return: a hiero.ui.TimelineEditor, or None if no appropriate TimelineEditor is found.
Insert a QAction into the given QMenu. If strings ‘before’ or ‘after’ are specified, the action is inserted before or after the action with that name. If no such action is found or ‘before/after’ are not given, the action is appended to the menu.
hiero.ui.mainWindow() -> used to get Hiero’s main window object.
@return: a PySide.QtGui.QMainWindow object
hiero.ui.menuBar() -> used to get Hiero’s global menu bar.
@return: a PySide.QtGui.QMenuBar object
openInNewViewer( binItem ) -> Opens a BinItem’s activeItem (Clip/Sequence) in a new Viewer.
@param binItem: BinItem to be opened in a new Viewer
@return: Viewer object
openInSpreadsheet( sequence ) -> Opens a Sequence in a Spreadsheet.
@param sequence: Sequence to be opened in Spreadsheet
openInTimeline( ) <openInTimeline, None>` -> Opens a BinItem’s activeItem (Clip/Sequence) in a Timeline View.
@return: TimelineEditor object
openInTimeline( -> Opens a list of BinItems’ activeItems (Clips/Sequences) in a Timeline View.
@return: tuple of TimelineEditor objects
openInViewer( binItem ) -> Opens a BinItem’s activeItem (Clip/Sequence) in the Viewer.
@param binItem: BinItem to be opened in the current Viewer
@return: Viewer object
hiero.ui.registerAction(action) -> Register an action.
registerBinViewCustomMimeDataType(customMimeType) -> registers a custom mime type so that Hiero passes on drag and drop events through the event system. For an example of how to use this method, see the bin_drop.py example.
hiero.ui.registeredActions() -> Returns a list of all registered actions.
@return: a tuple of QActions
hiero.ui.resetCurrentWorkspace() -> Resets the current Workspace to its default state.
@return: None
hiero.ui.saveWorkspace(name) -> Save the current Workspace with name.
@return: None
Example: hiero.ui.saveWorkspace(‘NewWorkspaceName’)
sendToViewerA( binItem ) -> Sends a BinItem’s activeItem (Clip/Sequence) to the Viewer A.
@param binItem: BinItem to be opened in the current Viewer’s A Buffer
sendToViewerB( binItem ) -> Sends a BinItem’s activeItem (Clip/Sequence) to the Viewer B.
@param binItem: BinItem to be opened in the current Viewer’s B buffer
hiero.ui.setWorkspace(name) -> Sets the Workspace with name, as per the name in the Workspace menu.
@return: None
Example: hiero.ui.setWorkspace(‘Reviewing’)
unregisterBinViewCustomMimeDataType(customMimeType) -> unregisters a custom mime type that was previously registered using registerBinViewCustomMimeDataType().
windowManager() -> returns the single WindowManager object.
@return: WindowManager
Python Dev Guide »