Kraken Logo

Kraken Engine

DocumentationGuidesShowcaseCommunity
Ctrl
K
Navigating the Docs
Building Docs
Overview
Anchor
AnimationController
Audio
Batcher
Body
Camera
Capsule
CastHit
CharacterBody
Circle
Collision
Color
DistanceJoint
Effect
Event
FilterJoint
Flip (Texture)
Font
ImageLayer
InputAction
Joint
Layer
Line
Map
MapObject
Mask
MotorJoint
MouseJoint
ObjectGroup
Orchestrator
PixelArray
PolarCoordinate
Polygon
PrismaticJoint
Rect
RevoluteJoint
RigidBody
Sample
Sampler
Shader
SheetStrip
StaticBody
Stream
Style
Terrain (TileSet)
Text
TextProperties
Texture
Tile (TileLayer)
Tile (TileSet)
TileLayer
TileResult (TileLayer)
TileSet
Timer
Transform
Tween
Vec2
Vertex
WeldJoint
WheelJoint
World

Built bydurkisneer1.Kraken Engine is open source and available onGitHub.

  1. Docs
  2. Classes
  3. Stream

Stream

A streaming audio resource intended for long music files. Access via the 'mixer' submodule.

Inherits from Audio.

Properties


NameDescriptionType
playback_posCurrent position in seconds. 0.0 if stopped/never played, paused position if paused.float
loopingWhether the stream should loop when it reaches the end.bool

Methods


Pause

pause() → Nonepause() → None

Pause playback. Releases the hardware track but preserves position.

Resume

resume(fade_in: float = 0.0) → Noneresume(fade_in: float = 0.0) → None

Resume playback from a paused state.

Args

  • fade_in : Duration in seconds to fade back in. Defaults to 0.0.

Seek

seek(seconds: float) → Noneseek(seconds: float) → None

Jump to a specific time in the audio file.

Args

  • seconds : Target position in seconds from the start.
PreviousStaticBody
NextStyle

On this page

PropertiesMethodsPauseResumeSeek