class

EmeraldVideoPlayer3D

Inherits Godot::Node3D < Godot::Node < Godot::Object < Reference < Object

Godot Node3D for in-world 3D video playback powered by LibVLC. Provides an ImageTexture that can be mapped onto 3D surfaces (in-game screens, TVs, cinema displays) or rendered automatically via an optional internal Sprite3D.

Constructors

new

Source

Class methods

_godot_has_virtual_method(method_name : String) : Bool

Source

_godot_register_node_class

Source

godot_class_name

Source

godot_parent_class_name

Source

Instance methods

_exit_tree

Lifecycle callback called when the node exits the tree hierarchy.

Source

_godot_call_tool_button(button_name : String) : Void

Dispatches inspector tool button clicks on this object.

Source

_godot_call_virtual(method_name : String, delta : Float64) : Void

Virtual method and property dispatch hooks overridden by class registration macros. Delta timestep is received with 64-bit precision (Float64).

Source

_godot_call_virtual_with_data(method_name : String, args : Pointer(Pointer(Void)), ret : Pointer(Void)) : Void

Dispatches generic virtual methods with raw arguments and return buffer.

Source

_godot_get_property(prop_name : String, ret_ptr : Pointer(Void)) : Void

Invoked by the GDExtension bridge when retrieving an exposed @export property.

Source

_godot_set_property(prop_name : String, val_ptr : Pointer(Void)) : Void

Invoked by the GDExtension bridge when setting an exposed @export property.

Source

_process(delta : Float64) : Void

Per-frame process callback receiving delta timestep in seconds (Float64).

Source

_ready

Lifecycle callback called when the node enters the active scene tree.

Source

autoplay

Source

autoplay=(autoplay : Bool)

Source

bind_error_occurred(callback : Proc(String, R), once : Bool = false) : UInt64 forall R

Source

bind_error_occurred(once : Bool = false, &block : String -> Void) : UInt64

Source

bind_length_changed(callback : Proc(Int64, R), once : Bool = false) : UInt64 forall R

Source

bind_length_changed(once : Bool = false, &block : Int64 -> Void) : UInt64

Source

bind_metadata_loaded(callback : Proc(R), once : Bool = false) : UInt64 forall R

Source

bind_metadata_loaded(once : Bool = false, &block : -> Void) : UInt64

Source

bind_playback_finished(callback : Proc(R), once : Bool = false) : UInt64 forall R

Source

bind_playback_finished(once : Bool = false, &block : -> Void) : UInt64

Source

bind_playback_paused(callback : Proc(R), once : Bool = false) : UInt64 forall R

Source

bind_playback_paused(once : Bool = false, &block : -> Void) : UInt64

Source

bind_playback_resumed(callback : Proc(R), once : Bool = false) : UInt64 forall R

Source

bind_playback_resumed(once : Bool = false, &block : -> Void) : UInt64

Source

bind_playback_started(callback : Proc(R), once : Bool = false) : UInt64 forall R

Playback lifecycle signals

Source

bind_playback_started(once : Bool = false, &block : -> Void) : UInt64

Playback lifecycle signals

Source

bind_playback_stopped(callback : Proc(R), once : Bool = false) : UInt64 forall R

Source

bind_playback_stopped(once : Bool = false, &block : -> Void) : UInt64

Source

bind_position_changed(callback : Proc(Float64, Int64, R), once : Bool = false) : UInt64 forall R

Dynamic progress signals

Source

bind_position_changed(once : Bool = false, &block : Float64, Int64 -> Void) : UInt64

Dynamic progress signals

Source

call(method : String, *args) : Pointer(Void)

Calls the named method on the object with variable arguments.

Source

create_sprite3d

Source

create_sprite3d=(create_sprite3d : Bool)

Source

decoder_config

Builds the Core::VideoDecoderConfig from node properties

Source

decoding_threads

Source

decoding_threads=(decoding_threads : Int32)

Source

drop_late_frames

Source

drop_late_frames=(drop_late_frames : Bool)

Source

emit_error_occurred(*args : *T) : Void forall T

Source

emit_length_changed(*args : *T) : Void forall T

Source

emit_metadata_loaded

Source

emit_playback_finished

Source

emit_playback_paused

Source

emit_playback_resumed

Source

emit_playback_started

Playback lifecycle signals

Source

emit_playback_stopped

Source

emit_position_changed(*args : *T) : Void forall T

Dynamic progress signals

Source

error_occurred

Source

error_occurred=(val : Godot::BoundSignal) : Godot::BoundSignal

Identity setter enabling compound operator sugar (node.error_occurred += ->handler, node.error_occurred -= ->handler)

Source

error_occurred_signal_hash

Source

error_occurred_slot

Source

get_metadata

Extracts media metadata tags

Source

hardware_acceleration

Source

hardware_acceleration=(hardware_acceleration : String)

Source

length_changed

Source

length_changed=(val : Godot::BoundSignal) : Godot::BoundSignal

Identity setter enabling compound operator sugar (node.length_changed += ->handler, node.length_changed -= ->handler)

Source

length_changed_signal_hash

Source

length_changed_slot

Source

load_subtitles(file_path : String) : Bool

Loads an external subtitle file (.srt, .vtt, .ass)

loop

loop=(loop : Bool)

low_latency

low_latency=(low_latency : Bool)

Source

media_resource

Source

media_resource=(media_resource : EmeraldMediaResource | Nil)

Source

metadata_loaded

Source

metadata_loaded=(val : Godot::BoundSignal) : Godot::BoundSignal

Identity setter enabling compound operator sugar (node.metadata_loaded += ->handler, node.metadata_loaded -= ->handler)

Source

metadata_loaded_signal_hash

Source

metadata_loaded_slot

Source

next_frame

Steps forward a single video frame

Source

open(media_path : String, &block : Emerald::DSL::MediaBuilder -> ) : Bool

Opens a video file or network stream with a declarative DSL configuration block

Source

open(media_path : String, config : Emerald::Core::VideoDecoderConfig | Nil = nil) : Bool

Opens a video file or network stream with an explicit decoder configuration

Source

pause

Pauses video playback

Source

play

Starts or resumes video playback

Source

playback_finished

Source

playback_finished=(val : Godot::BoundSignal) : Godot::BoundSignal

Identity setter enabling compound operator sugar (node.playback_finished += ->handler, node.playback_finished -= ->handler)

Source

playback_finished_signal_hash

Source

playback_finished_slot

Source

playback_paused

Source

playback_paused=(val : Godot::BoundSignal) : Godot::BoundSignal

Identity setter enabling compound operator sugar (node.playback_paused += ->handler, node.playback_paused -= ->handler)

Source

playback_paused_signal_hash

Source

playback_paused_slot

Source

playback_rate

Source

playback_rate=(playback_rate : Float64)

Source

playback_resumed

Source

playback_resumed=(val : Godot::BoundSignal) : Godot::BoundSignal

Identity setter enabling compound operator sugar (node.playback_resumed += ->handler, node.playback_resumed -= ->handler)

Source

playback_resumed_signal_hash

Source

playback_resumed_slot

Source

playback_started

Playback lifecycle signals

Source

playback_started=(val : Godot::BoundSignal) : Godot::BoundSignal

Identity setter enabling compound operator sugar (node.playback_started += ->handler, node.playback_started -= ->handler)

Source

playback_started_signal_hash

Playback lifecycle signals

Source

playback_started_slot

Playback lifecycle signals

Source

playback_stopped

Source

playback_stopped=(val : Godot::BoundSignal) : Godot::BoundSignal

Identity setter enabling compound operator sugar (node.playback_stopped += ->handler, node.playback_stopped -= ->handler)

Source

playback_stopped_signal_hash

Source

playback_stopped_slot

Source

playing?

Returns true if currently playing

Source

position_changed

Dynamic progress signals

Source

position_changed=(val : Godot::BoundSignal) : Godot::BoundSignal

Identity setter enabling compound operator sugar (node.position_changed += ->handler, node.position_changed -= ->handler)

Source

position_changed_signal_hash

Dynamic progress signals

Source

position_changed_slot

Dynamic progress signals

Source

seek(time_ms : Int64) : Void

Seeks to timestamp in milliseconds

Source

seek_ratio(ratio : Float64) : Void

Seeks to normalized progress ratio (0.0 .. 1.0)

Source

select_audio_track(track_id : Int32) : Void

Selects an active audio dub track by ID (-1 to mute)

Source

select_subtitle_track(track_id : Int32) : Void

Selects an active subtitle track by ID (-1 to disable)

Source

set_equalizer_preset(preset_name : String) : Void

Sets 10-band audio graphic equalizer preset

Source

source

Source

source=(source : String)

Source

stop

Stops video playback and resets position

Source

take_snapshot(file_path : String) : Bool

Captures a video snapshot to a local file (.png, .jpg)

Source

toggle_pause

Toggles between play and pause

Source

unbind_error_occurred(callback : Proc(String, R)) : Bool forall R

Source

unbind_error_occurred(token : UInt64) : Bool

Source

unbind_length_changed(callback : Proc(Int64, R)) : Bool forall R

Source

unbind_length_changed(token : UInt64) : Bool

Source

unbind_metadata_loaded(callback : Proc(R)) : Bool forall R

Source

unbind_metadata_loaded(token : UInt64) : Bool

Source

unbind_playback_finished(callback : Proc(R)) : Bool forall R

Source

unbind_playback_finished(token : UInt64) : Bool

Source

unbind_playback_paused(callback : Proc(R)) : Bool forall R

Source

unbind_playback_paused(token : UInt64) : Bool

Source

unbind_playback_resumed(callback : Proc(R)) : Bool forall R

Source

unbind_playback_resumed(token : UInt64) : Bool

Source

unbind_playback_started(callback : Proc(R)) : Bool forall R

Playback lifecycle signals

Source

unbind_playback_started(token : UInt64) : Bool

Playback lifecycle signals

Source

unbind_playback_stopped(callback : Proc(R)) : Bool forall R

Source

unbind_playback_stopped(token : UInt64) : Bool

Source

unbind_position_changed(callback : Proc(Float64, Int64, R)) : Bool forall R

Dynamic progress signals

Source

unbind_position_changed(token : UInt64) : Bool

Dynamic progress signals

Source

video_texture

Returns the ImageTexture containing live decoded video frames

Source

volume

Source

volume=(volume : Int32)

Source

Macros

autoload(*args, **kwargs)

DSL directives for in-body autoload configuration

Source

autoload_node(*args, **kwargs)

Source

build

Source

create

Source