1 /*************************************************************************/ 2 /* audio_stream.h */ 3 /*************************************************************************/ 4 /* This file is part of: */ 5 /* GODOT ENGINE */ 6 /* https://godotengine.org */ 7 /*************************************************************************/ 8 /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */ 9 /* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */ 10 /* */ 11 /* Permission is hereby granted, free of charge, to any person obtaining */ 12 /* a copy of this software and associated documentation files (the */ 13 /* "Software"), to deal in the Software without restriction, including */ 14 /* without limitation the rights to use, copy, modify, merge, publish, */ 15 /* distribute, sublicense, and/or sell copies of the Software, and to */ 16 /* permit persons to whom the Software is furnished to do so, subject to */ 17 /* the following conditions: */ 18 /* */ 19 /* The above copyright notice and this permission notice shall be */ 20 /* included in all copies or substantial portions of the Software. */ 21 /* */ 22 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ 23 /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ 24 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ 25 /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ 26 /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ 27 /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ 28 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ 29 /*************************************************************************/ 30 #ifndef AUDIO_STREAM_H 31 #define AUDIO_STREAM_H 32 33 #include "resource.h" 34 #include "servers/audio_server.h" 35 36 class AudioStreamPlayback : public Reference { 37 38 OBJ_TYPE(AudioStreamPlayback, Reference); 39 40 protected: 41 static void _bind_methods(); 42 43 public: 44 virtual void play(float p_from_pos = 0) = 0; 45 virtual void stop() = 0; 46 virtual bool is_playing() const = 0; 47 48 virtual void set_loop(bool p_enable) = 0; 49 virtual bool has_loop() const = 0; 50 51 virtual void set_loop_restart_time(float p_time) = 0; 52 53 virtual int get_loop_count() const = 0; 54 55 virtual float get_pos() const = 0; 56 virtual void seek_pos(float p_time) = 0; 57 58 virtual int mix(int16_t *p_bufer, int p_frames) = 0; 59 60 virtual float get_length() const = 0; 61 virtual String get_stream_name() const = 0; 62 63 virtual int get_channels() const = 0; 64 virtual int get_mix_rate() const = 0; 65 virtual int get_minimum_buffer_size() const = 0; 66 }; 67 68 class AudioStream : public Resource { 69 70 OBJ_TYPE(AudioStream, Resource); 71 OBJ_SAVE_TYPE(AudioStream); //children are all saved as AudioStream, so they can be exchanged 72 73 protected: 74 static void _bind_methods(); 75 76 public: 77 virtual Ref<AudioStreamPlayback> instance_playback() = 0; 78 }; 79 80 #endif // AUDIO_STREAM_H 81