Eyeon:Script/Reference/Applications/Fusion/Fusion
From VFXPedia
Contents |
Fusion()
Arguments
Fusion(ip, timeout, uuid, subtype)
- ipaddress (optional, string)
A stringcontaining the ip address or fully qualified domain name where a running instance of Fusion can be located. If no value is provided then "localhost" is assumed.
- timeout (optional, number )
A number which specifies how long in seconds to wait for a valid response before timing out.
- uuid ( optional, string )
Allows the user to specify the uuid of the instance of Fusion to connect to.
- subtype (optional, string)
Allows the user to specify the type of Fusion application to connect to. For instance one could specify “RenderManager” to only connect to valid instances of the standalone render manager.
Returns
A Fusion object, or nil if a connection to Fusion could not be established.
Remarks
The Fusion() function returns an object of the type Fusion, which allows eyeonScript to control an instance of Fusion. It's only argument is the IP address or fully qualified domain name of a system running Fusion.
When Fusion() is called from a command line script (using eyeonScript.exe), a TCP/IP connection is established with the copy of fusion referred to in the ipaddress argument, or with the copy of Fusion running on the localhost. The resulting connection can then be used to issue commands and control that instance of Fusion.
If a valid copy of Fusion cannot be found at the specified address then this function will return 'nil'.
When the Fusion() function is called interactively from within Fusion a local connection to the current copy of Fusion is established unless the ipaddress argument is provided.
In order to establish a connection from a command line script, the TCP/IP protocol must be installed, Fusion must be running at the specified address, and 'allow network renders' should be checked in the file menu.
Fusion uses tcp/ip port 10251 to communicate with eyeonScript, so you are running software that blocks local ports (such as Zone Alarm), or if you are attempting to communicate with a remote system behind a firewall, you must ensure that communications over this port are enabled. Consult your network administrator for additional details.
If script security is enabled on the remote workstation then it may be necessary to login before you can connect to a remote machine. See here for more information about scripting and security.
Requirements
- eyeonScript 5.0
- Fusion 5.0
Examples
-- connects to a copy of Fusion on the local machine fusion = Fusion()
-- connects to a copy of Fusion on the local machine, using an ipaddress fusion = Fusion("127.0.0.1")
-- connects to a copy of Fusion on the local machine, using localhost fusion = Fusion("localhost")
-- connects to a remote machine running Fusion, using an ipaddress fusion = Fusion("192.168.0.1")
-- connects to a remote machine running Fusion, using a fully qualified domain name fusion = Fusion("compositor.foobar.com")
-- connects to a local machine, and exits if no copy of Fusion responds fusion = Fusion("127.0.0.1") if not fusion then print("Fusion is not responding!") os.exit(-1) end
