VideoStreamPlayback

package
v0.0.0-...-fa94a0d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 18, 2025 License: MIT Imports: 25 Imported by: 0

Documentation

Overview

This class is intended to be overridden by video decoder extensions with custom implementations of VideoStream.

Index

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 Any

type Any interface {
	gd.IsClass
	AsVideoStreamPlayback() Instance
}

type Expanded

type Expanded = MoreArgs

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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]See Interface for methods that can be overridden by T.

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

func (*Extension[T]) AsVideoStreamPlayback

func (self *Extension[T]) AsVideoStreamPlayback() Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.VideoStreamPlayback

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 New

func New() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) AsVideoStreamPlayback

func (self Instance) AsVideoStreamPlayback() Instance

func (Instance) ID

func (self Instance) ID() ID

func (Instance) MixAudio

func (self Instance) MixAudio(num_frames int) int

Render 'num_frames' audio frames (of GetChannels floats each) from 'buffer', starting from index 'offset' in the array. Returns the number of audio frames rendered, or -1 on error.

func (Instance) MoreArgs

func (self Instance) MoreArgs() MoreArgs

MoreArgs enables certain functions to be called with additional 'optional' arguments.

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type Interface

type Interface interface {
	// Stops playback. May be called multiple times before [Play], or in response to [VideoStreamPlayer.Stop]. [IsPlaying] should return false once stopped.
	//
	// [IsPlaying]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayback#Interface
	// [Play]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayback#Interface
	// [VideoStreamPlayer.Stop]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayer#Instance.Stop
	Stop()
	// Called in response to [VideoStreamPlayer.Autoplay] or [VideoStreamPlayer.Play]. Note that manual playback may also invoke [Stop] multiple times before this method is called. [IsPlaying] should return true once playing.
	//
	// [IsPlaying]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayback#Interface
	// [Stop]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayback#Interface
	// [VideoStreamPlayer.Autoplay]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayer#Instance.Autoplay
	// [VideoStreamPlayer.Play]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayer#Instance.Play
	Play()
	// Returns the playback state, as determined by calls to [Play] and [Stop].
	//
	// [Play]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayback#Interface
	// [Stop]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayback#Interface
	IsPlaying() bool
	// Set the paused status of video playback. [IsPaused] must return 'paused'. Called in response to the [VideoStreamPlayer.Paused] setter.
	//
	// [IsPaused]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayback#Interface
	// [VideoStreamPlayer.Paused]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayer#Instance.Paused
	SetPaused(paused bool)
	// Returns the paused status, as set by [SetPaused].
	//
	// [SetPaused]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayback#Interface
	IsPaused() bool
	// Returns the video duration in seconds, if known, or 0 if unknown.
	GetLength() Float.X
	// Return the current playback timestamp. Called in response to the [VideoStreamPlayer.StreamPosition] getter.
	//
	// [VideoStreamPlayer.StreamPosition]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayer#Instance.StreamPosition
	GetPlaybackPosition() Float.X
	// Seeks to 'time' seconds. Called in response to the [VideoStreamPlayer.StreamPosition] setter.
	//
	// [VideoStreamPlayer.StreamPosition]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayer#Instance.StreamPosition
	Seek(time Float.X)
	// Select the audio track 'idx'. Called when playback starts, and in response to the [VideoStreamPlayer.AudioTrack] setter.
	//
	// [VideoStreamPlayer.AudioTrack]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayer#Instance.AudioTrack
	SetAudioTrack(idx int)
	// Allocates a [Texture2D] in which decoded video frames will be drawn.
	//
	// [Texture2D]: https://pkg.go.dev/graphics.gd/classdb/Texture2D
	GetTexture() Texture2D.Instance
	// Ticks video playback for 'delta' seconds. Called every frame as long as both [IsPaused] and [IsPlaying] return true.
	//
	// [IsPaused]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayback#Interface
	// [IsPlaying]: https://pkg.go.dev/graphics.gd/classdb/VideoStreamPlayback#Interface
	Update(delta Float.X)
	// Returns the number of audio channels.
	GetChannels() int
	// Returns the audio sample rate used for mixing.
	GetMixRate() int
}

type MoreArgs

type MoreArgs [1]gdclass.VideoStreamPlayback

MoreArgs is a container for Instance functions with additional 'optional' arguments.

func (MoreArgs) MixAudio

func (self MoreArgs) MixAudio(num_frames int, buffer []float32, offset int) int

Render 'num_frames' audio frames (of GetChannels floats each) from 'buffer', starting from index 'offset' in the array. Returns the number of audio frames rendered, or -1 on error.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL