Configuration options for StudioPropertiesModel instances.

This interface defines the configuration structure for Studio properties models, which manage real-time access to KOS Studio runtime properties and settings. The connection ID serves as the primary routing mechanism for Studio-specific property synchronization.

Example: Basic Usage

const studioProps = StudioPropertiesModel.instance('dev-studio')
.options({ connectionId: 'vm-development-001' })
.build();
interface StudioPropertiesOptions {
    connectionId: string;
}

Properties

Properties

connectionId: string

Studio VM connection identifier for property routing and WebSocket targeting.

This ID corresponds to an active Studio connection and determines which Studio instance provides the properties. Each Studio VM connection has unique runtime properties and configuration values.

Example

"vm-development-local-001"

Example

"studio-connection-abc123"

Example

"primary-studio-instance"