Documentation
¶
Overview ¶
The AudioStreamOggVorbis class is a specialized graphics.gd/classdb/AudioStream for handling Ogg Vorbis file formats. It offers functionality for loading and playing back Ogg Vorbis files, as well as managing looping and other playback properties. This class is part of the audio stream system, which also supports WAV files through the graphics.gd/classdb/AudioStreamWAV class.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsAudioStream() AudioStream.Instance
- func (self Instance) AsAudioStreamOggVorbis() 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) ID() ID
- func (self Instance) Loop() bool
- func (self Instance) LoopOffset() Float.X
- func (self Instance) PacketSequence() OggPacketSequence.Instance
- func (self Instance) SetBarBeats(value int)
- func (self Instance) SetBeatCount(value int)
- func (self Instance) SetBpm(value Float.X)
- 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) SetPacketSequence(value OggPacketSequence.Instance)
- func (self Instance) SetTags(value map[any]any)
- func (self Instance) Tags() map[any]any
- 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]) AsAudioStreamOggVorbis ¶
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.AudioStreamOggVorbis
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/AudioStreamOggVorbis instance from the given buffer. The buffer must contain Ogg Vorbis data.
func LoadFromFile ¶
Creates a new graphics.gd/classdb/AudioStreamOggVorbis instance from the given file path. The file must be in Ogg Vorbis format.
func (Instance) AsAudioStream ¶
func (self Instance) AsAudioStream() AudioStream.Instance
func (Instance) AsAudioStreamOggVorbis ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) LoopOffset ¶
func (Instance) PacketSequence ¶
func (self Instance) PacketSequence() OggPacketSequence.Instance
func (Instance) SetBarBeats ¶
func (Instance) SetBeatCount ¶
func (Instance) SetLoopOffset ¶
func (Instance) SetPacketSequence ¶
func (self Instance) SetPacketSequence(value OggPacketSequence.Instance)
Source Files