VideoStreamPlayer

Documentation

Overview

Package VideoStreamPlayer provides methods for working with VideoStreamPlayer object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsCanvasItem() CanvasItem.Instance
  • func (self Instance) AsControl() Control.Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsVideoStreamPlayer() Instance
  • func (self Instance) AudioTrack() int
  • func (self Instance) Autoplay() bool
  • func (self Instance) BufferingMsec() int
  • func (self Instance) Bus() string
  • func (self Instance) Expand() bool
  • func (self Instance) GetStreamLength() Float.X
  • func (self Instance) GetStreamName() string
  • func (self Instance) GetVideoTexture() [1]gdclass.Texture2D
  • func (self Instance) IsPlaying() bool
  • func (self Instance) Loop() bool
  • func (self Instance) OnFinished(cb func())
  • func (self Instance) Paused() bool
  • func (self Instance) Play()
  • func (self Instance) SetAudioTrack(value int)
  • func (self Instance) SetAutoplay(value bool)
  • func (self Instance) SetBufferingMsec(value int)
  • func (self Instance) SetBus(value string)
  • func (self Instance) SetExpand(value bool)
  • func (self Instance) SetLoop(value bool)
  • func (self Instance) SetPaused(value bool)
  • func (self Instance) SetStream(value [1]gdclass.VideoStream)
  • func (self Instance) SetStreamPosition(value Float.X)
  • func (self Instance) SetVolume(value Float.X)
  • func (self Instance) SetVolumeDb(value Float.X)
  • func (self Instance) Stop()
  • func (self Instance) Stream() [1]gdclass.VideoStream
  • func (self Instance) StreamPosition() Float.X
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
  • func (self Instance) Volume() Float.X
  • func (self Instance) VolumeDb() Float.X

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
	AsVideoStreamPlayer() Instance
}

type Instance

type Instance [1]gdclass.VideoStreamPlayer

A control used for playback of [VideoStream] resources. Supported video formats are [url=https://www.theora.org/]Ogg Theora[/url] ([code].ogv[/code], [VideoStreamTheora]) and any format exposed via a GDExtension plugin. [b]Warning:[/b] On Web, video playback [i]will[/i] perform poorly due to missing architecture-specific assembly optimizations.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsCanvasItem

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsControl

func (self Instance) AsControl() Control.Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject

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

func (Instance) AsVideoStreamPlayer

func (self Instance) AsVideoStreamPlayer() Instance

func (Instance) AudioTrack

func (self Instance) AudioTrack() int

func (Instance) Autoplay

func (self Instance) Autoplay() bool

func (Instance) BufferingMsec

func (self Instance) BufferingMsec() int

func (Instance) Bus

func (self Instance) Bus() string

func (Instance) Expand

func (self Instance) Expand() bool

func (Instance) GetStreamLength

func (self Instance) GetStreamLength() Float.X

The length of the current stream, in seconds. [b]Note:[/b] For [VideoStreamTheora] streams (the built-in format supported by Godot), this value will always be zero, as getting the stream length is not implemented yet. The feature may be supported by video formats implemented by a GDExtension add-on.

func (Instance) GetStreamName

func (self Instance) GetStreamName() string

Returns the video stream's name, or [code]"<No Stream>"[/code] if no video stream is assigned.

func (Instance) GetVideoTexture

func (self Instance) GetVideoTexture() [1]gdclass.Texture2D

Returns the current frame as a [Texture2D].

func (Instance) IsPlaying

func (self Instance) IsPlaying() bool

Returns [code]true[/code] if the video is playing. [b]Note:[/b] The video is still considered playing if paused during playback.

func (Instance) Loop

func (self Instance) Loop() bool

func (Instance) OnFinished

func (self Instance) OnFinished(cb func())

func (Instance) Paused

func (self Instance) Paused() bool

func (Instance) Play

func (self Instance) Play()

Starts the video playback from the beginning. If the video is paused, this will not unpause the video.

func (Instance) SetAudioTrack

func (self Instance) SetAudioTrack(value int)

func (Instance) SetAutoplay

func (self Instance) SetAutoplay(value bool)

func (Instance) SetBufferingMsec

func (self Instance) SetBufferingMsec(value int)

func (Instance) SetBus

func (self Instance) SetBus(value string)

func (Instance) SetExpand

func (self Instance) SetExpand(value bool)

func (Instance) SetLoop

func (self Instance) SetLoop(value bool)

func (Instance) SetPaused

func (self Instance) SetPaused(value bool)

func (Instance) SetStream

func (self Instance) SetStream(value [1]gdclass.VideoStream)

func (Instance) SetStreamPosition

func (self Instance) SetStreamPosition(value Float.X)

func (Instance) SetVolume

func (self Instance) SetVolume(value Float.X)

func (Instance) SetVolumeDb

func (self Instance) SetVolumeDb(value Float.X)

func (Instance) Stop

func (self Instance) Stop()

Stops the video playback and sets the stream position to 0. [b]Note:[/b] Although the stream position will be set to 0, the first frame of the video stream won't become the current frame.

func (Instance) Stream

func (self Instance) Stream() [1]gdclass.VideoStream

func (Instance) StreamPosition

func (self Instance) StreamPosition() Float.X

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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

func (Instance) Volume

func (self Instance) Volume() Float.X

func (Instance) VolumeDb

func (self Instance) VolumeDb() Float.X