End-to-End Demo Chart
Overview
The nvidia-lipsync-h4m-sample Helm chart deploys a complete LipSync demo pipeline on Holoscan for Media. This includes the following components:
- Sender pipeline.
- LipSync NIM service (
nvidia-lipsync-h4m-service). - Receiver pipeline (ST 2110 or NMOS).
- SRT output for preview.
This chart provides a ready-to-run setup for evaluating and demonstrating LipSync capabilities within a Holoscan for Media environment.
Installation
Prerequisites
Complete all prerequisite steps (Rivermax license, image pull and model pull secrets, GPU node, Multus attachment for SMPTE ST 2110) before running helm install. For details, refer to Getting Started.
If not already done, add the Helm repository and pull the chart:
Helm Installation
The chart includes a default values.yaml and can be deployed from the .tgz with -f. For the sample ST 2110 or NMOS pipelines, copy the YAML from Helm Configuration Parameters into values-st2110.yaml or values-nmos.yaml, adjust fields, and run the matching install command.
Default deployment (NMOS mode, 1080p):
The default values.yaml ships with example values for cluster-specific fields such as node selector (example-gpu-node), image pull secret, network name, and scheduler. You must update these values to match your cluster before deploying. The easiest approach is to use the global overrides so that each value is specified once for all components (sender, receiver, and NIM service). For details, refer to Global Overrides.
With global overrides:
Alternatively, set values per component when the sender, receiver, and NIM service run on different nodes or use different pull secrets:
For all available Helm values, refer to the Configuration Reference.
After installation, check the status of the pods:
Example output:
Confirm that the sender, LipSync NIM, and receiver pods all show 1/1 in the READY column before continuing.
Check the pod state:
Look for Pulling image in the events (normal—wait longer) or CrashLoopBackOff / ErrImagePull (actionable: check secrets and node resources).
For NMOS, refer to Chrome Remote Desktop for UI access and setup steps.
For NMOS connection order and NMOS known issues, refer to Limitations and Known Behaviors.
High-Speed Network Configuration
For ST 2110, confirm the high-speed network attachment name in the cluster, and then set the same network.name on the sender, receiver, and nvidia-lipsync-h4m-service so it matches that attachment (for example, the name from a NetworkAttachmentDefinition or what the platform documents).
Inline overrides (append to helm install):
Or in values YAML:
Replace media-a-tx-net with the attachment name used in the cluster.
Persistent Storage
To persist model cache and service logs across pod restarts or re-deployments, enable nimModelCache, serverLogs, or both in the values file. Both Persistent Volume Claims (PVCs) are optional and disabled by default.
nimModelCachestores downloaded models locally, preventing re-downloads on subsequent runs.serverLogspersists service logs for debugging and analysis.
Sender Sample Media
Input Media Files
The sender expects an MPEG Transport Stream (.ts) file containing specific media streams required for lip synchronization.
Stream Composition
Each input .ts file must contain the following streams:
- Video stream: Source video to be processed by the LipSync NIM.
- Original audio stream: The original audio associated with the video (used as reference audio).
- Translated audio stream: The target audio (such as a different language) to be synchronized with the video.
Codecs
- Video codec: H.264
- Audio codec: Opus, 48 kHz, mono (both the original and translated audio streams)
Bundled Sample Files
The sender container includes sample .ts files:
/workspace/assets/
Language Variants
_de: German_es: Spanish_fr: French
Use the same resolution and frame rate (FPS) for the sender, LipSync NIM service (nvidia-lipsync-h4m-service), and receiver.
Ensure that the resolution and frame rate specified in Helm (sender.video and related settings) match the selected input file.
Helm Configuration Parameters
Copy the appropriate configuration into values-st2110.yaml or values-nmos.yaml, adjust fields for your environment, and pass it to helm upgrade --install with -f.
For a full reference of all Helm keys and pipeline tuning parameters, refer to the Configuration Reference.
ST 2110 (Static Mode) Configuration (values-st2110.yaml)
NMOS Configuration (values-nmos.yaml)
Install
ST 2110:
NMOS:
Connect the receiver first by establishing sender audio and LipSync NIM output to receiver. After the receiver connection is in place, connect the sender audio and video streams to the LipSync NIM. For more information, refer to Limitations and Known Behaviors.
View Output via SRT
Use the internal IP address from the output. With the sample values in this guide, ST 2110 output is on port 32511 and NMOS on 32512—for example, srt://<internal-ip>:32511 or srt://<internal-ip>:32512 in VLC or ffplay.
Disabling Components
You can disable individual pipeline components during helm install or helm upgrade without removing the release by setting their enabled flag to false.
This stops only the selected component; the rest of the pipeline continues to run.
Uninstall
If serverLogs or nimModelCache were enabled, their PVCs are retained after uninstall (resource-policy: keep). Delete manually if no longer needed:
Verify and Check Logs
Replace the deploy names in kubectl logs with sender.appName, receiver.appName, and nvidia-lipsync-h4m-service.appName from the values file. (ST 2110 and NMOS use different names.)
On Red Hat OpenShift, replace kubectl with oc. For log access, refer to Observability.
End-to-End Setup and Validation
- Create
values-st2110.yamlorvalues-nmos.yamlfrom Starter Configuration Files and run the matching Install command. - Confirm all pods show READY 1/1 with
kubectl get pods. - Open the SRT preview; refer to View Output via SRT. For VLC steps, NMOS wiring, and screenshots, refer to Verification.
- Run
helm uninstall lipsync-h4m-sample.
For troubleshooting, refer to Advanced Usage.