spotted-ts 0.1.0

package/resources/audio-analysis.d.mts

@@ -0,0 +1,365 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class AudioAnalysis extends APIResource {
+    /**
+     * Get a low-level audio analysis for a track in the Spotify catalog. The audio
+     * analysis describes the track’s structure and musical content, including rhythm,
+     * pitch, and timbre.
+     *
+     * @deprecated
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<AudioAnalysisRetrieveResponse>;
+}
+export interface TimeIntervalObject {
+    /**
+     * The confidence, from 0.0 to 1.0, of the reliability of the interval.
+     */
+    confidence?: number;
+    /**
+     * The duration (in seconds) of the time interval.
+     */
+    duration?: number;
+    /**
+     * The starting point (in seconds) of the time interval.
+     */
+    start?: number;
+}
+export interface AudioAnalysisRetrieveResponse {
+    /**
+     * The time intervals of the bars throughout the track. A bar (or measure) is a
+     * segment of time defined as a given number of beats.
+     */
+    bars?: Array<TimeIntervalObject>;
+    /**
+     * The time intervals of beats throughout the track. A beat is the basic time unit
+     * of a piece of music; for example, each tick of a metronome. Beats are typically
+     * multiples of tatums.
+     */
+    beats?: Array<TimeIntervalObject>;
+    meta?: AudioAnalysisRetrieveResponse.Meta;
+    /**
+     * Sections are defined by large variations in rhythm or timbre, e.g. chorus,
+     * verse, bridge, guitar solo, etc. Each section contains its own descriptions of
+     * tempo, key, mode, time_signature, and loudness.
+     */
+    sections?: Array<AudioAnalysisRetrieveResponse.Section>;
+    /**
+     * Each segment contains a roughly conisistent sound throughout its duration.
+     */
+    segments?: Array<AudioAnalysisRetrieveResponse.Segment>;
+    /**
+     * A tatum represents the lowest regular pulse train that a listener intuitively
+     * infers from the timing of perceived musical events (segments).
+     */
+    tatums?: Array<TimeIntervalObject>;
+    track?: AudioAnalysisRetrieveResponse.Track;
+}
+export declare namespace AudioAnalysisRetrieveResponse {
+    interface Meta {
+        /**
+         * The amount of time taken to analyze this track.
+         */
+        analysis_time?: number;
+        /**
+         * The version of the Analyzer used to analyze this track.
+         */
+        analyzer_version?: string;
+        /**
+         * A detailed status code for this track. If analysis data is missing, this code
+         * may explain why.
+         */
+        detailed_status?: string;
+        /**
+         * The method used to read the track's audio data.
+         */
+        input_process?: string;
+        /**
+         * The platform used to read the track's audio data.
+         */
+        platform?: string;
+        /**
+         * The return code of the analyzer process. 0 if successful, 1 if any errors
+         * occurred.
+         */
+        status_code?: number;
+        /**
+         * The Unix timestamp (in seconds) at which this track was analyzed.
+         */
+        timestamp?: number;
+    }
+    interface Section {
+        /**
+         * The confidence, from 0.0 to 1.0, of the reliability of the section's
+         * "designation".
+         */
+        confidence?: number;
+        /**
+         * The duration (in seconds) of the section.
+         */
+        duration?: number;
+        /**
+         * The estimated overall key of the section. The values in this field ranging from
+         * 0 to 11 mapping to pitches using standard Pitch Class notation (E.g. 0 = C, 1 =
+         * C♯/D♭, 2 = D, and so on). If no key was detected, the value is -1.
+         */
+        key?: number;
+        /**
+         * The confidence, from 0.0 to 1.0, of the reliability of the key. Songs with many
+         * key changes may correspond to low values in this field.
+         */
+        key_confidence?: number;
+        /**
+         * The overall loudness of the section in decibels (dB). Loudness values are useful
+         * for comparing relative loudness of sections within tracks.
+         */
+        loudness?: number;
+        /**
+         * Indicates the modality (major or minor) of a section, the type of scale from
+         * which its melodic content is derived. This field will contain a 0 for "minor", a
+         * 1 for "major", or a -1 for no result. Note that the major key (e.g. C major)
+         * could more likely be confused with the minor key at 3 semitones lower (e.g. A
+         * minor) as both keys carry the same pitches.
+         */
+        mode?: -1 | 0 | 1;
+        /**
+         * The confidence, from 0.0 to 1.0, of the reliability of the `mode`.
+         */
+        mode_confidence?: number;
+        /**
+         * The starting point (in seconds) of the section.
+         */
+        start?: number;
+        /**
+         * The overall estimated tempo of the section in beats per minute (BPM). In musical
+         * terminology, tempo is the speed or pace of a given piece and derives directly
+         * from the average beat duration.
+         */
+        tempo?: number;
+        /**
+         * The confidence, from 0.0 to 1.0, of the reliability of the tempo. Some tracks
+         * contain tempo changes or sounds which don't contain tempo (like pure speech)
+         * which would correspond to a low value in this field.
+         */
+        tempo_confidence?: number;
+        /**
+         * An estimated time signature. The time signature (meter) is a notational
+         * convention to specify how many beats are in each bar (or measure). The time
+         * signature ranges from 3 to 7 indicating time signatures of "3/4", to "7/4".
+         */
+        time_signature?: number;
+        /**
+         * The confidence, from 0.0 to 1.0, of the reliability of the `time_signature`.
+         * Sections with time signature changes may correspond to low values in this field.
+         */
+        time_signature_confidence?: number;
+    }
+    interface Segment {
+        /**
+         * The confidence, from 0.0 to 1.0, of the reliability of the segmentation.
+         * Segments of the song which are difficult to logically segment (e.g: noise) may
+         * correspond to low values in this field.
+         */
+        confidence?: number;
+        /**
+         * The duration (in seconds) of the segment.
+         */
+        duration?: number;
+        /**
+         * The offset loudness of the segment in decibels (dB). This value should be
+         * equivalent to the loudness_start of the following segment.
+         */
+        loudness_end?: number;
+        /**
+         * The peak loudness of the segment in decibels (dB). Combined with
+         * `loudness_start` and `loudness_max_time`, these components can be used to
+         * describe the "attack" of the segment.
+         */
+        loudness_max?: number;
+        /**
+         * The segment-relative offset of the segment peak loudness in seconds. Combined
+         * with `loudness_start` and `loudness_max`, these components can be used to
+         * desctibe the "attack" of the segment.
+         */
+        loudness_max_time?: number;
+        /**
+         * The onset loudness of the segment in decibels (dB). Combined with `loudness_max`
+         * and `loudness_max_time`, these components can be used to describe the "attack"
+         * of the segment.
+         */
+        loudness_start?: number;
+        /**
+         * Pitch content is given by a “chroma” vector, corresponding to the 12 pitch
+         * classes C, C#, D to B, with values ranging from 0 to 1 that describe the
+         * relative dominance of every pitch in the chromatic scale. For example a C Major
+         * chord would likely be represented by large values of C, E and G (i.e. classes 0,
+         * 4, and 7).
+         *
+         * Vectors are normalized to 1 by their strongest dimension, therefore noisy sounds
+         * are likely represented by values that are all close to 1, while pure tones are
+         * described by one value at 1 (the pitch) and others near 0. As can be seen below,
+         * the 12 vector indices are a combination of low-power spectrum values at their
+         * respective pitch frequencies. ![pitch vector](/assets/audio/Pitch_vector.png)
+         */
+        pitches?: Array<number>;
+        /**
+         * The starting point (in seconds) of the segment.
+         */
+        start?: number;
+        /**
+         * Timbre is the quality of a musical note or sound that distinguishes different
+         * types of musical instruments, or voices. It is a complex notion also referred to
+         * as sound color, texture, or tone quality, and is derived from the shape of a
+         * segment’s spectro-temporal surface, independently of pitch and loudness. The
+         * timbre feature is a vector that includes 12 unbounded values roughly centered
+         * around 0. Those values are high level abstractions of the spectral surface,
+         * ordered by degree of importance.
+         *
+         * For completeness however, the first dimension represents the average loudness of
+         * the segment; second emphasizes brightness; third is more closely correlated to
+         * the flatness of a sound; fourth to sounds with a stronger attack; etc. See an
+         * image below representing the 12 basis functions (i.e. template segments).
+         * ![timbre basis functions](/assets/audio/Timbre_basis_functions.png)
+         *
+         * The actual timbre of the segment is best described as a linear combination of
+         * these 12 basis functions weighted by the coefficient values: timbre = c1 x b1 +
+         * c2 x b2 + ... + c12 x b12, where c1 to c12 represent the 12 coefficients and b1
+         * to b12 the 12 basis functions as displayed below. Timbre vectors are best used
+         * in comparison with each other.
+         */
+        timbre?: Array<number>;
+    }
+    interface Track {
+        /**
+         * The number of channels used for analysis. If 1, all channels are summed together
+         * to mono before analysis.
+         */
+        analysis_channels?: number;
+        /**
+         * The sample rate used to decode and analyze this track. May differ from the
+         * actual sample rate of this track available on Spotify.
+         */
+        analysis_sample_rate?: number;
+        /**
+         * A version number for the Echo Nest Musical Fingerprint format used in the
+         * codestring field.
+         */
+        code_version?: number;
+        /**
+         * An
+         * [Echo Nest Musical Fingerprint (ENMFP)](https://academiccommons.columbia.edu/doi/10.7916/D8Q248M4)
+         * codestring for this track.
+         */
+        codestring?: string;
+        /**
+         * Length of the track in seconds.
+         */
+        duration?: number;
+        /**
+         * A version number for the EchoPrint format used in the echoprintstring field.
+         */
+        echoprint_version?: number;
+        /**
+         * An [EchoPrint](https://github.com/spotify/echoprint-codegen) codestring for this
+         * track.
+         */
+        echoprintstring?: string;
+        /**
+         * The time, in seconds, at which the track's fade-in period ends. If the track has
+         * no fade-in, this will be 0.0.
+         */
+        end_of_fade_in?: number;
+        /**
+         * The key the track is in. Integers map to pitches using standard
+         * [Pitch Class notation](https://en.wikipedia.org/wiki/Pitch_class). E.g. 0 = C, 1
+         * = C♯/D♭, 2 = D, and so on. If no key was detected, the value is -1.
+         */
+        key?: number;
+        /**
+         * The confidence, from 0.0 to 1.0, of the reliability of the `key`.
+         */
+        key_confidence?: number;
+        /**
+         * The overall loudness of a track in decibels (dB). Loudness values are averaged
+         * across the entire track and are useful for comparing relative loudness of
+         * tracks. Loudness is the quality of a sound that is the primary psychological
+         * correlate of physical strength (amplitude). Values typically range between -60
+         * and 0 db.
+         */
+        loudness?: number;
+        /**
+         * Mode indicates the modality (major or minor) of a track, the type of scale from
+         * which its melodic content is derived. Major is represented by 1 and minor is 0.
+         */
+        mode?: number;
+        /**
+         * The confidence, from 0.0 to 1.0, of the reliability of the `mode`.
+         */
+        mode_confidence?: number;
+        /**
+         * The exact number of audio samples analyzed from this track. See also
+         * `analysis_sample_rate`.
+         */
+        num_samples?: number;
+        /**
+         * An offset to the start of the region of the track that was analyzed. (As the
+         * entire track is analyzed, this should always be 0.)
+         */
+        offset_seconds?: number;
+        /**
+         * A version number for the Rhythmstring used in the rhythmstring field.
+         */
+        rhythm_version?: number;
+        /**
+         * A Rhythmstring for this track. The format of this string is similar to the
+         * Synchstring.
+         */
+        rhythmstring?: string;
+        /**
+         * This field will always contain the empty string.
+         */
+        sample_md5?: string;
+        /**
+         * The time, in seconds, at which the track's fade-out period starts. If the track
+         * has no fade-out, this should match the track's length.
+         */
+        start_of_fade_out?: number;
+        /**
+         * A version number for the Synchstring used in the synchstring field.
+         */
+        synch_version?: number;
+        /**
+         * A [Synchstring](https://github.com/echonest/synchdata) for this track.
+         */
+        synchstring?: string;
+        /**
+         * The overall estimated tempo of a track in beats per minute (BPM). In musical
+         * terminology, tempo is the speed or pace of a given piece and derives directly
+         * from the average beat duration.
+         */
+        tempo?: number;
+        /**
+         * The confidence, from 0.0 to 1.0, of the reliability of the `tempo`.
+         */
+        tempo_confidence?: number;
+        /**
+         * An estimated time signature. The time signature (meter) is a notational
+         * convention to specify how many beats are in each bar (or measure). The time
+         * signature ranges from 3 to 7 indicating time signatures of "3/4", to "7/4".
+         */
+        time_signature?: number;
+        /**
+         * The confidence, from 0.0 to 1.0, of the reliability of the `time_signature`.
+         */
+        time_signature_confidence?: number;
+        /**
+         * The length of the region of the track was analyzed, if a subset of the track was
+         * analyzed. (As the entire track is analyzed, this should always be 0.)
+         */
+        window_seconds?: number;
+    }
+}
+export declare namespace AudioAnalysis {
+    export { type TimeIntervalObject as TimeIntervalObject, type AudioAnalysisRetrieveResponse as AudioAnalysisRetrieveResponse, };
+}
+//# sourceMappingURL=audio-analysis.d.mts.map

package/resources/audio-analysis.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audio-analysis.d.mts","sourceRoot":"","sources":["../src/resources/audio-analysis.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;CAG1F;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEjC;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAElC,IAAI,CAAC,EAAE,6BAA6B,CAAC,IAAI,CAAC;IAE1C;;;;OAIG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,OAAO,CAAC,CAAC;IAExD;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAEnC,KAAK,CAAC,EAAE,6BAA6B,CAAC,KAAK,CAAC;CAC7C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,OAAO;QACtB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;;;WAMG;QACH,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAElB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;KACpC;IAED,UAAiB,OAAO;QACtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;;;;;;;;;;WAYG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;;;;;;;;;;;;;;;;;WAoBG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACxB;IAED,UAAiB,KAAK;QACpB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;;WAIG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;;WAIG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;;;;WAMG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;QAEnC;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}