Difference between revisions of "Streaming to Unreal"

From iPi Docs
Jump to: navigation, search
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
--[[User:Pavel|Pavel]] ([[User talk:Pavel|talk]]) 08:58, 10 December 2020 (EST){{EditionFeature|Basic}}
+
{{EditionFeature|Basic}}
  
iPi Mocap Studio is capable of realtime streaming of character's pose over network. This can be used to preview captured motion in an actual game scene inside the Unreal editor or Unity editor.
+
iPi Mocap Studio is capable of realtime streaming of character's pose over network. This can be used to preview captured motion in an actual game scene inside the Unreal editor and integrate reading animation stream from [[iPi Mocap Studio]] into your games or applications created with Unreal.
  
= Usage in Mocap Studio =
+
==Usage in Mocap Studio==
  
To start streaming, go to the '''Export''' tab and press '''Start Streaming''' button. While streaming is active any changes to a pose of the actor in Mocap Studio (playback, tracking, manual edit etc.) are sent to the local network. If there is a target character applied for an actor then the program streams poses of that target character otherwise it streams poses of the actor model. To stop streaming press '''Stop Streaming''' button on the '''Export''' tab. Streaming also stops automatically when a project is closed.
+
{{:Animation Streaming In Mocap Studio}}
  
[[File:export-tab-streaming.png|center|300px]]
+
==Usage in Unreal==
 
+
{{Note|Streaming of multiple actors is not currently supported. In multi-actor projects, it streams an active (currently selected) actor.}}
+
 
+
Streaming protocol broadcasts UDP packets to a certain port on the local network. By default, the port used is ''31455''. You can change this value in '''Streaming Settings''' dialog which opens when you press a "gear" icon on '''Start Streaming''' button.
+
 
+
[[File:streaming-settings-dialog.png|center|300px]]
+
 
+
{{Tip|You may need to adjust firewall settings to allow '''outgoing''' connections to this UDP port.}}
+
 
+
= Usage in Unreal =
+
  
 
To get data streamed by [[iPi Mocap Studio]] into Unreal Engine please follow instructions below.  
 
To get data streamed by [[iPi Mocap Studio]] into Unreal Engine please follow instructions below.  
  
1. Install '''iPiMocapLiveLink''' plugin.
+
1. Install '''iPi Mocap Live Link''' plugin:
  
1.1. Download '''iPiMocapLiveLink''' plugin via links below.
+
1.1. Download '''iPi Mocap Live Link''' plugin via links below.
  
  Download: UE 4.25 - [http://files.ipisoft.com/iPiMocap-Unreal-4-25.zip iPiMocap-Unreal-4-25.zip]; UE 4.24 - [http://files.ipisoft.com/iPiMocap-Unreal-4-24.zip iPiMocap-Unreal-4-24.zip]
+
  Download: UE 4.26 - [https://files.ipisoft.com/iPiMocap-Unreal-4-26.zip iPiMocap-Unreal-4-26.zip]; UE 4.25 - [https://files.ipisoft.com/iPiMocap-Unreal-4-25.zip iPiMocap-Unreal-4-25.zip]; UE 4.24 - [https://files.ipisoft.com/iPiMocap-Unreal-4-24.zip iPiMocap-Unreal-4-24.zip]
  
1.2. Unpack downloaded archieve into ''Engine\Plugins'' folder of you Unreal Engine installation. The folder ''iPiSoft'' will be created with subfolder ''iPiMocapLiveLink'' that will contain the plugin binaries and source code.
+
1.2. Unpack downloaded archieve into ''Engine\Plugins'' folder of your Unreal Engine installation. The folder ''iPiSoft'' will be created with subfolder ''iPiMocapLiveLink'' that will contain the plugin binaries and source code.
  
 
2. You will then have to activate installed plugin in your project.  
 
2. You will then have to activate installed plugin in your project.  
Line 33: Line 23:
 
2.1. (Re)start the Unreal Editor.
 
2.1. (Re)start the Unreal Editor.
  
2.2. Open '''Plugins''' window via ''Edit > Plugins'' menu. Select '''Animation''' category.
+
2.2. Open '''Plugins''' window via ''Edit > Plugins'' menu. Select ''Animation'' category.
  
2.3. Enable '''iPiMocapLiveLink''' and '''LiveLink''' plugins.
+
2.3. Enable '''iPi Mocap Live Link''' and '''Live Link''' plugins.
  
 
2.4. Restart the editor by pressing '''Restart Now''' button.
 
2.4. Restart the editor by pressing '''Restart Now''' button.
Line 41: Line 31:
 
[[File:UE-Enable-Plugin-Screen-1.png|center]]
 
[[File:UE-Enable-Plugin-Screen-1.png|center]]
  
3. Installed plugin will provide ''Live Link Source'' you can use to get animation data from '''iPi Mocap Studio'''. You can further use standard '''Live Link''' features to apply animation data to your character.  
+
3. Installed plugin will provide ''iPi Mocap Live Link'' source you can use to get animation data from '''iPi Mocap Studio'''. You can further use standard '''Live Link''' features to apply animation data to your character.  
  
4. Instuctions for quick test. We used ''ThirdPerson'' project template.
+
===Instuctions for quick test.===
  
4.1. Start streaming in '''iPi Mocap Studio''' as expained above. You need to use ''UE4 Mannequin Rig'' if you use standard Unreal character. You can import your own rig into '''iPi Mocap Studio''' if you use custom rig.
+
We used ''ThirdPerson'' project template.
 +
 
 +
* Start streaming in '''iPi Mocap Studio''' as expained above. You need to use ''UE4 Mannequin'' rig if you use standard Unreal character. You can import your own rig into '''iPi Mocap Studio''' and setup motion transfer profile if you use custom rig.
  
 
[[File:UE-Start-Streaming-1.png|center]]
 
[[File:UE-Start-Streaming-1.png|center]]
  
4.2. Connect to '''iPi Mocap Live Link''' source in '''Unreal Editor'''. ''Live Link Subject'' should appear in subjects list.  
+
* Open '''Live Link streaming manager tab''' in '''Unreal Editor''' via '''Window > Live Link''' menu item.  
 +
 
 +
[[File:UE-Open-LiveLink-Manager.png|center]]
 +
 
 +
* Connect to '''iPi Mocap Live Link''' source in '''Unreal Editor'''. ''iPi Mocap Live Link'' subject names ''Character'' should appear in subjects list.  
  
 
:{{Note|Don't forget to start animation playback or live tracking session inside '''iPi Mocap Studio'''. Otherwise nothing will be streamed and subject will not show.}}
 
:{{Note|Don't forget to start animation playback or live tracking session inside '''iPi Mocap Studio'''. Otherwise nothing will be streamed and subject will not show.}}
Line 56: Line 52:
 
{|
 
{|
 
|[[File:UE-Connect-1.png|center]]
 
|[[File:UE-Connect-1.png|center]]
|[[File:UE-Connected.png|center]]
+
|[[File:UE-Connected-1.png|center]]
 
|}
 
|}
 
</center>
 
</center>
  
4.3. You can then use ''Live Link Pose'' blueprint to animate your character. Don't forget to select ''Character'' Live Link subject to feed in animation data.  
+
* You can then use ''Live Link Pose'' blueprint to animate your character. Don't forget to select ''Character'' Live Link subject to feed in animation data.  
 +
 
 +
:{{Note|You can use other '''Live Link''' capabilities as well. ''Live Link Pose'' blueprint was just selected just for expample.}}
  
[[File:UE-Animated.png|center]]
+
[[File:UE-Animated.png|center|800px]]

Latest revision as of 12:09, 26 March 2021

Note.png
Note: Feature is available in Basic and Pro editions only.

iPi Mocap Studio is capable of realtime streaming of character's pose over network. This can be used to preview captured motion in an actual game scene inside the Unreal editor and integrate reading animation stream from iPi Mocap Studio into your games or applications created with Unreal.

Usage in Mocap Studio

To start streaming, go to the Export tab and press Start Streaming button. While streaming is active any changes to a pose of the actor in Mocap Studio (playback, tracking, manual edit etc.) are sent to the local network. If there is a target character applied for an actor then the program streams poses of that target character otherwise it streams poses of the actor model. To stop streaming press Stop Streaming button on the Export tab. Streaming also stops automatically when a project is closed.

export-tab-streaming.png
Note.png
Note: Streaming of multiple actors is not currently supported. In multi-actor projects, it streams an active (currently selected) actor.

Streaming protocol broadcasts UDP packets to a certain port on the local network. By default, the port used is 31455. You can change this value in Streaming Settings dialog which opens when you press a "gear" icon on Start Streaming button.

streaming-settings-dialog.png
Tip.png
Tip: You may need to adjust firewall settings to allow outgoing connections to this UDP port.

Usage in Unreal

To get data streamed by iPi Mocap Studio into Unreal Engine please follow instructions below.

1. Install iPi Mocap Live Link plugin:

1.1. Download iPi Mocap Live Link plugin via links below.

Download: UE 4.26 - iPiMocap-Unreal-4-26.zip; UE 4.25 - iPiMocap-Unreal-4-25.zip; UE 4.24 - iPiMocap-Unreal-4-24.zip

1.2. Unpack downloaded archieve into Engine\Plugins folder of your Unreal Engine installation. The folder iPiSoft will be created with subfolder iPiMocapLiveLink that will contain the plugin binaries and source code.

2. You will then have to activate installed plugin in your project.

2.1. (Re)start the Unreal Editor.

2.2. Open Plugins window via Edit > Plugins menu. Select Animation category.

2.3. Enable iPi Mocap Live Link and Live Link plugins.

2.4. Restart the editor by pressing Restart Now button.

UE-Enable-Plugin-Screen-1.png

3. Installed plugin will provide iPi Mocap Live Link source you can use to get animation data from iPi Mocap Studio. You can further use standard Live Link features to apply animation data to your character.

Instuctions for quick test.

We used ThirdPerson project template.

  • Start streaming in iPi Mocap Studio as expained above. You need to use UE4 Mannequin rig if you use standard Unreal character. You can import your own rig into iPi Mocap Studio and setup motion transfer profile if you use custom rig.
UE-Start-Streaming-1.png
  • Open Live Link streaming manager tab in Unreal Editor via Window > Live Link menu item.
UE-Open-LiveLink-Manager.png
  • Connect to iPi Mocap Live Link source in Unreal Editor. iPi Mocap Live Link subject names Character should appear in subjects list.
Note.png
Note: Don't forget to start animation playback or live tracking session inside iPi Mocap Studio. Otherwise nothing will be streamed and subject will not show.
UE-Connect-1.png
UE-Connected-1.png
  • You can then use Live Link Pose blueprint to animate your character. Don't forget to select Character Live Link subject to feed in animation data.
Note.png
Note: You can use other Live Link capabilities as well. Live Link Pose blueprint was just selected just for expample.
UE-Animated.png