reckfellENGINE

VideoStreamPlayer

Элемент UI для воспроизведения видео и его звука.

На этой странице
class VideoStreamPlayerReckfellSharpНаследует Control

Назначьте ресурс VideoStream, добавьте VideoStreamPlayer в дерево и вызовите Play либо заранее включите Autoplay. Формат файла и точность перемотки определяются реализацией потока. Встроенный VideoStreamTheora загружает Ogg Theora .ogv; расширение произвольного файла не добавляет поддержку его кодека.

Для паузы используйте Paused, для остановки Stop. Expand растягивает кадр к размеру Control без отдельного режима сохранения пропорций: задайте подходящее соотношение сторон компоновкой. Finished означает естественное завершение без Loop, а не ручной Stop.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

VideoStreamPlayerКонструктор
# VideoStreamPlayer
C#
public VideoStreamPlayer();

Создаёт видеоплеер UI. Для Play он должен находиться в дереве и иметь действительный Stream с декодером.

Свойства12

AudioTrackСвойство
# AudioTrack
C#
public int AudioTrack { get; set; }

Индекс звуковой дорожки, обычно от 0. Передаётся и общему Stream, и текущему playback; поддержка смены зависит от декодера. Не создаёт новую дорожку и не выбирает аудиошину.

AutoplayСвойство
# Autoplay
C#
public bool Autoplay { get; set; }

Запуск при входе в дерево, если Stream уже назначен и это не редактор. Включение свойства после входа само не вызывает Play; позднее назначение Stream также не является повторным входом.

BufferingMsecСвойство
# BufferingMsec
C#
public int BufferingMsec { get; set; }

Размер звуковой буферизации в миллисекундах для настройки playback. Setter сохраняет значение, но не перестраивает уже созданный буфер: задайте до Stream или переназначьте поток. Это не длительность ролика и не сетевой видеобуфер.

BusСвойство
# Bus
C#
public StringName Bus { get; set; }

Имя существующей аудиошины. Getter возвращает Master, если указанная шина не найдена. Назначение не создаёт шину и не выбирает дорожку видео.

ExpandСвойство
# Expand
C#
public bool Expand { get; set; }

true растягивает кадр на текущий Size и снимает минимальный размер по разрешению видео. false рисует в естественном размере кадра. Пропорции при растяжении автоматически не сохраняются.

LoopСвойство
# Loop
C#
public bool Loop { get; set; }

При естественном завершении снова вызывает Play вместо Finished. Повторный запуск обеспечивает реализация playback. Не превращает ручной Stop в событие завершения.

PausedСвойство
# Paused
C#
public bool Paused { get; set; }

Пользовательская пауза; false возобновляет обработку, если дерево разрешает её. Не равна IsPlaying. Пауза/приостановка дерева также может временно остановить декодер без изменения этого пользовательского флага.

SpeedScaleСвойство
# SpeedScale
C#
public float SpeedScale { get; set; }

Неотрицательный множитель продвижения видео и звука; 1 — обычная скорость, отрицательное значение не допускается. Ноль не устанавливает Paused; для явного состояния паузы используйте Paused. Учитывается вместе с масштабом времени движка.

StreamСвойство
# Stream
C#
public VideoStream Stream { get; set; }

Ресурс видео. Назначение останавливает прежний поток, создаёт новый playback, обновляет текстуру и звуковой буфер. null снимает поток. Один и тот же ресурс может использоваться несколькими плеерами с отдельными playback; сам ресурс остаётся общим.

StreamPositionСвойство
# StreamPosition
C#
public double StreamPosition { get; set; }

Позиция в секундах. Setter очищает накопленное аудио и передаёт seek декодеру; сам не проверяет диапазон и не гарантирует точный кадр. Для известной длины используйте 0 <= position < length; Theora игнорирует позицию >= длины. Без playback getter возвращает 0.

VolumeСвойство
# Volume
C#
public float Volume { get; set; }

Линейный множитель звука: 0 — тишина, 1 — исходный уровень, значения > 1 усиливают. Используйте неотрицательное значение. Не влияет на яркость кадра и не заменяет общий уровень шины.

VolumeDbСвойство
# VolumeDb
C#
public float VolumeDb { get; set; }

Тот же уровень звука в децибелах: 0 dB соответствует Volume = 1. Значение ниже -79 dB устанавливает тишину; getter для тишины возвращает -80. Не независимая вторая регулировка.

Методы30

GetAudioTrackint
# GetAudioTrack
C#
public int GetAudioTrack();

Индекс звуковой дорожки, обычно от 0. Передаётся и общему Stream, и текущему playback; поддержка смены зависит от декодера. Не создаёт новую дорожку и не выбирает аудиошину.

Возвращает int

Индекс звуковой дорожки, обычно от 0. Передаётся и общему Stream, и текущему playback; поддержка смены зависит от декодера. Не создаёт новую дорожку и не выбирает аудиошину.

GetBufferingMsecint
# GetBufferingMsec
C#
public int GetBufferingMsec();

Размер звуковой буферизации в миллисекундах для настройки playback. Setter сохраняет значение, но не перестраивает уже созданный буфер: задайте до Stream или переназначьте поток. Это не длительность ролика и не сетевой видеобуфер.

Возвращает int

Размер звуковой буферизации в миллисекундах для настройки playback. Setter сохраняет значение, но не перестраивает уже созданный буфер: задайте до Stream или переназначьте поток. Это не длительность ролика и не сетевой видеобуфер.

GetBusStringName
# GetBus
C#
public StringName GetBus();

Имя существующей аудиошины. Getter возвращает Master, если указанная шина не найдена. Назначение не создаёт шину и не выбирает дорожку видео.

Возвращает StringName

Имя существующей аудиошины. Getter возвращает Master, если указанная шина не найдена. Назначение не создаёт шину и не выбирает дорожку видео.

GetSpeedScalefloat
# GetSpeedScale
C#
public float GetSpeedScale();

Неотрицательный множитель продвижения видео и звука; 1 — обычная скорость, отрицательное значение не допускается. Ноль не устанавливает Paused; для явного состояния паузы используйте Paused. Учитывается вместе с масштабом времени движка.

Возвращает float

Неотрицательный множитель продвижения видео и звука; 1 — обычная скорость, отрицательное значение не допускается. Ноль не устанавливает Paused; для явного состояния паузы используйте Paused. Учитывается вместе с масштабом времени движка.

GetStreamVideoStream
# GetStream
C#
public VideoStream GetStream();

Ресурс видео. Назначение останавливает прежний поток, создаёт новый playback, обновляет текстуру и звуковой буфер. null снимает поток. Один и тот же ресурс может использоваться несколькими плеерами с отдельными playback; сам ресурс остаётся общим.

Возвращает VideoStream

Ресурс видео. Назначение останавливает прежний поток, создаёт новый playback, обновляет текстуру и звуковой буфер. null снимает поток. Один и тот же ресурс может использоваться несколькими плеерами с отдельными playback; сам ресурс остаётся общим.

GetStreamLengthdouble
# GetStreamLength
C#
public double GetStreamLength();

Длина в секундах от текущего декодера, 0 без playback или при отсутствии информации в реализации. Не используйте 0 как доказательство, что файл пуст.

Возвращает double

Длина в секундах от текущего декодера, 0 без playback или при отсутствии информации в реализации. Не используйте 0 как доказательство, что файл пуст.

GetStreamNamestring
# GetStreamName
C#
public string GetStreamName();

Имя ресурса Stream, не гарантированно имя файла. Без Stream возвращает служебную строку <No Stream>. Для пути используйте свойство File ресурса.

Возвращает string

Имя ресурса Stream, не гарантированно имя файла. Без Stream возвращает служебную строку <No Stream>. Для пути используйте свойство File ресурса.

GetStreamPositiondouble
# GetStreamPosition
C#
public double GetStreamPosition();

Позиция в секундах. Setter очищает накопленное аудио и передаёт seek декодеру; сам не проверяет диапазон и не гарантирует точный кадр. Для известной длины используйте 0 <= position < length; Theora игнорирует позицию >= длины. Без playback getter возвращает 0.

Возвращает double

Позиция в секундах. Setter очищает накопленное аудио и передаёт seek декодеру; сам не проверяет диапазон и не гарантирует точный кадр. Для известной длины используйте 0 <= position < length; Theora игнорирует позицию >= длины. Без playback getter возвращает 0.

GetVideoTextureTexture2D
# GetVideoTexture
C#
public Texture2D GetVideoTexture();

Возвращает общую текущую текстуру декодера либо null без playback. Она может обновляться при декодировании: это не снимок кадра. Не освобождайте её как принадлежащий вам серверный ресурс.

Возвращает Texture2D

Возвращает общую текущую текстуру декодера либо null без playback. Она может обновляться при декодировании: это не снимок кадра. Не освобождайте её как принадлежащий вам серверный ресурс.

GetVolumefloat
# GetVolume
C#
public float GetVolume();

Линейный множитель звука: 0 — тишина, 1 — исходный уровень, значения > 1 усиливают. Используйте неотрицательное значение. Не влияет на яркость кадра и не заменяет общий уровень шины.

Возвращает float

Линейный множитель звука: 0 — тишина, 1 — исходный уровень, значения > 1 усиливают. Используйте неотрицательное значение. Не влияет на яркость кадра и не заменяет общий уровень шины.

GetVolumeDbfloat
# GetVolumeDb
C#
public float GetVolumeDb();

Тот же уровень звука в децибелах: 0 dB соответствует Volume = 1. Значение ниже -79 dB устанавливает тишину; getter для тишины возвращает -80. Не независимая вторая регулировка.

Возвращает float

Тот же уровень звука в децибелах: 0 dB соответствует Volume = 1. Значение ниже -79 dB устанавливает тишину; getter для тишины возвращает -80. Не независимая вторая регулировка.

HasAutoplaybool
# HasAutoplay
C#
public bool HasAutoplay();

Запуск при входе в дерево, если Stream уже назначен и это не редактор. Включение свойства после входа само не вызывает Play; позднее назначение Stream также не является повторным входом.

Возвращает bool

Запуск при входе в дерево, если Stream уже назначен и это не редактор. Включение свойства после входа само не вызывает Play; позднее назначение Stream также не является повторным входом.

HasExpandbool
# HasExpand
C#
public bool HasExpand();

true растягивает кадр на текущий Size и снимает минимальный размер по разрешению видео. false рисует в естественном размере кадра. Пропорции при растяжении автоматически не сохраняются.

Возвращает bool

true растягивает кадр на текущий Size и снимает минимальный размер по разрешению видео. false рисует в естественном размере кадра. Пропорции при растяжении автоматически не сохраняются.

HasLoopbool
# HasLoop
C#
public bool HasLoop();

При естественном завершении снова вызывает Play вместо Finished. Повторный запуск обеспечивает реализация playback. Не превращает ручной Stop в событие завершения.

Возвращает bool

При естественном завершении снова вызывает Play вместо Finished. Повторный запуск обеспечивает реализация playback. Не превращает ручной Stop в событие завершения.

IsPausedbool
# IsPaused
C#
public bool IsPaused();

Пользовательская пауза; false возобновляет обработку, если дерево разрешает её. Не равна IsPlaying. Пауза/приостановка дерева также может временно остановить декодер без изменения этого пользовательского флага.

Возвращает bool

Пользовательская пауза; false возобновляет обработку, если дерево разрешает её. Не равна IsPlaying. Пауза/приостановка дерева также может временно остановить декодер без изменения этого пользовательского флага.

IsPlayingbool
# IsPlaying
C#
public bool IsPlaying();

Возвращает состояние playback или false без него. Это не проверка слышимости звука или появления нового кадра; при Paused декодер может оставаться в состоянии playing.

Возвращает bool

Возвращает состояние playback или false без него. Это не проверка слышимости звука или появления нового кадра; при Paused декодер может оставаться в состоянии playing.

Playvoid
# Play
C#
public void Play();

Вызывает запуск текущего декодера; нужен элемент в дереве и подготовленный Stream. Повторный Play не гарантирует перезапуск с начала у каждой реализации. Для возобновления паузы используйте Paused = false.

SetAudioTrackvoid
# SetAudioTrack
C#
public void SetAudioTrack(int track);

Индекс звуковой дорожки, обычно от 0. Передаётся и общему Stream, и текущему playback; поддержка смены зависит от декодера. Не создаёт новую дорожку и не выбирает аудиошину.

Параметры
ИмяТипПо умолчанию
trackint—
track

Индекс звуковой дорожки согласно формату, обычно от 0.

SetAutoplayvoid
# SetAutoplay
C#
public void SetAutoplay(bool enabled);

Запуск при входе в дерево, если Stream уже назначен и это не редактор. Включение свойства после входа само не вызывает Play; позднее назначение Stream также не является повторным входом.

Параметры
ИмяТипПо умолчанию
enabledbool—
enabled

Запускать при входе в дерево при уже назначенном Stream.

SetBufferingMsecvoid
# SetBufferingMsec
C#
public void SetBufferingMsec(int msec);

Размер звуковой буферизации в миллисекундах для настройки playback. Setter сохраняет значение, но не перестраивает уже созданный буфер: задайте до Stream или переназначьте поток. Это не длительность ролика и не сетевой видеобуфер.

Параметры
ИмяТипПо умолчанию
msecint—
msec

Неотрицательная длительность аудиобуфера в миллисекундах.

SetBusvoid
# SetBus
C#
public void SetBus(StringName bus);

Имя существующей аудиошины. Getter возвращает Master, если указанная шина не найдена. Назначение не создаёт шину и не выбирает дорожку видео.

Параметры
ИмяТипПо умолчанию
busStringName—
bus

Имя существующей аудиошины.

SetExpandvoid
# SetExpand
C#
public void SetExpand(bool enable);

true растягивает кадр на текущий Size и снимает минимальный размер по разрешению видео. false рисует в естественном размере кадра. Пропорции при растяжении автоматически не сохраняются.

Параметры
ИмяТипПо умолчанию
enablebool—
enable

Растягивать кадр к размеру Control.

SetLoopvoid
# SetLoop
C#
public void SetLoop(bool loop);

При естественном завершении снова вызывает Play вместо Finished. Повторный запуск обеспечивает реализация playback. Не превращает ручной Stop в событие завершения.

Параметры
ИмяТипПо умолчанию
loopbool—
loop

Повторять естественно завершившееся воспроизведение.

SetPausedvoid
# SetPaused
C#
public void SetPaused(bool paused);

Пользовательская пауза; false возобновляет обработку, если дерево разрешает её. Не равна IsPlaying. Пауза/приостановка дерева также может временно остановить декодер без изменения этого пользовательского флага.

Параметры
ИмяТипПо умолчанию
pausedbool—
paused

Приостановить продвижение без завершения потока.

SetSpeedScalevoid
# SetSpeedScale
C#
public void SetSpeedScale(float speedScale);

Неотрицательный множитель продвижения видео и звука; 1 — обычная скорость, отрицательное значение не допускается. Ноль не устанавливает Paused; для явного состояния паузы используйте Paused. Учитывается вместе с масштабом времени движка.

Параметры
ИмяТипПо умолчанию
speedScalefloat—
speedScale

Неотрицательный множитель скорости, 1 — обычная.

SetStreamvoid
# SetStream
C#
public void SetStream(VideoStream stream);

Ресурс видео. Назначение останавливает прежний поток, создаёт новый playback, обновляет текстуру и звуковой буфер. null снимает поток. Один и тот же ресурс может использоваться несколькими плеерами с отдельными playback; сам ресурс остаётся общим.

Параметры
ИмяТипПо умолчанию
streamVideoStream—
stream

Действительный ресурс VideoStream с декодером или null для снятия.

SetStreamPositionvoid
# SetStreamPosition
C#
public void SetStreamPosition(double position);

Позиция в секундах. Setter очищает накопленное аудио и передаёт seek декодеру; сам не проверяет диапазон и не гарантирует точный кадр. Для известной длины используйте 0 <= position < length; Theora игнорирует позицию >= длины. Без playback getter возвращает 0.

Параметры
ИмяТипПо умолчанию
positiondouble—
position

Желаемая позиция в секундах; допустимость определяет декодер.

SetVolumevoid
# SetVolume
C#
public void SetVolume(float volume);

Линейный множитель звука: 0 — тишина, 1 — исходный уровень, значения > 1 усиливают. Используйте неотрицательное значение. Не влияет на яркость кадра и не заменяет общий уровень шины.

Параметры
ИмяТипПо умолчанию
volumefloat—
volume

Неотрицательный линейный множитель звука.

SetVolumeDbvoid
# SetVolumeDb
C#
public void SetVolumeDb(float db);

Тот же уровень звука в децибелах: 0 dB соответствует Volume = 1. Значение ниже -79 dB устанавливает тишину; getter для тишины возвращает -80. Не независимая вторая регулировка.

Параметры
ИмяТипПо умолчанию
dbfloat—
db

Уровень в dB; ниже -79 устанавливает тишину.

Stopvoid
# Stop
C#
public void Stop();

Останавливает playback и очищает накопленный звуковой буфер. Не испускает Finished; сброс позиции зависит от декодера, у Theora выполняется переход к началу. Вне дерева ничего не делает.

Сигналы и события1

FinishedСобытие
# Finished
C#
public event Action Finished;

Естественное завершение текущего playback при выключенном Loop. Не испускается ручным Stop и не означает удаление плеера или ресурса.

Документация Reckfell EngineНаверх ↑
БЫСТРЫЙ ПЕРЕХОДНачало работыEntity и иерархияC# & .NET 10Сцены и префабы
Руководства и полный API Reckfell K
reckfellENGINE
RECKFELL ACCOUNT

Вход в аккаунт

Войдите в аккаунт Reckfell.

Один аккаунт для всей платформы Reckfell.