NorskSettings interface

Top level Norsk configuration

Signature:

export interface NorskSettings

Properties

Property Type Description

Property	Type	Description
grpc?	Partial<grpc.ClientOptions>	(Optional)
onAmdMA35DLoad?	(load: AmdMA35DLoad) ⇒ void	(Optional)
onAttemptingToConnect?	() ⇒ void	(Optional)
onConnecting?	() ⇒ void	(Optional)
onCurrentLoad?	(load: CurrentLoad) ⇒ void	(Optional)
onFailedToConnect?	() ⇒ void	(Optional)
onHello?	(version: Version) ⇒ void	(Optional)
onIrohEndpointEvent?	(event: IrohEndpointEvent) ⇒ void	(Optional) A connection event on the shared iroh endpoint (peer connected / rejected by the allow-list / disconnected). remoteNodeId is the peer’s TLS-verified public key (64-char hex).
onLicenseChallenge?	(challenge: Uint8Array) ⇒ Promise<LicenseChallengeResponse> \| LicenseChallengeResponse	(Optional) Licensing V2: respond to the engine’s license challenge. Engines holding a per-product (V2) license send a challenge nonce in their hello and refuse to create media nodes until a product (e.g. Studio) has answered it with its certs and signatures. V1-licensed engines never issue a challenge, so plain SDK applications can ignore this setting entirely.
onLicenseChallengeFailed?	(message: string) ⇒ void	(Optional) Licensing V2: called if the license handshake fails (or no responder was supplied). connect() still resolves; `norsk.licenseHandshake` carries the same outcome. Media node creation will be refused by the engine.
onLicenseEvent?	(message: string, running: boolean, fullEvent: LicenseEvent) ⇒ void	(Optional) Manually handle license events, such as missing/invalid licenses and sandbox timeout. (Logs messages to console by default.)
onLogEvent?	(log: Log) ⇒ void	(Optional)
onNotification?	(notification: Notification) ⇒ void	(Optional)
onNotificationCleared?	(cleared: NotificationCleared) ⇒ void	(Optional) A previously-raised notification has been retracted (condition cleared)
onReady?	() ⇒ void	(Optional)
onShutdown?	() ⇒ void	(Optional) Code to execute if the Norsk node is shutdown - by default it logs and nothing else
url?	string	(Optional) Callback URL to listen on for gRPC session with Norsk Media Defaults to $NORSK_HOST:$NORSK_PORT if the environment variables are set where NORSK_HOST defaults to "127.0.0.1" and NORSK_PORT to "6790" (so "127.0.0.1:6790" if neither variable is set)

grpc?

Partial<grpc.ClientOptions>

(Optional)

onAmdMA35DLoad?

(load: AmdMA35DLoad) ⇒ void

(Optional)

onAttemptingToConnect?

() ⇒ void

(Optional)

onConnecting?

() ⇒ void

(Optional)

onCurrentLoad?

(load: CurrentLoad) ⇒ void

(Optional)

onFailedToConnect?

() ⇒ void

(Optional)

onHello?

(version: Version) ⇒ void

(Optional)

onIrohEndpointEvent?

(event: IrohEndpointEvent) ⇒ void

(Optional) A connection event on the shared iroh endpoint (peer connected / rejected by the allow-list / disconnected). remoteNodeId is the peer’s TLS-verified public key (64-char hex).

onLicenseChallenge?

(challenge: Uint8Array) ⇒ Promise<LicenseChallengeResponse> | LicenseChallengeResponse

(Optional) Licensing V2: respond to the engine’s license challenge. Engines holding a per-product (V2) license send a challenge nonce in their hello and refuse to create media nodes until a product (e.g. Studio) has answered it with its certs and signatures. V1-licensed engines never issue a challenge, so plain SDK applications can ignore this setting entirely.

onLicenseChallengeFailed?

(message: string) ⇒ void

(Optional) Licensing V2: called if the license handshake fails (or no responder was supplied). connect() still resolves; norsk.licenseHandshake carries the same outcome. Media node creation will be refused by the engine.

onLicenseEvent?

(message: string, running: boolean, fullEvent: LicenseEvent) ⇒ void

(Optional) Manually handle license events, such as missing/invalid licenses and sandbox timeout. (Logs messages to console by default.)

onLogEvent?

(log: Log) ⇒ void

(Optional)

onNotification?

(notification: Notification) ⇒ void

(Optional)

onNotificationCleared?

(cleared: NotificationCleared) ⇒ void

(Optional) A previously-raised notification has been retracted (condition cleared)

onReady?

() ⇒ void

(Optional)

onShutdown?

() ⇒ void

(Optional) Code to execute if the Norsk node is shutdown - by default it logs and nothing else

url?

string

(Optional) Callback URL to listen on for gRPC session with Norsk Media Defaults to $NORSK_HOST:$NORSK_PORT if the environment variables are set where NORSK_HOST defaults to "127.0.0.1" and NORSK_PORT to "6790" (so "127.0.0.1:6790" if neither variable is set)