RamPipeFile

A file which goes through a RamPipe.

Static Methods

Method Arguments Description
fromDict
RamPipeFile
object or dict: pipeFileDict Returns a RamPipeFile instance built using the given object/dict, as the ones returned by RamDaemonInterface.

Methods

Method Arguments Description
constructor string: shortName,
RamFileType: fileType,
string: colorSpace=""
check
boolean
string: filePath Checks if the given file can go through this pipe.
colorSpace
string
The color space used through the pipe.
customSettings
string
Can be any string which can be set from the pipeline editor in the Ramses Client Application. Use this to add more information to configure your pipeline and pass this information to the addons.
getFiles
list of string
string: folderPath Gets all the files which can go through this pipe in the given folder.
fileType
RamFileType
The file type used through the pipe.

API Dev notes

(Im)mutable data

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

Method Type of the returned data
colorSpace Immutable
customSettings Immutable
fileType Immutable

META