Parameters#
The Omniverse renderer microservice offers various configuration parameters, that can be found together with their description in the UCS microservice manifest and in the overview below:
Note
You can scroll the parameter table with the bottom slider to reveal more columns.
Parameter Name |
Description |
UCS Parameter Name |
Type |
UCS Default Value |
Environment Variable Name |
Docker Arguments |
|---|---|---|---|---|---|---|
Kit Settings |
Additional Kit settings passed at startup (e.g. ‘–/app/my/setting=42 –/app/my/other/setting=true’). |
kit.settings |
string |
“” |
–/app/my/setting= |
|
Print Kit Setttings |
Print Kit settings on startup. |
kit.printSettings |
boolean |
false |
–/app/printConfig= |
|
HTTP Server Port |
The port where the http API server is served. |
httpServer.port |
integer |
8021 |
–/exts/omni.services.transport.server.http/port= |
|
Memory Request |
Resource memory request for container. |
deployment.memoryRequest |
string |
“2Gi” |
||
Memory Limit |
Resource memory limit for container. |
deployment.memoryLimit |
string |
“16Gi” |
||
GPU Disable Allocation |
When set to true, the GPU allocation is switched from hardcoded to dynamic. |
deployment.gpuDisableAlloc |
boolean |
false |
GPU_DISABLE_ALLOC |
|
GPU Allocation LImit |
Controls how many replicas run on a single GPU. |
deployment.gpuAllocLimit |
integer |
1 |
GPU_ALLOC_LIMIT |
|
Asset Persistent Volume Size |
The size of the asset volume required to store the USD scene and all its dependencies. |
deployment.persistentVolumeSizeAssets |
string |
“5Gi” |
||
Cache Persistent Volume Size |
The size of the volume used for caches (e.g. compiled shaders). |
deployment.persistentVolumeSizeCache |
string |
“2Gi” |
||
Storage Class Name |
The storage class for the persistent volume claims. |
deployment.storageClassName |
string |
“mdx-local-path” |
||
Storage Access Mode |
The access mode for the persistent volume claims. |
deployment.storageAccessMode |
string |
“ReadWriteOnce” |
||
Remote Resource Path |
The remote resource path with the USD scene assets. Will be provided as “REMOTE_RESOURCE_PATH” env variable to the resource download init container. E.g. for NGC resources looks like “<NGC_ORG>/<NGC_TEAM>/<NGC_RESOURCE_NAME>:<NGC_RESOURCE_VERSION>”. |
resourceDownload.remoteResourcePath |
string |
“” |
REMOTE_RESOURCE_PATH (only for init container) |
|
Secret Name |
Name of the secret, that will be mounted into the resource download init container to provide credentials. E.g. for NGC the “NGC_CLI_API_KEY”. |
resourceDownload.secretName |
string |
“” |
||
Image |
Name of the image for the resource download init container. E.g. “nvcr.io/nvidia/ace/ngc-resource-downloader:1.2.0” |
resourceDownload.image |
string |
“” |
||
Window Width |
The rendered video width. |
window.width |
integer |
1280 |
–/app/window/width= |
|
Window Height |
The rendered video height. |
window.height |
integer |
720 |
–/app/window/height= |
|
Scene Filename |
The name of the USD asset (e.g. Avatar_Scene.usda). This can be a .usda or a .usd file. |
scene.filename |
string |
“Avatar_Scene.usda” |
IAORMS_SCENE_FILENAME |
|
Scene ValidationMode |
The scene validation to be performed. Possible values are NO_SCENE_VALIDATION, GENERIC_SCENE_VALIDATION, DEFAULT_SCENE_VALIDATION |
scene.sceneValidationMode |
string |
“DEFAULT_SCENE_VALIDATION” |
IAORMS_SCENE_VALIDATION_MODE |
|
Debug Log Enabled |
Enable debug logs. |
debug.logEnabled |
boolean |
true |
IAORMS_DEBUG_LOG_ENABLED |
|
Debug Log each received animation data message |
Log each animation data message that is received on the grpc stream. |
debug.logEachReceivedAnimationDataMessage |
boolean |
false |
IAORMS_DEBUG_LOG_EACH_RECEIVED_ANIMATION_DATA_MESSAGE |
|
Debug Log Frame Interval |
Enable debug output of each x-th frame. |
debug.logFrameInterval |
integer |
30 |
IAORMS_DEBUG_LOG_FRAME_INTERVAL |
|
Debug Show Wheel |
Show debug wheel in rendered video stream. |
debug.showWheel |
boolean |
false |
IAORMS_DEBUG_SHOW_WHEEL |
|
Animation Source Buffer Size |
The buffer size in seconds to delay rendering. |
animationSource.bufferSize |
number |
0.1 |
IAORMS_ANIMATION_SOURCE_BUFFER_SIZE |
|
Animation Source Host |
The animation source host address. |
string |
IAORMS_ANIMATION_SOURCE_HOST |
|||
Animation Source Port |
The animation source port. |
integer |
IAORMS_ANIMATION_SOURCE_PORT |
|||
Livestream Mock Streaming Enabled |
Start a mock server to stream to the configured host and ports without RTP negotiation. |
livestream.rtpNegotiationHostMockingEnabled |
boolean |
false |
IAORMS_RTP_NEGOTIATION_HOST_MOCKING_ENABLED |
|
RTP Negotiation Host |
The RTP negotiation host address |
string |
IAORMS_RTP_NEGOTIATION_HOST |
|||
RTP Negotiation Port |
The RTP negotiation port |
integer |
IAORMS_RTP_NEGOTIATION_PORT |
|||
Livestream Host |
The host or ip where to directly send the Livestream to. |
livestream.host |
string |
“localhost” |
IAORMS_LIVESTREAM_HOST |
|
Livestream Video Port |
The video port where to directly send the Livestream to. |
livestream.videoPort |
integer |
9020 |
IAORMS_LIVESTREAM_VIDEO_PORT |
|
Livestream Video Bit Rate |
The video bit rate in bits per second used for the Livestream RTP video stream. |
livestream.videoBitRate |
integer |
32777216 |
IAORMS_LIVESTREAM_VIDEO_BIT_RATE |
|
Livestream Video I-Frame Interval |
The video iframe interval used for the Livestream RTP video stream. |
livestream.videoIframeInterval |
integer |
30 |
IAORMS_LIVESTREAM_VIDEO_IFRAME_INTERVAL |
|
Livestream Video Frame Rate |
The video frame rate in frames per second used for the Livestream RTP video stream. |
livestream.videoFrameRate |
integer |
30 |
IAORMS_LIVESTREAM_VIDEO_FRAME_RATE |
|
Livestream Audio Port |
The audio port where to directly send the Livestream to. |
livestream.audioPort |
integer |
9021 |
IAORMS_LIVESTREAM_AUDIO_PORT |
|
Livestream Audio Delay |
Shifts the audio RTP stream relative to the video RTP stream. Only positive value in seconds are supported. Audio is delayed relative to the video. |
livestream.audioDelay |
number |
0.0 |
IAORMS_LIVESTREAM_AUDIO_DELAY |
|
Livestream Audio Sample Rate |
Defines the sample rate at which the renderer accepts and streams the audio. Note that WebRTC only supports 48kHz. |
livestream.audioSampleRate |
number |
16000 |
IAORMS_LIVESTREAM_AUDIO_SAMPLE_RATE |
|
Livestream WebRTC Enable |
Enables WebRTC streaming instead of RTP (Experimental) |
livestreamWebRtc.enable |
boolean |
false |
IAORMS_LIVESTREAM_WEB_RTC_ENABLE |
|
Livestream WebRTC Media Port |
Data port for the WebRTC flux |
livestreamWebRtc.mediaPort |
number |
49200 |
IAORMS_LIVESTREAM_WEB_RTC_MEDIA_PORT |
|
Livestream WebRTC Signal Port |
Port for the WebRTC signalling server |
livestreamWebRtc.signalPort |
number |
49100 |
IAORMS_LIVESTREAM_WEB_RTC_SIGNAL_PORT |
By default the UCS app configures the microservices to download the avatar scene from NGC. However, there are also alternative methods to download resources and you can also create your own resource downloader init container as described in the Resource Downloader section.
Default Scene#
The Omniverse renderer microservice supports various types of avatar scenes. Currently they must be created either with the Avatar Configurator or derived from the template scene by following the instructions in section Avatar Customization.