Class: Spotted::Models::AudioFeatureRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/spotted/models/audio_feature_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id: nil, acousticness: nil, analysis_url: nil, danceability: nil, duration_ms: nil, energy: nil, instrumentalness: nil, key: nil, liveness: nil, loudness: nil, mode: nil, speechiness: nil, tempo: nil, time_signature: nil, track_href: nil, type: nil, uri: nil, valence: nil) ⇒ Object

Some parameter documentations has been truncated, see Spotted::Models::AudioFeatureRetrieveResponse for more details.

Parameters:

  • id (String) (defaults to: nil) —

    The Spotify ID for the track.

  • acousticness (Float) (defaults to: nil) —

    A confidence measure from 0.0 to 1.0 of whether the track is acoustic. 1.0 repre

  • analysis_url (String) (defaults to: nil) —

    A URL to access the full audio analysis of this track. An access token is requir

  • danceability (Float) (defaults to: nil) —

    Danceability describes how suitable a track is for dancing based on a combinatio

  • duration_ms (Integer) (defaults to: nil) —

    The duration of the track in milliseconds.

  • energy (Float) (defaults to: nil) —

    Energy is a measure from 0.0 to 1.0 and represents a perceptual measure of inten

  • instrumentalness (Float) (defaults to: nil) —

    Predicts whether a track contains no vocals. “Ooh” and “aah” sounds are treated

  • key (Integer) (defaults to: nil) —

    The key the track is in. Integers map to pitches using standard [Pitch Class not

  • liveness (Float) (defaults to: nil) —

    Detects the presence of an audience in the recording. Higher liveness values rep

  • loudness (Float) (defaults to: nil) —

    The overall loudness of a track in decibels (dB). Loudness values are averaged a

  • mode (Integer) (defaults to: nil) —

    Mode indicates the modality (major or minor) of a track, the type of scale from

  • speechiness (Float) (defaults to: nil) —

    Speechiness detects the presence of spoken words in a track. The more exclusivel

  • tempo (Float) (defaults to: nil) —

    The overall estimated tempo of a track in beats per minute (BPM). In musical ter

  • time_signature (Integer) (defaults to: nil) —

    An estimated time signature. The time signature (meter) is a notational conventi

  • track_href (String) (defaults to: nil) —

    A link to the Web API endpoint providing full details of the track.

  • type (Symbol, Spotted::Models::AudioFeatureRetrieveResponse::Type) (defaults to: nil) —

    The object type.

  • uri (String) (defaults to: nil) —

    The Spotify URI for the track.

  • valence (Float) (defaults to: nil) —

    A measure from 0.0 to 1.0 describing the musical positiveness conveyed by a trac




# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 150

Instance Attribute Details

#acousticness ⇒ Float?

A confidence measure from 0.0 to 1.0 of whether the track is acoustic. 1.0 represents high confidence the track is acoustic.

Returns:

  • (Float, nil) 


18
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 18

optional :acousticness, Float

#analysis_url ⇒ String?

A URL to access the full audio analysis of this track. An access token is required to access this data.

Returns:

  • (String, nil) 


25
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 25

optional :analysis_url, String

#danceability ⇒ Float?

Danceability describes how suitable a track is for dancing based on a combination of musical elements including tempo, rhythm stability, beat strength, and overall regularity. A value of 0.0 is least danceable and 1.0 is most danceable.

Returns:

  • (Float, nil) 


34
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 34

optional :danceability, Float

#duration_ms ⇒ Integer?

The duration of the track in milliseconds.

Returns:

  • (Integer, nil) 


40
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 40

optional :duration_ms, Integer

#energy ⇒ Float?

Energy is a measure from 0.0 to 1.0 and represents a perceptual measure of intensity and activity. Typically, energetic tracks feel fast, loud, and noisy. For example, death metal has high energy, while a Bach prelude scores low on the scale. Perceptual features contributing to this attribute include dynamic range, perceived loudness, timbre, onset rate, and general entropy.

Returns:

  • (Float, nil) 


50
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 50

optional :energy, Float

#id ⇒ String?

The Spotify ID for the track.

Returns:

  • (String, nil) 


11
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 11

optional :id, String

#instrumentalness ⇒ Float?

Predicts whether a track contains no vocals. “Ooh” and “aah” sounds are treated as instrumental in this context. Rap or spoken word tracks are clearly “vocal”. The closer the instrumentalness value is to 1.0, the greater likelihood the track contains no vocal content. Values above 0.5 are intended to represent instrumental tracks, but confidence is higher as the value approaches 1.0.

Returns:

  • (Float, nil) 


60
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 60

optional :instrumentalness, Float

#key ⇒ Integer?

The key the track is in. Integers map to pitches using standard [Pitch Class notation](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.

Returns:

  • (Integer, nil) 


68
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 68

optional :key, Integer

#liveness ⇒ Float?

Detects the presence of an audience in the recording. Higher liveness values represent an increased probability that the track was performed live. A value above 0.8 provides strong likelihood that the track is live.

Returns:

  • (Float, nil) 


76
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 76

optional :liveness, Float

#loudness ⇒ Float?

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.

Returns:

  • (Float, nil) 


86
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 86

optional :loudness, Float

#mode ⇒ Integer?

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.

Returns:

  • (Integer, nil) 


93
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 93

optional :mode, Integer

#speechiness ⇒ Float?

Speechiness detects the presence of spoken words in a track. The more exclusively speech-like the recording (e.g. talk show, audio book, poetry), the closer to 1.0 the attribute value. Values above 0.66 describe tracks that are probably made entirely of spoken words. Values between 0.33 and 0.66 describe tracks that may contain both music and speech, either in sections or layered, including such cases as rap music. Values below 0.33 most likely represent music and other non-speech-like tracks.

Returns:

  • (Float, nil) 


105
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 105

optional :speechiness, Float

#tempo ⇒ Float?

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.

Returns:

  • (Float, nil) 


113
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 113

optional :tempo, Float

#time_signature ⇒ Integer?

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”.

Returns:

  • (Integer, nil) 


121
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 121

optional :time_signature, Integer

#track_href ⇒ String?

A link to the Web API endpoint providing full details of the track.

Returns:

  • (String, nil) 


127
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 127

optional :track_href, String

#type ⇒ Symbol, ...

The object type.

Returns:



133
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 133

optional :type, enum: -> { Spotted::Models::AudioFeatureRetrieveResponse::Type }

#uri ⇒ String?

The Spotify URI for the track.

Returns:

  • (String, nil) 


139
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 139

optional :uri, String

#valence ⇒ Float?

A measure from 0.0 to 1.0 describing the musical positiveness conveyed by a track. Tracks with high valence sound more positive (e.g. happy, cheerful, euphoric), while tracks with low valence sound more negative (e.g. sad, depressed, angry).

Returns:

  • (Float, nil) 


148
 
# File 'lib/spotted/models/audio_feature_retrieve_response.rb', line 148

optional :valence, Float