Home       Trees       Indices       Help   
Autodesk Toxik 2013
Package autodesk_toxik :: Module wiretap
[frames] | no frames]

Module wiretap

Wiretap module.

This module provides methods to import wiretap clips into the Toxik library.

Classes
  WiretapError
Functions
bool
canImport(...)
Returns: True if the specified Wiretap clip can be imported.
str
importClip(...)
Imports the specified Wiretap clip.
Variables
  __package__ = 'autodesk_toxik'
Function Details

canImport(...)

 
Parameters:
  • clipPath (str) - The Wiretap clip path.
Returns: bool
True if the specified Wiretap clip can be imported.

importClip(...)

 

Imports the specified Wiretap clip.

Parameters:
  • compPath (str) - The path to the footage composition that this function will create.
  • server (str) - The host name of a Wiretap server.
  • clipPath (str) - The complete path to the Wiretap clip. When importing from Autodesk IFFFS applications, the path always starts with the volume name, typically stonefs. IFFFS applications are inferno, flame, flint, fire and smoke.

    The folder containing the composition will be created automatically, if it does not exist.

Returns: str
The full composition name under which the composition has been imported.

Note: You must have already set a current project here or this will fail. See the ProjectMgr class from the admin module for more information.

Raises:

   Home       Trees       Indices       Help   
Autodesk Toxik 2013
Generated by Epydoc 3.0.1 on Wed Feb 8 08:00:12 2012 http://epydoc.sourceforge.net