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