UOperatingSystemVideoPlayerProgramData

#include <OperatingSystemSimulator/Public/Programs/VideoPlayer/OperatingSystemVideoPlayerProgramData.h>

class UOperatingSystemVideoPlayerProgramData

Defined in OperatingSystemVideoPlayerProgramData.h:18

Inherits: UOperatingSystemProgramData

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemVideoPlayerProgramData["UOperatingSystemVideoPlayerProgramData"]
  class UOperatingSystemProgramData["UOperatingSystemProgramData"]
  UOperatingSystemProgramData <|-- UOperatingSystemVideoPlayerProgramData

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemVideoPlayerProgramData["UOperatingSystemVideoPlayerProgramData"]
  class FOperatingSystemVideoPlayerConfig["FOperatingSystemVideoPlayerConfig"]
  UOperatingSystemVideoPlayerProgramData *-- FOperatingSystemVideoPlayerConfig
  class UOperatingSystemVideoPlayerSettings["UOperatingSystemVideoPlayerSettings"]
  UOperatingSystemVideoPlayerProgramData *-- UOperatingSystemVideoPlayerSettings

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemVideoPlayerProgramData {
    +UOperatingSystemVideoPlayerProgramData()
    +OnCreate() override
    +OnOpenFile(UOperatingSystemFile *OpenedFile)
    +SetLoopVideo(const bool bNewLoop)
    +K2_OnOpenFile(UOperatingSystemFile *OpenedFile)
    +CurrentSettings : FOperatingSystemVideoPlayerConfig()
    +VideoPlayerSettings : TWeakObjectPtr< UOperatingSystemVideoPla
    +bHasBlueprintOnOpenFile : uint8
  }

UOperatingSystemVideoPlayerProgramData is an abstract class that represents the program data for a video player program in the operating system.

This class inherits from UOperatingSystemProgramData and provides additional functionality specific to video players.

Public Methods

Return	Name	Description
	UOperatingSystemVideoPlayerProgramData
void	OnCreate virtual override	Called when the video player program data is created.
void	OnOpenFile	This function is called when a file is opened in the video player program. This function checks if there is a blueprint implementation of the OnOpenFile event. If there is a blueprint implementation, it calls the K2_OnOpenFile event and passes the opened file object as a parameter.
void	SetLoopVideo	Set to loop or not the video playback.

---

UOperatingSystemVideoPlayerProgramData

UOperatingSystemVideoPlayerProgramData()

Defined in OperatingSystemVideoPlayerProgramData.h:39

References

• CHECK_IN_BP
• IMPLEMENTED_IN_BP_LAMBDA
• OnOpenFile

---

OnCreate

virtual override

virtual void OnCreate() override

Defined in OperatingSystemVideoPlayerProgramData.h:52 Called when the video player program data is created.

This function is responsible for initializing the video player program data. It is called when the program data is created and performs the following tasks:

• Calls the OnCreate function of the base class UOperatingSystemProgramData to perform any necessary initialization.

• Retrieves the video player settings from the parent program.

• Checks if the retrieved video player settings are valid. If not, it logs a warning message.

See also: UOperatingSystemVideoPlayerSettings

References

• OS_LOG_WARN
• ParentProgram
• VideoPlayerSettings

Reimplements

• OnCreate

---

OnOpenFile

void OnOpenFile(UOperatingSystemFile * OpenedFile)

Defined in OperatingSystemVideoPlayerProgramData.h:62 This function is called when a file is opened in the video player program. This function checks if there is a blueprint implementation of the OnOpenFile event. If there is a blueprint implementation, it calls the K2_OnOpenFile event and passes the opened file object as a parameter.

Parameters

• OpenedFile A pointer to the UOperatingSystemFile object representing the opened file.

See also: UOperatingSystemVideoPlayerProgramData::K2_OnOpenFile

Referenced by

• UOperatingSystemVideoPlayerProgramData

References

• bHasBlueprintOnOpenFile
• K2_OnOpenFile

---

SetLoopVideo

void SetLoopVideo(const bool bNewLoop)

Defined in OperatingSystemVideoPlayerProgramData.h:70 Set to loop or not the video playback.

Parameters

• bNewLoop True to loop the video.

References

• bLoopVideo
• CurrentSettings

Protected Methods

Return	Name	Description
void	K2_OnOpenFile	Called when a file is opened in the video player program.

---

K2_OnOpenFile

void K2_OnOpenFile(UOperatingSystemFile * OpenedFile)

Defined in OperatingSystemVideoPlayerProgramData.h:84 Called when a file is opened in the video player program.

This function checks if there is a blueprint implementation of the OnOpenFile event. If there is a blueprint implementation, it calls the K2_OnOpenFile event and passes the opened file object as a parameter.

Parameters

• OpenedFile A pointer to the UOperatingSystemFile object representing the opened file.

See also: UOperatingSystemVideoPlayerProgramData::K2_OnOpenFile

Referenced by

• OnOpenFile

Private Attributes

Return	Name	Description
FOperatingSystemVideoPlayerConfig	CurrentSettings	Current settings for the video player.
TWeakObjectPtr< UOperatingSystemVideoPlayerSettings >	VideoPlayerSettings	Represents the settings for a video player. It is a weak reference to an instance of the class UOperatingSystemVideoPlayerSettings. It is used in the class UOperatingSystemVideoPlayerProgramData to store and access the current settings for the video player program. The UOperatingSystemVideoPlayerSettings class provides additional functionality specific to video players.
uint8	bHasBlueprintOnOpenFile

---

CurrentSettings

FOperatingSystemVideoPlayerConfig CurrentSettings

Defined in OperatingSystemVideoPlayerProgramData.h:24 Current settings for the video player.

Referenced by

• SetLoopVideo

---

VideoPlayerSettings

TWeakObjectPtr< UOperatingSystemVideoPlayerSettings > VideoPlayerSettings

Defined in OperatingSystemVideoPlayerProgramData.h:33 Represents the settings for a video player. It is a weak reference to an instance of the class UOperatingSystemVideoPlayerSettings. It is used in the class UOperatingSystemVideoPlayerProgramData to store and access the current settings for the video player program. The UOperatingSystemVideoPlayerSettings class provides additional functionality specific to video players.

See also: UOperatingSystemVideoPlayerProgramData

Referenced by

• OnCreate

---

bHasBlueprintOnOpenFile

uint8 bHasBlueprintOnOpenFile

Defined in OperatingSystemVideoPlayerProgramData.h:35

Referenced by

• OnOpenFile