class
IArcUIMediaSource
What a VideoPlayer widget needs from a clip, and nothing about how the clip is decoded. ArcUI sits below Game, where FMediaPlayer and the .media asset live, so the host injects a source factory the same way it injects the image decoder — the widget drives playback through this and samples the frame it hands back.
- Module
- ArcUI
- Header
#include "ArcUI/IArcUIMediaSource.h"- Namespace
Mowo
Constructors
| Signature | Name | Description |
|---|---|---|
virtual ~IArcUIMediaSource() = default | ~IArcUIMediaSource |
Public functions
| Returns | Name | Description |
|---|---|---|
bool | Open | A .media asset path (settings travel with it) or a bare clip path. |
void | Close | |
void | Play | |
void | Pause | |
void | Seek | |
void | SetLooping | |
void | SetVolume | |
void | Update | Advances the clock and decodes into the frame texture. |
bool | IsOpen | |
bool | IsPlaying | |
bool | IsLooping | |
double | GetTime | |
double | GetDuration | |
uint32_t | GetWidth | |
uint32_t | GetHeight | |
Arcf::Ref<Arcf::IArcRHITexture> | GetFrameTexture | The frame target, updated in place by Update. |
Function details
~IArcUIMediaSource
C++
virtual ~IArcUIMediaSource() = defaultOpen
C++
virtual bool Open(const std::string& assetPath) = 0A .media asset path (settings travel with it) or a bare clip path.
Close
C++
virtual void Close() = 0Play
C++
virtual void Play() = 0Pause
C++
virtual void Pause() = 0Seek
C++
virtual void Seek(double seconds) = 0SetLooping
C++
virtual void SetLooping(bool loop) = 0SetVolume
C++
virtual void SetVolume(float volume) = 0Update
C++
virtual void Update(float deltaSeconds) = 0Advances the clock and decodes into the frame texture. Called once per frame by the widget's tick; nothing decodes while paused.
IsOpen
C++
virtual bool IsOpen() const = 0IsPlaying
C++
virtual bool IsPlaying() const = 0IsLooping
C++
virtual bool IsLooping() const = 0GetTime
C++
virtual double GetTime() const = 0GetDuration
C++
virtual double GetDuration() const = 0GetWidth
C++
virtual uint32_t GetWidth() const = 0GetHeight
C++
virtual uint32_t GetHeight() const = 0GetFrameTexture
C++
virtual Arcf::Ref<Arcf::IArcRHITexture> GetFrameTexture() = 0The frame target, updated in place by Update. The source re-wraps it whenever the underlying image is recreated, so a widget compares the pointer it holds against this one to know when its brush went stale.
Generated from ArcUI/IArcUIMediaSource.h via arcui.json · Nov 4, 2026Version 1.0.0