From VFXPedia

Contents 1 Fusion : QueueComp 1.1 Arguments 1.2 Returns 1.3 Remarks 1.4 Requirements 1.5 Examples 1.6 Tips for QueueComp (edit)

Fusion : QueueComp

Arguments

QueueComp( comp_path, render_start, render_end, slave_group )

• comp_path (required, string)

A string describing the full path to the composition which is to be queued.

• render_start (optional, integer)

A number which describes the first frame in the render range.

• render_end (optional, integer)

A number which describes the last frame in the render range.

• slave_group (optional, string)

Specifies the slave group to use for this job.

QueueComp( args_table )

• args_table (required, table)

Specifies the slave group to use for this job. The following keys are valid:

FileName	The Comp to queue
QueuedBy	Who queued this comp
Groups	Slave groups to render on
Start	Render Start
End	Render End
FrameRange	Frame range string, used in place of start/end above
RenderStep	Render Step
ProxyScale	Proxy Scale to render at
TimeOut	Frame timeout

Returns

This function returns true if it succeeds in adding the composition to the Queue, and false if it fails.

Remarks

The QueueComp function submits a composition from disk to the render manager. If the render start and end are not provided then the render manager will render the range saved with the composition. Otherwise these arguments will override the saved range.

Requirements

• eyeonScript 5.0
• Fusion 5.0

Examples

A simple command line script that takes the path to a composition as its first argument, and adds that composition to the local Fusion's render queue. The render range is specified by the second and third arguments on arg[2] and arg[3]

-- get the first argument passed to the script
comp_path = arg[1]
render_start = arg[2]
render_end = arg[3]
 
fusion = Fusion("localhost")
 
-- queue comp and see if it failed
if not fusion:QueueComp(arg[1], render_start, render_end) then
   print("The composition ".. comp_path ..
   " was not added to the queue. Perhaps an incorrect path was provided?")
 
   os.exit()
end

This example shows how the function is used to specify additional options for the render.

fusion:QueueComp({
  FileName = [[c:\example.comp]],
  QueuedBy = "Bob Lloblaw",
  Start    = 1,
  End      = 25,
  Step     = 5,
  ProxyScale = 2
  })

Specify a non-sequential frame range.

fusion:QueueComp({ 
    FileName=[[c:\example.comp]], 
    FrameRange = "1..10,20,30,40..50" 
})

Note : It seems a bug in Fusion 5.1 prevents the ProxyScale argument from working correctly. This has been corrected for 5.2 and later. The following example shows a possible workaround. The issue has been corrected in Fusion 5.2

fusion:QueueComp({ 
  FileName = [[c:\example.comp]], 
  SizeType = 3, 
  RenderFlags = 2 
})

Set "SizeType" to what you want the proxy. Always leave "RenderFlags" at 2.

Tips for QueueComp (edit)

EyeonTips:Script/Reference/Applications/Fusion/Classes/Fusion/QueueComp