VideoStreamPlayer

Наследует: Control < CanvasItem < Node < Object

Элемент управления, используемый для воспроизведения видео.

Описание

Элемент управления, используемый для воспроизведения ресурсов VideoStream.

Поддерживаемые форматы видео: Ogg Theora (.ogv, VideoStreamTheora) и любой формат, предоставляемый через плагин GDExtension.

Предупреждение: В Интернете воспроизведение видео будет работать плохо из-за отсутствия архитектурно-специфических оптимизаций сборки.

Обучающие материалы

Свойства

int

audio_track

0

bool

autoplay

false

int

buffering_msec

500

StringName

bus

&"Master"

bool

expand

false

bool

loop

false

bool

paused

false

float

speed_scale

1.0

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" 🔗

Аудиошина для воспроизведения звука.

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, видео приостанавливается.

float speed_scale = 1.0 🔗

  • void set_speed_scale(value: float)

  • float get_speed_scale()

Текущая шкала скорости потока. 1.0 — это обычная скорость, 2.0 — это двойная скорость, а 0.5 — это половинная скорость. Шкала скорости 0.0 приостанавливает видео, аналогично установке paused на true.

VideoStream stream 🔗

Назначенный видеопоток. Смотрите описание поддерживаемых форматов.

float stream_position 🔗

  • void set_stream_position(value: float)

  • float get_stream_position()

Текущее положение потока в секундах.

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

Громкость звука в дБ.

Описания метода

float get_stream_length() const 🔗

Продолжительность текущего потока в секундах.

String get_stream_name() const 🔗

Возвращает имя видеопотока или "<No Stream>", если видеопоток не назначен.

Texture2D get_video_texture() const 🔗

Возвращает текущий кадр как Texture2D.

bool is_playing() const 🔗

Возвращает true, если видео воспроизводится.

Примечание: Видео все равно считается воспроизводимым, если оно приостановлено во время воспроизведения.

void play() 🔗

Начинает воспроизведение видео с начала. Если видео приостановлено, это не возобновит его воспроизведение.

void stop() 🔗

Останавливает воспроизведение видео и устанавливает позицию потока на 0.

Примечание: Хотя позиция потока будет установлена на 0, первый кадр видеопотока не станет текущим кадром.