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.QWidget
Bases: PySide.QtGui.QWidget
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.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 overlay mode of the player.
@return: Player.GuideOverlay object
self.ignorePixelAspectRatio() -> returns whether the player ignores the pixel aspect ratio or not.
@return: True or False
self.maskOverlay() -> returns the current aspect ratio of the mask overlay used by the player.
@return: float
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.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(guideOverlay) -> sets the guide overlay mode in the player.
@param guideOverlay: Player.GuideOverlay object
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 aspect ratio of the mask overlay.
@param aspect: float
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: Shiboken.Object
Bases: Shiboken.Object
Bases: Shiboken.Object
Object representing the Timeline Editor.
Deprecated; please use the selection method instead.
@return: tuple of TrackItem and Transition objects
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: 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.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.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.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.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.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.
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
hiero.ui.activeView() -> gets the currently active view object.
@return: depending on the active view, a hiero.ui.TimelineEditor, 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
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
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.activeView() -> gets the currently active view object.
@return: depending on the active view, a hiero.ui.TimelineEditor, a hiero.ui.Viewer object or a hiero.ui.BinView object
hiero.ui.getMainWindow() -> deprecated; please use hiero.ui.mainWindow() instead.
hiero.core.getPluginPath() -> deprecated; please use hiero.core.pluginPath instead.
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
hiero.core.pluginPath() -> Returns a tuple of the search paths used by Hiero to load Python scripts.
@return: tuple of strings
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.
unregisterBinViewCustomMimeDataType(customMimeType) -> unregisters a custom mime type that was previously registered using registerBinViewCustomMimeDataType().
windowManager() -> returns the single WindowManager object.
@return: WindowManager
Python Dev Guide »