Documentation
¶
Overview ¶
MP3 audio stream driver. See Instance.Data if you want to load an MP3 file at run-time.
Note: This class can optionally support legacy MP1 and MP2 formats, provided that the engine is compiled with the minimp3_extra_formats=yes SCons option. These extra formats are not enabled by default.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsAudioStream() AudioStream.Instance
- func (self Instance) AsAudioStreamMP3() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) BarBeats() int
- func (self Instance) BeatCount() int
- func (self Instance) Bpm() Float.X
- func (self Instance) Data() []byte
- func (self Instance) ID() ID
- func (self Instance) Loop() bool
- func (self Instance) LoopOffset() Float.X
- func (self Instance) SetBarBeats(value int)
- func (self Instance) SetBeatCount(value int)
- func (self Instance) SetBpm(value Float.X)
- func (self Instance) SetData(value []byte)
- func (self Instance) SetLoop(value bool)
- func (self Instance) SetLoopOffset(value Float.X)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsAudioStream ¶
func (self *Extension[T]) AsAudioStream() AudioStream.Instance
func (*Extension[T]) AsAudioStreamMP3 ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.AudioStreamMP3
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func LoadFromBuffer ¶
Creates a new graphics.gd/classdb/AudioStreamMP3 instance from the given buffer. The buffer must contain MP3 data.
func LoadFromFile ¶
Creates a new graphics.gd/classdb/AudioStreamMP3 instance from the given file path. The file must be in MP3 format.
func (Instance) AsAudioStream ¶
func (self Instance) AsAudioStream() AudioStream.Instance
func (Instance) AsAudioStreamMP3 ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
Source Files