Skip to content
YetiTech Studios

UOperatingSystemVideoPlayer

#include <OperatingSystemSimulator/Public/Programs/VideoPlayer/OperatingSystemVideoPlayer.h>
class UOperatingSystemVideoPlayer

Defined in OperatingSystemVideoPlayer.h:16

Inherits: UOperatingSystemBaseProgram

Inheritance diagram

Section titled “Inheritance diagram”
---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemVideoPlayer["UOperatingSystemVideoPlayer"]
  class UOperatingSystemBaseProgram["UOperatingSystemBaseProgram"]
  UOperatingSystemBaseProgram <|-- UOperatingSystemVideoPlayer

Class detail

Section titled “Class detail”
---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemVideoPlayer {
    +UOperatingSystemVideoPlayer()
    +OnOpenFile(UOperatingSystemFile *TargetFile, FGenericE void()
    +OnClose(FGenericError &OutError) override void()
  }

A class for representing a video player program in the operating system.

This class derives from UOperatingSystemBaseProgram and provides functionality for opening video files and closing the program.

Public Methods

Section titled “Public Methods”
ReturnNameDescription
UOperatingSystemVideoPlayer

UOperatingSystemVideoPlayer

Section titled “UOperatingSystemVideoPlayer”
UOperatingSystemVideoPlayer()

Defined in OperatingSystemVideoPlayer.h:22

References
Section titled “References”

Protected Methods

Section titled “Protected Methods”
ReturnNameDescription
voidOnOpenFile virtual overrideMethod for opening a file in the video player program.
voidOnClose virtual overrideMethod for handling the closing of the video player program.

OnOpenFile

Section titled “OnOpenFile”

virtual override

virtual void OnOpenFile(UOperatingSystemFile * TargetFile, FGenericError & OutError) override

Defined in OperatingSystemVideoPlayer.h:39 Method for opening a file in the video player program.

This method is called when a user selects a file to open in the video player program. It takes a pointer to the target file to be opened and an FGenericError object as input. The method calls the OnOpenFile method of the UOperatingSystemVideoPlayerProgramData class to handle the file opening logic. It modifies the OutError object if any error occurs during the file opening process.

DO NOT call this function directly. Use UOperatingSystemStatics::OpenFile function instead.

Parameters

Section titled “Parameters”

  • TargetFile A pointer to the UOperatingSystemFile object representing the file to be opened.

  • OutError An FGenericError object that will store any error information.

References
Section titled “References”
Reimplements
Section titled “Reimplements”

OnClose

Section titled “OnClose”

virtual override

virtual void OnClose(FGenericError & OutError) override

Defined in OperatingSystemVideoPlayer.h:52 Method for handling the closing of the video player program.

This method is called when the user wants to close the video player program. It stops the media audio in the device actor associated with the parent device. It modifies the OutError object if any error occurs during the closing process.

DO NOT call this function directly. Close the program instead to automatically close the file.

Parameters

Section titled “Parameters”
  • OutError An FGenericError object that will store any error information.
References
Section titled “References”
Reimplements
Section titled “Reimplements”