For information related to connecting a Python client to Live, see:
Create a client and check the connection
To connect a Python client to Shogun Live:
- Start Shogun Live.
It is now ready to be interacted with via the Python API.
- Start Python and begin by importing the Vicon Core API:
from vicon_core_api import *
- Create a client. In this example, the object is named
shogun_client = Client('localhost')
shogun_clientis the name of the object, which can be any name you want
localhostcan be replaced with an IP address or hostname running Shogun Live.
- Check that the client is connected:
This returns True if connected, and False if not.
Example: Setting the capture name
In Shogun Live, towards the top of the Capture panel, the default capture name is Take.
This example shows how you can change the capture name using the Python API.
- Import the relevant class for interacting with capture:
from shogun_live_api import CaptureServices
- Create an object for the capture services. In this example, the object is named
capture, but you can name it as required.
It references the object name used for the shogun client that was created:
capture = CaptureServices(shogun_client)
- Use the
set_capture_namemethod to set the capture name to
result = capture.set_capture_name('MyTake001')
- Check the return value to make sure that this succeeded:
In Shogun Live the capture name has changed:
For further information, see:
- The readme file:
- Sample scripts:
Explore using Python
Run the Python
dir() command on objects created, to show the methods that can be called:
help() on specific methods or classes.