Navigation
API > API/Plugins > API/Plugins/CommonUI
| Name | UCommonVideoPlayer |
| Type | class |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonVideoPlayer.h |
| Include Path | #include "CommonVideoPlayer.h" |
Syntax
UCLASS (MinimalAPI, ClassGroup=UI, Meta=(Category="Common UI"))
class UCommonVideoPlayer : public UWidget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UCommonVideoPlayer
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCommonVideoPlayer
(
const FObjectInitializer& Initializer |
CommonVideoPlayer.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsMuted | bool | CommonVideoPlayer.h | ||
| bMatchSize | bool | Should we match the size of the media source when it opens? | CommonVideoPlayer.h |
|
| MediaPlayer | TObjectPtr< UMediaPlayer > | CommonVideoPlayer.h |
|
|
| MediaTexture | TObjectPtr< UMediaTexture > | CommonVideoPlayer.h |
|
|
| MyImage | TSharedPtr< SImage > | CommonVideoPlayer.h | ||
| OnPlaybackCompleteEvent | FSimpleMulticastDelegate | CommonVideoPlayer.h | ||
| OnPlaybackPausedEvent | FSimpleMulticastDelegate | CommonVideoPlayer.h | ||
| OnPlaybackResumedEvent | FSimpleMulticastDelegate | CommonVideoPlayer.h | ||
| SoundComponent | TObjectPtr< UMediaSoundComponent > | CommonVideoPlayer.h |
|
|
| Video | TObjectPtr< UMediaSource > | CommonVideoPlayer.h |
|
|
| VideoBrush | FSlateBrush | CommonVideoPlayer.h |
|
|
| VideoMaterial | TObjectPtr< UMaterial > | CommonVideoPlayer.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Close() |
CommonVideoPlayer.h |
|
|
float GetPlaybackRate() |
CommonVideoPlayer.h |
|
|
float GetPlaybackTime() |
CommonVideoPlayer.h |
|
|
float GetVideoDuration() |
CommonVideoPlayer.h |
|
|
bool IsLooping() |
CommonVideoPlayer.h |
|
|
bool IsMuted() |
CommonVideoPlayer.h |
|
|
bool IsPaused() |
CommonVideoPlayer.h |
|
|
bool IsPlaying() |
CommonVideoPlayer.h |
|
|
FSimpleMulticastDelegate & OnPlaybackComplete() |
CommonVideoPlayer.h | ||
FSimpleMulticastDelegate & OnPlaybackPaused() |
CommonVideoPlayer.h | ||
FSimpleMulticastDelegate & OnPlaybackResumed() |
CommonVideoPlayer.h | ||
void Pause() |
CommonVideoPlayer.h |
|
|
void Play() |
CommonVideoPlayer.h |
|
|
void PlayFromStart() |
CommonVideoPlayer.h |
|
|
void Reverse() |
CommonVideoPlayer.h |
|
|
void Seek
(
float PlaybackTime |
CommonVideoPlayer.h |
|
|
void SetIsMuted
(
bool bInIsMuted |
CommonVideoPlayer.h |
|
|
void SetLooping
(
bool bShouldLoopPlayback |
CommonVideoPlayer.h |
|
|
void SetPlaybackRate
(
float PlaybackRate |
CommonVideoPlayer.h |
|
|
void SetShouldMatchSize
(
bool bInMatchSize |
CommonVideoPlayer.h |
|
|
void SetVideo
(
UMediaSource* NewVideo |
CommonVideoPlayer.h |
|
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostInitProperties() |
CommonVideoPlayer.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const UMediaPlayer & GetMediaPlayer() |
CommonVideoPlayer.h | ||
virtual void HandleMediaPlayerEvent
(
EMediaEvent EventType |
CommonVideoPlayer.h | ||
virtual void PlaybackTick
(
double InCurrentTime, |
CommonVideoPlayer.h | ||
void PlayInternal() |
CommonVideoPlayer.h |
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const FText GetPaletteCategory() |
CommonVideoPlayer.h | ||
virtual TSharedRef< SWidget > RebuildWidget() |
CommonVideoPlayer.h | ||
virtual void SynchronizeProperties() |
CommonVideoPlayer.h |
Overridden from UVisual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
CommonVideoPlayer.h |