Difference between revisions of "Session"

From Silhouette Wiki
Jump to navigation Jump to search
Line 9: Line 9:
  
 
Sessions can be created automatically from a [[Source]] using the <tt>tools.session.SessionBuilder</tt> class.
 
Sessions can be created automatically from a [[Source]] using the <tt>tools.session.SessionBuilder</tt> class.
 +
 +
Add the Session to a [[Project]] using <tt>project.addItem()</tt>.
  
 
=== Attributes ===
 
=== Attributes ===
Line 16: Line 18:
 
! scope="col" | Name
 
! scope="col" | Name
 
! scope="col" class="unsortable" | Description
 
! scope="col" class="unsortable" | Description
 +
| scope="col" | Added
 
|-
 
|-
 
|depth
 
|depth
Line 46: Line 49:
 
|workRange
 
|workRange
 
|the current work range as a Tuple of (start_frame, end_frame) (''read/write'')
 
|the current work range as a Tuple of (start_frame, end_frame) (''read/write'')
 +
|-
 +
|displayWindow
 +
|returns the session frame as a [[Recti]]
 +
|6.0
 +
|-
 +
|outputs
 +
|a list of all output nodes
 +
|6.0
 +
|-
 +
|outputRange
 +
|the output range as a tuple (start, end) - the range is in output frame numbers
 +
|6.0
 +
|-
 +
|renderRange
 +
|the render range as a tuple (start, end) - the range is in 0-based frame numbers
 +
|6.0
 
|}
 
|}
  
Line 53: Line 72:
 
! scope="col" | Name
 
! scope="col" | Name
 
! scope="col" class="unsortable" | Description
 
! scope="col" class="unsortable" | Description
 +
! scope="col" | Added
 
|-
 
|-
 
|node(<nowiki>name|type</nowiki>)
 
|node(<nowiki>name|type</nowiki>)
 
|finds the [[Node]] with the name or type, depending on the argument name, or None
 
|finds the [[Node]] with the name or type, depending on the argument name, or None
 +
|-
 +
|getNodes(type)
 +
|returns a list of [[Node|Nodes]] that match the given type
 +
|6.0
 +
|-
 +
|addNode(node)
 +
|adds the [[Node]]
 +
|6.0
 +
|-
 +
|removeNode(node)
 +
|removes the [[Node]]
 +
|6.0
 +
|-
 +
|roi(frame)
 +
|returns the ROI [[Recti]] for the frame
 +
|6.0
 
|}
 
|}
 
 
==== Sessions ====
 
* new Sessions can be created and activated
 
* new Sources can be created and added to the Project
 
* adding a Source to a Session creates a SourceNode and connects it
 
* <tt>Session.getNodes(type)</tt> returns a list of nodes of the desired type
 
* <tt>Session.addNode(node)</tt> adds the Node
 
* <tt>Session.removeNode(node)</tt> removes the Node
 
* <tt>Session.roi(frame)</tt> returns the ROI as a [[Recti]] for the specified frame
 
* <tt>Session.displayWindow</tt> attribute returns the session frame as a [[Recti]]
 
* <tt>Session.outputStreams</tt> attribute was removed
 
* <tt>Session.outputs</tt> a list of Output nodes
 
* <tt>Session.outputRange</tt> the session's output range as a tuple (start, end)
 
* <tt>Session.renderRange</tt> the session's render range as a tuple (start, end)
 
 
Note the output range is in output frame numbers and the render range is the zero-indexed frames needing to be rendered.
 

Revision as of 13:14, 26 July 2018

The Session object stores all the Nodes to create the outputs for a specific shot.

Base Class: Object

Construction

session = Session(label=None, width=None, height=None, pixelAspect=None, depth=None, duration=None, frameRate=None)

If any arguments are omitted they should be set using the respective Property.

Sessions can be created automatically from a Source using the tools.session.SessionBuilder class.

Add the Session to a Project using project.addItem().

Attributes

Attributes are read-only except where noted.

Name Description Added
depth the session depth (read/write)
duration the duration in frames
frameRate the frame rate
nodes List of Nodes in the session
pixelAspect the pixel aspect
project the Project containing the session
renderInfo the rendering settings
size the size as a Tuple of (width, height)
startFrame the start frame number
workRange the current work range as a Tuple of (start_frame, end_frame) (read/write)
displayWindow returns the session frame as a Recti 6.0
outputs a list of all output nodes 6.0
outputRange the output range as a tuple (start, end) - the range is in output frame numbers 6.0
renderRange the render range as a tuple (start, end) - the range is in 0-based frame numbers 6.0

Methods

Name Description Added
node(name|type) finds the Node with the name or type, depending on the argument name, or None
getNodes(type) returns a list of Nodes that match the given type 6.0
addNode(node) adds the Node 6.0
removeNode(node) removes the Node 6.0
roi(frame) returns the ROI Recti for the frame 6.0