Interface: SampleAppTemplateFlags

Flags accepted by the sample-app template generator.

The CLI merges these values from the command line, config.json, and template requirements before invoking the generator script. Keeping this definition in src/ ensures the API docs stay in sync with the supported options.

Interface Definition

interface SampleAppTemplateFlags {
    appId?: string;
    appProfile?: string;
    appVersion?: string;
    fps?: number;
    framework: "react" | undefined;
    height?: number;
    nvcfApiKey?: string;
    nvcfEndpoint?: string;
    nvcfFunctionId?: string;
    signalingServer?: string;
    streamServer?: string;
    streamSource?: StreamSource;
    width?: number;
}

Properties

framework

framework: "react" | undefined

Select the generated client framework (default: TypeScript only). When set to react, the generator copies the reusable React components and emits src/main.tsx. If omitted, the project remains TypeScript-only and emits src/main.ts.

---

streamSource

optional streamSource: StreamSource

Stream source for the generated client (local, okas, or nvcf, default: local).

---

appId

optional appId: string

Omniverse application identifier used when starting OKAS sessions (default: usd-viewer).

---

appProfile

optional appProfile: string

Omniverse application profile to launch (default: default).

---

appVersion

optional appVersion: string

Omniverse application version to launch (default: 107.3.1).

---

streamServer

optional streamServer: string

OKAS streaming server base URL (default: http://localhost:8080).

---

signalingServer

optional signalingServer: string

Local signaling server host for direct streaming (default: 127.0.0.1).

---

nvcfEndpoint

optional nvcfEndpoint: string

NVCF API endpoint for cloud function invocation (required when streamSource is nvcf, default: https://grpc.nvcf.nvidia.com).

---

nvcfApiKey

optional nvcfApiKey: string

NVCF API key for cloud function authentication (required when streamSource is nvcf, default: nvapi-****).

---

nvcfFunctionId

optional nvcfFunctionId: string

NVCF function ID to invoke (required when streamSource is nvcf, default: **-**-**-**-**).

---

width

optional width: number

Remote render width (default: 1920).

---

height

optional height: number

Remote render height (default: 1080).

---

fps

optional fps: number

Target frames-per-second for the stream (default: 60).