@stinkycomputing/sesame-api-client 1.6.0 → 1.8.0
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/README.md +14 -2
- package/dist/command-list.d.ts +1 -1
- package/dist/command-list.d.ts.map +1 -1
- package/dist/index.browser.mjs +790 -51
- package/dist/index.browser.mjs.map +2 -2
- package/dist/index.cjs +790 -51
- package/dist/index.cjs.map +2 -2
- package/dist/index.mjs +790 -51
- package/dist/index.mjs.map +2 -2
- package/dist/proto/api.d.ts +290 -12
- package/dist/proto/api.js +1169 -158
- package/docs/protocol-reference.md +122 -7
- package/package.json +1 -1
package/dist/proto/api.d.ts
CHANGED
|
@@ -4616,6 +4616,13 @@ export namespace sesame {
|
|
|
4616
4616
|
SIGNAL_GENERATOR_AUDIO_MODE_SILENCE = 3
|
|
4617
4617
|
}
|
|
4618
4618
|
|
|
4619
|
+
/** SignalGeneratorTimecodeMode enum. */
|
|
4620
|
+
enum SignalGeneratorTimecodeMode {
|
|
4621
|
+
SIGNAL_GENERATOR_TIMECODE_MODE_NONE = 0,
|
|
4622
|
+
SIGNAL_GENERATOR_TIMECODE_MODE_FREE_RUN = 1,
|
|
4623
|
+
SIGNAL_GENERATOR_TIMECODE_MODE_TIME_OF_DAY = 2
|
|
4624
|
+
}
|
|
4625
|
+
|
|
4619
4626
|
/** Properties of a SignalGeneratorSourceConfig. */
|
|
4620
4627
|
interface ISignalGeneratorSourceConfig {
|
|
4621
4628
|
|
|
@@ -4627,6 +4634,12 @@ export namespace sesame {
|
|
|
4627
4634
|
|
|
4628
4635
|
/** SignalGeneratorSourceConfig audioMode */
|
|
4629
4636
|
audioMode?: (sesame.v1.sources.SignalGeneratorAudioMode|null);
|
|
4637
|
+
|
|
4638
|
+
/** SignalGeneratorSourceConfig timecodeMode */
|
|
4639
|
+
timecodeMode?: (sesame.v1.sources.SignalGeneratorTimecodeMode|null);
|
|
4640
|
+
|
|
4641
|
+
/** SignalGeneratorSourceConfig timecodeStartFrame */
|
|
4642
|
+
timecodeStartFrame?: (number|null);
|
|
4630
4643
|
}
|
|
4631
4644
|
|
|
4632
4645
|
/** Represents a SignalGeneratorSourceConfig. */
|
|
@@ -4647,6 +4660,12 @@ export namespace sesame {
|
|
|
4647
4660
|
/** SignalGeneratorSourceConfig audioMode. */
|
|
4648
4661
|
public audioMode: sesame.v1.sources.SignalGeneratorAudioMode;
|
|
4649
4662
|
|
|
4663
|
+
/** SignalGeneratorSourceConfig timecodeMode. */
|
|
4664
|
+
public timecodeMode: sesame.v1.sources.SignalGeneratorTimecodeMode;
|
|
4665
|
+
|
|
4666
|
+
/** SignalGeneratorSourceConfig timecodeStartFrame. */
|
|
4667
|
+
public timecodeStartFrame: number;
|
|
4668
|
+
|
|
4650
4669
|
/**
|
|
4651
4670
|
* Creates a new SignalGeneratorSourceConfig instance using the specified properties.
|
|
4652
4671
|
* @param [properties] Properties to set
|
|
@@ -9267,6 +9286,12 @@ export namespace sesame {
|
|
|
9267
9286
|
|
|
9268
9287
|
/** SystemStatus version */
|
|
9269
9288
|
version?: (string|null);
|
|
9289
|
+
|
|
9290
|
+
/** SystemStatus nvencSessions */
|
|
9291
|
+
nvencSessions?: (number|null);
|
|
9292
|
+
|
|
9293
|
+
/** SystemStatus nvdecSessions */
|
|
9294
|
+
nvdecSessions?: (number|null);
|
|
9270
9295
|
}
|
|
9271
9296
|
|
|
9272
9297
|
/** Represents a SystemStatus. */
|
|
@@ -9332,6 +9357,12 @@ export namespace sesame {
|
|
|
9332
9357
|
/** SystemStatus version. */
|
|
9333
9358
|
public version: string;
|
|
9334
9359
|
|
|
9360
|
+
/** SystemStatus nvencSessions. */
|
|
9361
|
+
public nvencSessions: number;
|
|
9362
|
+
|
|
9363
|
+
/** SystemStatus nvdecSessions. */
|
|
9364
|
+
public nvdecSessions: number;
|
|
9365
|
+
|
|
9335
9366
|
/**
|
|
9336
9367
|
* Creates a new SystemStatus instance using the specified properties.
|
|
9337
9368
|
* @param [properties] Properties to set
|
|
@@ -10545,12 +10576,222 @@ export namespace sesame {
|
|
|
10545
10576
|
ENCODER_TYPE_VIDEO = 1
|
|
10546
10577
|
}
|
|
10547
10578
|
|
|
10548
|
-
/**
|
|
10549
|
-
enum
|
|
10550
|
-
|
|
10551
|
-
|
|
10552
|
-
|
|
10553
|
-
|
|
10579
|
+
/** EncoderTuning enum. */
|
|
10580
|
+
enum EncoderTuning {
|
|
10581
|
+
ENCODER_TUNING_UNSPECIFIED = 0,
|
|
10582
|
+
ENCODER_TUNING_ULTRA_LOW_LATENCY = 1,
|
|
10583
|
+
ENCODER_TUNING_LOW_LATENCY = 2,
|
|
10584
|
+
ENCODER_TUNING_HIGH_QUALITY = 3
|
|
10585
|
+
}
|
|
10586
|
+
|
|
10587
|
+
/** EncoderRateControl enum. */
|
|
10588
|
+
enum EncoderRateControl {
|
|
10589
|
+
ENCODER_RATE_CONTROL_UNSPECIFIED = 0,
|
|
10590
|
+
ENCODER_RATE_CONTROL_CBR = 1,
|
|
10591
|
+
ENCODER_RATE_CONTROL_VBR = 2
|
|
10592
|
+
}
|
|
10593
|
+
|
|
10594
|
+
/** EncoderProfile enum. */
|
|
10595
|
+
enum EncoderProfile {
|
|
10596
|
+
ENCODER_PROFILE_AUTO = 0,
|
|
10597
|
+
ENCODER_PROFILE_BASELINE = 1,
|
|
10598
|
+
ENCODER_PROFILE_MAIN = 2,
|
|
10599
|
+
ENCODER_PROFILE_MAIN10 = 3,
|
|
10600
|
+
ENCODER_PROFILE_HIGH = 4
|
|
10601
|
+
}
|
|
10602
|
+
|
|
10603
|
+
/** EncoderMultipass enum. */
|
|
10604
|
+
enum EncoderMultipass {
|
|
10605
|
+
ENCODER_MULTIPASS_DISABLED = 0,
|
|
10606
|
+
ENCODER_MULTIPASS_QUARTER_RESOLUTION = 1,
|
|
10607
|
+
ENCODER_MULTIPASS_FULL_RESOLUTION = 2
|
|
10608
|
+
}
|
|
10609
|
+
|
|
10610
|
+
/** EncoderChromaFormat enum. */
|
|
10611
|
+
enum EncoderChromaFormat {
|
|
10612
|
+
ENCODER_CHROMA_FORMAT_420 = 0,
|
|
10613
|
+
ENCODER_CHROMA_FORMAT_444 = 1
|
|
10614
|
+
}
|
|
10615
|
+
|
|
10616
|
+
/** Properties of an EncoderSettings. */
|
|
10617
|
+
interface IEncoderSettings {
|
|
10618
|
+
|
|
10619
|
+
/** EncoderSettings tuning */
|
|
10620
|
+
tuning?: (sesame.v1.outputs.EncoderTuning|null);
|
|
10621
|
+
|
|
10622
|
+
/** EncoderSettings effort */
|
|
10623
|
+
effort?: (number|null);
|
|
10624
|
+
|
|
10625
|
+
/** EncoderSettings rateControl */
|
|
10626
|
+
rateControl?: (sesame.v1.outputs.EncoderRateControl|null);
|
|
10627
|
+
|
|
10628
|
+
/** EncoderSettings maxBitrateKbps */
|
|
10629
|
+
maxBitrateKbps?: (number|null);
|
|
10630
|
+
|
|
10631
|
+
/** EncoderSettings profile */
|
|
10632
|
+
profile?: (sesame.v1.outputs.EncoderProfile|null);
|
|
10633
|
+
|
|
10634
|
+
/** EncoderSettings bframes */
|
|
10635
|
+
bframes?: (number|null);
|
|
10636
|
+
|
|
10637
|
+
/** EncoderSettings idrOnly */
|
|
10638
|
+
idrOnly?: (boolean|null);
|
|
10639
|
+
|
|
10640
|
+
/** EncoderSettings spatialAq */
|
|
10641
|
+
spatialAq?: (boolean|null);
|
|
10642
|
+
|
|
10643
|
+
/** EncoderSettings multipass */
|
|
10644
|
+
multipass?: (sesame.v1.outputs.EncoderMultipass|null);
|
|
10645
|
+
|
|
10646
|
+
/** EncoderSettings lookaheadDepth */
|
|
10647
|
+
lookaheadDepth?: (number|null);
|
|
10648
|
+
|
|
10649
|
+
/** EncoderSettings zeroReorderDelay */
|
|
10650
|
+
zeroReorderDelay?: (boolean|null);
|
|
10651
|
+
|
|
10652
|
+
/** EncoderSettings bitDepth */
|
|
10653
|
+
bitDepth?: (number|null);
|
|
10654
|
+
|
|
10655
|
+
/** EncoderSettings chromaFormat */
|
|
10656
|
+
chromaFormat?: (sesame.v1.outputs.EncoderChromaFormat|null);
|
|
10657
|
+
|
|
10658
|
+
/** EncoderSettings outputAud */
|
|
10659
|
+
outputAud?: (boolean|null);
|
|
10660
|
+
|
|
10661
|
+
/** EncoderSettings level */
|
|
10662
|
+
level?: (string|null);
|
|
10663
|
+
}
|
|
10664
|
+
|
|
10665
|
+
/** Represents an EncoderSettings. */
|
|
10666
|
+
class EncoderSettings implements IEncoderSettings {
|
|
10667
|
+
|
|
10668
|
+
/**
|
|
10669
|
+
* Constructs a new EncoderSettings.
|
|
10670
|
+
* @param [properties] Properties to set
|
|
10671
|
+
*/
|
|
10672
|
+
constructor(properties?: sesame.v1.outputs.IEncoderSettings);
|
|
10673
|
+
|
|
10674
|
+
/** EncoderSettings tuning. */
|
|
10675
|
+
public tuning: sesame.v1.outputs.EncoderTuning;
|
|
10676
|
+
|
|
10677
|
+
/** EncoderSettings effort. */
|
|
10678
|
+
public effort: number;
|
|
10679
|
+
|
|
10680
|
+
/** EncoderSettings rateControl. */
|
|
10681
|
+
public rateControl: sesame.v1.outputs.EncoderRateControl;
|
|
10682
|
+
|
|
10683
|
+
/** EncoderSettings maxBitrateKbps. */
|
|
10684
|
+
public maxBitrateKbps: number;
|
|
10685
|
+
|
|
10686
|
+
/** EncoderSettings profile. */
|
|
10687
|
+
public profile: sesame.v1.outputs.EncoderProfile;
|
|
10688
|
+
|
|
10689
|
+
/** EncoderSettings bframes. */
|
|
10690
|
+
public bframes: number;
|
|
10691
|
+
|
|
10692
|
+
/** EncoderSettings idrOnly. */
|
|
10693
|
+
public idrOnly: boolean;
|
|
10694
|
+
|
|
10695
|
+
/** EncoderSettings spatialAq. */
|
|
10696
|
+
public spatialAq: boolean;
|
|
10697
|
+
|
|
10698
|
+
/** EncoderSettings multipass. */
|
|
10699
|
+
public multipass: sesame.v1.outputs.EncoderMultipass;
|
|
10700
|
+
|
|
10701
|
+
/** EncoderSettings lookaheadDepth. */
|
|
10702
|
+
public lookaheadDepth: number;
|
|
10703
|
+
|
|
10704
|
+
/** EncoderSettings zeroReorderDelay. */
|
|
10705
|
+
public zeroReorderDelay: boolean;
|
|
10706
|
+
|
|
10707
|
+
/** EncoderSettings bitDepth. */
|
|
10708
|
+
public bitDepth: number;
|
|
10709
|
+
|
|
10710
|
+
/** EncoderSettings chromaFormat. */
|
|
10711
|
+
public chromaFormat: sesame.v1.outputs.EncoderChromaFormat;
|
|
10712
|
+
|
|
10713
|
+
/** EncoderSettings outputAud. */
|
|
10714
|
+
public outputAud: boolean;
|
|
10715
|
+
|
|
10716
|
+
/** EncoderSettings level. */
|
|
10717
|
+
public level: string;
|
|
10718
|
+
|
|
10719
|
+
/**
|
|
10720
|
+
* Creates a new EncoderSettings instance using the specified properties.
|
|
10721
|
+
* @param [properties] Properties to set
|
|
10722
|
+
* @returns EncoderSettings instance
|
|
10723
|
+
*/
|
|
10724
|
+
public static create(properties?: sesame.v1.outputs.IEncoderSettings): sesame.v1.outputs.EncoderSettings;
|
|
10725
|
+
|
|
10726
|
+
/**
|
|
10727
|
+
* Encodes the specified EncoderSettings message. Does not implicitly {@link sesame.v1.outputs.EncoderSettings.verify|verify} messages.
|
|
10728
|
+
* @param message EncoderSettings message or plain object to encode
|
|
10729
|
+
* @param [writer] Writer to encode to
|
|
10730
|
+
* @returns Writer
|
|
10731
|
+
*/
|
|
10732
|
+
public static encode(message: sesame.v1.outputs.IEncoderSettings, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
10733
|
+
|
|
10734
|
+
/**
|
|
10735
|
+
* Encodes the specified EncoderSettings message, length delimited. Does not implicitly {@link sesame.v1.outputs.EncoderSettings.verify|verify} messages.
|
|
10736
|
+
* @param message EncoderSettings message or plain object to encode
|
|
10737
|
+
* @param [writer] Writer to encode to
|
|
10738
|
+
* @returns Writer
|
|
10739
|
+
*/
|
|
10740
|
+
public static encodeDelimited(message: sesame.v1.outputs.IEncoderSettings, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
10741
|
+
|
|
10742
|
+
/**
|
|
10743
|
+
* Decodes an EncoderSettings message from the specified reader or buffer.
|
|
10744
|
+
* @param reader Reader or buffer to decode from
|
|
10745
|
+
* @param [length] Message length if known beforehand
|
|
10746
|
+
* @returns EncoderSettings
|
|
10747
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
10748
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
10749
|
+
*/
|
|
10750
|
+
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): sesame.v1.outputs.EncoderSettings;
|
|
10751
|
+
|
|
10752
|
+
/**
|
|
10753
|
+
* Decodes an EncoderSettings message from the specified reader or buffer, length delimited.
|
|
10754
|
+
* @param reader Reader or buffer to decode from
|
|
10755
|
+
* @returns EncoderSettings
|
|
10756
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
10757
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
10758
|
+
*/
|
|
10759
|
+
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): sesame.v1.outputs.EncoderSettings;
|
|
10760
|
+
|
|
10761
|
+
/**
|
|
10762
|
+
* Verifies an EncoderSettings message.
|
|
10763
|
+
* @param message Plain object to verify
|
|
10764
|
+
* @returns `null` if valid, otherwise the reason why it is not
|
|
10765
|
+
*/
|
|
10766
|
+
public static verify(message: { [k: string]: any }): (string|null);
|
|
10767
|
+
|
|
10768
|
+
/**
|
|
10769
|
+
* Creates an EncoderSettings message from a plain object. Also converts values to their respective internal types.
|
|
10770
|
+
* @param object Plain object
|
|
10771
|
+
* @returns EncoderSettings
|
|
10772
|
+
*/
|
|
10773
|
+
public static fromObject(object: { [k: string]: any }): sesame.v1.outputs.EncoderSettings;
|
|
10774
|
+
|
|
10775
|
+
/**
|
|
10776
|
+
* Creates a plain object from an EncoderSettings message. Also converts values to other types if specified.
|
|
10777
|
+
* @param message EncoderSettings
|
|
10778
|
+
* @param [options] Conversion options
|
|
10779
|
+
* @returns Plain object
|
|
10780
|
+
*/
|
|
10781
|
+
public static toObject(message: sesame.v1.outputs.EncoderSettings, options?: $protobuf.IConversionOptions): { [k: string]: any };
|
|
10782
|
+
|
|
10783
|
+
/**
|
|
10784
|
+
* Converts this EncoderSettings to JSON.
|
|
10785
|
+
* @returns JSON object
|
|
10786
|
+
*/
|
|
10787
|
+
public toJSON(): { [k: string]: any };
|
|
10788
|
+
|
|
10789
|
+
/**
|
|
10790
|
+
* Gets the default type url for EncoderSettings
|
|
10791
|
+
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
|
|
10792
|
+
* @returns The default type url
|
|
10793
|
+
*/
|
|
10794
|
+
public static getTypeUrl(typeUrlPrefix?: string): string;
|
|
10554
10795
|
}
|
|
10555
10796
|
|
|
10556
10797
|
/** RecorderType enum. */
|
|
@@ -10560,15 +10801,19 @@ export namespace sesame {
|
|
|
10560
10801
|
RECORDER_TYPE_CLIPS = 2
|
|
10561
10802
|
}
|
|
10562
10803
|
|
|
10804
|
+
/** TimecodeMode enum. */
|
|
10805
|
+
enum TimecodeMode {
|
|
10806
|
+
TIMECODE_MODE_UNSPECIFIED = 0,
|
|
10807
|
+
TIMECODE_MODE_WALLCLOCK = 1,
|
|
10808
|
+
TIMECODE_MODE_SOURCE = 2
|
|
10809
|
+
}
|
|
10810
|
+
|
|
10563
10811
|
/** Properties of an EncoderConfig. */
|
|
10564
10812
|
interface IEncoderConfig {
|
|
10565
10813
|
|
|
10566
10814
|
/** EncoderConfig codec */
|
|
10567
10815
|
codec?: (sesame.v1.common.CodecType|null);
|
|
10568
10816
|
|
|
10569
|
-
/** EncoderConfig preset */
|
|
10570
|
-
preset?: (sesame.v1.outputs.EncoderPreset|null);
|
|
10571
|
-
|
|
10572
10817
|
/** EncoderConfig bitrateKbps */
|
|
10573
10818
|
bitrateKbps?: (number|null);
|
|
10574
10819
|
|
|
@@ -10583,6 +10828,15 @@ export namespace sesame {
|
|
|
10583
10828
|
|
|
10584
10829
|
/** EncoderConfig fps */
|
|
10585
10830
|
fps?: (number|null);
|
|
10831
|
+
|
|
10832
|
+
/** EncoderConfig timecodeMode */
|
|
10833
|
+
timecodeMode?: (sesame.v1.outputs.TimecodeMode|null);
|
|
10834
|
+
|
|
10835
|
+
/** EncoderConfig timecodeSourceId */
|
|
10836
|
+
timecodeSourceId?: (string|null);
|
|
10837
|
+
|
|
10838
|
+
/** EncoderConfig settings */
|
|
10839
|
+
settings?: (sesame.v1.outputs.IEncoderSettings|null);
|
|
10586
10840
|
}
|
|
10587
10841
|
|
|
10588
10842
|
/** Represents an EncoderConfig. */
|
|
@@ -10597,9 +10851,6 @@ export namespace sesame {
|
|
|
10597
10851
|
/** EncoderConfig codec. */
|
|
10598
10852
|
public codec: sesame.v1.common.CodecType;
|
|
10599
10853
|
|
|
10600
|
-
/** EncoderConfig preset. */
|
|
10601
|
-
public preset: sesame.v1.outputs.EncoderPreset;
|
|
10602
|
-
|
|
10603
10854
|
/** EncoderConfig bitrateKbps. */
|
|
10604
10855
|
public bitrateKbps: number;
|
|
10605
10856
|
|
|
@@ -10615,6 +10866,15 @@ export namespace sesame {
|
|
|
10615
10866
|
/** EncoderConfig fps. */
|
|
10616
10867
|
public fps: number;
|
|
10617
10868
|
|
|
10869
|
+
/** EncoderConfig timecodeMode. */
|
|
10870
|
+
public timecodeMode: sesame.v1.outputs.TimecodeMode;
|
|
10871
|
+
|
|
10872
|
+
/** EncoderConfig timecodeSourceId. */
|
|
10873
|
+
public timecodeSourceId: string;
|
|
10874
|
+
|
|
10875
|
+
/** EncoderConfig settings. */
|
|
10876
|
+
public settings?: (sesame.v1.outputs.IEncoderSettings|null);
|
|
10877
|
+
|
|
10618
10878
|
/**
|
|
10619
10879
|
* Creates a new EncoderConfig instance using the specified properties.
|
|
10620
10880
|
* @param [properties] Properties to set
|
|
@@ -11019,6 +11279,12 @@ export namespace sesame {
|
|
|
11019
11279
|
|
|
11020
11280
|
/** DecklinkOutputConfig keyAndFill */
|
|
11021
11281
|
keyAndFill?: (boolean|null);
|
|
11282
|
+
|
|
11283
|
+
/** DecklinkOutputConfig timecodeMode */
|
|
11284
|
+
timecodeMode?: (sesame.v1.outputs.TimecodeMode|null);
|
|
11285
|
+
|
|
11286
|
+
/** DecklinkOutputConfig timecodeSourceId */
|
|
11287
|
+
timecodeSourceId?: (string|null);
|
|
11022
11288
|
}
|
|
11023
11289
|
|
|
11024
11290
|
/** Represents a DecklinkOutputConfig. */
|
|
@@ -11039,6 +11305,12 @@ export namespace sesame {
|
|
|
11039
11305
|
/** DecklinkOutputConfig keyAndFill. */
|
|
11040
11306
|
public keyAndFill: boolean;
|
|
11041
11307
|
|
|
11308
|
+
/** DecklinkOutputConfig timecodeMode. */
|
|
11309
|
+
public timecodeMode: sesame.v1.outputs.TimecodeMode;
|
|
11310
|
+
|
|
11311
|
+
/** DecklinkOutputConfig timecodeSourceId. */
|
|
11312
|
+
public timecodeSourceId: string;
|
|
11313
|
+
|
|
11042
11314
|
/**
|
|
11043
11315
|
* Creates a new DecklinkOutputConfig instance using the specified properties.
|
|
11044
11316
|
* @param [properties] Properties to set
|
|
@@ -12471,6 +12743,9 @@ export namespace sesame {
|
|
|
12471
12743
|
|
|
12472
12744
|
/** EncoderStatus compositionId */
|
|
12473
12745
|
compositionId?: (string|null);
|
|
12746
|
+
|
|
12747
|
+
/** EncoderStatus droppedFrames */
|
|
12748
|
+
droppedFrames?: (number|null);
|
|
12474
12749
|
}
|
|
12475
12750
|
|
|
12476
12751
|
/** Represents an EncoderStatus. */
|
|
@@ -12497,6 +12772,9 @@ export namespace sesame {
|
|
|
12497
12772
|
/** EncoderStatus compositionId. */
|
|
12498
12773
|
public compositionId: string;
|
|
12499
12774
|
|
|
12775
|
+
/** EncoderStatus droppedFrames. */
|
|
12776
|
+
public droppedFrames: number;
|
|
12777
|
+
|
|
12500
12778
|
/**
|
|
12501
12779
|
* Creates a new EncoderStatus instance using the specified properties.
|
|
12502
12780
|
* @param [properties] Properties to set
|