AR Suite
...
Reference Manual
Tools Overview

LiveLink

7min

This section explains the different Live Link related components and their settings.

It is important to note that if you use the Workflow Wizard that the required Live Link components will be created and initialized for you and there is no need to set them up manually.

Ncam Live Link Source

The Ncam Live Link source receives the tracking data streamed by Ncam Reality and makes it available to the Unreal Engine. There are two types of source: NcamLiveLinkSource and NcamLiveLinkSourceLite which are each the endpoints for the Ncam SDK and Ncam SDK Lite respectively.

LiveLink can be found under the Virtual Production Windowmenu
LiveLink can be found under the Virtual Production Windowmenu


To add an Ncam Live Link source, open the Live Link tab (Window → Virtual Production → Live Link).

Document image


Ncam SDK Connection Parameters

The NcamLiveLink Source Connection Parameters
The NcamLiveLink Source Connection Parameters


The available connection parameters are as follows:

  • Ip Address The IP address of the Ncam Reality server which is streaming the Ncam SDK data.
  • Packets The various SDK packets to request from the Ncam Server. Enabling/disabling the packets requested will change the capabilities of the LiveLink source.

Note that in order to use the NcamMarkers LiveLink subject the "Markers" packet must be enabled.

Note that in order to use lens distortion with either the Compositing: Legacy Composure Guide or Compositing: AR Suite the "Distortion Map" packet must be enabled.

Ncam SDK Lite Connection Parameters

The NcamLiveLinkSDKLite Source Connection Parameters
The NcamLiveLinkSDKLite Source Connection Parameters


The available connection parameters are as follows:

  • IPAddress The IP address of the Ncam Reality server which is streaming the Ncam SDK Lite data. Leaving this field empty will attempt to resolve the host automatically.
  • UDPPort Number The UDP port to listen to for Ncam SDK Lite data.

Live Link Component Controller

In order for an actor to receive tracking data it needs to have an attached “LiveLinkComponentController”.

Document image


The LiveLinkComponentController can simply be added to the desired Actor, e.g. CineCameraActor, CameraActor etc, using the "+ Add Component" button on the details panel for the selected actor.

Document image


Subject Representation: Select an Ncam Camera subject and give a role to it.

Component to Control: The component on the actor to control using the given subject.

The following role settings are automatically populated when the Live Link Component Controller is added to a new actor and the subject is set to reference the Ncam Camera. They can be changed to override the default behaviour:

Transform Role: The role that will be used to drive the Component to Control. This can be overridden to disable the transform altogether.

Camera Role: The role that is used to drive all standard UE4 cameras.

Ncam Camera Role: An extension to the Camera Role that is used to drive NcTrackedCamera objects.

Updated 25 Mar 2024
Doc contributor
Doc contributor
Did this page help you?