wapi.launch¶
Use this module to interact with the softwares process launched by wizard.
Launch functions¶
- wapi.launch.work_env(work_env)¶
Launch a work environment ( example : seq_0001/sh_0001/animation/main/maya ).
- Parameters:
work_env (str or int) – The work environment as string ( example : “seq_0001/sh_0001/animation/main/maya” ) or int
- Returns:
None
- Return type:
None
- wapi.launch.work_version(work_version)¶
Launch a work version ( example : seq_0001/sh_0001/animation/main/maya/0004 ).
- Parameters:
work_version (str or int) – The work version as string ( example : “seq_0001/sh_0001/animation/main/maya/0004” ) or int
- Returns:
None
- Return type:
None
- wapi.launch.kill_work_env(work_env)¶
Terminate the given work environment if running ( example : seq_0001/sh_0001/animation/main/maya ).
- Parameters:
work_env (str or int) – The work environment as string ( example : “seq_0001/sh_0001/animation/main/maya” ) or int
- Returns:
None
- Return type:
None
- wapi.launch.kill_all()¶
Terminate all the running work environments
- Returns:
None
- Return type:
None
- wapi.launch.get_running_work_envs()¶
Return a list of the running work environment as a list of strings.
- Returns:
A list of the running work environments
- Return type:
list[str]
Lock functions¶
- wapi.launch.lock_work_env(work_env)¶
Lock the given work environment ( example : seq_0001/sh_0001/animation/main/maya ).
- Parameters:
work_env (str or int) – The work environment as string ( example : “seq_0001/sh_0001/animation/main/maya” ) or int
- Returns:
None
- Return type:
None
- wapi.launch.unlock_work_env(work_env)¶
Unlock the given work environment ( example : seq_0001/sh_0001/animation/main/maya ).
- Parameters:
work_env (str or int) – The work environment as string ( example : “seq_0001/sh_0001/animation/main/maya” ) or int
- Returns:
None
- Return type:
None
- wapi.launch.unlock_all(work_env)¶
Unlock all the work environments locked by the current user.
- Returns:
None
- Return type:
None