CognitiveXR Clients

This repository collects links to clients and client SDKs for the cognitivexr-platform.

Unity

Unity Package

Is a package that can be included into a Unity project via its package manager

• CPOP

  The Unity CPOP client connects to a CPOP stream and listens for updates

• CogStream

  Contains the MediatorClient and EngineClient. The MediatorClient establishes a connection to the mediator, returns a list of available engines and facilitates the launch and connection to the engine. Once an engine is launched, the address, returned by the mediator client, can be passed to an EngineClient. The EngineClient connects to an engine and supports a send and a receive channel.

  Example Project

Python

• Interactive CogStream desktop client

  Client to interact with the mediator to start engines and stream the connected camera. Useful for debugging and developing. Navigate into cogstream/clients/python, create a virtual environment and install the requirements. With the mediator running you can then run python -m interactive.main and you should see something like this:

  % python -m interactive.main
  0: EngineSpec(name='debug', attributes={'format.colorMode': ['0'], 'format.height': ['0'], 'format.width': ['0']})
  1: EngineSpec(name='fermx', attributes={'format.colorMode': ['0'], 'format.height': ['0'], 'format.width': ['0']})
  2: EngineSpec(name='yolov5', attributes={'format.colorMode': ['0'], 'format.height': ['0'], 'format.width': ['0']})
  which engine do you want to use?: 
  

  Once an engine is selected, the client will attempt to stream the currently connected camera to the engine.

• CogStream engine client library

  Part of the cogstream python framework. Some of the python engines also come with an engine client for debugging, that demonstrates how the engine client library can be used. Here is one example: https://github.com/cognitivexr/CogStream/blob/main/engines/engines-py/fermx/fermx/client.py

License

• Code: Apache 2.0
• Documentation and READMEs: CC-BY-SA-4.0