AVideoPlayer
UMG's MediaPlayer + Image pairing in one node: binds a .media asset, owns the playback controls Visual Script reaches through MUIStatics, and shows the decoded frame through a hosted AImage so the picture takes the same brush path every other image on the screen does. The decode itself lives behind IArcUIMediaSource; without a source factory installed the widget builds, holds its settings and paints its backdrop, so a headless build of the screen still reports the node.
- Module
- ArcUI
- Header
#include "ArcUI/Widgets/AVideoPlayer.h"- Namespace
Arcf
Constructors
| Signature | Name | Description |
|---|---|---|
AVideoPlayer() | AVideoPlayer | |
~AVideoPlayer() override | ~AVideoPlayer | |
AVideoPlayer(const AVideoPlayer&) = delete | AVideoPlayer |
Public functions
| Returns | Name | Description |
|---|---|---|
AVideoPlayer& | operator= | |
bool | SetSource | Opens the asset through the installed source factory; an empty path closes whatever is open. |
const std::string& | GetSource | |
void | AdoptSource | Hands the widget a source directly — the host-side seam and the test seam, so a fake clip can stand in for the decoder. |
void | Play | |
void | Pause | |
void | Stop | |
void | Seek | |
void | SetLooping | |
bool | IsLooping | |
void | SetVolume | |
float | GetVolume | |
void | SetAutoPlay | |
bool | IsAutoPlay | |
void | SetKeepAspect | Letterbox the frame inside the node instead of stretching it. |
bool | KeepsAspect | |
void | SetTint | |
void | SetBackdropColor | |
bool | HasSource | |
bool | IsPlaying | |
float | GetTime | |
float | GetDuration | |
void | Tick | Advances the clip and refreshes the hosted image when the frame target was recreated. |
void | TickAll | |
int32_t | LiveCount | |
ArcVec2 | ComputeDesiredSize | |
void | ArrangeChildren | |
int32_t | OnPaint | |
bool | CanSkipArrange | The frame arrives in place; a recreated target swaps the brush and invalidates, so a replay can never show a stale image handle. |
bool | CanRetainPaint | |
const char* | GetTypeName |
Function details
AVideoPlayer
AVideoPlayer()~AVideoPlayer
~AVideoPlayer() overrideAVideoPlayer
AVideoPlayer(const AVideoPlayer&) = deleteoperator=
AVideoPlayer& operator=(const AVideoPlayer&) = deleteSetSource
bool SetSource(const std::string& assetPath)Opens the asset through the installed source factory; an empty path closes whatever is open. AutoPlay starts the clip on success.
GetSource
const std::string& GetSource() constAdoptSource
void AdoptSource(std::unique_ptr<::Mowo::IArcUIMediaSource> source, const std::string& assetPath)Hands the widget a source directly — the host-side seam and the test seam, so a fake clip can stand in for the decoder.
Play
void Play()Pause
void Pause()Stop
void Stop()Seek
void Seek(float seconds)SetLooping
void SetLooping(bool loop)IsLooping
bool IsLooping() constSetVolume
void SetVolume(float volume)GetVolume
float GetVolume() constSetAutoPlay
void SetAutoPlay(bool autoPlay)IsAutoPlay
bool IsAutoPlay() constSetKeepAspect
void SetKeepAspect(bool keep)Letterbox the frame inside the node instead of stretching it.
KeepsAspect
bool KeepsAspect() constSetTint
void SetTint(const ArcColor& tint)SetBackdropColor
void SetBackdropColor(const ArcColor& color)HasSource
bool HasSource() constIsPlaying
bool IsPlaying() constGetTime
float GetTime() constGetDuration
float GetDuration() constTick
void Tick(float deltaSeconds)Advances the clip and refreshes the hosted image when the frame target was recreated. The screen stack drives this through TickAll.
TickAll
static void TickAll(float deltaSeconds)LiveCount
static int32_t LiveCount()ComputeDesiredSize
ArcVec2 ComputeDesiredSize(float scale) const overrideArrangeChildren
void ArrangeChildren(const CGeometry& geo) overrideOnPaint
int32_t OnPaint(const CArcPaintArgs& args, const CGeometry& geo, CArcUIRenderer& renderer, int32_t layerId) const overrideCanSkipArrange
bool CanSkipArrange() const overrideThe frame arrives in place; a recreated target swaps the brush and invalidates, so a replay can never show a stale image handle.
CanRetainPaint
bool CanRetainPaint() const overrideGetTypeName
const char* GetTypeName() const override