VideoPlayer

VideoPlayer

Inherits: Control < CanvasItem < Node < Object

用于播放视频流的控件。

描述

用于播放使用VideoStream资源视频流的控件节点。

支持的视频格式有 WebM (.webm, VideoStreamWebm), Ogg Theora (.ogv, VideoStreamTheora ) 以及任何通过GDNative插件使用VideoStreamGDNative公开的格式。

注意： 由于一个错误，VideoPlayer还不支持本地化重映射。

警告： 在HTML5上，视频播放将表现不佳，因为缺少特定架构的汇编优化，特别是对于VP8/VP9。

属性

int	audio_track	`0`
bool	autoplay	`false`
int	buffering_msec	`500`
String	bus	`“Master”`
bool	expand	`true`
bool	paused	`false`
VideoStream	stream
float	stream_position
float	volume
float	volume_db	`0.0`

方法

String	get_stream_name ( ) const
Texture	get_video_texture ( ) const
bool	is_playing ( ) const
void	play ( )
void	stop ( )

信号

finished ( )

播放结束时触发。

属性说明

int audio_track

Default	`0`
Setter	set_audio_track(value)
Getter	get_audio_track()

要播放的嵌入式音轨。

bool autoplay

Default	`false`
Setter	set_autoplay(value)
Getter	has_autoplay()

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

int buffering_msec

Default	`500`
Setter	set_buffering_msec(value)
Getter	get_buffering_msec()

播放时存储在缓冲区的时间，以毫秒计。

String bus

Default	`“Master”`
Setter	set_bus(value)
Getter	get_bus()

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

bool expand

Default	`true`
Setter	set_expand(value)
Getter	has_expand()

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

bool paused

Default	`false`
Setter	set_paused(value)
Getter	is_paused()

如果true，则暂停视频。

VideoStream stream

Setter	set_stream(value)
Getter	get_stream()

指定的视频流。支持的格式见描述。

float stream_position

Setter	set_stream_position(value)
Getter	get_stream_position()

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

注意： 更改此值不会产生任何影响，因为搜索尚未实现，除了由 GDNative 附加组件实现的视频格式。

float volume

Setter	set_volume(value)
Getter	get_volume()

音频音量为线性值。

float volume_db

Default	`0.0`
Setter	set_volume_db(value)
Getter	get_volume_db()

音频音量，单位是dB。

方法说明

String get_stream_name ( ) const

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

Texture get_video_texture ( ) const

将当前帧作为Texture返回。

bool is_playing ( ) const

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

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

void play ( )

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

void stop ( )

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

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