@stinkycomputing/sesame-api-client 1.6.0 → 1.8.0

package/docs/protocol-reference.md

@@ -920,16 +920,61 @@ Timing information for clips.
 
 
 
-### EncoderPreset
+### EncoderChromaFormat
 
-Encoder preset.
+Encoder chroma subsampling.
 
 | Value | Name | Description |
 |-------|------|-------------|
-| 0 | `ENCODER_PRESET_UNSPECIFIED` | Unspecified (invalid) |
-| 1 | `ENCODER_PRESET_LOW_LATENCY` | Low-latency tune |
-| 2 | `ENCODER_PRESET_LOW_LATENCY_IDR_ONLY` | Low-latency with IDR-only GOP |
-| 3 | `ENCODER_PRESET_HIGH_QUALITY` | High-quality tune |
+| 0 | `ENCODER_CHROMA_FORMAT_420` | 4:2:0 (default) |
+| 1 | `ENCODER_CHROMA_FORMAT_444` | 4:4:4 (H264/HEVC only) |
+
+
+### EncoderMultipass
+
+Encoder multipass mode.
+
+| Value | Name | Description |
+|-------|------|-------------|
+| 0 | `ENCODER_MULTIPASS_DISABLED` | Single pass |
+| 1 | `ENCODER_MULTIPASS_QUARTER_RESOLUTION` | First pass at quarter resolution |
+| 2 | `ENCODER_MULTIPASS_FULL_RESOLUTION` | First pass at full resolution |
+
+
+### EncoderProfile
+
+Encoder profile. Codec-specific; invalid combinations fall back to the codec default.
+
+| Value | Name | Description |
+|-------|------|-------------|
+| 0 | `ENCODER_PROFILE_AUTO` | Codec default (H264/AV1: baseline/main, HEVC: main) |
+| 1 | `ENCODER_PROFILE_BASELINE` | H264 baseline |
+| 2 | `ENCODER_PROFILE_MAIN` | Main profile |
+| 3 | `ENCODER_PROFILE_MAIN10` | HEVC main10 |
+| 4 | `ENCODER_PROFILE_HIGH` | H264 high |
+
+
+### EncoderRateControl
+
+Encoder rate control mode.
+
+| Value | Name | Description |
+|-------|------|-------------|
+| 0 | `ENCODER_RATE_CONTROL_UNSPECIFIED` | Unspecified: treated as CBR |
+| 1 | `ENCODER_RATE_CONTROL_CBR` | Constant bitrate |
+| 2 | `ENCODER_RATE_CONTROL_VBR` | Variable bitrate |
+
+
+### EncoderTuning
+
+Encoder tuning (NVENC tuning info).
+
+| Value | Name | Description |
+|-------|------|-------------|
+| 0 | `ENCODER_TUNING_UNSPECIFIED` | Unspecified: treated as ultra low latency |
+| 1 | `ENCODER_TUNING_ULTRA_LOW_LATENCY` | Ultra low latency tune |
+| 2 | `ENCODER_TUNING_LOW_LATENCY` | Low latency tune |
+| 3 | `ENCODER_TUNING_HIGH_QUALITY` | High quality tune |
 
 
 ### EncoderType
@@ -969,6 +1014,17 @@ Recorder type.
 | 2 | `RECORDER_TYPE_CLIPS` | Clip recorder; not continuously recording, only ingested frames are persisted |
 
 
+### TimecodeMode
+
+Timecode embedding mode for encoded streams (SEI/metadata OBU).
+
+| Value | Name | Description |
+|-------|------|-------------|
+| 0 | `TIMECODE_MODE_UNSPECIFIED` | No timecode embedded |
+| 1 | `TIMECODE_MODE_WALLCLOCK` | Composite-time wallclock (identical across outputs of the same frame) |
+| 2 | `TIMECODE_MODE_SOURCE` | Timecode published by the source in timecode_source_id (e.g. Decklink RP188 or SDI ingress wallclock) |
+
+
 ### DecklinkOutputConfig
 
 Decklink output configuration.
@@ -979,6 +1035,8 @@ Decklink output configuration.
 | `device_index` |  uint32 | Decklink device index |
 | `video_format` |  sesame.v1.common.VideoFormat | Video format |
 | `key_and_fill` |  bool | Key and fill mode |
+| `timecode_mode` |  TimecodeMode | RP188 timecode embedding mode for SDI output |
+| `timecode_source_id` |  string | Source ID providing timecode when timecode_mode == SOURCE |
 
 
 ### EncodedMoqOutputConfig
@@ -1070,12 +1128,14 @@ Encoded output configuration (WebSocket, SRT, MoQ).
 | Field | Type | Description |
 |-------|------|-------------|
 | `codec` |  sesame.v1.common.CodecType | Encoder codec |
-| `preset` |  EncoderPreset | Encoder preset |
 | `bitrate_kbps` |  uint32 | Bitrate in kbps |
 | `keyframe_interval` |  uint32 | GOP length in frames (0 = codec/preset default) |
 | `width` |  uint32 | Video width |
 | `height` |  uint32 | Video height |
 | `fps` |  float | Video framerate |
+| `timecode_mode` |  TimecodeMode | Timecode embedding mode |
+| `timecode_source_id` |  string | Source ID providing timecode when timecode_mode == SOURCE |
+| `settings` |  EncoderSettings | Explicit encoder settings |
 
 
 ### EncoderRemoveRequest
@@ -1088,6 +1148,31 @@ Request to remove a shared encoder resource.
 | `id` |  string | Encoder ID to remove |
 
 
+### EncoderSettings
+
+Explicit encoder settings. The client always sends the full set; named presets
+exist only client-side as bundles of these values.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `tuning` |  EncoderTuning | NVENC tuning info |
+| `effort` |  uint32 | Speed/quality effort 1-7 (1 = fastest, 7 = best quality, 0 = 4); maps to NVENC presets P1-P7 |
+| `rate_control` |  EncoderRateControl | Rate control mode |
+| `max_bitrate_kbps` |  uint32 | Max bitrate in kbps (0 = auto: bitrate for CBR, 2x bitrate for VBR) |
+| `profile` |  EncoderProfile | Codec profile |
+| `bframes` |  uint32 | Consecutive B frames between references (0 = none) |
+| `idr_only` |  bool | Encode every frame as an IDR (overrides GOP and bframes) |
+| `spatial_aq` |  bool | Spatial adaptive quantization |
+| `multipass` |  EncoderMultipass | Multipass encoding mode |
+| `lookahead_depth` |  uint32 | Rate-control lookahead in frames (0 = off, adds latency) |
+| `zero_reorder_delay` |  bool | Emit frames in encode order (no reordering delay) |
+| `bit_depth` |  uint32 | Output bit depth: 0 or 8 = 8-bit, 10 = 10-bit (HEVC/AV1 only) |
+| `chroma_format` |  EncoderChromaFormat | Chroma subsampling |
+| `output_aud` |  bool | Emit access unit delimiters (H264/HEVC) |
+| `level` |  string | Codec level as "major.minor" (empty or "auto" = codec default, e.g. "5.1") |
+
+
 ### EncoderStatus
 
 Encoder status information.
@@ -1100,6 +1185,7 @@ Encoder status information.
 | `state` |  sesame.v1.common.ConnectionState | Connection/lifecycle state |
 | `msg` | optional string | Error message (typically when state == ERROR) |
 | `composition_id` |  string | Compositor ID being encoded |
+| `dropped_frames` |  uint32 | Frames skipped because the encoder fell behind the renderer |
 
 
 ### EncoderUpdateRequest
@@ -1532,6 +1618,17 @@ that have a binding from this node+metadataId.
 | `data_type` |  sesame.v1.wire.DataType | Wire data type (default DATA_TYPE_JSON for backward compat) |
 
 
+### SystemOperationRequest
+
+System maintenance operations. One oneof entry per operation keeps the
+single RPC extensible.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `reset_frame_drops` |  sesame.v1.common.Empty | Resets the engine's dropped-frame counter shown in status. |
+
+
 ### SesameAPIService
 
 Main Sesame API service.
@@ -1551,6 +1648,7 @@ Main Sesame API service.
 | `RequestKeyframe` | .sesame.v1.outputs.KeyframeRequest | .sesame.v1.common.Empty | Request keyframe from encoder. |
 | `RequestIODeviceList` | .sesame.v1.common.Empty | .sesame.v1.status.IODeviceListResponse | Get list of I/O devices. |
 | `PublishMetadata` | PublishMetadataRequest | .sesame.v1.common.Empty | Publish a JSON metadata payload to all output transports bound to this node+metadataId. Used by apps (e.g. Snigel) to emit state that should be forwarded on MoQ/WebSocket outputs. |
+| `RequestSystemOperation` | SystemOperationRequest | .sesame.v1.common.Empty | System maintenance operations (counter resets and similar). |
 
 
 ---
@@ -1599,6 +1697,17 @@ Signal generator audio program.
 | 3 | `SIGNAL_GENERATOR_AUDIO_MODE_SILENCE` | Silence |
 
 
+### SignalGeneratorTimecodeMode
+
+Signal generator timecode program.
+
+| Value | Name | Description |
+|-------|------|-------------|
+| 0 | `SIGNAL_GENERATOR_TIMECODE_MODE_NONE` | No timecode published |
+| 1 | `SIGNAL_GENERATOR_TIMECODE_MODE_FREE_RUN` | Deterministic counter from timecode_start_frame; freeze() freezes it |
+| 2 | `SIGNAL_GENERATOR_TIMECODE_MODE_TIME_OF_DAY` | System clock time of day |
+
+
 ### SignalGeneratorVideoPattern
 
 Signal generator video test pattern.
@@ -1785,6 +1894,8 @@ Signal generator source configuration.
 | `freeze` |  bool | Freeze the moving lip-sync overlay at its sync point (static test pattern) |
 | `video_pattern` |  SignalGeneratorVideoPattern | Video test pattern |
 | `audio_mode` |  SignalGeneratorAudioMode | Audio program |
+| `timecode_mode` |  SignalGeneratorTimecodeMode | Timecode program |
+| `timecode_start_frame` |  uint32 | FREE_RUN start value (frames since midnight at engine rate) |
 
 
 ### SourceAddRequest
@@ -2122,6 +2233,9 @@ Provides overall system health and performance metrics.
 | `gpu_decoder_utilization` |  uint32 | NVDEC utilization (0-100%) |
 | `gpu_name` |  string | GPU model name |
 | `vma_bytes` |  uint64 | Vulkan Memory Allocator total bytes |
+| `version` |  string | Server version string |
+| `nvenc_sessions` |  uint32 | Open NVENC encoder sessions |
+| `nvdec_sessions` |  uint32 | Open NVDEC decoder sessions |
 
 
 ---
@@ -2437,6 +2551,7 @@ Properties are set via `PropertySetRequest` or animated via `PropertyAnimateRequ
 |----------|------|-------------|
 | `source` | string | Source ID to display |
 | `audio_meter_source` | string | Pipe-delimited mixer IDs for audio meters |
+| `audio_meter_count` | float | Number of audio meters to display (0 = automatic) |
 | `show_audio_meter` | bool | Show audio meters |
 | `show_border` | bool | Show border |
 | `show_label_bg` | bool | Show label background |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stinkycomputing/sesame-api-client",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "description": "Sesame API client library with protobuf definitions and command list helpers",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",