VideoStreamPlayback

Documentation

Overview

Package VideoStreamPlayback provides methods for working with VideoStreamPlayback object instances.

Index

• type Advanced
• type Any
• type Implementation
• type Instance
  • func New() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) AsVideoStreamPlayback() Instance
  • func (self Instance) MixAudio(num_frames int) int
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type Interface

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 Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.VideoStreamPlayback

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

See [Interface] for methods that can be overridden by a [Class] that extends it.

%!(EXTRA string=VideoStreamPlayback)

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) MixAudio

func (self Instance) MixAudio(num_frames int) int

Render [param num_frames] audio frames (of [method _get_channels] floats each) from [param buffer], starting from index [param offset] in the array. Returns the number of audio frames rendered, or -1 on error.

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

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

type Interface

type Interface interface {
	//Stops playback. May be called multiple times before [method _play], or in response to [method VideoStreamPlayer.stop]. [method _is_playing] should return false once stopped.
	Stop()
	//Called in response to [member VideoStreamPlayer.autoplay] or [method VideoStreamPlayer.play]. Note that manual playback may also invoke [method _stop] multiple times before this method is called. [method _is_playing] should return true once playing.
	Play()
	//Returns the playback state, as determined by calls to [method _play] and [method _stop].
	IsPlaying() bool
	//Set the paused status of video playback. [method _is_paused] must return [param paused]. Called in response to the [member VideoStreamPlayer.paused] setter.
	SetPaused(paused bool)
	//Returns the paused status, as set by [method _set_paused].
	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 [member VideoStreamPlayer.stream_position] getter.
	GetPlaybackPosition() Float.X
	//Seeks to [param time] seconds. Called in response to the [member VideoStreamPlayer.stream_position] setter.
	Seek(time Float.X)
	//Select the audio track [param idx]. Called when playback starts, and in response to the [member VideoStreamPlayer.audio_track] setter.
	SetAudioTrack(idx int)
	//Allocates a [Texture2D] in which decoded video frames will be drawn.
	GetTexture() [1]gdclass.Texture2D
	//Ticks video playback for [param delta] seconds. Called every frame as long as [method _is_paused] and [method _is_playing] return true.
	Update(delta Float.X)
	//Returns the number of audio channels.
	GetChannels() int
	//Returns the audio sample rate used for mixing.
	GetMixRate() int
}