@stinkycomputing/sesame-api-client 1.5.8 → 1.5.9

package/docs/protocol-reference.md

@@ -70,9 +70,9 @@ Per-channel property updates. Absent optional fields are left unchanged.
 | Field | Type | Description |
 |-------|------|-------------|
 | `channel_id` |  string |   |
-| `level` | optional float |   |
-| `pan` | optional float |   |
-| `plugins` | repeated AudioPluginControlRequest |   |
+| `level` | optional float |   |
+| `pan` | optional float |   |
+| `plugins` | repeated AudioPluginControlRequest |   |
 
 
 ### AudioChannelPluginStatus
@@ -110,9 +110,9 @@ Audio channel status.
 | `level` |  float |   |
 | `pan` |  float |   |
 | `vu` | repeated float |   |
-| `has_data` |  bool |   |
-| `read_errors` |  uint32 |   |
-| `plugins` | repeated AudioChannelPluginStatus |   |
+| `has_data` |  bool |   |
+| `read_errors` |  uint32 |   |
+| `plugins` | repeated AudioChannelPluginStatus |   |
 
 
 ### AudioControlRequest
@@ -121,15 +121,15 @@ Payload for DATA_TYPE_AUDIO_CONTROL frames (transport → server).
 
 The target mixer ID is NOT included here — it is resolved server-side from
 the MetadataRouter binding configured for this source track. This mirrors
-AudioMixerStatus: to build a control message, take an AudioMixerStatus,
-pick the channels you want to change, copy their `id` into `channel_id`,
-and set the desired `level`/`pan`/plugin params. Omit fields you don't
-want to change (optional fields that are absent are left unchanged).
+AudioMixerStatus: to build a control message, take an AudioMixerStatus,
+pick the channels you want to change, copy their `id` into `channel_id`,
+and set the desired `level`/`pan`/plugin params. Omit fields you don't
+want to change (optional fields that are absent are left unchanged).
 
 
-| Field | Type | Description |
-|-------|------|-------------|
-| `channels` | repeated AudioChannelControlRequest |   |
+| Field | Type | Description |
+|-------|------|-------------|
+| `channels` | repeated AudioChannelControlRequest |   |
 
 
 ### AudioMixerAddRequest
@@ -154,9 +154,9 @@ Audio mixer channel configuration.
 | `source_id` |  string |   |
 | `channel_type` |  AudioMixerChannelType |   |
 | `source_channels` | repeated uint32 |   |
-| `level` |  float |   |
-| `pan` |  float |   |
-| `plugins` | repeated AudioPlugin |   |
+| `level` |  float |   |
+| `pan` |  float |   |
+| `plugins` | repeated AudioPlugin |   |
 
 
 ### AudioMixerConfig
@@ -166,9 +166,9 @@ Audio mixer configuration.
 
 | Field | Type | Description |
 |-------|------|-------------|
-| `channels` | repeated AudioMixerChannel |   |
-| `output_type` |  AudioMixerChannelType |   |
-| `order` |  uint32 |   |
+| `channels` | repeated AudioMixerChannel |   |
+| `output_type` |  AudioMixerChannelType |   |
+| `order` |  uint32 |   |
 
 
 ### AudioMixerRemoveRequest
@@ -189,9 +189,9 @@ Audio mixer status.
 | Field | Type | Description |
 |-------|------|-------------|
 | `id` |  string |   |
-| `output_type` |  AudioMixerChannelType |   |
-| `vu` | repeated float |   |
-| `channels` | repeated AudioChannelStatus |   |
+| `output_type` |  AudioMixerChannelType |   |
+| `vu` | repeated float |   |
+| `channels` | repeated AudioChannelStatus |   |
 
 
 ### AudioMixerUpdateRequest
@@ -311,11 +311,12 @@ Each item represents a single command to execute at a specific time offset.
 | `update_source_transport` |  sesame.v1.sources.SourceTransportCommand |   |
 | `load_playlist` |  sesame.v1.sources.LoadPlaylistRequest |   |
 | `eject_playlist` |  sesame.v1.sources.EjectPlaylistRequest |   |
-| `callback` |  sesame.v1.common.Callback |   |
-| `set_source_metadata` |  sesame.v1.sources.SourceMetadataSetRequest |   |
-| `set_metadata_bindings` |  SetMetadataBindingsRequest |   |
-| `transaction_id` | optional uint32 |   |
-| `transaction_deps` | repeated uint32 |   |
+| `callback` |  sesame.v1.common.Callback |   |
+| `set_source_metadata` |  sesame.v1.sources.SourceMetadataSetRequest |   |
+| `set_metadata_bindings` |  SetMetadataBindingsRequest |   |
+| `take_playlist` |  sesame.v1.sources.TakePlaylistRequest |   |
+| `transaction_id` | optional uint32 |   |
+| `transaction_deps` | repeated uint32 |   |
 
 
 ### MetadataBinding
@@ -877,7 +878,7 @@ Encoder preset.
 | 3 | `ENCODER_PRESET_HIGH_QUALITY` | High-quality tune |
 
 
-### OutputType
+### OutputType
 
 Type of output.
 
@@ -923,10 +924,10 @@ Decklink output configuration.
 
 | Field | Type | Description |
 |-------|------|-------------|
-| `encoder` |  EncoderConfig |   |
-| `url` |  string |   |
-| `broadcast` |  string |   |
-| `key` |  string |   |
+| `encoder` |  EncoderConfig |   |
+| `url` |  string |   |
+| `broadcast` |  string |   |
+| `key` |  string |   |
 | `metadata_tracks` | repeated string |   |
 
 
@@ -937,10 +938,10 @@ Decklink output configuration.
 
 | Field | Type | Description |
 |-------|------|-------------|
-| `encoder` |  EncoderConfig |   |
-| `filename` |  string |   |
-| `size_gb` |  uint32 |   |
-| `group_id` |  string |   |
+| `encoder` |  EncoderConfig |   |
+| `filename` |  string |   |
+| `size_gb` |  uint32 |   |
+| `group_id` |  string |   |
 | `recorder_type` |  RecorderType |   |
 
 
@@ -949,10 +950,10 @@ Decklink output configuration.
 
 
 
-| Field | Type | Description |
-|-------|------|-------------|
-| `url` |  string |   |
-| `encoder` |  EncoderConfig |   |
+| Field | Type | Description |
+|-------|------|-------------|
+| `url` |  string |   |
+| `encoder` |  EncoderConfig |   |
 
 
 ### EncodedSuperSlowMoRecorderOutputConfig
@@ -978,14 +979,14 @@ Type-specific output payloads
 -----------------------------------------------------------------------------
 
 
-| Field | Type | Description |
-|-------|------|-------------|
-| `channel` |  string |   |
-| `encoder` |  EncoderConfig |   |
-| `metadata_tracks` | repeated string |   |
-
-
-### EncoderConfig
+| Field | Type | Description |
+|-------|------|-------------|
+| `channel` |  string |   |
+| `encoder` |  EncoderConfig |   |
+| `metadata_tracks` | repeated string |   |
+
+
+### EncoderConfig
 
 Encoded output configuration (WebSocket, SRT, MoQ).
 
@@ -998,7 +999,7 @@ Encoded output configuration (WebSocket, SRT, MoQ).
 | `keyframe_interval` |  uint32 |   |
 | `width` |  uint32 |   |
 | `height` |  uint32 |   |
-| `fps` |  float |   |
+| `fps` |  float |   |
 
 
 ### KeyframeRequest
@@ -1053,9 +1054,9 @@ Output status information.
 | `type` |  OutputType |   |
 | `state` |  sesame.v1.common.ConnectionState |   |
 | `msg` | optional string |   |
-| `url` |  string |   |
-| `buffer_size` |  uint32 |   |
-| `srt_stats` | optional sesame.v1.status.SRTSendStatistics |   |
+| `url` |  string |   |
+| `buffer_size` |  uint32 |   |
+| `srt_stats` | optional sesame.v1.status.SRTSendStatistics |   |
 
 
 ### OutputUpdateRequest
@@ -1503,10 +1504,10 @@ Source transport command type.
 | 10 | `SOURCE_TRANSPORT_CMD_POST_ROLL` | Post-roll |
 | 11 | `SOURCE_TRANSPORT_CMD_PRE_ROLL` | Pre-roll |
 | 12 | `SOURCE_TRANSPORT_CMD_NEXT` | Next item |
-| 13 | `SOURCE_TRANSPORT_CMD_SKIP_NEXT` | Skip to next |
-| 14 | `SOURCE_TRANSPORT_CMD_TRANSITIONS_DISABLED` | Disable transitions |
-| 15 | `SOURCE_TRANSPORT_CMD_SET_SCRUBBING` | Set scrubbing mode |
-| 16 | `SOURCE_TRANSPORT_CMD_SET_END_NOTIFICATION` | Set near-end callback threshold (int64 µs before end; 0 = disabled) |
+| 13 | `SOURCE_TRANSPORT_CMD_SKIP_NEXT` | Skip to next |
+| 14 | `SOURCE_TRANSPORT_CMD_TRANSITIONS_DISABLED` | Disable transitions |
+| 15 | `SOURCE_TRANSPORT_CMD_SET_SCRUBBING` | Set scrubbing mode |
+| 16 | `SOURCE_TRANSPORT_CMD_SET_END_NOTIFICATION` | Set near-end callback threshold (int64 µs before end; 0 = disabled) |
 
 
 ### SourceTransportState
@@ -1799,6 +1800,27 @@ Request to update an existing source.
 | `device_name` |  string |   |
 
 
+### TakePlaylistRequest
+
+Request to take directly to a recorder playlist.
+A single clip is represented as a playlist with one item. The request-level
+transition_time_us is the outer transition from the current source state into
+this playlist; each PlaylistItem.transition_time_us remains the transition
+between items inside the playlist.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `source_id` |  string |   |
+| `user_playlist_id` |  string |   |
+| `items` | repeated sesame.v1.recorder.PlaylistItem |   |
+| `start_time_us` | optional int64 |   |
+| `start_index` | optional int64 |   |
+| `material_pos_us` | optional int64 |   |
+| `transition_time_us` | optional int64 |   |
+| `playback_speed` | optional float |   |
+
+
 ### TransportControlRequest
 
 Payload for DATA_TYPE_TRANSPORT_CONTROL frames (transport → server).
@@ -2065,9 +2087,9 @@ Overall system status.
 | `render_status_cpu` |  FrameTiming |   |
 | `sources` | repeated sesame.v1.sources.SourceStatus |   |
 | `compositions` | repeated CompositorStatus |   |
-| `audio_mixes` | repeated sesame.v1.audio.AudioMixerStatus |   |
-| `outputs` | repeated sesame.v1.outputs.OutputStatus |   |
-| `recorders` | repeated sesame.v1.recorder.RecorderStatus |   |
+| `audio_mixes` | repeated sesame.v1.audio.AudioMixerStatus |   |
+| `outputs` | repeated sesame.v1.outputs.OutputStatus |   |
+| `recorders` | repeated sesame.v1.recorder.RecorderStatus |   |
 
 
 ### SubscriptionRequest
@@ -2103,10 +2125,10 @@ Transport event (source playback state change).
 | `clip_id` |  uint64 |   |
 | `clip_position_us` |  int64 |   |
 | `clip_duration_us` |  int64 |   |
-| `preroll` |  uint32 |   |
-| `postroll` |  uint32 |   |
-| `metadata` |  sesame.v1.common.TransportMetadata |   |
-| `near_end` |  bool | True in the single event fired when the end-notification threshold is crossed |
+| `preroll` |  uint32 |   |
+| `postroll` |  uint32 |   |
+| `metadata` |  sesame.v1.common.TransportMetadata |   |
+| `near_end` |  bool | True in the single event fired when the end-notification threshold is crossed |
 
 
 ---
@@ -2324,14 +2346,14 @@ Properties are set via `PropertySetRequest` or animated via `PropertyAnimateRequ
 
 The server disambiguates these two cases by whether `address` contains the `::` delimiter: if it does, the address is split into channel ID and plugin ID, and `property` is parsed as a numeric param ID; otherwise the full `address` string is used as the channel ID for a named channel property.
 
-| Property | Type | Description |
-|----------|------|-------------|
-| `level` | float | Channel level (0-1) |
-| `pan` | float | Pan position (-1 to 1) |
-| `mute` | bool | Mute channel |
-| `source_channels` | vec4 | Source channel routing |
-| `source_id` | string | Source ID |
-| `<param_id>` | float | Plugin parameter — `address` must be `channel_id::plugin_id`, `property` is the numeric param ID |
+| Property | Type | Description |
+|----------|------|-------------|
+| `level` | float | Channel level (0-1) |
+| `pan` | float | Pan position (-1 to 1) |
+| `mute` | bool | Mute channel |
+| `source_channels` | vec4 | Source channel routing |
+| `source_id` | string | Source ID |
+| `<param_id>` | float | Plugin parameter — `address` must be `channel_id::plugin_id`, `property` is the numeric param ID |
 
 **Level animation:** use `propertyAnimate` with `ANIM_MODE_STATE_FROM` to fade from the current level. For an instant cut (no transition), `propertySet` is preferred — a zero-duration `propertyAnimate` is clamped to 1 ms by the server rather than producing an instant cut.
 
@@ -2357,11 +2379,11 @@ client.addSubscription(sesame.v1.common.EventTopic.EVENT_TOPIC_TRANSPORT, callba
 client.addSubscription(sesame.v1.common.EventTopic.EVENT_TOPIC_JOB, callback);
 ```
 
-| Topic | Event type | When fired |
-|-------|-----------|------------|
-| `EVENT_TOPIC_ERROR` | ErrorEvent | Engine error |
-| `EVENT_TOPIC_TRANSPORT` | TransportEvent | Source playback state change; also fired once per playback run with `near_end=true` when the end-notification threshold is crossed |
-| `EVENT_TOPIC_CALLBACK` | Callback | Client callback command echoed |
+| Topic | Event type | When fired |
+|-------|-----------|------------|
+| `EVENT_TOPIC_ERROR` | ErrorEvent | Engine error |
+| `EVENT_TOPIC_TRANSPORT` | TransportEvent | Source playback state change; also fired once per playback run with `near_end=true` when the end-notification threshold is crossed |
+| `EVENT_TOPIC_CALLBACK` | Callback | Client callback command echoed |
 | `EVENT_TOPIC_JOB` | Job | Job lifecycle change + progress (~2 Hz) |
 | `EVENT_TOPIC_RECORDER` | RecorderEvent | Recorder online/offline |
 

package/package.json

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