@stinkycomputing/sesame-api-client 1.4.1-beta.13 → 1.4.1-beta.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/protocol-reference.md +481 -483
- package/package.json +1 -1
|
@@ -58,8 +58,8 @@ Request to add a channel to an audio mixer.
|
|
|
58
58
|
|
|
59
59
|
| Field | Type | Description |
|
|
60
60
|
|-------|------|-------------|
|
|
61
|
-
| `mixer_id` | string |
|
|
62
|
-
| `channel_config` | AudioMixerChannel |
|
|
61
|
+
| `mixer_id` | string | |
|
|
62
|
+
| `channel_config` | AudioMixerChannel | |
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
### AudioChannelPluginStatus
|
|
@@ -69,9 +69,9 @@ Audio channel plugin status.
|
|
|
69
69
|
|
|
70
70
|
| Field | Type | Description |
|
|
71
71
|
|-------|------|-------------|
|
|
72
|
-
| `id` | string |
|
|
73
|
-
| `type` | string |
|
|
74
|
-
| `params` | repeated AudioPluginParamStatus |
|
|
72
|
+
| `id` | string | |
|
|
73
|
+
| `type` | string | |
|
|
74
|
+
| `params` | repeated AudioPluginParamStatus | |
|
|
75
75
|
|
|
76
76
|
|
|
77
77
|
### AudioChannelRemoveRequest
|
|
@@ -81,8 +81,8 @@ Request to remove a channel from an audio mixer.
|
|
|
81
81
|
|
|
82
82
|
| Field | Type | Description |
|
|
83
83
|
|-------|------|-------------|
|
|
84
|
-
| `mixer_id` | string |
|
|
85
|
-
| `channel_id` | string |
|
|
84
|
+
| `mixer_id` | string | |
|
|
85
|
+
| `channel_id` | string | |
|
|
86
86
|
|
|
87
87
|
|
|
88
88
|
### AudioChannelStatus
|
|
@@ -92,14 +92,14 @@ Audio channel status.
|
|
|
92
92
|
|
|
93
93
|
| Field | Type | Description |
|
|
94
94
|
|-------|------|-------------|
|
|
95
|
-
| `id` | string |
|
|
96
|
-
| `output_type` | AudioMixerChannelType |
|
|
97
|
-
| `level` | float |
|
|
98
|
-
| `pan` | float |
|
|
99
|
-
| `vu` | repeated float |
|
|
100
|
-
| `has_data` | bool |
|
|
101
|
-
| `read_errors` | uint32 |
|
|
102
|
-
| `plugins` | repeated AudioChannelPluginStatus |
|
|
95
|
+
| `id` | string | |
|
|
96
|
+
| `output_type` | AudioMixerChannelType | |
|
|
97
|
+
| `level` | float | |
|
|
98
|
+
| `pan` | float | |
|
|
99
|
+
| `vu` | repeated float | |
|
|
100
|
+
| `has_data` | bool | |
|
|
101
|
+
| `read_errors` | uint32 | |
|
|
102
|
+
| `plugins` | repeated AudioChannelPluginStatus | |
|
|
103
103
|
|
|
104
104
|
|
|
105
105
|
### AudioMixerAddRequest
|
|
@@ -109,8 +109,8 @@ Request to add a new audio mixer.
|
|
|
109
109
|
|
|
110
110
|
| Field | Type | Description |
|
|
111
111
|
|-------|------|-------------|
|
|
112
|
-
| `id` | string |
|
|
113
|
-
| `config` | AudioMixerConfig |
|
|
112
|
+
| `id` | string | |
|
|
113
|
+
| `config` | AudioMixerConfig | |
|
|
114
114
|
|
|
115
115
|
|
|
116
116
|
### AudioMixerChannel
|
|
@@ -120,13 +120,13 @@ Audio mixer channel configuration.
|
|
|
120
120
|
|
|
121
121
|
| Field | Type | Description |
|
|
122
122
|
|-------|------|-------------|
|
|
123
|
-
| `id` | string |
|
|
124
|
-
| `source_id` | string |
|
|
125
|
-
| `channel_type` | AudioMixerChannelType |
|
|
126
|
-
| `source_channels` | repeated uint32 |
|
|
127
|
-
| `level` | float |
|
|
128
|
-
| `pan` | float |
|
|
129
|
-
| `plugins` | repeated AudioPlugin |
|
|
123
|
+
| `id` | string | |
|
|
124
|
+
| `source_id` | string | |
|
|
125
|
+
| `channel_type` | AudioMixerChannelType | |
|
|
126
|
+
| `source_channels` | repeated uint32 | |
|
|
127
|
+
| `level` | float | |
|
|
128
|
+
| `pan` | float | |
|
|
129
|
+
| `plugins` | repeated AudioPlugin | |
|
|
130
130
|
|
|
131
131
|
|
|
132
132
|
### AudioMixerConfig
|
|
@@ -136,9 +136,9 @@ Audio mixer configuration.
|
|
|
136
136
|
|
|
137
137
|
| Field | Type | Description |
|
|
138
138
|
|-------|------|-------------|
|
|
139
|
-
| `channels` | repeated AudioMixerChannel |
|
|
140
|
-
| `output_type` | AudioMixerChannelType |
|
|
141
|
-
| `order` | uint32 |
|
|
139
|
+
| `channels` | repeated AudioMixerChannel | |
|
|
140
|
+
| `output_type` | AudioMixerChannelType | |
|
|
141
|
+
| `order` | uint32 | |
|
|
142
142
|
|
|
143
143
|
|
|
144
144
|
### AudioMixerRemoveRequest
|
|
@@ -148,7 +148,7 @@ Request to remove an audio mixer.
|
|
|
148
148
|
|
|
149
149
|
| Field | Type | Description |
|
|
150
150
|
|-------|------|-------------|
|
|
151
|
-
| `id` | string |
|
|
151
|
+
| `id` | string | |
|
|
152
152
|
|
|
153
153
|
|
|
154
154
|
### AudioMixerStatus
|
|
@@ -158,10 +158,10 @@ Audio mixer status.
|
|
|
158
158
|
|
|
159
159
|
| Field | Type | Description |
|
|
160
160
|
|-------|------|-------------|
|
|
161
|
-
| `id` | string |
|
|
162
|
-
| `output_type` | AudioMixerChannelType |
|
|
163
|
-
| `vu` | repeated float |
|
|
164
|
-
| `channels` | repeated AudioChannelStatus |
|
|
161
|
+
| `id` | string | |
|
|
162
|
+
| `output_type` | AudioMixerChannelType | |
|
|
163
|
+
| `vu` | repeated float | |
|
|
164
|
+
| `channels` | repeated AudioChannelStatus | |
|
|
165
165
|
|
|
166
166
|
|
|
167
167
|
### AudioMixerUpdateRequest
|
|
@@ -171,8 +171,8 @@ Request to update an existing audio mixer.
|
|
|
171
171
|
|
|
172
172
|
| Field | Type | Description |
|
|
173
173
|
|-------|------|-------------|
|
|
174
|
-
| `id` | string |
|
|
175
|
-
| `config` | AudioMixerConfig |
|
|
174
|
+
| `id` | string | |
|
|
175
|
+
| `config` | AudioMixerConfig | |
|
|
176
176
|
|
|
177
177
|
|
|
178
178
|
### AudioPlugin
|
|
@@ -182,10 +182,10 @@ Audio plugin instance.
|
|
|
182
182
|
|
|
183
183
|
| Field | Type | Description |
|
|
184
184
|
|-------|------|-------------|
|
|
185
|
-
| `id` | string |
|
|
186
|
-
| `type` | string |
|
|
187
|
-
| `params` | repeated AudioPluginParam |
|
|
188
|
-
| `aux_input_mix_ids` | repeated string |
|
|
185
|
+
| `id` | string | |
|
|
186
|
+
| `type` | string | |
|
|
187
|
+
| `params` | repeated AudioPluginParam | |
|
|
188
|
+
| `aux_input_mix_ids` | repeated string | |
|
|
189
189
|
|
|
190
190
|
|
|
191
191
|
### AudioPluginParam
|
|
@@ -195,8 +195,8 @@ Audio plugin parameter.
|
|
|
195
195
|
|
|
196
196
|
| Field | Type | Description |
|
|
197
197
|
|-------|------|-------------|
|
|
198
|
-
| `id` | uint32 |
|
|
199
|
-
| `float_value` | float |
|
|
198
|
+
| `id` | uint32 | |
|
|
199
|
+
| `float_value` | float | |
|
|
200
200
|
|
|
201
201
|
|
|
202
202
|
### AudioPluginParamStatus
|
|
@@ -206,10 +206,10 @@ Audio plugin parameter status (with display info).
|
|
|
206
206
|
|
|
207
207
|
| Field | Type | Description |
|
|
208
208
|
|-------|------|-------------|
|
|
209
|
-
| `id` | uint32 |
|
|
210
|
-
| `float_value` | float |
|
|
211
|
-
| `label` | string |
|
|
212
|
-
| `display_value` | string |
|
|
209
|
+
| `id` | uint32 | |
|
|
210
|
+
| `float_value` | float | |
|
|
211
|
+
| `label` | string | |
|
|
212
|
+
| `display_value` | string | |
|
|
213
213
|
|
|
214
214
|
|
|
215
215
|
---
|
|
@@ -237,7 +237,7 @@ A list of commands to execute in sequence.
|
|
|
237
237
|
|
|
238
238
|
| Field | Type | Description |
|
|
239
239
|
|-------|------|-------------|
|
|
240
|
-
| `command_list` | repeated CommandListItem |
|
|
240
|
+
| `command_list` | repeated CommandListItem | |
|
|
241
241
|
|
|
242
242
|
|
|
243
243
|
### CommandListItem
|
|
@@ -248,32 +248,32 @@ Each item represents a single command to execute at a specific time offset.
|
|
|
248
248
|
|
|
249
249
|
| Field | Type | Description |
|
|
250
250
|
|-------|------|-------------|
|
|
251
|
-
| `time_offset_us` | int64 |
|
|
252
|
-
| `add_source` | sesame.v1.sources.SourceAddRequest |
|
|
253
|
-
| `update_source` | sesame.v1.sources.SourceUpdateRequest |
|
|
254
|
-
| `remove_source` | sesame.v1.sources.SourceRemoveRequest |
|
|
255
|
-
| `add_output` | sesame.v1.outputs.OutputAddRequest |
|
|
256
|
-
| `update_output` | sesame.v1.outputs.OutputUpdateRequest |
|
|
257
|
-
| `remove_output` | sesame.v1.outputs.OutputRemoveRequest |
|
|
258
|
-
| `add_compositor` | sesame.v1.compositor.CompositorAddRequest |
|
|
259
|
-
| `remove_compositor` | sesame.v1.compositor.CompositorRemoveRequest |
|
|
260
|
-
| `clear_compositor` | sesame.v1.compositor.CompositorClearRequest |
|
|
261
|
-
| `add_node` | sesame.v1.compositor.NodeAddRequest |
|
|
262
|
-
| `remove_node` | sesame.v1.compositor.NodeRemoveRequest |
|
|
263
|
-
| `set_property` | sesame.v1.compositor.PropertySetRequest |
|
|
264
|
-
| `animate_property` | sesame.v1.compositor.PropertyAnimateRequest |
|
|
265
|
-
| `add_audio_mixer` | sesame.v1.audio.AudioMixerAddRequest |
|
|
266
|
-
| `update_audio_mixer` | sesame.v1.audio.AudioMixerUpdateRequest |
|
|
267
|
-
| `remove_audio_mixer` | sesame.v1.audio.AudioMixerRemoveRequest |
|
|
268
|
-
| `add_audio_channel` | sesame.v1.audio.AudioChannelAddRequest |
|
|
269
|
-
| `remove_audio_channel` | sesame.v1.audio.AudioChannelRemoveRequest |
|
|
270
|
-
| `update_source_transport` | sesame.v1.sources.SourceTransportCommand |
|
|
271
|
-
| `load_playlist` | sesame.v1.sources.LoadPlaylistRequest |
|
|
272
|
-
| `eject_playlist` | sesame.v1.sources.EjectPlaylistRequest |
|
|
273
|
-
| `callback` | sesame.v1.common.Callback |
|
|
274
|
-
| `set_source_metadata` | sesame.v1.sources.SourceMetadataSetRequest |
|
|
275
|
-
| `transaction_id` | optional uint32 |
|
|
276
|
-
| `transaction_deps` | repeated uint32 |
|
|
251
|
+
| `time_offset_us` | int64 | |
|
|
252
|
+
| `add_source` | sesame.v1.sources.SourceAddRequest | |
|
|
253
|
+
| `update_source` | sesame.v1.sources.SourceUpdateRequest | |
|
|
254
|
+
| `remove_source` | sesame.v1.sources.SourceRemoveRequest | |
|
|
255
|
+
| `add_output` | sesame.v1.outputs.OutputAddRequest | |
|
|
256
|
+
| `update_output` | sesame.v1.outputs.OutputUpdateRequest | |
|
|
257
|
+
| `remove_output` | sesame.v1.outputs.OutputRemoveRequest | |
|
|
258
|
+
| `add_compositor` | sesame.v1.compositor.CompositorAddRequest | |
|
|
259
|
+
| `remove_compositor` | sesame.v1.compositor.CompositorRemoveRequest | |
|
|
260
|
+
| `clear_compositor` | sesame.v1.compositor.CompositorClearRequest | |
|
|
261
|
+
| `add_node` | sesame.v1.compositor.NodeAddRequest | |
|
|
262
|
+
| `remove_node` | sesame.v1.compositor.NodeRemoveRequest | |
|
|
263
|
+
| `set_property` | sesame.v1.compositor.PropertySetRequest | |
|
|
264
|
+
| `animate_property` | sesame.v1.compositor.PropertyAnimateRequest | |
|
|
265
|
+
| `add_audio_mixer` | sesame.v1.audio.AudioMixerAddRequest | |
|
|
266
|
+
| `update_audio_mixer` | sesame.v1.audio.AudioMixerUpdateRequest | |
|
|
267
|
+
| `remove_audio_mixer` | sesame.v1.audio.AudioMixerRemoveRequest | |
|
|
268
|
+
| `add_audio_channel` | sesame.v1.audio.AudioChannelAddRequest | |
|
|
269
|
+
| `remove_audio_channel` | sesame.v1.audio.AudioChannelRemoveRequest | |
|
|
270
|
+
| `update_source_transport` | sesame.v1.sources.SourceTransportCommand | |
|
|
271
|
+
| `load_playlist` | sesame.v1.sources.LoadPlaylistRequest | |
|
|
272
|
+
| `eject_playlist` | sesame.v1.sources.EjectPlaylistRequest | |
|
|
273
|
+
| `callback` | sesame.v1.common.Callback | |
|
|
274
|
+
| `set_source_metadata` | sesame.v1.sources.SourceMetadataSetRequest | |
|
|
275
|
+
| `transaction_id` | optional uint32 | |
|
|
276
|
+
| `transaction_deps` | repeated uint32 | |
|
|
277
277
|
|
|
278
278
|
|
|
279
279
|
---
|
|
@@ -359,8 +359,8 @@ Used to trigger client-side callbacks when specific events occur.
|
|
|
359
359
|
|
|
360
360
|
| Field | Type | Description |
|
|
361
361
|
|-------|------|-------------|
|
|
362
|
-
| `event` | string |
|
|
363
|
-
| `data` | string |
|
|
362
|
+
| `event` | string | |
|
|
363
|
+
| `data` | string | |
|
|
364
364
|
|
|
365
365
|
|
|
366
366
|
### Empty
|
|
@@ -377,8 +377,8 @@ Used for transport metadata, custom properties, etc.
|
|
|
377
377
|
|
|
378
378
|
| Field | Type | Description |
|
|
379
379
|
|-------|------|-------------|
|
|
380
|
-
| `name` | string |
|
|
381
|
-
| `value` | PropValue |
|
|
380
|
+
| `name` | string | |
|
|
381
|
+
| `value` | PropValue | |
|
|
382
382
|
|
|
383
383
|
|
|
384
384
|
### PropValue
|
|
@@ -390,11 +390,11 @@ Only one field should be set at a time.
|
|
|
390
390
|
|
|
391
391
|
| Field | Type | Description |
|
|
392
392
|
|-------|------|-------------|
|
|
393
|
-
| `float_value` | float |
|
|
394
|
-
| `vec4_value` | Vec4 |
|
|
395
|
-
| `string_value` | string |
|
|
396
|
-
| `bool_value` | bool |
|
|
397
|
-
| `int_value` | int32 |
|
|
393
|
+
| `float_value` | float | |
|
|
394
|
+
| `vec4_value` | Vec4 | |
|
|
395
|
+
| `string_value` | string | |
|
|
396
|
+
| `bool_value` | bool | |
|
|
397
|
+
| `int_value` | int32 | |
|
|
398
398
|
|
|
399
399
|
|
|
400
400
|
### PropertyDomain
|
|
@@ -405,10 +405,10 @@ Used for property set/animate operations across different domains.
|
|
|
405
405
|
|
|
406
406
|
| Field | Type | Description |
|
|
407
407
|
|-------|------|-------------|
|
|
408
|
-
| `compositor_id` | string |
|
|
409
|
-
| `audio_mixer_id` | string |
|
|
410
|
-
| `replay_id` | string |
|
|
411
|
-
| `source_id` | string |
|
|
408
|
+
| `compositor_id` | string | |
|
|
409
|
+
| `audio_mixer_id` | string | |
|
|
410
|
+
| `replay_id` | string | |
|
|
411
|
+
| `source_id` | string | |
|
|
412
412
|
|
|
413
413
|
|
|
414
414
|
### TransportMetadata
|
|
@@ -419,7 +419,7 @@ Used for source and recorder metadata operations.
|
|
|
419
419
|
|
|
420
420
|
| Field | Type | Description |
|
|
421
421
|
|-------|------|-------------|
|
|
422
|
-
| `items` | repeated NameValue |
|
|
422
|
+
| `items` | repeated NameValue | |
|
|
423
423
|
|
|
424
424
|
|
|
425
425
|
### Vec4
|
|
@@ -431,10 +431,10 @@ but can be arbitrary for positions and sizes.
|
|
|
431
431
|
|
|
432
432
|
| Field | Type | Description |
|
|
433
433
|
|-------|------|-------------|
|
|
434
|
-
| `x` | float |
|
|
435
|
-
| `y` | float |
|
|
436
|
-
| `z` | float |
|
|
437
|
-
| `w` | float |
|
|
434
|
+
| `x` | float | |
|
|
435
|
+
| `y` | float | |
|
|
436
|
+
| `z` | float | |
|
|
437
|
+
| `w` | float | |
|
|
438
438
|
|
|
439
439
|
|
|
440
440
|
---
|
|
@@ -482,10 +482,10 @@ Request to add a new compositor.
|
|
|
482
482
|
|
|
483
483
|
| Field | Type | Description |
|
|
484
484
|
|-------|------|-------------|
|
|
485
|
-
| `id` | string |
|
|
486
|
-
| `multisample` | bool |
|
|
487
|
-
| `width` | uint32 |
|
|
488
|
-
| `height` | uint32 |
|
|
485
|
+
| `id` | string | |
|
|
486
|
+
| `multisample` | bool | |
|
|
487
|
+
| `width` | uint32 | |
|
|
488
|
+
| `height` | uint32 | |
|
|
489
489
|
|
|
490
490
|
|
|
491
491
|
### CompositorClearRequest
|
|
@@ -495,7 +495,7 @@ Request to clear a compositor (remove all nodes).
|
|
|
495
495
|
|
|
496
496
|
| Field | Type | Description |
|
|
497
497
|
|-------|------|-------------|
|
|
498
|
-
| `id` | string |
|
|
498
|
+
| `id` | string | |
|
|
499
499
|
|
|
500
500
|
|
|
501
501
|
### CompositorRemoveRequest
|
|
@@ -505,7 +505,7 @@ Request to remove a compositor.
|
|
|
505
505
|
|
|
506
506
|
| Field | Type | Description |
|
|
507
507
|
|-------|------|-------------|
|
|
508
|
-
| `id` | string |
|
|
508
|
+
| `id` | string | |
|
|
509
509
|
|
|
510
510
|
|
|
511
511
|
### KeyFrame
|
|
@@ -515,10 +515,10 @@ Animation keyframe.
|
|
|
515
515
|
|
|
516
516
|
| Field | Type | Description |
|
|
517
517
|
|-------|------|-------------|
|
|
518
|
-
| `time_us` | int64 |
|
|
519
|
-
| `value` | sesame.v1.common.PropValue |
|
|
520
|
-
| `easing_in` | string |
|
|
521
|
-
| `easing_out` | string |
|
|
518
|
+
| `time_us` | int64 | |
|
|
519
|
+
| `value` | sesame.v1.common.PropValue | |
|
|
520
|
+
| `easing_in` | string | |
|
|
521
|
+
| `easing_out` | string | |
|
|
522
522
|
|
|
523
523
|
|
|
524
524
|
### NodeAddRequest
|
|
@@ -528,10 +528,10 @@ Request to add a node to the scene graph.
|
|
|
528
528
|
|
|
529
529
|
| Field | Type | Description |
|
|
530
530
|
|-------|------|-------------|
|
|
531
|
-
| `compositor_id` | string |
|
|
532
|
-
| `parent_address` | string |
|
|
533
|
-
| `node_id` | string |
|
|
534
|
-
| `node_type` | NodeType |
|
|
531
|
+
| `compositor_id` | string | |
|
|
532
|
+
| `parent_address` | string | |
|
|
533
|
+
| `node_id` | string | |
|
|
534
|
+
| `node_type` | NodeType | |
|
|
535
535
|
|
|
536
536
|
|
|
537
537
|
### NodeRemoveRequest
|
|
@@ -541,8 +541,8 @@ Request to remove a node from the scene graph.
|
|
|
541
541
|
|
|
542
542
|
| Field | Type | Description |
|
|
543
543
|
|-------|------|-------------|
|
|
544
|
-
| `compositor_id` | string |
|
|
545
|
-
| `address` | string |
|
|
544
|
+
| `compositor_id` | string | |
|
|
545
|
+
| `address` | string | |
|
|
546
546
|
|
|
547
547
|
|
|
548
548
|
### PropertyAnimateRequest
|
|
@@ -552,12 +552,12 @@ Request to animate a property.
|
|
|
552
552
|
|
|
553
553
|
| Field | Type | Description |
|
|
554
554
|
|-------|------|-------------|
|
|
555
|
-
| `domain` | sesame.v1.common.PropertyDomain |
|
|
556
|
-
| `address` | string |
|
|
557
|
-
| `property` | string |
|
|
558
|
-
| `keyframes` | repeated KeyFrame |
|
|
559
|
-
| `before` | AnimationChannelEvaluationMode |
|
|
560
|
-
| `after` | AnimationChannelEvaluationMode |
|
|
555
|
+
| `domain` | sesame.v1.common.PropertyDomain | |
|
|
556
|
+
| `address` | string | |
|
|
557
|
+
| `property` | string | |
|
|
558
|
+
| `keyframes` | repeated KeyFrame | |
|
|
559
|
+
| `before` | AnimationChannelEvaluationMode | |
|
|
560
|
+
| `after` | AnimationChannelEvaluationMode | |
|
|
561
561
|
|
|
562
562
|
|
|
563
563
|
### PropertySetRequest
|
|
@@ -567,10 +567,10 @@ Request to set a property value.
|
|
|
567
567
|
|
|
568
568
|
| Field | Type | Description |
|
|
569
569
|
|-------|------|-------------|
|
|
570
|
-
| `domain` | sesame.v1.common.PropertyDomain |
|
|
571
|
-
| `address` | string |
|
|
572
|
-
| `property` | string |
|
|
573
|
-
| `value` | sesame.v1.common.PropValue |
|
|
570
|
+
| `domain` | sesame.v1.common.PropertyDomain | |
|
|
571
|
+
| `address` | string | |
|
|
572
|
+
| `property` | string | |
|
|
573
|
+
| `value` | sesame.v1.common.PropValue | |
|
|
574
574
|
|
|
575
575
|
|
|
576
576
|
---
|
|
@@ -640,30 +640,30 @@ Playlist export configuration.
|
|
|
640
640
|
|
|
641
641
|
| Field | Type | Description |
|
|
642
642
|
|-------|------|-------------|
|
|
643
|
-
| `filename` | string |
|
|
644
|
-
| `container` | ContainerFormat |
|
|
645
|
-
| `video_codec` | sesame.v1.common.CodecType |
|
|
646
|
-
| `width` | uint32 |
|
|
647
|
-
| `height` | uint32 |
|
|
648
|
-
| `fps_num` | uint32 |
|
|
649
|
-
| `fps_den` | uint32 |
|
|
650
|
-
| `rate_control` | RateControlMode |
|
|
651
|
-
| `video_bitrate_kbps` | uint32 |
|
|
652
|
-
| `max_video_bitrate_kbps` | uint32 |
|
|
653
|
-
| `gop_size` | uint32 |
|
|
654
|
-
| `max_b_frames` | uint32 |
|
|
655
|
-
| `profile` | string |
|
|
656
|
-
| `level` | string |
|
|
657
|
-
| `pixel_format` | string |
|
|
658
|
-
| `color_primaries` | string |
|
|
659
|
-
| `color_transfer` | string |
|
|
660
|
-
| `color_matrix` | string |
|
|
661
|
-
| `full_range` | bool |
|
|
662
|
-
| `audio_codec` | sesame.v1.common.CodecType |
|
|
663
|
-
| `audio_bitrate_kbps` | uint32 |
|
|
664
|
-
| `audio_sample_rate_hz` | uint32 |
|
|
665
|
-
| `audio_channels` | uint32 |
|
|
666
|
-
| `audio_routing` | repeated uint32 |
|
|
643
|
+
| `filename` | string | |
|
|
644
|
+
| `container` | ContainerFormat | |
|
|
645
|
+
| `video_codec` | sesame.v1.common.CodecType | |
|
|
646
|
+
| `width` | uint32 | |
|
|
647
|
+
| `height` | uint32 | |
|
|
648
|
+
| `fps_num` | uint32 | |
|
|
649
|
+
| `fps_den` | uint32 | |
|
|
650
|
+
| `rate_control` | RateControlMode | |
|
|
651
|
+
| `video_bitrate_kbps` | uint32 | |
|
|
652
|
+
| `max_video_bitrate_kbps` | uint32 | |
|
|
653
|
+
| `gop_size` | uint32 | |
|
|
654
|
+
| `max_b_frames` | uint32 | |
|
|
655
|
+
| `profile` | string | |
|
|
656
|
+
| `level` | string | |
|
|
657
|
+
| `pixel_format` | string | |
|
|
658
|
+
| `color_primaries` | string | |
|
|
659
|
+
| `color_transfer` | string | |
|
|
660
|
+
| `color_matrix` | string | |
|
|
661
|
+
| `full_range` | bool | |
|
|
662
|
+
| `audio_codec` | sesame.v1.common.CodecType | |
|
|
663
|
+
| `audio_bitrate_kbps` | uint32 | |
|
|
664
|
+
| `audio_sample_rate_hz` | uint32 | |
|
|
665
|
+
| `audio_channels` | uint32 | |
|
|
666
|
+
| `audio_routing` | repeated uint32 | |
|
|
667
667
|
|
|
668
668
|
|
|
669
669
|
### ExportStartRequest
|
|
@@ -673,8 +673,8 @@ Request to start playlist export.
|
|
|
673
673
|
|
|
674
674
|
| Field | Type | Description |
|
|
675
675
|
|-------|------|-------------|
|
|
676
|
-
| `config` | ExportConfiguration |
|
|
677
|
-
| `items` | repeated sesame.v1.recorder.PlaylistItem |
|
|
676
|
+
| `config` | ExportConfiguration | |
|
|
677
|
+
| `items` | repeated sesame.v1.recorder.PlaylistItem | |
|
|
678
678
|
|
|
679
679
|
|
|
680
680
|
### ImportConfiguration
|
|
@@ -684,12 +684,12 @@ Clip import configuration.
|
|
|
684
684
|
|
|
685
685
|
| Field | Type | Description |
|
|
686
686
|
|-------|------|-------------|
|
|
687
|
-
| `src_filename` | string |
|
|
688
|
-
| `audio_routing` | repeated uint32 |
|
|
689
|
-
| `dst_recorder_id` | string |
|
|
690
|
-
| `dst_clip_id` | uint64 |
|
|
691
|
-
| `dst_clip_name` | string |
|
|
692
|
-
| `dst_clip_user_data` | string |
|
|
687
|
+
| `src_filename` | string | |
|
|
688
|
+
| `audio_routing` | repeated uint32 | |
|
|
689
|
+
| `dst_recorder_id` | string | |
|
|
690
|
+
| `dst_clip_id` | uint64 | |
|
|
691
|
+
| `dst_clip_name` | string | |
|
|
692
|
+
| `dst_clip_user_data` | string | |
|
|
693
693
|
|
|
694
694
|
|
|
695
695
|
### ImportStartRequest
|
|
@@ -699,7 +699,7 @@ Request to start clip import.
|
|
|
699
699
|
|
|
700
700
|
| Field | Type | Description |
|
|
701
701
|
|-------|------|-------------|
|
|
702
|
-
| `config` | ImportConfiguration |
|
|
702
|
+
| `config` | ImportConfiguration | |
|
|
703
703
|
|
|
704
704
|
|
|
705
705
|
### Job
|
|
@@ -709,15 +709,15 @@ A job. Used as RPC response, list item, and event payload.
|
|
|
709
709
|
|
|
710
710
|
| Field | Type | Description |
|
|
711
711
|
|-------|------|-------------|
|
|
712
|
-
| `id` | uint32 |
|
|
713
|
-
| `type` | JobType |
|
|
714
|
-
| `status` | JobStatus |
|
|
715
|
-
| `name` | string |
|
|
716
|
-
| `description` | string |
|
|
717
|
-
| `error` | optional string |
|
|
718
|
-
| `progress` | int64 |
|
|
719
|
-
| `total` | int64 |
|
|
720
|
-
| `timing_info` | optional TimingInfo |
|
|
712
|
+
| `id` | uint32 | |
|
|
713
|
+
| `type` | JobType | |
|
|
714
|
+
| `status` | JobStatus | |
|
|
715
|
+
| `name` | string | |
|
|
716
|
+
| `description` | string | |
|
|
717
|
+
| `error` | optional string | |
|
|
718
|
+
| `progress` | int64 | |
|
|
719
|
+
| `total` | int64 | |
|
|
720
|
+
| `timing_info` | optional TimingInfo | |
|
|
721
721
|
|
|
722
722
|
|
|
723
723
|
### JobAbortRequest
|
|
@@ -727,7 +727,7 @@ Request to abort a job.
|
|
|
727
727
|
|
|
728
728
|
| Field | Type | Description |
|
|
729
729
|
|-------|------|-------------|
|
|
730
|
-
| `job_id` | uint32 |
|
|
730
|
+
| `job_id` | uint32 | |
|
|
731
731
|
|
|
732
732
|
|
|
733
733
|
### JobList
|
|
@@ -737,7 +737,7 @@ List of jobs.
|
|
|
737
737
|
|
|
738
738
|
| Field | Type | Description |
|
|
739
739
|
|-------|------|-------------|
|
|
740
|
-
| `jobs` | repeated Job |
|
|
740
|
+
| `jobs` | repeated Job | |
|
|
741
741
|
|
|
742
742
|
|
|
743
743
|
### JobListRequest
|
|
@@ -752,8 +752,8 @@ Request to start a job.
|
|
|
752
752
|
|
|
753
753
|
| Field | Type | Description |
|
|
754
754
|
|-------|------|-------------|
|
|
755
|
-
| `export_request` | ExportStartRequest |
|
|
756
|
-
| `import_request` | ImportStartRequest |
|
|
755
|
+
| `export_request` | ExportStartRequest | |
|
|
756
|
+
| `import_request` | ImportStartRequest | |
|
|
757
757
|
|
|
758
758
|
|
|
759
759
|
### JobStatusRequest
|
|
@@ -763,7 +763,7 @@ Request to get job status.
|
|
|
763
763
|
|
|
764
764
|
| Field | Type | Description |
|
|
765
765
|
|-------|------|-------------|
|
|
766
|
-
| `job_id` | uint32 |
|
|
766
|
+
| `job_id` | uint32 | |
|
|
767
767
|
|
|
768
768
|
|
|
769
769
|
### TimingInfo
|
|
@@ -773,8 +773,8 @@ Timing information for clips.
|
|
|
773
773
|
|
|
774
774
|
| Field | Type | Description |
|
|
775
775
|
|-------|------|-------------|
|
|
776
|
-
| `tc_in` | int64 |
|
|
777
|
-
| `tc_out` | int64 |
|
|
776
|
+
| `tc_in` | int64 | |
|
|
777
|
+
| `tc_out` | int64 | |
|
|
778
778
|
|
|
779
779
|
|
|
780
780
|
---
|
|
@@ -833,9 +833,9 @@ Decklink output configuration.
|
|
|
833
833
|
|
|
834
834
|
| Field | Type | Description |
|
|
835
835
|
|-------|------|-------------|
|
|
836
|
-
| `device_index` | uint32 |
|
|
837
|
-
| `video_format` | sesame.v1.common.VideoFormat |
|
|
838
|
-
| `key_and_fill` | bool |
|
|
836
|
+
| `device_index` | uint32 | |
|
|
837
|
+
| `video_format` | sesame.v1.common.VideoFormat | |
|
|
838
|
+
| `key_and_fill` | bool | |
|
|
839
839
|
|
|
840
840
|
|
|
841
841
|
### EncodedMoqOutputConfig
|
|
@@ -845,10 +845,10 @@ Decklink output configuration.
|
|
|
845
845
|
|
|
846
846
|
| Field | Type | Description |
|
|
847
847
|
|-------|------|-------------|
|
|
848
|
-
| `encoder` | EncoderConfig |
|
|
849
|
-
| `url` | string |
|
|
850
|
-
| `broadcast` | string |
|
|
851
|
-
| `key` | string |
|
|
848
|
+
| `encoder` | EncoderConfig | |
|
|
849
|
+
| `url` | string | |
|
|
850
|
+
| `broadcast` | string | |
|
|
851
|
+
| `key` | string | |
|
|
852
852
|
|
|
853
853
|
|
|
854
854
|
### EncodedRecorderOutputConfig
|
|
@@ -858,11 +858,11 @@ Decklink output configuration.
|
|
|
858
858
|
|
|
859
859
|
| Field | Type | Description |
|
|
860
860
|
|-------|------|-------------|
|
|
861
|
-
| `encoder` | EncoderConfig |
|
|
862
|
-
| `filename` | string |
|
|
863
|
-
| `size_gb` | uint32 |
|
|
864
|
-
| `group_id` | string |
|
|
865
|
-
| `recorder_type` | RecorderType |
|
|
861
|
+
| `encoder` | EncoderConfig | |
|
|
862
|
+
| `filename` | string | |
|
|
863
|
+
| `size_gb` | uint32 | |
|
|
864
|
+
| `group_id` | string | |
|
|
865
|
+
| `recorder_type` | RecorderType | |
|
|
866
866
|
|
|
867
867
|
|
|
868
868
|
### EncodedSrtOutputConfig
|
|
@@ -872,8 +872,8 @@ Decklink output configuration.
|
|
|
872
872
|
|
|
873
873
|
| Field | Type | Description |
|
|
874
874
|
|-------|------|-------------|
|
|
875
|
-
| `url` | string |
|
|
876
|
-
| `encoder` | EncoderConfig |
|
|
875
|
+
| `url` | string | |
|
|
876
|
+
| `encoder` | EncoderConfig | |
|
|
877
877
|
|
|
878
878
|
|
|
879
879
|
### EncodedSuperSlowMoRecorderOutputConfig
|
|
@@ -883,13 +883,13 @@ Decklink output configuration.
|
|
|
883
883
|
|
|
884
884
|
| Field | Type | Description |
|
|
885
885
|
|-------|------|-------------|
|
|
886
|
-
| `encoder` | EncoderConfig |
|
|
887
|
-
| `filename` | string |
|
|
888
|
-
| `size_gb` | uint32 |
|
|
889
|
-
| `group_id` | string |
|
|
890
|
-
| `recorder_type` | RecorderType |
|
|
891
|
-
| `composition_ids` | repeated string |
|
|
892
|
-
| `source_ids` | repeated string |
|
|
886
|
+
| `encoder` | EncoderConfig | |
|
|
887
|
+
| `filename` | string | |
|
|
888
|
+
| `size_gb` | uint32 | |
|
|
889
|
+
| `group_id` | string | |
|
|
890
|
+
| `recorder_type` | RecorderType | |
|
|
891
|
+
| `composition_ids` | repeated string | |
|
|
892
|
+
| `source_ids` | repeated string | |
|
|
893
893
|
|
|
894
894
|
|
|
895
895
|
### EncodedWebSocketOutputConfig
|
|
@@ -901,8 +901,8 @@ Type-specific output payloads
|
|
|
901
901
|
|
|
902
902
|
| Field | Type | Description |
|
|
903
903
|
|-------|------|-------------|
|
|
904
|
-
| `channel` | string |
|
|
905
|
-
| `encoder` | EncoderConfig |
|
|
904
|
+
| `channel` | string | |
|
|
905
|
+
| `encoder` | EncoderConfig | |
|
|
906
906
|
|
|
907
907
|
|
|
908
908
|
### EncoderConfig
|
|
@@ -912,13 +912,13 @@ Encoded output configuration (WebSocket, SRT, MoQ).
|
|
|
912
912
|
|
|
913
913
|
| Field | Type | Description |
|
|
914
914
|
|-------|------|-------------|
|
|
915
|
-
| `codec` | sesame.v1.common.CodecType |
|
|
916
|
-
| `preset` | EncoderPreset |
|
|
917
|
-
| `bitrate_kbps` | uint32 |
|
|
918
|
-
| `keyframe_interval` | uint32 |
|
|
919
|
-
| `width` | uint32 |
|
|
920
|
-
| `height` | uint32 |
|
|
921
|
-
| `fps` | float |
|
|
915
|
+
| `codec` | sesame.v1.common.CodecType | |
|
|
916
|
+
| `preset` | EncoderPreset | |
|
|
917
|
+
| `bitrate_kbps` | uint32 | |
|
|
918
|
+
| `keyframe_interval` | uint32 | |
|
|
919
|
+
| `width` | uint32 | |
|
|
920
|
+
| `height` | uint32 | |
|
|
921
|
+
| `fps` | float | |
|
|
922
922
|
|
|
923
923
|
|
|
924
924
|
### KeyframeRequest
|
|
@@ -929,7 +929,7 @@ Requests an immediate keyframe (IDR frame) from an encoder output.
|
|
|
929
929
|
|
|
930
930
|
| Field | Type | Description |
|
|
931
931
|
|-------|------|-------------|
|
|
932
|
-
| `id` | string |
|
|
932
|
+
| `id` | string | |
|
|
933
933
|
|
|
934
934
|
|
|
935
935
|
### OutputAddRequest
|
|
@@ -939,17 +939,17 @@ Request to add a new output.
|
|
|
939
939
|
|
|
940
940
|
| Field | Type | Description |
|
|
941
941
|
|-------|------|-------------|
|
|
942
|
-
| `id` | string |
|
|
943
|
-
| `composition_id` | string |
|
|
944
|
-
| `audio_mix_ids` | repeated string |
|
|
945
|
-
| `use_as_clock` | bool |
|
|
946
|
-
| `websocket` | EncodedWebSocketOutputConfig |
|
|
947
|
-
| `recorder` | EncodedRecorderOutputConfig |
|
|
948
|
-
| `super_slowmo_recorder` | EncodedSuperSlowMoRecorderOutputConfig |
|
|
949
|
-
| `srt` | EncodedSrtOutputConfig |
|
|
950
|
-
| `moq` | EncodedMoqOutputConfig |
|
|
951
|
-
| `decklink` | DecklinkOutputConfig |
|
|
952
|
-
| `system_audio` | SystemAudioOutputConfig |
|
|
942
|
+
| `id` | string | |
|
|
943
|
+
| `composition_id` | string | |
|
|
944
|
+
| `audio_mix_ids` | repeated string | |
|
|
945
|
+
| `use_as_clock` | bool | |
|
|
946
|
+
| `websocket` | EncodedWebSocketOutputConfig | |
|
|
947
|
+
| `recorder` | EncodedRecorderOutputConfig | |
|
|
948
|
+
| `super_slowmo_recorder` | EncodedSuperSlowMoRecorderOutputConfig | |
|
|
949
|
+
| `srt` | EncodedSrtOutputConfig | |
|
|
950
|
+
| `moq` | EncodedMoqOutputConfig | |
|
|
951
|
+
| `decklink` | DecklinkOutputConfig | |
|
|
952
|
+
| `system_audio` | SystemAudioOutputConfig | |
|
|
953
953
|
|
|
954
954
|
|
|
955
955
|
### OutputRemoveRequest
|
|
@@ -959,7 +959,7 @@ Request to remove an output.
|
|
|
959
959
|
|
|
960
960
|
| Field | Type | Description |
|
|
961
961
|
|-------|------|-------------|
|
|
962
|
-
| `id` | string |
|
|
962
|
+
| `id` | string | |
|
|
963
963
|
|
|
964
964
|
|
|
965
965
|
### OutputStatus
|
|
@@ -969,13 +969,13 @@ Output status information.
|
|
|
969
969
|
|
|
970
970
|
| Field | Type | Description |
|
|
971
971
|
|-------|------|-------------|
|
|
972
|
-
| `id` | string |
|
|
973
|
-
| `type` | OutputType |
|
|
974
|
-
| `state` | sesame.v1.common.ConnectionState |
|
|
975
|
-
| `msg` | optional string |
|
|
976
|
-
| `url` | string |
|
|
977
|
-
| `buffer_size` | uint32 |
|
|
978
|
-
| `srt_stats` | optional sesame.v1.status.SRTSendStatistics |
|
|
972
|
+
| `id` | string | |
|
|
973
|
+
| `type` | OutputType | |
|
|
974
|
+
| `state` | sesame.v1.common.ConnectionState | |
|
|
975
|
+
| `msg` | optional string | |
|
|
976
|
+
| `url` | string | |
|
|
977
|
+
| `buffer_size` | uint32 | |
|
|
978
|
+
| `srt_stats` | optional sesame.v1.status.SRTSendStatistics | |
|
|
979
979
|
|
|
980
980
|
|
|
981
981
|
### OutputUpdateRequest
|
|
@@ -985,17 +985,17 @@ Request to update an existing output.
|
|
|
985
985
|
|
|
986
986
|
| Field | Type | Description |
|
|
987
987
|
|-------|------|-------------|
|
|
988
|
-
| `id` | string |
|
|
989
|
-
| `composition_id` | string |
|
|
990
|
-
| `audio_mix_ids` | repeated string |
|
|
991
|
-
| `use_as_clock` | bool |
|
|
992
|
-
| `websocket` | EncodedWebSocketOutputConfig |
|
|
993
|
-
| `recorder` | EncodedRecorderOutputConfig |
|
|
994
|
-
| `super_slowmo_recorder` | EncodedSuperSlowMoRecorderOutputConfig |
|
|
995
|
-
| `srt` | EncodedSrtOutputConfig |
|
|
996
|
-
| `moq` | EncodedMoqOutputConfig |
|
|
997
|
-
| `decklink` | DecklinkOutputConfig |
|
|
998
|
-
| `system_audio` | SystemAudioOutputConfig |
|
|
988
|
+
| `id` | string | |
|
|
989
|
+
| `composition_id` | string | |
|
|
990
|
+
| `audio_mix_ids` | repeated string | |
|
|
991
|
+
| `use_as_clock` | bool | |
|
|
992
|
+
| `websocket` | EncodedWebSocketOutputConfig | |
|
|
993
|
+
| `recorder` | EncodedRecorderOutputConfig | |
|
|
994
|
+
| `super_slowmo_recorder` | EncodedSuperSlowMoRecorderOutputConfig | |
|
|
995
|
+
| `srt` | EncodedSrtOutputConfig | |
|
|
996
|
+
| `moq` | EncodedMoqOutputConfig | |
|
|
997
|
+
| `decklink` | DecklinkOutputConfig | |
|
|
998
|
+
| `system_audio` | SystemAudioOutputConfig | |
|
|
999
999
|
|
|
1000
1000
|
|
|
1001
1001
|
### SystemAudioOutputConfig
|
|
@@ -1005,7 +1005,7 @@ Request to update an existing output.
|
|
|
1005
1005
|
|
|
1006
1006
|
| Field | Type | Description |
|
|
1007
1007
|
|-------|------|-------------|
|
|
1008
|
-
| `device_name` | string |
|
|
1008
|
+
| `device_name` | string | |
|
|
1009
1009
|
|
|
1010
1010
|
|
|
1011
1011
|
---
|
|
@@ -1037,16 +1037,16 @@ Playlist item for recorder source playback.
|
|
|
1037
1037
|
|
|
1038
1038
|
| Field | Type | Description |
|
|
1039
1039
|
|-------|------|-------------|
|
|
1040
|
-
| `recorder_id` | string |
|
|
1041
|
-
| `id` | uint64 |
|
|
1042
|
-
| `transition_time_us` | int64 |
|
|
1043
|
-
| `transition_type` | TransitionType |
|
|
1044
|
-
| `transition_fade_color` | sesame.v1.common.Vec4 |
|
|
1045
|
-
| `speed` | float |
|
|
1046
|
-
| `audio_routing` | repeated uint32 |
|
|
1047
|
-
| `start_time_us` | optional int64 |
|
|
1048
|
-
| `end_time_us` | optional int64 |
|
|
1049
|
-
| `audio_levels` | repeated float |
|
|
1040
|
+
| `recorder_id` | string | |
|
|
1041
|
+
| `id` | uint64 | |
|
|
1042
|
+
| `transition_time_us` | int64 | |
|
|
1043
|
+
| `transition_type` | TransitionType | |
|
|
1044
|
+
| `transition_fade_color` | sesame.v1.common.Vec4 | |
|
|
1045
|
+
| `speed` | float | |
|
|
1046
|
+
| `audio_routing` | repeated uint32 | |
|
|
1047
|
+
| `start_time_us` | optional int64 | |
|
|
1048
|
+
| `end_time_us` | optional int64 | |
|
|
1049
|
+
| `audio_levels` | repeated float | |
|
|
1050
1050
|
|
|
1051
1051
|
|
|
1052
1052
|
### RecorderClip
|
|
@@ -1056,15 +1056,15 @@ Recorder clip information.
|
|
|
1056
1056
|
|
|
1057
1057
|
| Field | Type | Description |
|
|
1058
1058
|
|-------|------|-------------|
|
|
1059
|
-
| `id` | uint64 |
|
|
1060
|
-
| `name` | string |
|
|
1061
|
-
| `user_data` | string |
|
|
1062
|
-
| `flags` | uint64 |
|
|
1063
|
-
| `start_time_us` | int64 |
|
|
1064
|
-
| `end_time_us` | int64 |
|
|
1065
|
-
| `locked_start_us` | int64 |
|
|
1066
|
-
| `locked_end_us` | int64 |
|
|
1067
|
-
| `user_time_us` | int64 |
|
|
1059
|
+
| `id` | uint64 | |
|
|
1060
|
+
| `name` | string | |
|
|
1061
|
+
| `user_data` | string | |
|
|
1062
|
+
| `flags` | uint64 | |
|
|
1063
|
+
| `start_time_us` | int64 | |
|
|
1064
|
+
| `end_time_us` | int64 | |
|
|
1065
|
+
| `locked_start_us` | int64 | |
|
|
1066
|
+
| `locked_end_us` | int64 | |
|
|
1067
|
+
| `user_time_us` | int64 | |
|
|
1068
1068
|
|
|
1069
1069
|
|
|
1070
1070
|
### RecorderClipAddRequest
|
|
@@ -1074,7 +1074,7 @@ Request to add a clip to a recorder.
|
|
|
1074
1074
|
|
|
1075
1075
|
| Field | Type | Description |
|
|
1076
1076
|
|-------|------|-------------|
|
|
1077
|
-
| `clip` | RecorderClip |
|
|
1077
|
+
| `clip` | RecorderClip | |
|
|
1078
1078
|
|
|
1079
1079
|
|
|
1080
1080
|
### RecorderClipCopyRequest
|
|
@@ -1084,8 +1084,8 @@ Request to copy a clip.
|
|
|
1084
1084
|
|
|
1085
1085
|
| Field | Type | Description |
|
|
1086
1086
|
|-------|------|-------------|
|
|
1087
|
-
| `clip_id` | uint64 |
|
|
1088
|
-
| `new_clip_id` | uint64 |
|
|
1087
|
+
| `clip_id` | uint64 | |
|
|
1088
|
+
| `new_clip_id` | uint64 | |
|
|
1089
1089
|
|
|
1090
1090
|
|
|
1091
1091
|
### RecorderClipFlagSetRequest
|
|
@@ -1095,9 +1095,9 @@ Request to set a clip flag.
|
|
|
1095
1095
|
|
|
1096
1096
|
| Field | Type | Description |
|
|
1097
1097
|
|-------|------|-------------|
|
|
1098
|
-
| `clip_id` | uint64 |
|
|
1099
|
-
| `flag` | uint64 |
|
|
1100
|
-
| `value` | bool |
|
|
1098
|
+
| `clip_id` | uint64 | |
|
|
1099
|
+
| `flag` | uint64 | |
|
|
1100
|
+
| `value` | bool | |
|
|
1101
1101
|
|
|
1102
1102
|
|
|
1103
1103
|
### RecorderClipRange
|
|
@@ -1107,8 +1107,8 @@ Clip id range.
|
|
|
1107
1107
|
|
|
1108
1108
|
| Field | Type | Description |
|
|
1109
1109
|
|-------|------|-------------|
|
|
1110
|
-
| `low` | uint64 |
|
|
1111
|
-
| `high` | uint64 |
|
|
1110
|
+
| `low` | uint64 | |
|
|
1111
|
+
| `high` | uint64 | |
|
|
1112
1112
|
|
|
1113
1113
|
|
|
1114
1114
|
### RecorderClipRemoveRequest
|
|
@@ -1118,7 +1118,7 @@ Request to remove a clip.
|
|
|
1118
1118
|
|
|
1119
1119
|
| Field | Type | Description |
|
|
1120
1120
|
|-------|------|-------------|
|
|
1121
|
-
| `clip_id` | uint64 |
|
|
1121
|
+
| `clip_id` | uint64 | |
|
|
1122
1122
|
|
|
1123
1123
|
|
|
1124
1124
|
### RecorderClipsClearRequest
|
|
@@ -1128,9 +1128,9 @@ Request to clear clips with filters.
|
|
|
1128
1128
|
|
|
1129
1129
|
| Field | Type | Description |
|
|
1130
1130
|
|-------|------|-------------|
|
|
1131
|
-
| `protected_ranges` | repeated RecorderClipRange |
|
|
1132
|
-
| `must_have_flags` | uint64 |
|
|
1133
|
-
| `must_not_have_flags` | uint64 |
|
|
1131
|
+
| `protected_ranges` | repeated RecorderClipRange | |
|
|
1132
|
+
| `must_have_flags` | uint64 | |
|
|
1133
|
+
| `must_not_have_flags` | uint64 | |
|
|
1134
1134
|
|
|
1135
1135
|
|
|
1136
1136
|
### RecorderClipsGetRequest
|
|
@@ -1147,7 +1147,7 @@ Response with recorder clips.
|
|
|
1147
1147
|
|
|
1148
1148
|
| Field | Type | Description |
|
|
1149
1149
|
|-------|------|-------------|
|
|
1150
|
-
| `clips` | repeated RecorderClip |
|
|
1150
|
+
| `clips` | repeated RecorderClip | |
|
|
1151
1151
|
|
|
1152
1152
|
|
|
1153
1153
|
### RecorderClipsVerifyRequest
|
|
@@ -1164,7 +1164,7 @@ Response with verification errors.
|
|
|
1164
1164
|
|
|
1165
1165
|
| Field | Type | Description |
|
|
1166
1166
|
|-------|------|-------------|
|
|
1167
|
-
| `errors` | repeated string |
|
|
1167
|
+
| `errors` | repeated string | |
|
|
1168
1168
|
|
|
1169
1169
|
|
|
1170
1170
|
### RecorderEvent
|
|
@@ -1174,9 +1174,9 @@ Recorder event notification.
|
|
|
1174
1174
|
|
|
1175
1175
|
| Field | Type | Description |
|
|
1176
1176
|
|-------|------|-------------|
|
|
1177
|
-
| `id` | string |
|
|
1178
|
-
| `online` | bool |
|
|
1179
|
-
| `message` | optional string |
|
|
1177
|
+
| `id` | string | |
|
|
1178
|
+
| `online` | bool | |
|
|
1179
|
+
| `message` | optional string | |
|
|
1180
1180
|
|
|
1181
1181
|
|
|
1182
1182
|
### RecorderLockedDurationSetRequest
|
|
@@ -1186,7 +1186,7 @@ Request to set locked duration.
|
|
|
1186
1186
|
|
|
1187
1187
|
| Field | Type | Description |
|
|
1188
1188
|
|-------|------|-------------|
|
|
1189
|
-
| `frames` | uint32 |
|
|
1189
|
+
| `frames` | uint32 | |
|
|
1190
1190
|
|
|
1191
1191
|
|
|
1192
1192
|
### RecorderMetadataSetRequest
|
|
@@ -1196,7 +1196,7 @@ Request to set recorder metadata.
|
|
|
1196
1196
|
|
|
1197
1197
|
| Field | Type | Description |
|
|
1198
1198
|
|-------|------|-------------|
|
|
1199
|
-
| `metadata` | sesame.v1.common.TransportMetadata |
|
|
1199
|
+
| `metadata` | sesame.v1.common.TransportMetadata | |
|
|
1200
1200
|
|
|
1201
1201
|
|
|
1202
1202
|
### RecorderOkResponse
|
|
@@ -1213,16 +1213,16 @@ Recorder request wrapper.
|
|
|
1213
1213
|
|
|
1214
1214
|
| Field | Type | Description |
|
|
1215
1215
|
|-------|------|-------------|
|
|
1216
|
-
| `recorder_id` | string |
|
|
1217
|
-
| `get_clips` | RecorderClipsGetRequest |
|
|
1218
|
-
| `add_clip` | RecorderClipAddRequest |
|
|
1219
|
-
| `remove_clip` | RecorderClipRemoveRequest |
|
|
1220
|
-
| `clear_clips` | RecorderClipsClearRequest |
|
|
1221
|
-
| `set_metadata` | RecorderMetadataSetRequest |
|
|
1222
|
-
| `verify_clips` | RecorderClipsVerifyRequest |
|
|
1223
|
-
| `set_clip_flag` | RecorderClipFlagSetRequest |
|
|
1224
|
-
| `copy_clip` | RecorderClipCopyRequest |
|
|
1225
|
-
| `set_locked_duration` | RecorderLockedDurationSetRequest |
|
|
1216
|
+
| `recorder_id` | string | |
|
|
1217
|
+
| `get_clips` | RecorderClipsGetRequest | |
|
|
1218
|
+
| `add_clip` | RecorderClipAddRequest | |
|
|
1219
|
+
| `remove_clip` | RecorderClipRemoveRequest | |
|
|
1220
|
+
| `clear_clips` | RecorderClipsClearRequest | |
|
|
1221
|
+
| `set_metadata` | RecorderMetadataSetRequest | |
|
|
1222
|
+
| `verify_clips` | RecorderClipsVerifyRequest | |
|
|
1223
|
+
| `set_clip_flag` | RecorderClipFlagSetRequest | |
|
|
1224
|
+
| `copy_clip` | RecorderClipCopyRequest | |
|
|
1225
|
+
| `set_locked_duration` | RecorderLockedDurationSetRequest | |
|
|
1226
1226
|
|
|
1227
1227
|
|
|
1228
1228
|
### RecorderResponse
|
|
@@ -1232,9 +1232,9 @@ Recorder response wrapper.
|
|
|
1232
1232
|
|
|
1233
1233
|
| Field | Type | Description |
|
|
1234
1234
|
|-------|------|-------------|
|
|
1235
|
-
| `get_clips_response` | RecorderClipsGetResponse |
|
|
1236
|
-
| `ok_response` | RecorderOkResponse |
|
|
1237
|
-
| `verify_clips_response` | RecorderClipsVerifyResponse |
|
|
1235
|
+
| `get_clips_response` | RecorderClipsGetResponse | |
|
|
1236
|
+
| `ok_response` | RecorderOkResponse | |
|
|
1237
|
+
| `verify_clips_response` | RecorderClipsVerifyResponse | |
|
|
1238
1238
|
|
|
1239
1239
|
|
|
1240
1240
|
### RecorderStatus
|
|
@@ -1244,7 +1244,7 @@ Recorder status.
|
|
|
1244
1244
|
|
|
1245
1245
|
| Field | Type | Description |
|
|
1246
1246
|
|-------|------|-------------|
|
|
1247
|
-
| `id` | string |
|
|
1247
|
+
| `id` | string | |
|
|
1248
1248
|
|
|
1249
1249
|
|
|
1250
1250
|
---
|
|
@@ -1264,8 +1264,8 @@ Server event notification.
|
|
|
1264
1264
|
|
|
1265
1265
|
| Field | Type | Description |
|
|
1266
1266
|
|-------|------|-------------|
|
|
1267
|
-
| `topic` | sesame.v1.common.EventTopic |
|
|
1268
|
-
| `payload` | bytes |
|
|
1267
|
+
| `topic` | sesame.v1.common.EventTopic | |
|
|
1268
|
+
| `payload` | bytes | |
|
|
1269
1269
|
|
|
1270
1270
|
|
|
1271
1271
|
### Message
|
|
@@ -1277,9 +1277,9 @@ Exactly one payload field will be set, determining the message type.
|
|
|
1277
1277
|
|
|
1278
1278
|
| Field | Type | Description |
|
|
1279
1279
|
|-------|------|-------------|
|
|
1280
|
-
| `request` | Request |
|
|
1281
|
-
| `response` | Response |
|
|
1282
|
-
| `event` | Event |
|
|
1280
|
+
| `request` | Request | |
|
|
1281
|
+
| `response` | Response | |
|
|
1282
|
+
| `event` | Event | |
|
|
1283
1283
|
|
|
1284
1284
|
|
|
1285
1285
|
### Request
|
|
@@ -1289,9 +1289,9 @@ RPC request from client to server.
|
|
|
1289
1289
|
|
|
1290
1290
|
| Field | Type | Description |
|
|
1291
1291
|
|-------|------|-------------|
|
|
1292
|
-
| `method` | string |
|
|
1293
|
-
| `seq` | uint32 |
|
|
1294
|
-
| `payload` | bytes |
|
|
1292
|
+
| `method` | string | |
|
|
1293
|
+
| `seq` | uint32 | |
|
|
1294
|
+
| `payload` | bytes | |
|
|
1295
1295
|
|
|
1296
1296
|
|
|
1297
1297
|
### Response
|
|
@@ -1308,10 +1308,10 @@ Error handling:
|
|
|
1308
1308
|
|
|
1309
1309
|
| Field | Type | Description |
|
|
1310
1310
|
|-------|------|-------------|
|
|
1311
|
-
| `seq` | uint32 |
|
|
1312
|
-
| `ok` | bool |
|
|
1313
|
-
| `payload` | bytes |
|
|
1314
|
-
| `error` | string |
|
|
1311
|
+
| `seq` | uint32 | |
|
|
1312
|
+
| `ok` | bool | |
|
|
1313
|
+
| `payload` | bytes | |
|
|
1314
|
+
| `error` | string | |
|
|
1315
1315
|
|
|
1316
1316
|
|
|
1317
1317
|
---
|
|
@@ -1452,9 +1452,9 @@ Type of video/audio source.
|
|
|
1452
1452
|
|
|
1453
1453
|
| Field | Type | Description |
|
|
1454
1454
|
|-------|------|-------------|
|
|
1455
|
-
| `url` | string |
|
|
1456
|
-
| `width` | uint32 |
|
|
1457
|
-
| `height` | uint32 |
|
|
1455
|
+
| `url` | string | |
|
|
1456
|
+
| `width` | uint32 | |
|
|
1457
|
+
| `height` | uint32 | |
|
|
1458
1458
|
|
|
1459
1459
|
|
|
1460
1460
|
### DecklinkSourceConfig
|
|
@@ -1464,9 +1464,9 @@ Decklink source configuration.
|
|
|
1464
1464
|
|
|
1465
1465
|
| Field | Type | Description |
|
|
1466
1466
|
|-------|------|-------------|
|
|
1467
|
-
| `device_index` | uint32 |
|
|
1468
|
-
| `video_format` | sesame.v1.common.VideoFormat |
|
|
1469
|
-
| `sync_group` | optional uint32 |
|
|
1467
|
+
| `device_index` | uint32 | |
|
|
1468
|
+
| `video_format` | sesame.v1.common.VideoFormat | |
|
|
1469
|
+
| `sync_group` | optional uint32 | |
|
|
1470
1470
|
|
|
1471
1471
|
|
|
1472
1472
|
### EjectPlaylistRequest
|
|
@@ -1476,7 +1476,7 @@ Request to eject playlist from recorder source.
|
|
|
1476
1476
|
|
|
1477
1477
|
| Field | Type | Description |
|
|
1478
1478
|
|-------|------|-------------|
|
|
1479
|
-
| `source_id` | string |
|
|
1479
|
+
| `source_id` | string | |
|
|
1480
1480
|
|
|
1481
1481
|
|
|
1482
1482
|
### FileSourceConfig
|
|
@@ -1486,7 +1486,7 @@ Type-specific source payloads.
|
|
|
1486
1486
|
|
|
1487
1487
|
| Field | Type | Description |
|
|
1488
1488
|
|-------|------|-------------|
|
|
1489
|
-
| `url` | string |
|
|
1489
|
+
| `url` | string | |
|
|
1490
1490
|
|
|
1491
1491
|
|
|
1492
1492
|
### LoadPlaylistRequest
|
|
@@ -1496,12 +1496,12 @@ Request to load a playlist into a recorder source.
|
|
|
1496
1496
|
|
|
1497
1497
|
| Field | Type | Description |
|
|
1498
1498
|
|-------|------|-------------|
|
|
1499
|
-
| `source_id` | string |
|
|
1500
|
-
| `user_playlist_id` | string |
|
|
1501
|
-
| `items` | repeated sesame.v1.recorder.PlaylistItem |
|
|
1502
|
-
| `start_time_us` | optional int64 |
|
|
1503
|
-
| `start_index` | optional int64 |
|
|
1504
|
-
| `material_pos_us` | optional int64 |
|
|
1499
|
+
| `source_id` | string | |
|
|
1500
|
+
| `user_playlist_id` | string | |
|
|
1501
|
+
| `items` | repeated sesame.v1.recorder.PlaylistItem | |
|
|
1502
|
+
| `start_time_us` | optional int64 | |
|
|
1503
|
+
| `start_index` | optional int64 | |
|
|
1504
|
+
| `material_pos_us` | optional int64 | |
|
|
1505
1505
|
|
|
1506
1506
|
|
|
1507
1507
|
### MoqSourceConfig
|
|
@@ -1511,10 +1511,10 @@ Request to load a playlist into a recorder source.
|
|
|
1511
1511
|
|
|
1512
1512
|
| Field | Type | Description |
|
|
1513
1513
|
|-------|------|-------------|
|
|
1514
|
-
| `url` | string |
|
|
1515
|
-
| `broadcast` | string |
|
|
1516
|
-
| `key` | string |
|
|
1517
|
-
| `decode_buffer_frames` | uint32 |
|
|
1514
|
+
| `url` | string | |
|
|
1515
|
+
| `broadcast` | string | |
|
|
1516
|
+
| `key` | string | |
|
|
1517
|
+
| `decode_buffer_frames` | uint32 | |
|
|
1518
1518
|
|
|
1519
1519
|
|
|
1520
1520
|
### RTTSourceConfig
|
|
@@ -1524,9 +1524,9 @@ RTT (Render-to-Texture) source configuration.
|
|
|
1524
1524
|
|
|
1525
1525
|
| Field | Type | Description |
|
|
1526
1526
|
|-------|------|-------------|
|
|
1527
|
-
| `rtt_id` | string |
|
|
1528
|
-
| `audio_mixes` | repeated string |
|
|
1529
|
-
| `delay_frames` | uint32 |
|
|
1527
|
+
| `rtt_id` | string | |
|
|
1528
|
+
| `audio_mixes` | repeated string | |
|
|
1529
|
+
| `delay_frames` | uint32 | |
|
|
1530
1530
|
|
|
1531
1531
|
|
|
1532
1532
|
### RecorderSourceConfig
|
|
@@ -1536,8 +1536,8 @@ RTT (Render-to-Texture) source configuration.
|
|
|
1536
1536
|
|
|
1537
1537
|
| Field | Type | Description |
|
|
1538
1538
|
|-------|------|-------------|
|
|
1539
|
-
| `recorder_id` | string |
|
|
1540
|
-
| `codec` | sesame.v1.common.CodecType |
|
|
1539
|
+
| `recorder_id` | string | |
|
|
1540
|
+
| `codec` | sesame.v1.common.CodecType | |
|
|
1541
1541
|
|
|
1542
1542
|
|
|
1543
1543
|
### SignalGeneratorSourceConfig
|
|
@@ -1552,8 +1552,8 @@ Request to add a new source.
|
|
|
1552
1552
|
|
|
1553
1553
|
| Field | Type | Description |
|
|
1554
1554
|
|-------|------|-------------|
|
|
1555
|
-
| `id` | string |
|
|
1556
|
-
| `config` | SourceConfig |
|
|
1555
|
+
| `id` | string | |
|
|
1556
|
+
| `config` | SourceConfig | |
|
|
1557
1557
|
|
|
1558
1558
|
|
|
1559
1559
|
### SourceCommonConfig
|
|
@@ -1563,16 +1563,16 @@ Shared fields for all source kinds.
|
|
|
1563
1563
|
|
|
1564
1564
|
| Field | Type | Description |
|
|
1565
1565
|
|-------|------|-------------|
|
|
1566
|
-
| `user_id` | string |
|
|
1567
|
-
| `use_as_clock` | bool |
|
|
1568
|
-
| `audio_only` | bool |
|
|
1569
|
-
| `audio_channels` | uint32 |
|
|
1570
|
-
| `loop` | bool |
|
|
1571
|
-
| `play_state` | SourceTransportState |
|
|
1572
|
-
| `mip_map` | bool |
|
|
1573
|
-
| `texture_size` | SourceTextureSize |
|
|
1574
|
-
| `deinterlace` | DeinterlaceType |
|
|
1575
|
-
| `video_processors` | repeated VideoProcessor |
|
|
1566
|
+
| `user_id` | string | |
|
|
1567
|
+
| `use_as_clock` | bool | |
|
|
1568
|
+
| `audio_only` | bool | |
|
|
1569
|
+
| `audio_channels` | uint32 | |
|
|
1570
|
+
| `loop` | bool | |
|
|
1571
|
+
| `play_state` | SourceTransportState | |
|
|
1572
|
+
| `mip_map` | bool | |
|
|
1573
|
+
| `texture_size` | SourceTextureSize | |
|
|
1574
|
+
| `deinterlace` | DeinterlaceType | |
|
|
1575
|
+
| `video_processors` | repeated VideoProcessor | |
|
|
1576
1576
|
|
|
1577
1577
|
|
|
1578
1578
|
### SourceConfig
|
|
@@ -1583,17 +1583,17 @@ Defines how a source is created and configured.
|
|
|
1583
1583
|
|
|
1584
1584
|
| Field | Type | Description |
|
|
1585
1585
|
|-------|------|-------------|
|
|
1586
|
-
| `common` | SourceCommonConfig |
|
|
1587
|
-
| `file` | FileSourceConfig |
|
|
1588
|
-
| `recorder` | RecorderSourceConfig |
|
|
1589
|
-
| `browser` | BrowserSourceConfig |
|
|
1590
|
-
| `rtt` | RTTSourceConfig |
|
|
1591
|
-
| `decklink` | DecklinkSourceConfig |
|
|
1592
|
-
| `signal_generator` | SignalGeneratorSourceConfig |
|
|
1593
|
-
| `system_audio` | SystemAudioSourceConfig |
|
|
1594
|
-
| `srt_stream` | SrtSourceConfig |
|
|
1595
|
-
| `websocket` | WebsocketSourceConfig |
|
|
1596
|
-
| `moq` | MoqSourceConfig |
|
|
1586
|
+
| `common` | SourceCommonConfig | |
|
|
1587
|
+
| `file` | FileSourceConfig | |
|
|
1588
|
+
| `recorder` | RecorderSourceConfig | |
|
|
1589
|
+
| `browser` | BrowserSourceConfig | |
|
|
1590
|
+
| `rtt` | RTTSourceConfig | |
|
|
1591
|
+
| `decklink` | DecklinkSourceConfig | |
|
|
1592
|
+
| `signal_generator` | SignalGeneratorSourceConfig | |
|
|
1593
|
+
| `system_audio` | SystemAudioSourceConfig | |
|
|
1594
|
+
| `srt_stream` | SrtSourceConfig | |
|
|
1595
|
+
| `websocket` | WebsocketSourceConfig | |
|
|
1596
|
+
| `moq` | MoqSourceConfig | |
|
|
1597
1597
|
|
|
1598
1598
|
|
|
1599
1599
|
### SourceMetadataEvent
|
|
@@ -1603,8 +1603,8 @@ Source metadata transport event notification.
|
|
|
1603
1603
|
|
|
1604
1604
|
| Field | Type | Description |
|
|
1605
1605
|
|-------|------|-------------|
|
|
1606
|
-
| `source_id` | string |
|
|
1607
|
-
| `metadata` | sesame.v1.common.TransportMetadata |
|
|
1606
|
+
| `source_id` | string | |
|
|
1607
|
+
| `metadata` | sesame.v1.common.TransportMetadata | |
|
|
1608
1608
|
|
|
1609
1609
|
|
|
1610
1610
|
### SourceMetadataSetRequest
|
|
@@ -1614,8 +1614,8 @@ Request to set source metadata.
|
|
|
1614
1614
|
|
|
1615
1615
|
| Field | Type | Description |
|
|
1616
1616
|
|-------|------|-------------|
|
|
1617
|
-
| `source_id` | string |
|
|
1618
|
-
| `metadata` | sesame.v1.common.TransportMetadata |
|
|
1617
|
+
| `source_id` | string | |
|
|
1618
|
+
| `metadata` | sesame.v1.common.TransportMetadata | |
|
|
1619
1619
|
|
|
1620
1620
|
|
|
1621
1621
|
### SourceRemoveRequest
|
|
@@ -1625,7 +1625,7 @@ Request to remove a source.
|
|
|
1625
1625
|
|
|
1626
1626
|
| Field | Type | Description |
|
|
1627
1627
|
|-------|------|-------------|
|
|
1628
|
-
| `id` | string |
|
|
1628
|
+
| `id` | string | |
|
|
1629
1629
|
|
|
1630
1630
|
|
|
1631
1631
|
### SourceStatus
|
|
@@ -1635,27 +1635,27 @@ Source status information.
|
|
|
1635
1635
|
|
|
1636
1636
|
| Field | Type | Description |
|
|
1637
1637
|
|-------|------|-------------|
|
|
1638
|
-
| `id` | string |
|
|
1639
|
-
| `type` | SourceType |
|
|
1640
|
-
| `user_id` | string |
|
|
1641
|
-
| `state` | sesame.v1.common.ConnectionState |
|
|
1642
|
-
| `transport_state` | SourceTransportState |
|
|
1643
|
-
| `msg` | optional string |
|
|
1644
|
-
| `url` | string |
|
|
1645
|
-
| `width` | uint32 |
|
|
1646
|
-
| `height` | uint32 |
|
|
1647
|
-
| `fps` | float |
|
|
1648
|
-
| `duration_us` | int64 |
|
|
1649
|
-
| `play_position_us` | int64 |
|
|
1650
|
-
| `video_buf` | int32 |
|
|
1651
|
-
| `audio_buf` | int32 |
|
|
1652
|
-
| `gpu_buf` | int32 |
|
|
1653
|
-
| `audio_channels` | uint32 |
|
|
1654
|
-
| `audio_level` | float |
|
|
1655
|
-
| `lip_sync_offset_us` | int64 |
|
|
1656
|
-
| `decode_timing` | sesame.v1.status.FrameTiming |
|
|
1657
|
-
| `video_buf_avg` | double |
|
|
1658
|
-
| `srt_stats` | optional sesame.v1.status.SRTReceiveStatistics |
|
|
1638
|
+
| `id` | string | |
|
|
1639
|
+
| `type` | SourceType | |
|
|
1640
|
+
| `user_id` | string | |
|
|
1641
|
+
| `state` | sesame.v1.common.ConnectionState | |
|
|
1642
|
+
| `transport_state` | SourceTransportState | |
|
|
1643
|
+
| `msg` | optional string | |
|
|
1644
|
+
| `url` | string | |
|
|
1645
|
+
| `width` | uint32 | |
|
|
1646
|
+
| `height` | uint32 | |
|
|
1647
|
+
| `fps` | float | |
|
|
1648
|
+
| `duration_us` | int64 | |
|
|
1649
|
+
| `play_position_us` | int64 | |
|
|
1650
|
+
| `video_buf` | int32 | |
|
|
1651
|
+
| `audio_buf` | int32 | |
|
|
1652
|
+
| `gpu_buf` | int32 | |
|
|
1653
|
+
| `audio_channels` | uint32 | |
|
|
1654
|
+
| `audio_level` | float | |
|
|
1655
|
+
| `lip_sync_offset_us` | int64 | |
|
|
1656
|
+
| `decode_timing` | sesame.v1.status.FrameTiming | |
|
|
1657
|
+
| `video_buf_avg` | double | |
|
|
1658
|
+
| `srt_stats` | optional sesame.v1.status.SRTReceiveStatistics | |
|
|
1659
1659
|
|
|
1660
1660
|
|
|
1661
1661
|
### SourceTransportCommand
|
|
@@ -1665,9 +1665,9 @@ Source transport command.
|
|
|
1665
1665
|
|
|
1666
1666
|
| Field | Type | Description |
|
|
1667
1667
|
|-------|------|-------------|
|
|
1668
|
-
| `source_id` | string |
|
|
1669
|
-
| `cmd_type` | SourceTransportCommandType |
|
|
1670
|
-
| `value` | sesame.v1.common.PropValue |
|
|
1668
|
+
| `source_id` | string | |
|
|
1669
|
+
| `cmd_type` | SourceTransportCommandType | |
|
|
1670
|
+
| `value` | sesame.v1.common.PropValue | |
|
|
1671
1671
|
|
|
1672
1672
|
|
|
1673
1673
|
### SourceUpdateRequest
|
|
@@ -1677,8 +1677,8 @@ Request to update an existing source.
|
|
|
1677
1677
|
|
|
1678
1678
|
| Field | Type | Description |
|
|
1679
1679
|
|-------|------|-------------|
|
|
1680
|
-
| `id` | string |
|
|
1681
|
-
| `config` | SourceConfig |
|
|
1680
|
+
| `id` | string | |
|
|
1681
|
+
| `config` | SourceConfig | |
|
|
1682
1682
|
|
|
1683
1683
|
|
|
1684
1684
|
### SrtSourceConfig
|
|
@@ -1688,8 +1688,8 @@ Request to update an existing source.
|
|
|
1688
1688
|
|
|
1689
1689
|
| Field | Type | Description |
|
|
1690
1690
|
|-------|------|-------------|
|
|
1691
|
-
| `url` | string |
|
|
1692
|
-
| `decode_buffer_frames` | uint32 |
|
|
1691
|
+
| `url` | string | |
|
|
1692
|
+
| `decode_buffer_frames` | uint32 | |
|
|
1693
1693
|
|
|
1694
1694
|
|
|
1695
1695
|
### SystemAudioSourceConfig
|
|
@@ -1699,7 +1699,7 @@ Request to update an existing source.
|
|
|
1699
1699
|
|
|
1700
1700
|
| Field | Type | Description |
|
|
1701
1701
|
|-------|------|-------------|
|
|
1702
|
-
| `device_name` | string |
|
|
1702
|
+
| `device_name` | string | |
|
|
1703
1703
|
|
|
1704
1704
|
|
|
1705
1705
|
### VideoProcessor
|
|
@@ -1709,9 +1709,9 @@ Video processor instance configuration.
|
|
|
1709
1709
|
|
|
1710
1710
|
| Field | Type | Description |
|
|
1711
1711
|
|-------|------|-------------|
|
|
1712
|
-
| `id` | string |
|
|
1713
|
-
| `type` | PreprocessStep |
|
|
1714
|
-
| `params` | repeated VideoProcessorParam |
|
|
1712
|
+
| `id` | string | |
|
|
1713
|
+
| `type` | PreprocessStep | |
|
|
1714
|
+
| `params` | repeated VideoProcessorParam | |
|
|
1715
1715
|
|
|
1716
1716
|
|
|
1717
1717
|
### VideoProcessorParam
|
|
@@ -1721,8 +1721,8 @@ Video processor parameter (mirrors AudioPluginParam).
|
|
|
1721
1721
|
|
|
1722
1722
|
| Field | Type | Description |
|
|
1723
1723
|
|-------|------|-------------|
|
|
1724
|
-
| `id` | uint32 |
|
|
1725
|
-
| `float_value` | float |
|
|
1724
|
+
| `id` | uint32 | |
|
|
1725
|
+
| `float_value` | float | |
|
|
1726
1726
|
|
|
1727
1727
|
|
|
1728
1728
|
### WebsocketSourceConfig
|
|
@@ -1732,8 +1732,8 @@ Video processor parameter (mirrors AudioPluginParam).
|
|
|
1732
1732
|
|
|
1733
1733
|
| Field | Type | Description |
|
|
1734
1734
|
|-------|------|-------------|
|
|
1735
|
-
| `channel` | string |
|
|
1736
|
-
| `decode_buffer_frames` | uint32 |
|
|
1735
|
+
| `channel` | string | |
|
|
1736
|
+
| `decode_buffer_frames` | uint32 | |
|
|
1737
1737
|
|
|
1738
1738
|
|
|
1739
1739
|
---
|
|
@@ -1755,10 +1755,10 @@ All times are in microseconds (us).
|
|
|
1755
1755
|
|
|
1756
1756
|
| Field | Type | Description |
|
|
1757
1757
|
|-------|------|-------------|
|
|
1758
|
-
| `frame_time` | int32 |
|
|
1759
|
-
| `frame_time_avg` | int32 |
|
|
1760
|
-
| `frame_time_min` | int32 |
|
|
1761
|
-
| `frame_time_max` | int32 |
|
|
1758
|
+
| `frame_time` | int32 | |
|
|
1759
|
+
| `frame_time_avg` | int32 | |
|
|
1760
|
+
| `frame_time_min` | int32 | |
|
|
1761
|
+
| `frame_time_max` | int32 | |
|
|
1762
1762
|
|
|
1763
1763
|
|
|
1764
1764
|
### MemoryDomainStats
|
|
@@ -1769,9 +1769,9 @@ Tracks memory usage for different allocation domains.
|
|
|
1769
1769
|
|
|
1770
1770
|
| Field | Type | Description |
|
|
1771
1771
|
|-------|------|-------------|
|
|
1772
|
-
| `current_bytes` | uint64 |
|
|
1773
|
-
| `peak_bytes` | uint64 |
|
|
1774
|
-
| `budget_bytes` | uint64 |
|
|
1772
|
+
| `current_bytes` | uint64 | |
|
|
1773
|
+
| `peak_bytes` | uint64 | |
|
|
1774
|
+
| `budget_bytes` | uint64 | |
|
|
1775
1775
|
|
|
1776
1776
|
|
|
1777
1777
|
### SRTReceiveStatistics
|
|
@@ -1783,16 +1783,16 @@ Used for monitoring stream health and diagnosing issues.
|
|
|
1783
1783
|
|
|
1784
1784
|
| Field | Type | Description |
|
|
1785
1785
|
|-------|------|-------------|
|
|
1786
|
-
| `packets_received` | int64 |
|
|
1787
|
-
| `packets_received_lost` | int32 |
|
|
1788
|
-
| `packet_ack_sent` | int32 |
|
|
1789
|
-
| `packet_nack_sent` | int32 |
|
|
1790
|
-
| `bytes_received` | int64 |
|
|
1791
|
-
| `bytes_received_lost` | int64 |
|
|
1792
|
-
| `receive_rate_mbps` | double |
|
|
1793
|
-
| `tsbpd_delay` | int32 |
|
|
1794
|
-
| `bandwidth_mbps` | double |
|
|
1795
|
-
| `rtt_ms` | double |
|
|
1786
|
+
| `packets_received` | int64 | |
|
|
1787
|
+
| `packets_received_lost` | int32 | |
|
|
1788
|
+
| `packet_ack_sent` | int32 | |
|
|
1789
|
+
| `packet_nack_sent` | int32 | |
|
|
1790
|
+
| `bytes_received` | int64 | |
|
|
1791
|
+
| `bytes_received_lost` | int64 | |
|
|
1792
|
+
| `receive_rate_mbps` | double | |
|
|
1793
|
+
| `tsbpd_delay` | int32 | |
|
|
1794
|
+
| `bandwidth_mbps` | double | |
|
|
1795
|
+
| `rtt_ms` | double | |
|
|
1796
1796
|
|
|
1797
1797
|
|
|
1798
1798
|
### SRTSendStatistics
|
|
@@ -1803,17 +1803,17 @@ Provides detailed metrics for SRT stream transmission.
|
|
|
1803
1803
|
|
|
1804
1804
|
| Field | Type | Description |
|
|
1805
1805
|
|-------|------|-------------|
|
|
1806
|
-
| `packets_sent` | int64 |
|
|
1807
|
-
| `packets_sent_lost` | int32 |
|
|
1808
|
-
| `packets_sent_dropped` | int32 |
|
|
1809
|
-
| `packets_retransmitted` | int32 |
|
|
1810
|
-
| `packet_ack_received` | int32 |
|
|
1811
|
-
| `packet_nack_received` | int32 |
|
|
1812
|
-
| `bytes_sent` | int64 |
|
|
1813
|
-
| `bytes_sent_dropped` | int64 |
|
|
1814
|
-
| `send_rate_mbps` | double |
|
|
1815
|
-
| `bandwidth_mbps` | double |
|
|
1816
|
-
| `rtt_ms` | double |
|
|
1806
|
+
| `packets_sent` | int64 | |
|
|
1807
|
+
| `packets_sent_lost` | int32 | |
|
|
1808
|
+
| `packets_sent_dropped` | int32 | |
|
|
1809
|
+
| `packets_retransmitted` | int32 | |
|
|
1810
|
+
| `packet_ack_received` | int32 | |
|
|
1811
|
+
| `packet_nack_received` | int32 | |
|
|
1812
|
+
| `bytes_sent` | int64 | |
|
|
1813
|
+
| `bytes_sent_dropped` | int64 | |
|
|
1814
|
+
| `send_rate_mbps` | double | |
|
|
1815
|
+
| `bandwidth_mbps` | double | |
|
|
1816
|
+
| `rtt_ms` | double | |
|
|
1817
1817
|
|
|
1818
1818
|
|
|
1819
1819
|
### SystemStatus
|
|
@@ -1824,25 +1824,23 @@ Provides overall system health and performance metrics.
|
|
|
1824
1824
|
|
|
1825
1825
|
| Field | Type | Description |
|
|
1826
1826
|
|-------|------|-------------|
|
|
1827
|
-
| `uptime` | uint64 |
|
|
1828
|
-
| `framedrops` | uint32 |
|
|
1829
|
-
| `framerate` | float |
|
|
1830
|
-
| `gpu_mem` | uint64 |
|
|
1831
|
-
| `cpu_mem` | uint64 |
|
|
1832
|
-
| `mem_gpu_pool` | MemoryDomainStats |
|
|
1833
|
-
| `mem_cpu_pool` | MemoryDomainStats |
|
|
1834
|
-
| `mem_gpu_adhoc` | MemoryDomainStats |
|
|
1835
|
-
| `mem_gpu_pinned` | MemoryDomainStats |
|
|
1836
|
-
| `gpu_mem_total` | uint64 |
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
| `
|
|
1840
|
-
| `
|
|
1841
|
-
| `
|
|
1842
|
-
| `
|
|
1843
|
-
| `
|
|
1844
|
-
| `gpu_name` | string | GPU model name |
|
|
1845
|
-
| `vma_bytes` | uint64 | Vulkan Memory Allocator total bytes |
|
|
1827
|
+
| `uptime` | uint64 | |
|
|
1828
|
+
| `framedrops` | uint32 | |
|
|
1829
|
+
| `framerate` | float | |
|
|
1830
|
+
| `gpu_mem` | uint64 | |
|
|
1831
|
+
| `cpu_mem` | uint64 | |
|
|
1832
|
+
| `mem_gpu_pool` | MemoryDomainStats | |
|
|
1833
|
+
| `mem_cpu_pool` | MemoryDomainStats | |
|
|
1834
|
+
| `mem_gpu_adhoc` | MemoryDomainStats | |
|
|
1835
|
+
| `mem_gpu_pinned` | MemoryDomainStats | |
|
|
1836
|
+
| `gpu_mem_total` | uint64 | |
|
|
1837
|
+
| `gpu_mem_used` | uint64 | |
|
|
1838
|
+
| `gpu_utilization` | uint32 | |
|
|
1839
|
+
| `gpu_mem_utilization` | uint32 | |
|
|
1840
|
+
| `gpu_encoder_utilization` | uint32 | |
|
|
1841
|
+
| `gpu_decoder_utilization` | uint32 | |
|
|
1842
|
+
| `gpu_name` | string | |
|
|
1843
|
+
| `vma_bytes` | uint64 | |
|
|
1846
1844
|
|
|
1847
1845
|
|
|
1848
1846
|
---
|
|
@@ -1875,7 +1873,7 @@ Compositor status.
|
|
|
1875
1873
|
|
|
1876
1874
|
| Field | Type | Description |
|
|
1877
1875
|
|-------|------|-------------|
|
|
1878
|
-
| `id` | string |
|
|
1876
|
+
| `id` | string | |
|
|
1879
1877
|
|
|
1880
1878
|
|
|
1881
1879
|
### ErrorEvent
|
|
@@ -1885,7 +1883,7 @@ Error event.
|
|
|
1885
1883
|
|
|
1886
1884
|
| Field | Type | Description |
|
|
1887
1885
|
|-------|------|-------------|
|
|
1888
|
-
| `msg` | string |
|
|
1886
|
+
| `msg` | string | |
|
|
1889
1887
|
|
|
1890
1888
|
|
|
1891
1889
|
### Event
|
|
@@ -1895,11 +1893,11 @@ Event message wrapper.
|
|
|
1895
1893
|
|
|
1896
1894
|
| Field | Type | Description |
|
|
1897
1895
|
|-------|------|-------------|
|
|
1898
|
-
| `error_event` | ErrorEvent |
|
|
1899
|
-
| `transport_event` | TransportEvent |
|
|
1900
|
-
| `callback_event` | sesame.v1.common.Callback |
|
|
1901
|
-
| `job_event` | sesame.v1.jobs.Job |
|
|
1902
|
-
| `recorder_event` | sesame.v1.recorder.RecorderEvent |
|
|
1896
|
+
| `error_event` | ErrorEvent | |
|
|
1897
|
+
| `transport_event` | TransportEvent | |
|
|
1898
|
+
| `callback_event` | sesame.v1.common.Callback | |
|
|
1899
|
+
| `job_event` | sesame.v1.jobs.Job | |
|
|
1900
|
+
| `recorder_event` | sesame.v1.recorder.RecorderEvent | |
|
|
1903
1901
|
|
|
1904
1902
|
|
|
1905
1903
|
### IODeviceItem
|
|
@@ -1909,9 +1907,9 @@ I/O device item.
|
|
|
1909
1907
|
|
|
1910
1908
|
| Field | Type | Description |
|
|
1911
1909
|
|-------|------|-------------|
|
|
1912
|
-
| `id` | string |
|
|
1913
|
-
| `name` | string |
|
|
1914
|
-
| `type` | IODeviceType |
|
|
1910
|
+
| `id` | string | |
|
|
1911
|
+
| `name` | string | |
|
|
1912
|
+
| `type` | IODeviceType | |
|
|
1915
1913
|
|
|
1916
1914
|
|
|
1917
1915
|
### IODeviceListResponse
|
|
@@ -1921,7 +1919,7 @@ I/O device list response.
|
|
|
1921
1919
|
|
|
1922
1920
|
| Field | Type | Description |
|
|
1923
1921
|
|-------|------|-------------|
|
|
1924
|
-
| `devices` | repeated IODeviceItem |
|
|
1922
|
+
| `devices` | repeated IODeviceItem | |
|
|
1925
1923
|
|
|
1926
1924
|
|
|
1927
1925
|
### Status
|
|
@@ -1931,14 +1929,14 @@ Overall system status.
|
|
|
1931
1929
|
|
|
1932
1930
|
| Field | Type | Description |
|
|
1933
1931
|
|-------|------|-------------|
|
|
1934
|
-
| `system_status` | SystemStatus |
|
|
1935
|
-
| `render_status_gpu` | FrameTiming |
|
|
1936
|
-
| `render_status_cpu` | FrameTiming |
|
|
1937
|
-
| `sources` | repeated sesame.v1.sources.SourceStatus |
|
|
1938
|
-
| `compositions` | repeated CompositorStatus |
|
|
1939
|
-
| `audio_mixes` | repeated sesame.v1.audio.AudioMixerStatus |
|
|
1940
|
-
| `outputs` | repeated sesame.v1.outputs.OutputStatus |
|
|
1941
|
-
| `recorders` | repeated sesame.v1.recorder.RecorderStatus |
|
|
1932
|
+
| `system_status` | SystemStatus | |
|
|
1933
|
+
| `render_status_gpu` | FrameTiming | |
|
|
1934
|
+
| `render_status_cpu` | FrameTiming | |
|
|
1935
|
+
| `sources` | repeated sesame.v1.sources.SourceStatus | |
|
|
1936
|
+
| `compositions` | repeated CompositorStatus | |
|
|
1937
|
+
| `audio_mixes` | repeated sesame.v1.audio.AudioMixerStatus | |
|
|
1938
|
+
| `outputs` | repeated sesame.v1.outputs.OutputStatus | |
|
|
1939
|
+
| `recorders` | repeated sesame.v1.recorder.RecorderStatus | |
|
|
1942
1940
|
|
|
1943
1941
|
|
|
1944
1942
|
### SubscriptionRequest
|
|
@@ -1948,8 +1946,8 @@ Subscription request.
|
|
|
1948
1946
|
|
|
1949
1947
|
| Field | Type | Description |
|
|
1950
1948
|
|-------|------|-------------|
|
|
1951
|
-
| `event_topics` | repeated sesame.v1.common.EventTopic |
|
|
1952
|
-
| `channels` | repeated string |
|
|
1949
|
+
| `event_topics` | repeated sesame.v1.common.EventTopic | |
|
|
1950
|
+
| `channels` | repeated string | |
|
|
1953
1951
|
|
|
1954
1952
|
|
|
1955
1953
|
### TransportEvent
|
|
@@ -1959,24 +1957,24 @@ Transport event (source playback state change).
|
|
|
1959
1957
|
|
|
1960
1958
|
| Field | Type | Description |
|
|
1961
1959
|
|-------|------|-------------|
|
|
1962
|
-
| `source_id` | string |
|
|
1963
|
-
| `user_id` | string |
|
|
1964
|
-
| `uri` | string |
|
|
1965
|
-
| `state` | sesame.v1.sources.SourceTransportState |
|
|
1966
|
-
| `duration_us` | int64 |
|
|
1967
|
-
| `position_us` | int64 |
|
|
1968
|
-
| `material_position_us` | int64 |
|
|
1969
|
-
| `user_time_us` | int64 |
|
|
1970
|
-
| `speed` | float |
|
|
1971
|
-
| `user_playlist_id` | string |
|
|
1972
|
-
| `playlist_index` | uint32 |
|
|
1973
|
-
| `playlist_length` | uint32 |
|
|
1974
|
-
| `clip_id` | uint64 |
|
|
1975
|
-
| `clip_position_us` | int64 |
|
|
1976
|
-
| `clip_duration_us` | int64 |
|
|
1977
|
-
| `preroll` | uint32 |
|
|
1978
|
-
| `postroll` | uint32 |
|
|
1979
|
-
| `metadata` | sesame.v1.common.TransportMetadata |
|
|
1960
|
+
| `source_id` | string | |
|
|
1961
|
+
| `user_id` | string | |
|
|
1962
|
+
| `uri` | string | |
|
|
1963
|
+
| `state` | sesame.v1.sources.SourceTransportState | |
|
|
1964
|
+
| `duration_us` | int64 | |
|
|
1965
|
+
| `position_us` | int64 | |
|
|
1966
|
+
| `material_position_us` | int64 | |
|
|
1967
|
+
| `user_time_us` | int64 | |
|
|
1968
|
+
| `speed` | float | |
|
|
1969
|
+
| `user_playlist_id` | string | |
|
|
1970
|
+
| `playlist_index` | uint32 | |
|
|
1971
|
+
| `playlist_length` | uint32 | |
|
|
1972
|
+
| `clip_id` | uint64 | |
|
|
1973
|
+
| `clip_position_us` | int64 | |
|
|
1974
|
+
| `clip_duration_us` | int64 | |
|
|
1975
|
+
| `preroll` | uint32 | |
|
|
1976
|
+
| `postroll` | uint32 | |
|
|
1977
|
+
| `metadata` | sesame.v1.common.TransportMetadata | |
|
|
1980
1978
|
|
|
1981
1979
|
|
|
1982
1980
|
---
|
|
@@ -2012,9 +2010,9 @@ Serialized with a 4-byte little-endian size prefix on the wire.
|
|
|
2012
2010
|
|
|
2013
2011
|
| Field | Type | Description |
|
|
2014
2012
|
|-------|------|-------------|
|
|
2015
|
-
| `type` | FrameType |
|
|
2016
|
-
| `routing_metadata` | string |
|
|
2017
|
-
| `media` | MediaFrameData |
|
|
2013
|
+
| `type` | FrameType | |
|
|
2014
|
+
| `routing_metadata` | string | |
|
|
2015
|
+
| `media` | MediaFrameData | |
|
|
2018
2016
|
|
|
2019
2017
|
|
|
2020
2018
|
### MediaCodecData
|
|
@@ -2024,16 +2022,16 @@ Codec parameters for a media stream.
|
|
|
2024
2022
|
|
|
2025
2023
|
| Field | Type | Description |
|
|
2026
2024
|
|-------|------|-------------|
|
|
2027
|
-
| `codec_type` | sesame.v1.common.CodecType |
|
|
2028
|
-
| `sample_rate` | uint32 |
|
|
2029
|
-
| `timebase_num` | uint32 |
|
|
2030
|
-
| `timebase_den` | uint32 |
|
|
2031
|
-
| `codec_profile` | uint32 |
|
|
2032
|
-
| `codec_level` | uint32 |
|
|
2033
|
-
| `width` | uint32 |
|
|
2034
|
-
| `height` | uint32 |
|
|
2035
|
-
| `channels` | uint32 |
|
|
2036
|
-
| `bit_depth` | uint32 |
|
|
2025
|
+
| `codec_type` | sesame.v1.common.CodecType | |
|
|
2026
|
+
| `sample_rate` | uint32 | |
|
|
2027
|
+
| `timebase_num` | uint32 | |
|
|
2028
|
+
| `timebase_den` | uint32 | |
|
|
2029
|
+
| `codec_profile` | uint32 | |
|
|
2030
|
+
| `codec_level` | uint32 | |
|
|
2031
|
+
| `width` | uint32 | |
|
|
2032
|
+
| `height` | uint32 | |
|
|
2033
|
+
| `channels` | uint32 | |
|
|
2034
|
+
| `bit_depth` | uint32 | |
|
|
2037
2035
|
|
|
2038
2036
|
|
|
2039
2037
|
### MediaFrameData
|
|
@@ -2043,9 +2041,9 @@ Media-specific fields for VIDEO, AUDIO, MUXED, and DECODER_DATA frames.
|
|
|
2043
2041
|
|
|
2044
2042
|
| Field | Type | Description |
|
|
2045
2043
|
|-------|------|-------------|
|
|
2046
|
-
| `pts` | uint64 |
|
|
2047
|
-
| `keyframe` | bool |
|
|
2048
|
-
| `codec_data` | MediaCodecData |
|
|
2044
|
+
| `pts` | uint64 | |
|
|
2045
|
+
| `keyframe` | bool | |
|
|
2046
|
+
| `codec_data` | MediaCodecData | |
|
|
2049
2047
|
|
|
2050
2048
|
|
|
2051
2049
|
---
|
|
@@ -2150,10 +2148,10 @@ Properties are set via `PropertySetRequest` or animated via `PropertyAnimateRequ
|
|
|
2150
2148
|
| Property | Type | Description |
|
|
2151
2149
|
|----------|------|-------------|
|
|
2152
2150
|
| `clip-plane` | vec4 | Clip plane XYZW |
|
|
2153
|
-
| `clip-plane.
|
|
2154
|
-
| `clip-plane.
|
|
2155
|
-
| `clip-plane.
|
|
2156
|
-
| `clip-plane.
|
|
2151
|
+
| `clip-plane.x` | float | Clip plane X |
|
|
2152
|
+
| `clip-plane.y` | float | Clip plane Y |
|
|
2153
|
+
| `clip-plane.z` | float | Clip plane Z |
|
|
2154
|
+
| `clip-plane.w` | float | Clip plane W |
|
|
2157
2155
|
| `feather` | float | Feather amount |
|
|
2158
2156
|
|
|
2159
2157
|
### Audio Mixer Domain (`domain.audio_mixer_id`)
|