RamProject

A project handled by Ramses. Projects contains general items, assets and shots.

Inherits: RamObject

Static Methods

Method Arguments Description
fromDict
RamProject
dict or object: projectDict Builds a RamProject from a dict or object like the one returned by the RamDaemonInterface
fromPath
RamProject
string: path
Returns a RamProject instance built using the given path. The path can be any file or folder path from the project

Methods

Method Arguments Description
constructor string: projectName,
string: projectShortName,
string: projectPath="",
int: width=1920,
int: height=1080,
float: framerate=24.0
adminPath
str
The path to the administration files of this project. When calling this method, the folder will created if it does not exist yet.
absolutePath
str
string: relativePath Builds an absolute path from a path relative to the project path
asset
RamAsset
string: assetShortName Gets an asset with its short name.
assetGroups
list of string
Available asset groups in this project
assets
list of RamAsset
string: groupName="" Available assets in this project and group. If groupName is an empty string, returns all assets.
assetsPath
str
string: assetGroup="" The path to the assets (including the asset group if provided) of this project. When calling this method, the folder will created if it does not exist yet.
exportPath
str
The path to the exported medias of this project. When calling this method, the folder will created if it does not exist yet.
folderPath
string
The project’s root folder.
framerate
float
The project’s framerate, in frames per second.
height
int
The project’s height, in pixels.
pipes
list of RamPipe
Available pipes in this project
postProdPath
str
The path to the post-production steps common files of this project. When calling this method, the folder will created if it does not exist yet.
preProdPath
str
The path to the pre-production steps common files of this project. When calling this method, the folder will created if it does not exist yet.
prodPath
str
The path to the production steps common files of this project. When calling this method, the folder will created if it does not exist yet.
sequences
list of string
Available sequences in this project
shot
RamShot
string: shotShortName Gets a shot with its short name.
shots
RamShot
string: nameFilter="*",
string: sequence=""
Available shots in this project
shotsPath
str
The path to the shots of this project. When calling this method, the folder will created if it does not exist yet.
step
RamStep
string: stepShortName Gets a step with its short name.
steps
list of RamStep
enumerated value: type=RamStep.ALL,
boolean: deepSearch=false
Available steps in this project. Use type to filter the results.
One of: StepType.ALL, StepType.ASSET_PODUCTION, StepType.SHOT_PRODUCTION, StepType.PRE_PRODUCTION, StepType.PRODUCTION, StepType.POST_PRODUCTION.
StepType.PRODUCTION represents a combination of SHOT and ASSET.
When offline, deepSearch will also look for existing steps in the Assets and Shots folder of the project, but this can take a long time if there are many assets and shots.
width
int
The project’s width, in pixels.

API Dev notes

Note

These section is for the development of the API only; you should not need these when developping your add-on using the API.

Private methods

Method Arguments Description
_getAssetsInFolder
list of RamAsset
string: folderPath,
string: groupName=""
Recursively gets all assets contained in the given folder.

(Im)mutable data

The data returned by the methods can be either mutable or immutable.

If a method is not listed here, it means the corresponding data is never stored in a class attribute, and must always be got from the Daemon or the tree.

Method Type of the returned data
framerate Immutable
height Immutable
pipes Immutable
width Immutable

META