Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

VideoStreamPlayer

Успадковує: Control < CanvasItem < Node < Object

Використовується для відтворення відео.

Опис

Контроль, що використовується для відтворення ресурсів VideoStream.

Підтримувані формати відео Ogg Theora (.ogv, VideoStreamTheora) і будь-який формат, що видається за допомогою плагіна GDExtension.

Навігація: На Веб-сайті, відтворення відео will виконає погано через відсутність архітектурно-специфічної оптимізації збірки.

Посібники

Властивості

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

Аудіо об'єм в 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, перший кадр відеопотоку не стане поточною рамою.