@prdb/sdk 0.10.0 → 0.12.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.
@@ -979,6 +979,12 @@ export declare function createUpdateWantedVideoResponseFromDiscriminatorValue(pa
979
979
  * @returns {UserIdentityResponse}
980
980
  */
981
981
  export declare function createUserIdentityResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
982
+ /**
983
+ * Creates a new instance of the appropriate class based on discriminator value
984
+ * @param parseNode The parse node to use to read the discriminator value and create the object
985
+ * @returns {VideoCodecCountDto}
986
+ */
987
+ export declare function createVideoCodecCountDtoFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
982
988
  /**
983
989
  * Creates a new instance of the appropriate class based on discriminator value
984
990
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -1069,6 +1075,18 @@ export declare function createVideoImageChangeImageDtoFromDiscriminatorValue(par
1069
1075
  * @returns {VideoImageChangesCursorDto}
1070
1076
  */
1071
1077
  export declare function createVideoImageChangesCursorDtoFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1078
+ /**
1079
+ * Creates a new instance of the appropriate class based on discriminator value
1080
+ * @param parseNode The parse node to use to read the discriminator value and create the object
1081
+ * @returns {VideoQualityOverviewDto}
1082
+ */
1083
+ export declare function createVideoQualityOverviewDtoFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1084
+ /**
1085
+ * Creates a new instance of the appropriate class based on discriminator value
1086
+ * @param parseNode The parse node to use to read the discriminator value and create the object
1087
+ * @returns {VideoResolutionCountDto}
1088
+ */
1089
+ export declare function createVideoResolutionCountDtoFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1072
1090
  /**
1073
1091
  * Creates a new instance of the appropriate class based on discriminator value
1074
1092
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -1117,6 +1135,12 @@ export declare function createWantedVideoChangesCursorDtoFromDiscriminatorValue(
1117
1135
  * @returns {WantedVideoChangeWantedVideoDto}
1118
1136
  */
1119
1137
  export declare function createWantedVideoChangeWantedVideoDtoFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1138
+ /**
1139
+ * Creates a new instance of the appropriate class based on discriminator value
1140
+ * @param parseNode The parse node to use to read the discriminator value and create the object
1141
+ * @returns {WantedVideoLimitProblemDetails}
1142
+ */
1143
+ export declare function createWantedVideoLimitProblemDetailsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
1120
1144
  /**
1121
1145
  * Creates a new instance of the appropriate class based on discriminator value
1122
1146
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -1591,6 +1615,12 @@ export declare function deserializeIntoUpdateWantedVideoResponse(updateWantedVid
1591
1615
  * @returns {Record<string, (node: ParseNode) => void>}
1592
1616
  */
1593
1617
  export declare function deserializeIntoUserIdentityResponse(userIdentityResponse?: Partial<UserIdentityResponse> | undefined): Record<string, (node: ParseNode) => void>;
1618
+ /**
1619
+ * The deserialization information for the current model
1620
+ * @param VideoCodecCountDto The instance to deserialize into.
1621
+ * @returns {Record<string, (node: ParseNode) => void>}
1622
+ */
1623
+ export declare function deserializeIntoVideoCodecCountDto(videoCodecCountDto?: Partial<VideoCodecCountDto> | undefined): Record<string, (node: ParseNode) => void>;
1594
1624
  /**
1595
1625
  * The deserialization information for the current model
1596
1626
  * @param VideoDetailActorDto The instance to deserialize into.
@@ -1681,6 +1711,18 @@ export declare function deserializeIntoVideoImageChangeImageDto(videoImageChange
1681
1711
  * @returns {Record<string, (node: ParseNode) => void>}
1682
1712
  */
1683
1713
  export declare function deserializeIntoVideoImageChangesCursorDto(videoImageChangesCursorDto?: Partial<VideoImageChangesCursorDto> | undefined): Record<string, (node: ParseNode) => void>;
1714
+ /**
1715
+ * The deserialization information for the current model
1716
+ * @param VideoQualityOverviewDto The instance to deserialize into.
1717
+ * @returns {Record<string, (node: ParseNode) => void>}
1718
+ */
1719
+ export declare function deserializeIntoVideoQualityOverviewDto(videoQualityOverviewDto?: Partial<VideoQualityOverviewDto> | undefined): Record<string, (node: ParseNode) => void>;
1720
+ /**
1721
+ * The deserialization information for the current model
1722
+ * @param VideoResolutionCountDto The instance to deserialize into.
1723
+ * @returns {Record<string, (node: ParseNode) => void>}
1724
+ */
1725
+ export declare function deserializeIntoVideoResolutionCountDto(videoResolutionCountDto?: Partial<VideoResolutionCountDto> | undefined): Record<string, (node: ParseNode) => void>;
1684
1726
  /**
1685
1727
  * The deserialization information for the current model
1686
1728
  * @param VideoSummaryActorDto The instance to deserialize into.
@@ -1729,6 +1771,12 @@ export declare function deserializeIntoWantedVideoChangesCursorDto(wantedVideoCh
1729
1771
  * @returns {Record<string, (node: ParseNode) => void>}
1730
1772
  */
1731
1773
  export declare function deserializeIntoWantedVideoChangeWantedVideoDto(wantedVideoChangeWantedVideoDto?: Partial<WantedVideoChangeWantedVideoDto> | undefined): Record<string, (node: ParseNode) => void>;
1774
+ /**
1775
+ * The deserialization information for the current model
1776
+ * @param WantedVideoLimitProblemDetails The instance to deserialize into.
1777
+ * @returns {Record<string, (node: ParseNode) => void>}
1778
+ */
1779
+ export declare function deserializeIntoWantedVideoLimitProblemDetails(wantedVideoLimitProblemDetails?: Partial<WantedVideoLimitProblemDetails> | undefined): Record<string, (node: ParseNode) => void>;
1732
1780
  /**
1733
1781
  * The deserialization information for the current model
1734
1782
  * @param WantedVideoSummaryDto The instance to deserialize into.
@@ -3371,6 +3419,13 @@ export declare function serializeUpdateWantedVideoResponse(writer: Serialization
3371
3419
  * @param writer Serialization writer to use to serialize this model
3372
3420
  */
3373
3421
  export declare function serializeUserIdentityResponse(writer: SerializationWriter, userIdentityResponse?: Partial<UserIdentityResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
3422
+ /**
3423
+ * Serializes information the current object
3424
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
3425
+ * @param VideoCodecCountDto The instance to serialize from.
3426
+ * @param writer Serialization writer to use to serialize this model
3427
+ */
3428
+ export declare function serializeVideoCodecCountDto(writer: SerializationWriter, videoCodecCountDto?: Partial<VideoCodecCountDto> | undefined | null, isSerializingDerivedType?: boolean): void;
3374
3429
  /**
3375
3430
  * Serializes information the current object
3376
3431
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -3476,6 +3531,20 @@ export declare function serializeVideoImageChangeImageDto(writer: SerializationW
3476
3531
  * @param writer Serialization writer to use to serialize this model
3477
3532
  */
3478
3533
  export declare function serializeVideoImageChangesCursorDto(writer: SerializationWriter, videoImageChangesCursorDto?: Partial<VideoImageChangesCursorDto> | undefined | null, isSerializingDerivedType?: boolean): void;
3534
+ /**
3535
+ * Serializes information the current object
3536
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
3537
+ * @param VideoQualityOverviewDto The instance to serialize from.
3538
+ * @param writer Serialization writer to use to serialize this model
3539
+ */
3540
+ export declare function serializeVideoQualityOverviewDto(writer: SerializationWriter, videoQualityOverviewDto?: Partial<VideoQualityOverviewDto> | undefined | null, isSerializingDerivedType?: boolean): void;
3541
+ /**
3542
+ * Serializes information the current object
3543
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
3544
+ * @param VideoResolutionCountDto The instance to serialize from.
3545
+ * @param writer Serialization writer to use to serialize this model
3546
+ */
3547
+ export declare function serializeVideoResolutionCountDto(writer: SerializationWriter, videoResolutionCountDto?: Partial<VideoResolutionCountDto> | undefined | null, isSerializingDerivedType?: boolean): void;
3479
3548
  /**
3480
3549
  * Serializes information the current object
3481
3550
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -3532,6 +3601,13 @@ export declare function serializeWantedVideoChangesCursorDto(writer: Serializati
3532
3601
  * @param writer Serialization writer to use to serialize this model
3533
3602
  */
3534
3603
  export declare function serializeWantedVideoChangeWantedVideoDto(writer: SerializationWriter, wantedVideoChangeWantedVideoDto?: Partial<WantedVideoChangeWantedVideoDto> | undefined | null, isSerializingDerivedType?: boolean): void;
3604
+ /**
3605
+ * Serializes information the current object
3606
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
3607
+ * @param WantedVideoLimitProblemDetails The instance to serialize from.
3608
+ * @param writer Serialization writer to use to serialize this model
3609
+ */
3610
+ export declare function serializeWantedVideoLimitProblemDetails(writer: SerializationWriter, wantedVideoLimitProblemDetails?: Partial<WantedVideoLimitProblemDetails> | undefined | null, isSerializingDerivedType?: boolean): void;
3535
3611
  /**
3536
3612
  * Serializes information the current object
3537
3613
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -3795,6 +3871,19 @@ export interface UserIdentityResponse extends AdditionalDataHolder, Parsable {
3795
3871
  */
3796
3872
  userHash?: string | null;
3797
3873
  }
3874
+ /**
3875
+ * One video codec a video is known in, and how many of its files carry it.
3876
+ */
3877
+ export interface VideoCodecCountDto extends AdditionalDataHolder, Parsable {
3878
+ /**
3879
+ * Codec name as the probing client reported it, lower-cased ("h264", "hevc", "av1").
3880
+ */
3881
+ codec?: string | null;
3882
+ /**
3883
+ * How many of the video's files use this codec.
3884
+ */
3885
+ fileCount?: number | null;
3886
+ }
3798
3887
  export interface VideoDetailActorDto extends AdditionalDataHolder, Parsable {
3799
3888
  /**
3800
3889
  * The birthday property
@@ -3849,6 +3938,18 @@ export interface VideoDetailDto extends AdditionalDataHolder, Parsable {
3849
3938
  * The createdAtUtc property
3850
3939
  */
3851
3940
  createdAtUtc?: Date | null;
3941
+ /**
3942
+ * How many files the duration was taken over. The spread cannot be read without it — one overtwo files says far less than one over twenty. Null exactly when `durationMs` is null.
3943
+ */
3944
+ durationFileCount?: number | null;
3945
+ /**
3946
+ * Consensus duration in milliseconds across the files prdb holds for this video, or null whiletoo few independent submitters have reported one. A median, not an average: durations differlegitimately — cuts, with and without an intro, re-encodes with padding — and one shortoutlier would drag an average off the value the real files agree on.
3947
+ */
3948
+ durationMs?: number | null;
3949
+ /**
3950
+ * How far the files disagree about the duration, in milliseconds (median absolute deviation).Zero means every file agrees; a large value means several versions are in circulation, whichis the more useful of the two statements. Null exactly when `durationMs` is null.
3951
+ */
3952
+ durationSpreadMs?: number | null;
3852
3953
  /**
3853
3954
  * The id property
3854
3955
  */
@@ -3861,6 +3962,10 @@ export interface VideoDetailDto extends AdditionalDataHolder, Parsable {
3861
3962
  * The preNames property
3862
3963
  */
3863
3964
  preNames?: VideoDetailPreNameDto[] | null;
3965
+ /**
3966
+ * What technical shapes a video is known to exist in, counted over the files prdb holds for it.
3967
+ */
3968
+ qualityOverview?: VideoQualityOverviewDto | null;
3864
3969
  /**
3865
3970
  * The releaseDate property
3866
3971
  */
@@ -3952,6 +4057,22 @@ export interface VideoFilehashChangeDto extends AdditionalDataHolder, Parsable {
3952
4057
  * Current persisted state of a changed video filehash row, including soft-delete fields.
3953
4058
  */
3954
4059
  export interface VideoFilehashChangeFilehashDto extends AdditionalDataHolder, Parsable {
4060
+ /**
4061
+ * Channel count of the audio stream.
4062
+ */
4063
+ audioChannels?: number | null;
4064
+ /**
4065
+ * Codec of the audio stream, lower-cased ("aac", "mp3").
4066
+ */
4067
+ audioCodec?: string | null;
4068
+ /**
4069
+ * Overall bit rate in bits per second, across all streams.
4070
+ */
4071
+ bitRate?: number | null;
4072
+ /**
4073
+ * Container as the probe names it. Usually a comma separated list of the formats one demuxer covers ("mov,mp4,m4a,3gp,3g2,mj2"), not a single token.
4074
+ */
4075
+ containerFormat?: string | null;
3955
4076
  /**
3956
4077
  * The createdAtUtc property
3957
4078
  */
@@ -3960,6 +4081,10 @@ export interface VideoFilehashChangeFilehashDto extends AdditionalDataHolder, Pa
3960
4081
  * Timestamp when the row was soft-deleted, or null when still active.
3961
4082
  */
3962
4083
  deletedAtUtc?: Date | null;
4084
+ /**
4085
+ * Duration of this file in milliseconds, as the submitting clients probed it, or null when none reported one.
4086
+ */
4087
+ durationMs?: number | null;
3963
4088
  /**
3964
4089
  * Original filename submitted for this filehash record.
3965
4090
  */
@@ -3968,6 +4093,14 @@ export interface VideoFilehashChangeFilehashDto extends AdditionalDataHolder, Pa
3968
4093
  * File size in bytes.
3969
4094
  */
3970
4095
  filesize?: number | null;
4096
+ /**
4097
+ * Average frame rate as a rational, exactly as it was measured: "24000/1001", never a roundeddecimal. Rounding merges rates that are not the same one, and a variable-rate file carries aper-file average whose large denominator is what marks it as variable rather than as a rate.
4098
+ */
4099
+ frameRate?: string | null;
4100
+ /**
4101
+ * Height of the video stream in pixels, as stored.
4102
+ */
4103
+ height?: number | null;
3971
4104
  /**
3972
4105
  * The id property
3973
4106
  */
@@ -3996,10 +4129,18 @@ export interface VideoFilehashChangeFilehashDto extends AdditionalDataHolder, Pa
3996
4129
  * The updatedAtUtc property
3997
4130
  */
3998
4131
  updatedAtUtc?: Date | null;
4132
+ /**
4133
+ * Codec of the video stream, lower-cased ("h264", "hevc", "av1").
4134
+ */
4135
+ videoCodec?: string | null;
3999
4136
  /**
4000
4137
  * The videoId property
4001
4138
  */
4002
4139
  videoId?: Guid | null;
4140
+ /**
4141
+ * Width of the video stream in pixels, as stored. Not necessarily the larger dimension: portrait video is ordinary.
4142
+ */
4143
+ width?: number | null;
4003
4144
  }
4004
4145
  /**
4005
4146
  * Seek cursor for continuing a video filehash change feed.
@@ -4015,10 +4156,30 @@ export interface VideoFilehashChangesCursorDto extends AdditionalDataHolder, Par
4015
4156
  updatedAtUtc?: Date | null;
4016
4157
  }
4017
4158
  export interface VideoFilehashDto extends AdditionalDataHolder, Parsable {
4159
+ /**
4160
+ * Channel count of the audio stream.
4161
+ */
4162
+ audioChannels?: number | null;
4163
+ /**
4164
+ * Codec of the audio stream, lower-cased ("aac", "mp3").
4165
+ */
4166
+ audioCodec?: string | null;
4167
+ /**
4168
+ * Overall bit rate in bits per second, across all streams.
4169
+ */
4170
+ bitRate?: number | null;
4171
+ /**
4172
+ * Container as the probe names it. Usually a comma separated list of the formats one demuxer covers ("mov,mp4,m4a,3gp,3g2,mj2"), not a single token.
4173
+ */
4174
+ containerFormat?: string | null;
4018
4175
  /**
4019
4176
  * The createdAtUtc property
4020
4177
  */
4021
4178
  createdAtUtc?: Date | null;
4179
+ /**
4180
+ * Duration of this file in milliseconds, as the submitting clients probed it, or null when none reported one.
4181
+ */
4182
+ durationMs?: number | null;
4022
4183
  /**
4023
4184
  * Original filename submitted for this filehash record.
4024
4185
  */
@@ -4027,6 +4188,14 @@ export interface VideoFilehashDto extends AdditionalDataHolder, Parsable {
4027
4188
  * File size in bytes.
4028
4189
  */
4029
4190
  filesize?: number | null;
4191
+ /**
4192
+ * Average frame rate as a rational, exactly as it was measured: "24000/1001", never a roundeddecimal. Rounding merges rates that are not the same one, and a variable-rate file carries aper-file average whose large denominator is what marks it as variable rather than as a rate.
4193
+ */
4194
+ frameRate?: string | null;
4195
+ /**
4196
+ * Height of the video stream in pixels, as stored.
4197
+ */
4198
+ height?: number | null;
4030
4199
  /**
4031
4200
  * The id property
4032
4201
  */
@@ -4051,10 +4220,18 @@ export interface VideoFilehashDto extends AdditionalDataHolder, Parsable {
4051
4220
  * The updatedAtUtc property
4052
4221
  */
4053
4222
  updatedAtUtc?: Date | null;
4223
+ /**
4224
+ * Codec of the video stream, lower-cased ("h264", "hevc", "av1").
4225
+ */
4226
+ videoCodec?: string | null;
4054
4227
  /**
4055
4228
  * The videoId property
4056
4229
  */
4057
4230
  videoId?: Guid | null;
4231
+ /**
4232
+ * Width of the video stream in pixels, as stored. Not necessarily the larger dimension: portrait video is ordinary.
4233
+ */
4234
+ width?: number | null;
4058
4235
  }
4059
4236
  export interface VideoFilehashesByVideoIdDto extends AdditionalDataHolder, Parsable {
4060
4237
  /**
@@ -4117,6 +4294,36 @@ export interface VideoImageChangesCursorDto extends AdditionalDataHolder, Parsab
4117
4294
  */
4118
4295
  updatedAtUtc?: Date | null;
4119
4296
  }
4297
+ /**
4298
+ * What technical shapes a video is known to exist in, counted over the files prdb holds for it.
4299
+ */
4300
+ export interface VideoQualityOverviewDto extends AdditionalDataHolder, Parsable {
4301
+ /**
4302
+ * Resolutions the video is known in, most files first. Width and height are as stored, neverreordered — a portrait file has the smaller width, and treating the larger side as "theresolution" is wrong for a substantial share of real libraries.
4303
+ */
4304
+ resolutions?: VideoResolutionCountDto[] | null;
4305
+ /**
4306
+ * Video codecs the video is known in, most files first.
4307
+ */
4308
+ videoCodecs?: VideoCodecCountDto[] | null;
4309
+ }
4310
+ /**
4311
+ * One resolution a video is known in, and how many of its files carry it.
4312
+ */
4313
+ export interface VideoResolutionCountDto extends AdditionalDataHolder, Parsable {
4314
+ /**
4315
+ * How many of the video's files are in this resolution.
4316
+ */
4317
+ fileCount?: number | null;
4318
+ /**
4319
+ * Height in pixels, as stored.
4320
+ */
4321
+ height?: number | null;
4322
+ /**
4323
+ * Width in pixels, as stored.
4324
+ */
4325
+ width?: number | null;
4326
+ }
4120
4327
  /**
4121
4328
  * Minimal actor summary included in a video list item.
4122
4329
  */
@@ -4142,6 +4349,18 @@ export interface VideoSummaryDto extends AdditionalDataHolder, Parsable {
4142
4349
  * Timestamp when the video was created in PRDB.
4143
4350
  */
4144
4351
  createdAtUtc?: Date | null;
4352
+ /**
4353
+ * How many files the duration was taken over, without which the spread cannot be read.
4354
+ */
4355
+ durationFileCount?: number | null;
4356
+ /**
4357
+ * Consensus duration in milliseconds across the files prdb holds for this video, or null whiletoo few independent submitters have reported one. A median over the video's files, so atrailer submitted under the same video does not move it.
4358
+ */
4359
+ durationMs?: number | null;
4360
+ /**
4361
+ * How far those files disagree about the duration, in milliseconds (median absolutedeviation). Zero means they agree; a large value means several versions are in circulation.
4362
+ */
4363
+ durationSpreadMs?: number | null;
4145
4364
  /**
4146
4365
  * Unique identifier of the video.
4147
4366
  */
@@ -4373,6 +4592,47 @@ export interface WantedVideoChangeWantedVideoDto extends AdditionalDataHolder, P
4373
4592
  */
4374
4593
  videoTitle?: string | null;
4375
4594
  }
4595
+ /**
4596
+ * Problem response returned when adding wanted videos would exceed the current limit.
4597
+ */
4598
+ export interface WantedVideoLimitProblemDetails extends AdditionalDataHolder, ApiError, Parsable {
4599
+ /**
4600
+ * Stable machine-readable error code.
4601
+ */
4602
+ code?: string | null;
4603
+ /**
4604
+ * The detail property
4605
+ */
4606
+ detail?: string | null;
4607
+ /**
4608
+ * The instance property
4609
+ */
4610
+ instance?: string | null;
4611
+ /**
4612
+ * Current wanted video limit.
4613
+ */
4614
+ limit?: number | null;
4615
+ /**
4616
+ * Number of entries that can still be added.
4617
+ */
4618
+ remaining?: number | null;
4619
+ /**
4620
+ * The status property
4621
+ */
4622
+ status?: number | null;
4623
+ /**
4624
+ * The title property
4625
+ */
4626
+ title?: string | null;
4627
+ /**
4628
+ * The type property
4629
+ */
4630
+ type?: string | null;
4631
+ /**
4632
+ * Current number of non-deleted wanted videos.
4633
+ */
4634
+ used?: number | null;
4635
+ }
4376
4636
  /**
4377
4637
  * A wanted video entry for the current user.
4378
4638
  */