META

RamProject

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

Inherits objectRamObjectRamProject

Static Methods

Method Arguments Description
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
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
assetGroups
list of RamAssetGroup
Available asset groups in this project
assets
list of RamAsset
RamAssetGroup: assetGroup=None 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 RamSequence
Available sequences in this project
shots
RamShot
string: nameFilter="*",
RamSequence: sequence=None
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 or None
string: shortName (Try to) retrieve a step from its short name.
steps
list of RamStep
enumerated value: type=RamStep.ALL 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.
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,
RamAssetGroup: assetGroup=None
Recursively gets all assets contained in the given folder.