Deprecate _get_stream_name

This commit is contained in:
Akosmo
2026-06-12 10:04:48 -03:00
parent ec67cbe926
commit e81e0d9fcc
20 changed files with 6 additions and 62 deletions
+2 -2
View File
@@ -45,10 +45,10 @@
Return the controllable parameters of this stream. This array contains dictionaries with a property info description format (see [method Object.get_property_list]). Additionally, the default value for this parameter must be added tho each dictionary in "default_value" field.
</description>
</method>
<method name="_get_stream_name" qualifiers="virtual const">
<method name="_get_stream_name" qualifiers="virtual const" deprecated="This method is not used by the engine.">
<return type="String" />
<description>
Override this method to customize the name assigned to this audio stream. Unused by the engine.
Override this method to customize the name assigned to this audio stream.
</description>
</method>
<method name="_get_tags" qualifiers="virtual const">
@@ -44,10 +44,6 @@ Ref<AudioStreamPlayback> AudioStreamInteractive::instantiate_playback() {
return playback_transitioner;
}
String AudioStreamInteractive::get_stream_name() const {
return "Transitioner";
}
void AudioStreamInteractive::set_clip_count(int p_count) {
ERR_FAIL_COND(p_count < 0 || p_count > MAX_CLIPS);
@@ -180,7 +180,6 @@ public:
PackedInt32Array get_transition_list() const;
virtual Ref<AudioStreamPlayback> instantiate_playback() override;
virtual String get_stream_name() const override;
virtual double get_length() const override { return 0; }
virtual bool is_meta_stream() const override { return true; }
@@ -42,10 +42,6 @@ Ref<AudioStreamPlayback> AudioStreamPlaylist::instantiate_playback() {
return playback_playlist;
}
String AudioStreamPlaylist::get_stream_name() const {
return "Playlist";
}
void AudioStreamPlaylist::set_list_stream(int p_stream_index, Ref<AudioStream> p_stream) {
ERR_FAIL_COND(p_stream == this);
ERR_FAIL_INDEX(p_stream_index, MAX_STREAMS);
@@ -67,7 +67,6 @@ public:
Ref<AudioStream> get_list_stream(int p_stream_index) const;
virtual Ref<AudioStreamPlayback> instantiate_playback() override;
virtual String get_stream_name() const override;
virtual double get_length() const override;
virtual bool is_meta_stream() const override { return true; }
@@ -45,10 +45,6 @@ Ref<AudioStreamPlayback> AudioStreamSynchronized::instantiate_playback() {
return playback_playlist;
}
String AudioStreamSynchronized::get_stream_name() const {
return "Synchronized";
}
void AudioStreamSynchronized::set_sync_stream(int p_stream_index, Ref<AudioStream> p_stream) {
ERR_FAIL_COND(p_stream == this);
ERR_FAIL_INDEX(p_stream_index, MAX_STREAMS);
@@ -63,7 +63,6 @@ public:
float get_sync_stream_volume(int p_stream_index) const;
virtual Ref<AudioStreamPlayback> instantiate_playback() override;
virtual String get_stream_name() const override;
virtual double get_length() const override;
virtual bool is_meta_stream() const override { return true; }
-4
View File
@@ -211,10 +211,6 @@ Ref<AudioStreamPlayback> AudioStreamMP3::instantiate_playback() {
return mp3s;
}
String AudioStreamMP3::get_stream_name() const {
return ""; //return stream_name;
}
void AudioStreamMP3::clear_data() {
data.clear();
}
-1
View File
@@ -131,7 +131,6 @@ public:
virtual int get_bar_beats() const override;
virtual Ref<AudioStreamPlayback> instantiate_playback() override;
virtual String get_stream_name() const override;
void set_data(const Vector<uint8_t> &p_data);
Vector<uint8_t> get_data() const;
@@ -428,10 +428,6 @@ Ref<AudioStreamPlayback> AudioStreamOggVorbis::instantiate_playback() {
return nullptr;
}
String AudioStreamOggVorbis::get_stream_name() const {
return ""; //return stream_name;
}
void AudioStreamOggVorbis::maybe_update_info() {
ERR_FAIL_COND(packet_sequence.is_null());
-1
View File
@@ -161,7 +161,6 @@ public:
virtual Dictionary get_tags() const override;
virtual Ref<AudioStreamPlayback> instantiate_playback() override;
virtual String get_stream_name() const override;
void set_packet_sequence(Ref<OggPacketSequence> p_packet_sequence);
Ref<OggPacketSequence> get_packet_sequence() const;
@@ -44,10 +44,6 @@ Ref<AudioStreamPlayback> AudioStreamPolyphonic::instantiate_playback() {
return playback;
}
String AudioStreamPolyphonic::get_stream_name() const {
return "AudioStreamPolyphonic";
}
bool AudioStreamPolyphonic::is_monophonic() const {
return true; // This avoids stream players to instantiate more than one of these.
}
@@ -45,7 +45,6 @@ class AudioStreamPolyphonic : public AudioStream {
public:
virtual Ref<AudioStreamPlayback> instantiate_playback() override;
virtual String get_stream_name() const override;
virtual bool is_monophonic() const override;
void set_polyphony(int p_voices);
-4
View File
@@ -625,10 +625,6 @@ Ref<AudioStreamPlayback> AudioStreamWAV::instantiate_playback() {
return sample;
}
String AudioStreamWAV::get_stream_name() const {
return "";
}
Ref<AudioSample> AudioStreamWAV::generate_sample() const {
Ref<AudioSample> sample;
sample.instantiate();
-1
View File
@@ -164,7 +164,6 @@ public:
Error save_to_wav(const String &p_path);
virtual Ref<AudioStreamPlayback> instantiate_playback() override;
virtual String get_stream_name() const override;
virtual bool can_be_sampled() const override {
return true;
+2 -16
View File
@@ -244,11 +244,6 @@ Ref<AudioStreamPlayback> AudioStream::instantiate_playback() {
GDVIRTUAL_CALL(_instantiate_playback, ret);
return ret;
}
String AudioStream::get_stream_name() const {
String ret;
GDVIRTUAL_CALL(_get_stream_name, ret);
return ret;
}
double AudioStream::get_length() const {
double ret = 0;
@@ -340,7 +335,9 @@ void AudioStream::_bind_methods() {
ClassDB::bind_method(D_METHOD("is_meta_stream"), &AudioStream::is_meta_stream);
GDVIRTUAL_BIND(_instantiate_playback);
#ifndef DISABLE_DEPRECATED
GDVIRTUAL_BIND(_get_stream_name);
#endif
GDVIRTUAL_BIND(_get_length);
GDVIRTUAL_BIND(_is_monophonic);
GDVIRTUAL_BIND(_get_bpm)
@@ -367,13 +364,6 @@ Ref<AudioStreamPlayback> AudioStreamMicrophone::instantiate_playback() {
return playback;
}
String AudioStreamMicrophone::get_stream_name() const {
//if (audio_stream.is_valid()) {
//return "Random: " + audio_stream->get_name();
//}
return "Microphone";
}
double AudioStreamMicrophone::get_length() const {
return 0;
}
@@ -720,10 +710,6 @@ Ref<AudioStreamPlayback> AudioStreamRandomizer::instantiate_playback() {
}
}
String AudioStreamRandomizer::get_stream_name() const {
return "Randomizer";
}
double AudioStreamRandomizer::get_length() const {
if (!last_playback.is_valid()) {
return 0;
+2 -3
View File
@@ -170,7 +170,9 @@ protected:
static void _bind_methods();
GDVIRTUAL0RC_REQUIRED(Ref<AudioStreamPlayback>, _instantiate_playback)
#ifndef DISABLE_DEPRECATED
GDVIRTUAL0RC(String, _get_stream_name)
#endif
GDVIRTUAL0RC(double, _get_length)
GDVIRTUAL0RC(bool, _is_monophonic)
GDVIRTUAL0RC(double, _get_bpm)
@@ -182,7 +184,6 @@ protected:
public:
virtual Ref<AudioStreamPlayback> instantiate_playback();
virtual String get_stream_name() const;
virtual double get_bpm() const;
virtual bool has_loop() const;
@@ -227,7 +228,6 @@ class AudioStreamMicrophone : public AudioStream {
public:
virtual Ref<AudioStreamPlayback> instantiate_playback() override;
virtual String get_stream_name() const override;
virtual double get_length() const override; //if supported, otherwise return 0
@@ -337,7 +337,6 @@ public:
PlaybackMode get_playback_mode() const;
virtual Ref<AudioStreamPlayback> instantiate_playback() override;
virtual String get_stream_name() const override;
virtual double get_length() const override; //if supported, otherwise return 0
virtual bool is_monophonic() const override;
@@ -78,10 +78,6 @@ Ref<AudioStreamPlayback> AudioStreamGenerator::instantiate_playback() {
return playback;
}
String AudioStreamGenerator::get_stream_name() const {
return "UserFeed";
}
double AudioStreamGenerator::get_length() const {
return 0;
}
@@ -65,7 +65,6 @@ public:
float get_buffer_length() const;
virtual Ref<AudioStreamPlayback> instantiate_playback() override;
virtual String get_stream_name() const override;
virtual double get_length() const override;
virtual bool is_monophonic() const override;
-1
View File
@@ -203,7 +203,6 @@ TEST_CASE("[Audio][AudioStreamWAV] Default values") {
CHECK(stream->get_length() == 0);
CHECK(stream->is_monophonic() == false);
CHECK(stream->get_data() == Vector<uint8_t>{});
CHECK(stream->get_stream_name() == "");
}
TEST_CASE("[Audio][AudioStreamWAV] Save empty file") {