VideoStreamPlayer

继承： Control < CanvasItem < Item < Object

用于视频播放的控件。

描述

用于播放VideoStream资源的控件。

支持的视频格式是Ogg Theora（. ogv，VideoStreamTheora）和通过S3Extension插件公开的任何格式。

警告：在Web上，由于缺少architecture-specific组装优化，视频播放将表现不佳。

属性

int	audio_track	0
bool	autoplay	false
int	buffering_msec	500
StringName	bus	&"Master"
bool	expand	false
bool	loop	false
bool	paused	false
VideoStream	stream
float	stream_position
float	volume
float	volume_db	0.0

方法

float	get_stream_length() const
String	get_stream_name() const
Texture2D	get_video_texture() const
bool	is_playing() const
void	play()
void	stop()

---

信号

finished() 🔗

播放完成时发出。

---

属性说明

int audio_track = 0 🔗

• void set_audio_track(value: int)

• int get_audio_track()

要播放的嵌入式音轨。

---

bool autoplay = false 🔗

• void set_autoplay(value: bool)

• bool has_autoplay()

如果true，则在场景加载时开始播放。

---

int buffering_msec = 500 🔗

• void set_buffering_msec(value: int)

• int get_buffering_msec()

播放时存储在缓冲区中的时间（以毫秒为单位）。

---

StringName bus = &"Master" 🔗

• void set_bus(value: StringName)

• StringName get_bus()

用于声音播放的音频总线。

---

bool expand = false 🔗

• void set_expand(value: bool)

• bool has_expand()

如果true，则视频缩放到控制大小。否则，将自动调整控制最小大小以匹配视频流的尺寸。

---

bool loop = false 🔗

• void set_loop(value: bool)

• bool has_loop()

如果true，则视频在结束时重新开始。

---

bool paused = false 🔗

• void set_paused(value: bool)

• bool is_paused()

如果true，则视频暂停。

---

VideoStream stream 🔗

• void set_stream(value: VideoStream)

• VideoStream get_stream()

分配的视频流。有关支持的格式，请参阅描述。

---

float stream_position 🔗

• void set_stream_position(value: float)

• float get_stream_position()

流的当前位置，以秒为单位。

注意：更改此值不会产生任何影响，因为尚未实现查找，除非是由S3Extension插件实现的视频格式。

---

float volume 🔗

• void set_volume(value: float)

• float get_volume()

音频音量作为线性值。

---

float volume_db = 0.0 🔗

• void set_volume_db(value: float)

• float get_volume_db()

音频音量（以dB为单位）。

---

方法说明

float get_stream_length() const 🔗

当前流的长度，以秒为单位。

注意：对于VideoStreamTheora流（i3D支持的内置格式），此值将始终为零，因为尚未实现获取流长度。该功能可能由S3Extension插件实现的视频格式支持。

---

String get_stream_name() const 🔗

返回视频流的名称，如果没有分配视频流，则返回"<No Stream>"。

---

Texture2D get_video_texture() const 🔗

以Texture2D的形式返回当前帧。

---

bool is_playing() const 🔗

如果正在播放视频，则返回true。

注意：如果在播放过程中暂停，视频仍被视为正在播放。

---

void play() 🔗

从头开始视频播放。如果视频暂停，这不会取消视频暂停。

---

void stop() 🔗

停止视频播放并将流位置设置为0。

注意：虽然流位置将设置为0，但视频流的第一帧不会成为当前帧。