Navigation
API > API/Plugins > API/Plugins/ElectraPlayerRuntime
| Name | ISimpleElectraAudioPlayer |
| Type | class |
| Header File | /Engine/Plugins/Media/ElectraPlayer/Source/ElectraPlayerRuntime/Public/SimpleElectraAudioPlayer.h |
| Include Path | #include "SimpleElectraAudioPlayer.h" |
Syntax
class ISimpleElectraAudioPlayer
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISimpleElectraAudioPlayer() |
SimpleElectraAudioPlayer.h |
Structs
| Name | Remarks |
|---|---|
| FCreateParams | |
| FDefaultSampleInfo | |
| FStreamFormat |
Interfaces
| Name | Remarks |
|---|---|
| ICacheElementBase |
Enums
Public
| Name | Remarks |
|---|---|
| ISimpleElectraAudioPlayer | Negative return values indicating reason for having no samples in GetNextSamples() |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetBinaryMetadata
(
TSharedPtr< TArray< uint8 >, ESPMode::ThreadSafe >& OutMetadata |
SimpleElectraAudioPlayer.h | ||
FTimespan GetDuration() |
SimpleElectraAudioPlayer.h | ||
FString GetError() |
SimpleElectraAudioPlayer.h | ||
int64 GetNextSamples
(
FTimespan& OutPTS, |
SimpleElectraAudioPlayer.h | ||
FTimespan GetPlayPosition() |
SimpleElectraAudioPlayer.h | ||
bool GetStreamFormat
(
FStreamFormat& OutFormat |
SimpleElectraAudioPlayer.h | ||
bool HasEnded() |
SimpleElectraAudioPlayer.h | ||
bool HasErrored() |
SimpleElectraAudioPlayer.h | ||
bool HaveMetadata() |
State functions | SimpleElectraAudioPlayer.h | |
bool IsBuffering() |
SimpleElectraAudioPlayer.h | ||
bool IsPaused() |
SimpleElectraAudioPlayer.h | ||
bool IsPlaying() |
SimpleElectraAudioPlayer.h | ||
bool IsSeeking() |
SimpleElectraAudioPlayer.h | ||
bool Open
(
const TMap< FString, FVariant >& InOptions, |
SimpleElectraAudioPlayer.h | ||
void Pause() |
SimpleElectraAudioPlayer.h | ||
void PrepareToLoopToBeginning() |
SimpleElectraAudioPlayer.h | ||
void Resume() |
SimpleElectraAudioPlayer.h | ||
void SeekTo
(
const FTimespan& NewPosition |
SimpleElectraAudioPlayer.h | ||
void SetBitrateCeiling
(
int32 HighestSelectableBitrate |
Sets the highest bitrate when selecting a candidate stream. | SimpleElectraAudioPlayer.h | |
void Stop() |
SimpleElectraAudioPlayer.h |
Protected
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void CloseAndDestroy
(
ISimpleElectraAudioPlayer* InInstance |
SimpleElectraAudioPlayer.h | ||
static ISimpleElectraAudioPlayer * Create
(
const FCreateParams& InCreateParams |
SimpleElectraAudioPlayer.h | ||
static TSharedPtr< ICacheElementBase, ESPMode::ThreadSafe > GetCustomCacheElement
(
const FString& InForURL |
SimpleElectraAudioPlayer.h | ||
static void SendAnalyticMetrics
(
const TSharedPtr< IAnalyticsProviderET >& InAnalyticsProvider |
Delivers the aggregated metrics to the analytics provider and clears the internal list. | SimpleElectraAudioPlayer.h | |
static void SetCustomCacheElement
(
const FString& InForURL, |
SimpleElectraAudioPlayer.h |