Class: Spotted::Models::AudioFeatureListResponse::AudioFeature

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

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::AudioFeatureListResponse::AudioFeature 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::AudioFeatureListResponse::AudioFeature::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



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 16

class AudioFeature < Spotted::Internal::Type::BaseModel
  # @!attribute id
  #   The Spotify ID for the track.
  #
  #   @return [String, nil]
  optional :id, String

  # @!attribute acousticness
  #   A confidence measure from 0.0 to 1.0 of whether the track is acoustic. 1.0
  #   represents high confidence the track is acoustic.
  #
  #   @return [Float, nil]
  optional :acousticness, Float

  # @!attribute analysis_url
  #   A URL to access the full audio analysis of this track. An access token is
  #   required to access this data.
  #
  #   @return [String, nil]
  optional :analysis_url, String

  # @!attribute danceability
  #   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.
  #
  #   @return [Float, nil]
  optional :danceability, Float

  # @!attribute duration_ms
  #   The duration of the track in milliseconds.
  #
  #   @return [Integer, nil]
  optional :duration_ms, Integer

  # @!attribute energy
  #   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.
  #
  #   @return [Float, nil]
  optional :energy, Float

  # @!attribute instrumentalness
  #   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.
  #
  #   @return [Float, nil]
  optional :instrumentalness, Float

  # @!attribute key
  #   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.
  #
  #   @return [Integer, nil]
  optional :key, Integer

  # @!attribute liveness
  #   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.
  #
  #   @return [Float, nil]
  optional :liveness, Float

  # @!attribute loudness
  #   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.
  #
  #   @return [Float, nil]
  optional :loudness, Float

  # @!attribute mode
  #   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.
  #
  #   @return [Integer, nil]
  optional :mode, Integer

  # @!attribute speechiness
  #   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.
  #
  #   @return [Float, nil]
  optional :speechiness, Float

  # @!attribute tempo
  #   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.
  #
  #   @return [Float, nil]
  optional :tempo, Float

  # @!attribute time_signature
  #   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".
  #
  #   @return [Integer, nil]
  optional :time_signature, Integer

  # @!attribute track_href
  #   A link to the Web API endpoint providing full details of the track.
  #
  #   @return [String, nil]
  optional :track_href, String

  # @!attribute type
  #   The object type.
  #
  #   @return [Symbol, Spotted::Models::AudioFeatureListResponse::AudioFeature::Type, nil]
  optional :type, enum: -> { Spotted::Models::AudioFeatureListResponse::AudioFeature::Type }

  # @!attribute uri
  #   The Spotify URI for the track.
  #
  #   @return [String, nil]
  optional :uri, String

  # @!attribute valence
  #   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).
  #
  #   @return [Float, nil]
  optional :valence, Float

  # @!method 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)
  #   Some parameter documentations has been truncated, see
  #   {Spotted::Models::AudioFeatureListResponse::AudioFeature} for more details.
  #
  #   @param id [String] The Spotify ID for the track.
  #
  #   @param acousticness [Float] A confidence measure from 0.0 to 1.0 of whether the track is acoustic. 1.0 repre
  #
  #   @param analysis_url [String] A URL to access the full audio analysis of this track. An access token is requir
  #
  #   @param danceability [Float] Danceability describes how suitable a track is for dancing based on a combinatio
  #
  #   @param duration_ms [Integer] The duration of the track in milliseconds.
  #
  #   @param energy [Float] Energy is a measure from 0.0 to 1.0 and represents a perceptual measure of inten
  #
  #   @param instrumentalness [Float] Predicts whether a track contains no vocals. "Ooh" and "aah" sounds are treated
  #
  #   @param key [Integer] The key the track is in. Integers map to pitches using standard [Pitch Class not
  #
  #   @param liveness [Float] Detects the presence of an audience in the recording. Higher liveness values rep
  #
  #   @param loudness [Float] The overall loudness of a track in decibels (dB). Loudness values are averaged a
  #
  #   @param mode [Integer] Mode indicates the modality (major or minor) of a track, the type of scale from
  #
  #   @param speechiness [Float] Speechiness detects the presence of spoken words in a track. The more exclusivel
  #
  #   @param tempo [Float] The overall estimated tempo of a track in beats per minute (BPM). In musical ter
  #
  #   @param time_signature [Integer] An estimated time signature. The time signature (meter) is a notational conventi
  #
  #   @param track_href [String] A link to the Web API endpoint providing full details of the track.
  #
  #   @param type [Symbol, Spotted::Models::AudioFeatureListResponse::AudioFeature::Type] The object type.
  #
  #   @param uri [String] The Spotify URI for the track.
  #
  #   @param valence [Float] A measure from 0.0 to 1.0 describing the musical positiveness conveyed by a trac

  # The object type.
  #
  # @see Spotted::Models::AudioFeatureListResponse::AudioFeature#type
  module Type
    extend Spotted::Internal::Type::Enum

    AUDIO_FEATURES = :audio_features

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

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) 


28
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 28

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) 


35
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 35

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) 


44
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 44

optional :danceability, Float

#duration_ms ⇒ Integer?

The duration of the track in milliseconds.

Returns:

  • (Integer, nil) 


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

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) 


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

optional :energy, Float

#id ⇒ String?

The Spotify ID for the track.

Returns:

  • (String, nil) 


21
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 21

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) 


70
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 70

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) 


78
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 78

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) 


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

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) 


96
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 96

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) 


103
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 103

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) 


115
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 115

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) 


123
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 123

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) 


131
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 131

optional :time_signature, Integer

#track_href ⇒ String?

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

Returns:

  • (String, nil) 


137
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 137

optional :track_href, String

#type ⇒ Symbol, ...

The object type.

Returns:



143
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 143

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

#uri ⇒ String?

The Spotify URI for the track.

Returns:

  • (String, nil) 


149
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 149

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) 


158
 
# File 'lib/spotted/models/audio_feature_list_response.rb', line 158

optional :valence, Float