Direct Camera for Unreal
Direct Camera Unreal docs
Loading...
Searching...
No Matches
FDirectCameraMediaPlayer Class Reference

#include <DirectCameraMediaPlayer.h>

Public Member Functions

 FDirectCameraMediaPlayer (IMediaEventSink &InEventSink)
virtual ~FDirectCameraMediaPlayer ()
virtual void OnImageAvailable (DirectCameraImage image)
virtual void Close () override
virtual bool Open (const FString &Url, const IMediaOptions *Options) override
virtual void TickInput (FTimespan DeltaTime, FTimespan Timecode) override
virtual FGuid GetPlayerPluginGUID () const override
virtual IMediaSamples & GetSamples () override
virtual FTimespan GetDuration () const override
virtual FTimespan GetTime () const override
bool GetPlayerFeatureFlag (EFeatureFlag flag) const
virtual bool IsLooping () const override
virtual bool SetLooping (bool Looping) override
virtual bool GetAudioTrackFormat (int32 TrackIndex, int32 FormatIndex, FMediaAudioTrackFormat &OutFormat) const
virtual bool Open (const TSharedRef< FArchive, ESPMode::ThreadSafe > &Archive, const FString &OriginalUrl, const IMediaOptions *Options)
virtual FString GetUrl () const override
virtual IMediaTracks & GetTracks ()
virtual IMediaView & GetView () override
virtual IMediaControls & GetControls () override
virtual FString GetTrackName (EMediaTrackType TrackType, int32 TrackIndex) const override
virtual FString GetStats () const override
virtual FString GetInfo () const override
virtual IMediaCache & GetCache ()
virtual bool Seek (const FTimespan &Time) override
virtual bool SetRate (float Rate) override
virtual bool CanControl (EMediaControl Control) const override
virtual TRangeSet< float > GetSupportedRates (EMediaRateThinning Thinning) const override
virtual EMediaStatus GetStatus () const override
virtual EMediaState GetState () const override
virtual float GetRate () const override
virtual int32 GetNumTracks (EMediaTrackType TrackType) const override
virtual int32 GetSelectedTrack (EMediaTrackType TrackType) const override
virtual int32 GetNumTrackFormats (EMediaTrackType TrackType, int32 TrackIndex) const override
virtual bool GetVideoTrackFormat (int32 TrackIndex, int32 FormatIndex, FMediaVideoTrackFormat &OutFormat) const override
virtual bool SetVideoTrackFrameRate (int32 TrackIndex, int32 FormatIndex, float FrameRate) override
virtual FText GetTrackDisplayName (EMediaTrackType TrackType, int32 TrackIndex) const override
virtual int32 GetTrackFormat (EMediaTrackType TrackType, int32 TrackIndex) const override
virtual FString GetTrackLanguage (EMediaTrackType TrackType, int32 TrackIndex) const override
virtual bool SelectTrack (EMediaTrackType TrackType, int32 TrackIndex) override
virtual bool SetTrackFormat (EMediaTrackType TrackType, int32 TrackIndex, int32 FormatIndex) override
virtual bool GetCameraSettings (DirectCameraCaptureSettings *settings)
virtual bool SetCameraSettings (const DirectCameraCaptureSettings *settings)
UDirectCameraFrameBuffer * CreateCaptureFrameBuffer (DirectCameraFrameType frameType, int width, int height)
bool CaptureFrame (UDirectCameraFrameBuffer *FrameBuffer, const DirectCameraCaptureSettings *OverrideSettings)
bool StopCapturing (UDirectCameraFrameBuffer *FrameBuffer)
bool DestroyCaptureRequest (int32 CaptureID)

Static Public Attributes

static constexpr FGuid PlayerGUID = FGuid(0xBBDCAB12, 0x3C454793, 0x87D86464, 0x990F3CA5)

Detailed Description

This class implements the media player interface for DirectCamera on Android, so you can use it with the Unreal media framework. You can open a camera on an Unreal Media Player object either by using a URL like directcamera://t=back&w=1920&h=1080&fps=30 or by using UCameraCaptureSettingsLibrary::OpenDirectCamera, which is exposed in blueprints as Open Direct Camera.

You should never need to create or use this class directly, unless you are reimplementing media handling things done by Unreal for some reason.

Constructor & Destructor Documentation

◆ FDirectCameraMediaPlayer()

FDirectCameraMediaPlayer::FDirectCameraMediaPlayer ( IMediaEventSink & InEventSink)

◆ ~FDirectCameraMediaPlayer()

FDirectCameraMediaPlayer::~FDirectCameraMediaPlayer ( )
virtual

Member Function Documentation

◆ CanControl()

bool FDirectCameraMediaPlayer::CanControl ( EMediaControl Control) const
overridevirtual

◆ CaptureFrame()

bool FDirectCameraMediaPlayer::CaptureFrame ( UDirectCameraFrameBuffer * FrameBuffer,
const DirectCameraCaptureSettings * OverrideSettings )

◆ Close()

void FDirectCameraMediaPlayer::Close ( )
overridevirtual

◆ CreateCaptureFrameBuffer()

UDirectCameraFrameBuffer * FDirectCameraMediaPlayer::CreateCaptureFrameBuffer ( DirectCameraFrameType frameType,
int width,
int height )

◆ DestroyCaptureRequest()

bool FDirectCameraMediaPlayer::DestroyCaptureRequest ( int32 CaptureID)

◆ GetAudioTrackFormat()

virtual bool FDirectCameraMediaPlayer::GetAudioTrackFormat ( int32 TrackIndex,
int32 FormatIndex,
FMediaAudioTrackFormat & OutFormat ) const
inlinevirtual

◆ GetCache()

virtual IMediaCache & FDirectCameraMediaPlayer::GetCache ( )
inlinevirtual

◆ GetCameraSettings()

virtual bool FDirectCameraMediaPlayer::GetCameraSettings ( DirectCameraCaptureSettings * settings)
inlinevirtual

◆ GetControls()

virtual IMediaControls & FDirectCameraMediaPlayer::GetControls ( )
inlineoverridevirtual

◆ GetDuration()

virtual FTimespan FDirectCameraMediaPlayer::GetDuration ( ) const
inlineoverridevirtual

◆ GetInfo()

virtual FString FDirectCameraMediaPlayer::GetInfo ( ) const
inlineoverridevirtual

◆ GetNumTrackFormats()

int32 FDirectCameraMediaPlayer::GetNumTrackFormats ( EMediaTrackType TrackType,
int32 TrackIndex ) const
overridevirtual

◆ GetNumTracks()

int32 FDirectCameraMediaPlayer::GetNumTracks ( EMediaTrackType TrackType) const
overridevirtual

◆ GetPlayerFeatureFlag()

bool FDirectCameraMediaPlayer::GetPlayerFeatureFlag ( EFeatureFlag flag) const
inline

◆ GetPlayerPluginGUID()

FGuid FDirectCameraMediaPlayer::GetPlayerPluginGUID ( ) const
overridevirtual

◆ GetRate()

virtual float FDirectCameraMediaPlayer::GetRate ( ) const
inlineoverridevirtual

◆ GetSamples()

IMediaSamples & FDirectCameraMediaPlayer::GetSamples ( )
overridevirtual

◆ GetSelectedTrack()

int32 FDirectCameraMediaPlayer::GetSelectedTrack ( EMediaTrackType TrackType) const
overridevirtual

◆ GetState()

virtual EMediaState FDirectCameraMediaPlayer::GetState ( ) const
inlineoverridevirtual

◆ GetStats()

virtual FString FDirectCameraMediaPlayer::GetStats ( ) const
inlineoverridevirtual

◆ GetStatus()

virtual EMediaStatus FDirectCameraMediaPlayer::GetStatus ( ) const
inlineoverridevirtual

◆ GetSupportedRates()

virtual TRangeSet< float > FDirectCameraMediaPlayer::GetSupportedRates ( EMediaRateThinning Thinning) const
inlineoverridevirtual

◆ GetTime()

virtual FTimespan FDirectCameraMediaPlayer::GetTime ( ) const
inlineoverridevirtual

◆ GetTrackDisplayName()

virtual FText FDirectCameraMediaPlayer::GetTrackDisplayName ( EMediaTrackType TrackType,
int32 TrackIndex ) const
inlineoverridevirtual

◆ GetTrackFormat()

int32 FDirectCameraMediaPlayer::GetTrackFormat ( EMediaTrackType TrackType,
int32 TrackIndex ) const
overridevirtual

◆ GetTrackLanguage()

virtual FString FDirectCameraMediaPlayer::GetTrackLanguage ( EMediaTrackType TrackType,
int32 TrackIndex ) const
inlineoverridevirtual

◆ GetTrackName()

virtual FString FDirectCameraMediaPlayer::GetTrackName ( EMediaTrackType TrackType,
int32 TrackIndex ) const
inlineoverridevirtual

◆ GetTracks()

virtual IMediaTracks & FDirectCameraMediaPlayer::GetTracks ( )
inlinevirtual

◆ GetUrl()

virtual FString FDirectCameraMediaPlayer::GetUrl ( ) const
inlineoverridevirtual

◆ GetVideoTrackFormat()

bool FDirectCameraMediaPlayer::GetVideoTrackFormat ( int32 TrackIndex,
int32 FormatIndex,
FMediaVideoTrackFormat & OutFormat ) const
overridevirtual

◆ GetView()

virtual IMediaView & FDirectCameraMediaPlayer::GetView ( )
inlineoverridevirtual

◆ IsLooping()

virtual bool FDirectCameraMediaPlayer::IsLooping ( ) const
inlineoverridevirtual

◆ OnImageAvailable()

void FDirectCameraMediaPlayer::OnImageAvailable ( DirectCameraImage image)
virtual

◆ Open() [1/2]

bool FDirectCameraMediaPlayer::Open ( const FString & Url,
const IMediaOptions * Options )
overridevirtual

◆ Open() [2/2]

virtual bool FDirectCameraMediaPlayer::Open ( const TSharedRef< FArchive, ESPMode::ThreadSafe > & Archive,
const FString & OriginalUrl,
const IMediaOptions * Options )
inlinevirtual

◆ Seek()

bool FDirectCameraMediaPlayer::Seek ( const FTimespan & Time)
overridevirtual

◆ SelectTrack()

bool FDirectCameraMediaPlayer::SelectTrack ( EMediaTrackType TrackType,
int32 TrackIndex )
overridevirtual

◆ SetCameraSettings()

virtual bool FDirectCameraMediaPlayer::SetCameraSettings ( const DirectCameraCaptureSettings * settings)
inlinevirtual

◆ SetLooping()

virtual bool FDirectCameraMediaPlayer::SetLooping ( bool Looping)
inlineoverridevirtual

◆ SetRate()

bool FDirectCameraMediaPlayer::SetRate ( float Rate)
overridevirtual

◆ SetTrackFormat()

bool FDirectCameraMediaPlayer::SetTrackFormat ( EMediaTrackType TrackType,
int32 TrackIndex,
int32 FormatIndex )
overridevirtual

◆ SetVideoTrackFrameRate()

bool FDirectCameraMediaPlayer::SetVideoTrackFrameRate ( int32 TrackIndex,
int32 FormatIndex,
float FrameRate )
overridevirtual

◆ StopCapturing()

bool FDirectCameraMediaPlayer::StopCapturing ( UDirectCameraFrameBuffer * FrameBuffer)

◆ TickInput()

void FDirectCameraMediaPlayer::TickInput ( FTimespan DeltaTime,
FTimespan Timecode )
overridevirtual

Member Data Documentation

◆ PlayerGUID

FGuid FDirectCameraMediaPlayer::PlayerGUID = FGuid(0xBBDCAB12, 0x3C454793, 0x87D86464, 0x990F3CA5)
staticconstexpr
The documentation for this class was generated from the following files: