Muster Console Python API

import MConsoleAPI
MConsoleAPI.registerScript("Mycommand","Tools",MConsoleAPI.kLocationContextMenuBar,"print('hello!')",MConsoleAPI.kLaunchContextConsole,"")

import shiboken
from PySide import QtGui, QtCore
import MConsoleAPI
 
winPointer = int(MConsoleAPI.getMainWindow())
if winPointer != 0:
    mainWindow = shiboken.wrapInstance(winPointer,QtGui.QMainWindow)
 
# Further objects may be parented to mainWindow

# The following example uses Pyside to cast a pointer returned from Console to QAbtractItemModel and let you write your own views bound to the internal Console document model, this allows a complete customization of the Muster views
 
import shiboken
from PySide import QtGui, QtCore
import MConsoleAPI
 
modelPointer = int(MConsoleAPI.getJobsModel())
if modelPointer != 0:
    jobsModel = shiboken.wrapInstance(modelPointer,QtCore.QAbstractItemModel)
 
treeView = QtGui.QTreeView()
treeView.setModel(jobsModel) # Attach the Console jobs model to the tree view
treeView.show()

import MConsoleAPI
err, list = MConsoleAPI.getJobViewSelection()
if (err.getErrorCode() != 0): sys.exit(err.getDescription())
for job in list:
    err, jobObj = MConsoleAPI.jobGet(job)
    if (err.getErrorCode() ==0): print("Selected job: " + jobObj.getJobName())

import MConsoleAPI
err, list = MConsoleAPI.getInstancesViewSelection()
if (err.getErrorCode() != 0): sys.exit(err.getDescription())
for nodeId in list:
    err, nodeObj = MConsoleAPI.nodeGet(nodeId)
    if (err.getErrorCode() ==0): print("Selected instance: " + nodeObj.getInstanceName())

import MConsoleAPI
err, list = MConsoleAPI.getLogsViewSelection()
if (err.getErrorCode() != 0): sys.exit(err.getDescription())
for logId in list:
    err, logObj = MConsoleAPI.logGet(logId)
    if (err.getErrorCode() ==0): print("Selected log: " + logObj.getDescription())

import MConsoleAPI
err, jobId, list, historyList = MConsoleAPI.getChunksViewSelection()
if (err.getErrorCode() != 0): sys.exit(err.getDescription())
for chunkId in list:
    err, chunk = MConsoleAPI.chunkGet(jobId,chunkId)
    if (err.getErrorCode() ==0): print("Selected chunk frame: " + chunk.getStartFrame())

import MConsoleAPI
MConsoleAPI.nodeKillProcess(1) # Terminate rendering on instance ID 1

import MConsoleAPI
MConsoleAPI.nodeKillAndPauseNodesWorkingOnJob(1) # Terminate rendering and pause any instance working on job ID 1

import MConsoleAPI
MConsoleAPI.nodePause(1) # Pauses instance ID 1

import MConsoleAPI
MConsoleAPI.nodeResume(1) # Resumes instance ID 1

import MConsoleAPI
MConsoleAPI.nodeSetProcessPriority(1,MClientAPI.MNode.kProcessPriorityIdle) # Sets the process priority of instance ID 1 to idle

import MConsoleAPI
MConsoleAPI.nodeSoftRestart(1)

import MConsoleAPI
MConsoleAPI.nodePurgeTemplatesExclusion(1,"-1") # Purges the entire templates exclusion list on instance ID 1

import MConsoleAPI
MConsoleAPI.nodePurgeJobsExclusions(1,"-1") # Purges the entire jobs exclusion list on instance ID 1

import MConsoleAPI
MConsoleAPI.nodeSetRealtimeLog(1,0) # Disables realtime log on instance ID 1

import MConsoleAPI
MConsoleAPI.nodeSendSystemEvent(1,MClientAPI.MNode.kSysEventShutdown) # Shutdown the node of instance ID 1

import MConsoleAPI
MConsoleAPI.nodeRunPythonCode(1,"print(\"Hello world!\")") # Runs python code on instance ID 1

import MConsoleAPI
MConsoleAPI.nodeSetNotes(1,"My notes!") # Changes the notes on instance ID 1

import MConsoleAPI
MConsoleAPI.nodeRemoveRegistration(1) # Removes the registration of instance ID 1 (Must be offline)

import MConsoleAPI
err, list = MConsoleAPI.nodeGetList()
for node in list:
    print (node.getInstanceName())

import MConsoleAPI
err, node = MConsoleAPI.nodeGet(1) # Gets object of instance ID 1
if (err.getErrorCode() != 0): print("Instance ID 1 does not exist!")

import MConsoleAPI
err, node = MConsoleAPI.nodeGetByName("HAL9000") # Gets instance named HAL9000
if (err.getErrorCode() != 0): print("HAL9000 does not exist!")

import MConsoleAPI
MConsoleAPI.chunkEnsureAvailability(1) # Be sure that chunks of job ID are available into Console, downloads them if required

import MConsoleAPI
err , list = MConsoleAPI.chunkGetList(1) # Get the chunks of job ID 1
for chunk in list:
    print ("Chunk start frame: " + str(chunk.getStartFrame()))

import MConsoleAPI
err , chunk = MConsoleAPI.chunkGet(1,1) # Get the first chunk of job ID 1
if (err.getErrorCode() != 0): sys.exit(err.getDescription())
print ("Job first chunk starts at frame : " + str(chunk.getStartFrame()))

import MConsoleAPI
err = MConsoleAPI.chunkSetStatus(1,1,MClientAPI.MChunk.KChunkStatusOnHold) # Resets the chunk status on hold
if (err.getErrorCode() != 0): sys.exit(err.getDescription())

import MConsoleAPI
err, list = MConsoleAPI.jobGetList()
for job in list:
    print(job.getName())

import MConsoleAPI
err, job = MConsoleAPI.jobGet(1) # Get the job ID 1
if (err.getErrorCode() != 0): sys.exit(err.getDescription())
print ("Job ID 1 name is " + job.getName())

import MDispatcherAPI
err = MConsoleAPI.jobReparent(2,3)
if (err.getErrorCode() != 0): print("Error: " + err.getDescription())

import MConsoleAPI
import MClientAPI
 
# Creates a new MJob object
job = MClientAPI.MJob()
# Sets the base attributes
job.setName("A new job")
job.setTemplateID(1) # Targets Maya sw rendering
job.setPacketSize(1) # Sets the packet size to 1
job.setParentId(-1)
job.setDependMode(MClientAPI.MJob.kJobDependSuccess)
job.setJobType(MClientAPI.MJob.kJobTypeJob)
job.setPriority(1)
job.setPacketType(MTemplateAPI.kTemplateMultiframe)
job.setMaximumNodes(4)
 
''' Template specific attributes '''
job.attributeSetString("job_file","\\\\Myserver\\myshare\\myproject\\scenes\\test.mb",1,1)
job.attributeSetString("job_project","\\\\Myserver\\myshare\\myproject",1,1)
job.attributeSetString("output_folder","\\\\Myserver\\myshare\\myproject\\images",1,1)
job.attributeSetFloat("start_frame",1.0)
job.attributeSetFloat("by_frame",1.0)
job.attributeSetFloat("end_frame",10.0)
job.attributeSetInt("step_by",1)
job.attributeSetInt("number_by",1)
job.attributeSetInt("MAYADIGITS",1)
 
err = MConsoleAPI.jobSubmit(job)
if (err.getErrorCode() != 0): print("Error: " + err.getDescription())

import MConsoleAPI
import MClientAPI
 
# Gets an existing job
err, job = MConsoleAPI.jobGet(10)
if (err.getErrorCode() != 0): sys.exit(err.getDescription())
 
# Changes the job filename
job.attributeSetString("job_file","/new/path")
 
# Edit and reinit the job
err = MConsoleAPI.jobEdit(job)
if (err.getErrorCode() != 0): print("Error: " + err.getDescription())

import MConsoleAPI
MConsoleAPI.jobChangeAttrib(1,"output_folder","c:\\My Folder")

import MConsoleAPI
MConsoleAPI.jobRemoveAttrib(1,"output_folder")

import MConsoleAPI
MConsoleAPI.jobAddFolder(0,100,"new folder")

import MConsoleAPI
MConsoleAPI.jobReinit(2) # Reinit job ID 2

import MConsoleAPI
MConsoleAPI.jobDelete(2) # Deletes job ID 2

import MConsoleAPI
MConsoleAPI.logClear() # Clear the dispatcher internal log

import MConsoleAPI
err, list = MConsoleAPI.logGetList()
for log in list:
    print(log.getEventID())

import MConsoleAPI
err, log = MConsoleAPI.logGet(1) # Get the log ID 1
if (err.getErrorCode() != 0): sys.exit(err.getDescription())
print ("Log ID 1 description is " + log.getDescription())

import MConsoleAPI
err = MConsoleAPI.dispatcherRunPythonCode("print(\"Hello world!\")")
if (err.getErrorCode() != 0): sys.exit(err.getDescription())

import MConsoleAPI
err = MConsoleAPI.dispatcherSendCustomMessage(0,"Hello!"))
if (err.getErrorCode() != 0): sys.exit(err.getDescription())