AudioStreamOggVorbis

Conformances

• protocol CustomStringConvertible

  A type with a customized textual representation.

• protocol Equatable

  A type that can be compared for value equality.

• protocol Hashable

  A type that can be hashed into a Hasher to produce an integer hash value.

• protocol Identifiable<ID>

  A class of types whose instances hold the value of an entity with stable identity.

• protocol VariantRepresentable

  Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.

• protocol VariantStorable

  Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Type members

• static func loadFromBuffer(PackedByteArray) -> AudioStreamOggVorbis?

  Creates a new AudioStreamOggVorbis instance from the given buffer. The buffer must contain Ogg Vorbis data.

• static func loadFromFile(path: String) -> AudioStreamOggVorbis?

  Creates a new AudioStreamOggVorbis instance from the given file path. The file must be in Ogg Vorbis format.

• class var godotClassName: StringName

Instance members

• var barBeats: Int32
• var beatCount: Int32
• var bpm: Double
• var loop: Bool

  If true, the audio will play again from the specified loopOffset once it is done playing. Useful for ambient sounds and background music.

• var loopOffset: Double

  Time in seconds at which the stream starts after being looped.

• var packetSequence: OggPacketSequence?

  Contains the raw Ogg data for this stream.