@prdb/sdk 0.9.0 → 0.11.0

package/dist/generated/models/index.d.ts

@@ -979,6 +979,12 @@ export declare function createUpdateWantedVideoResponseFromDiscriminatorValue(pa
  * @returns {UserIdentityResponse}
  */
 export declare function createUserIdentityResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {VideoCodecCountDto}
+ */
+export declare function createVideoCodecCountDtoFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
 /**
  * Creates a new instance of the appropriate class based on discriminator value
  * @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
  * @returns {VideoImageChangesCursorDto}
  */
 export declare function createVideoImageChangesCursorDtoFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {VideoQualityOverviewDto}
+ */
+export declare function createVideoQualityOverviewDtoFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
+/**
+ * Creates a new instance of the appropriate class based on discriminator value
+ * @param parseNode The parse node to use to read the discriminator value and create the object
+ * @returns {VideoResolutionCountDto}
+ */
+export declare function createVideoResolutionCountDtoFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
 /**
  * Creates a new instance of the appropriate class based on discriminator value
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -1591,6 +1609,12 @@ export declare function deserializeIntoUpdateWantedVideoResponse(updateWantedVid
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoUserIdentityResponse(userIdentityResponse?: Partial<UserIdentityResponse> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param VideoCodecCountDto The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoVideoCodecCountDto(videoCodecCountDto?: Partial<VideoCodecCountDto> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param VideoDetailActorDto The instance to deserialize into.
@@ -1681,6 +1705,18 @@ export declare function deserializeIntoVideoImageChangeImageDto(videoImageChange
  * @returns {Record<string, (node: ParseNode) => void>}
  */
 export declare function deserializeIntoVideoImageChangesCursorDto(videoImageChangesCursorDto?: Partial<VideoImageChangesCursorDto> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param VideoQualityOverviewDto The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoVideoQualityOverviewDto(videoQualityOverviewDto?: Partial<VideoQualityOverviewDto> | undefined): Record<string, (node: ParseNode) => void>;
+/**
+ * The deserialization information for the current model
+ * @param VideoResolutionCountDto The instance to deserialize into.
+ * @returns {Record<string, (node: ParseNode) => void>}
+ */
+export declare function deserializeIntoVideoResolutionCountDto(videoResolutionCountDto?: Partial<VideoResolutionCountDto> | undefined): Record<string, (node: ParseNode) => void>;
 /**
  * The deserialization information for the current model
  * @param VideoSummaryActorDto The instance to deserialize into.
@@ -3371,6 +3407,13 @@ export declare function serializeUpdateWantedVideoResponse(writer: Serialization
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeUserIdentityResponse(writer: SerializationWriter, userIdentityResponse?: Partial<UserIdentityResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param VideoCodecCountDto The instance to serialize from.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeVideoCodecCountDto(writer: SerializationWriter, videoCodecCountDto?: Partial<VideoCodecCountDto> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -3476,6 +3519,20 @@ export declare function serializeVideoImageChangeImageDto(writer: SerializationW
  * @param writer Serialization writer to use to serialize this model
  */
 export declare function serializeVideoImageChangesCursorDto(writer: SerializationWriter, videoImageChangesCursorDto?: Partial<VideoImageChangesCursorDto> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param VideoQualityOverviewDto The instance to serialize from.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeVideoQualityOverviewDto(writer: SerializationWriter, videoQualityOverviewDto?: Partial<VideoQualityOverviewDto> | undefined | null, isSerializingDerivedType?: boolean): void;
+/**
+ * Serializes information the current object
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
+ * @param VideoResolutionCountDto The instance to serialize from.
+ * @param writer Serialization writer to use to serialize this model
+ */
+export declare function serializeVideoResolutionCountDto(writer: SerializationWriter, videoResolutionCountDto?: Partial<VideoResolutionCountDto> | undefined | null, isSerializingDerivedType?: boolean): void;
 /**
  * Serializes information the current object
  * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
@@ -3594,6 +3651,26 @@ export interface SubmitVideoFilehashesResponse extends AdditionalDataHolder, Par
  * A single hash-to-video assignment.
  */
 export interface SubmitVideoFilehashItem extends AdditionalDataHolder, Parsable {
+    /**
+     * Channel count of the audio stream.
+     */
+    audioChannels?: number | null;
+    /**
+     * Codec of the audio stream, as the probe names it ("aac", "mp3").
+     */
+    audioCodec?: string | null;
+    /**
+     * Overall bit rate of the file in bits per second, across all streams.
+     */
+    bitRate?: number | null;
+    /**
+     * Container of the file as the probe names it. Send it verbatim — it is usually a commaseparated list of the formats the demuxer covers ("mov,mp4,m4a,3gp,3g2,mj2"), not one token.
+     */
+    containerFormat?: string | null;
+    /**
+     * Duration of the file in milliseconds, if the client probed it. Optional, like every fieldbelow it: a client that cannot or will not probe submits without them.
+     */
+    durationMs?: number | null;
     /**
      * File name without directory. Optional — a client may withhold it, and the endpoint works without it.
      */
@@ -3602,6 +3679,14 @@ export interface SubmitVideoFilehashItem extends AdditionalDataHolder, Parsable
      * Size of the file in bytes.
      */
     filesize?: number | null;
+    /**
+     * Average frame rate as the rational the probe reports, verbatim: "24000/1001", not "23.976".Rounding merges rates that are not the same one, and for a variable-rate file the largedenominator is the only sign that the value is an average rather than a rate.
+     */
+    frameRate?: string | null;
+    /**
+     * Height of the video stream in pixels, as stored.
+     */
+    height?: number | null;
     /**
      * OS hash of the file, 16 hexadecimal characters. Required; it is the only aggregation key.
      */
@@ -3618,10 +3703,18 @@ export interface SubmitVideoFilehashItem extends AdditionalDataHolder, Parsable
      * Known values: UserConfirmed (0), ClientDetected (1).
      */
     source?: number | null;
+    /**
+     * Codec of the video stream, as the probe names it ("h264", "hevc", "av1").
+     */
+    videoCodec?: string | null;
     /**
      * The video this file is. Required — a hash observation without an assignment is not accepted.
      */
     videoId?: Guid | null;
+    /**
+     * Width of the video stream in pixels, as stored. Do not reorder it with the height to make the file landscape.
+     */
+    width?: number | null;
 }
 /**
  * What happened to one submitted assignment.
@@ -3759,6 +3852,19 @@ export interface UserIdentityResponse extends AdditionalDataHolder, Parsable {
      */
     userHash?: string | null;
 }
+/**
+ * One video codec a video is known in, and how many of its files carry it.
+ */
+export interface VideoCodecCountDto extends AdditionalDataHolder, Parsable {
+    /**
+     * Codec name as the probing client reported it, lower-cased ("h264", "hevc", "av1").
+     */
+    codec?: string | null;
+    /**
+     * How many of the video's files use this codec.
+     */
+    fileCount?: number | null;
+}
 export interface VideoDetailActorDto extends AdditionalDataHolder, Parsable {
     /**
      * The birthday property
@@ -3813,6 +3919,18 @@ export interface VideoDetailDto extends AdditionalDataHolder, Parsable {
      * The createdAtUtc property
      */
     createdAtUtc?: Date | null;
+    /**
+     * 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.
+     */
+    durationFileCount?: number | null;
+    /**
+     * 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.
+     */
+    durationMs?: number | null;
+    /**
+     * 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.
+     */
+    durationSpreadMs?: number | null;
     /**
      * The id property
      */
@@ -3825,6 +3943,10 @@ export interface VideoDetailDto extends AdditionalDataHolder, Parsable {
      * The preNames property
      */
     preNames?: VideoDetailPreNameDto[] | null;
+    /**
+     * What technical shapes a video is known to exist in, counted over the files prdb holds for it.
+     */
+    qualityOverview?: VideoQualityOverviewDto | null;
     /**
      * The releaseDate property
      */
@@ -3916,6 +4038,22 @@ export interface VideoFilehashChangeDto extends AdditionalDataHolder, Parsable {
  * Current persisted state of a changed video filehash row, including soft-delete fields.
  */
 export interface VideoFilehashChangeFilehashDto extends AdditionalDataHolder, Parsable {
+    /**
+     * Channel count of the audio stream.
+     */
+    audioChannels?: number | null;
+    /**
+     * Codec of the audio stream, lower-cased ("aac", "mp3").
+     */
+    audioCodec?: string | null;
+    /**
+     * Overall bit rate in bits per second, across all streams.
+     */
+    bitRate?: number | null;
+    /**
+     * 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.
+     */
+    containerFormat?: string | null;
     /**
      * The createdAtUtc property
      */
@@ -3924,6 +4062,10 @@ export interface VideoFilehashChangeFilehashDto extends AdditionalDataHolder, Pa
      * Timestamp when the row was soft-deleted, or null when still active.
      */
     deletedAtUtc?: Date | null;
+    /**
+     * Duration of this file in milliseconds, as the submitting clients probed it, or null when none reported one.
+     */
+    durationMs?: number | null;
     /**
      * Original filename submitted for this filehash record.
      */
@@ -3932,6 +4074,14 @@ export interface VideoFilehashChangeFilehashDto extends AdditionalDataHolder, Pa
      * File size in bytes.
      */
     filesize?: number | null;
+    /**
+     * 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.
+     */
+    frameRate?: string | null;
+    /**
+     * Height of the video stream in pixels, as stored.
+     */
+    height?: number | null;
     /**
      * The id property
      */
@@ -3960,10 +4110,18 @@ export interface VideoFilehashChangeFilehashDto extends AdditionalDataHolder, Pa
      * The updatedAtUtc property
      */
     updatedAtUtc?: Date | null;
+    /**
+     * Codec of the video stream, lower-cased ("h264", "hevc", "av1").
+     */
+    videoCodec?: string | null;
     /**
      * The videoId property
      */
     videoId?: Guid | null;
+    /**
+     * Width of the video stream in pixels, as stored. Not necessarily the larger dimension: portrait video is ordinary.
+     */
+    width?: number | null;
 }
 /**
  * Seek cursor for continuing a video filehash change feed.
@@ -3979,10 +4137,30 @@ export interface VideoFilehashChangesCursorDto extends AdditionalDataHolder, Par
     updatedAtUtc?: Date | null;
 }
 export interface VideoFilehashDto extends AdditionalDataHolder, Parsable {
+    /**
+     * Channel count of the audio stream.
+     */
+    audioChannels?: number | null;
+    /**
+     * Codec of the audio stream, lower-cased ("aac", "mp3").
+     */
+    audioCodec?: string | null;
+    /**
+     * Overall bit rate in bits per second, across all streams.
+     */
+    bitRate?: number | null;
+    /**
+     * 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.
+     */
+    containerFormat?: string | null;
     /**
      * The createdAtUtc property
      */
     createdAtUtc?: Date | null;
+    /**
+     * Duration of this file in milliseconds, as the submitting clients probed it, or null when none reported one.
+     */
+    durationMs?: number | null;
     /**
      * Original filename submitted for this filehash record.
      */
@@ -3991,6 +4169,14 @@ export interface VideoFilehashDto extends AdditionalDataHolder, Parsable {
      * File size in bytes.
      */
     filesize?: number | null;
+    /**
+     * 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.
+     */
+    frameRate?: string | null;
+    /**
+     * Height of the video stream in pixels, as stored.
+     */
+    height?: number | null;
     /**
      * The id property
      */
@@ -4015,10 +4201,18 @@ export interface VideoFilehashDto extends AdditionalDataHolder, Parsable {
      * The updatedAtUtc property
      */
     updatedAtUtc?: Date | null;
+    /**
+     * Codec of the video stream, lower-cased ("h264", "hevc", "av1").
+     */
+    videoCodec?: string | null;
     /**
      * The videoId property
      */
     videoId?: Guid | null;
+    /**
+     * Width of the video stream in pixels, as stored. Not necessarily the larger dimension: portrait video is ordinary.
+     */
+    width?: number | null;
 }
 export interface VideoFilehashesByVideoIdDto extends AdditionalDataHolder, Parsable {
     /**
@@ -4081,6 +4275,36 @@ export interface VideoImageChangesCursorDto extends AdditionalDataHolder, Parsab
      */
     updatedAtUtc?: Date | null;
 }
+/**
+ * What technical shapes a video is known to exist in, counted over the files prdb holds for it.
+ */
+export interface VideoQualityOverviewDto extends AdditionalDataHolder, Parsable {
+    /**
+     * 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.
+     */
+    resolutions?: VideoResolutionCountDto[] | null;
+    /**
+     * Video codecs the video is known in, most files first.
+     */
+    videoCodecs?: VideoCodecCountDto[] | null;
+}
+/**
+ * One resolution a video is known in, and how many of its files carry it.
+ */
+export interface VideoResolutionCountDto extends AdditionalDataHolder, Parsable {
+    /**
+     * How many of the video's files are in this resolution.
+     */
+    fileCount?: number | null;
+    /**
+     * Height in pixels, as stored.
+     */
+    height?: number | null;
+    /**
+     * Width in pixels, as stored.
+     */
+    width?: number | null;
+}
 /**
  * Minimal actor summary included in a video list item.
  */
@@ -4106,6 +4330,18 @@ export interface VideoSummaryDto extends AdditionalDataHolder, Parsable {
      * Timestamp when the video was created in PRDB.
      */
     createdAtUtc?: Date | null;
+    /**
+     * How many files the duration was taken over, without which the spread cannot be read.
+     */
+    durationFileCount?: number | null;
+    /**
+     * 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.
+     */
+    durationMs?: number | null;
+    /**
+     * 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.
+     */
+    durationSpreadMs?: number | null;
     /**
      * Unique identifier of the video.
      */