description: Decodes XX escaped sequences into their original characters. Appends to the output. Hence in and out must not be the same.

code: static bool UrlDecode ( [FString](API\Runtime\Core\Containers\FString) & OutResult, const [FString](API\Runtime\Core\Containers\FString) & InUrlToDecode )


description: Encodes characters not permitted in a URL into XX escaped sequences. Appends to the output. Hence in and out must not be the same. A list of characters that should NOT be escaped, even if they normally would, can be passed. These characters must be strictly ASCII characters only. This is useful to prevent '/' path delimiters to be escaped if the string to be encoded represents a path.

module: ElectraBase

code: static bool UrlEncode ( [FString](API\Runtime\Core\Containers\FString) & OutResult, const [FString](API\Runtime\Core\Containers\FString) & InUrlToEncode, const [FString](API\Runtime\Core\Containers\FString) & InCharsToKeep )


module: ElectraCDM

code: [EResult](API\Plugins\ElectraCDM\Crypto\IStreamDecrypterAES128\EResult) CBCDecryptInPlace ( int32 & OutNumBytes, uint8 * InOutData, int32 NumBytes16, bool bIsFinalBlock )


code: [EResult](API\Plugins\ElectraCDM\Crypto\IStreamDecrypterAES128\EResult) CBCEncryptInPlace ( int32 & OutNumBytes, uint8 * InOutData, int32 NumBytes, bool bIsFinalData )


code: int32 CBCGetEncryptionDataSize ( int32 PlaintextSize )


code: [EResult](API\Plugins\ElectraCDM\Crypto\IStreamDecrypterAES128\EResult) CBCInit ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Key, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > * OptionalIV )


code: [EResult](API\Plugins\ElectraCDM\Crypto\IStreamDecrypterAES128\EResult) CTRDecryptInPlace ( uint8 * InOutData, int32 InNumBytes )


code: static [EResult](API\Plugins\ElectraCDM\Crypto\IStreamDecrypterAES128\EResult) ConvHexStringToBin ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutBinData, const char * InHexString )


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IStreamDecrypterAES128](API\Plugins\ElectraCDM\Crypto\IStreamDecrypterAES128), ESPMode::ThreadSafe > Create()


code: [EResult](API\Plugins\ElectraCDM\Crypto\IStreamDecrypterAES128\EResult) CTRInit ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Key )


code: [EResult](API\Plugins\ElectraCDM\Crypto\IStreamDecrypterAES128\EResult) CTRSetIV ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & IV )


code: [EResult](API\Plugins\ElectraCDM\Crypto\IStreamDecrypterAES128\EResult) CTRSetKey ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Key )


code: static const TCHAR * GetResultText ( [EResult](API\Plugins\ElectraCDM\Crypto\IStreamDecrypterAES128\EResult) ResultCode )


className: EResult

code: enum EResult { Ok, NotInitialized, BadKeyLength, BadIVLength, BadDataLength, InvalidArg, BadHexChar, }


code: static void MakePaddedIVFromUInt64 ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutBinData, uint64 lower64Bits )


code: virtual ~IStreamDecrypterAES128()


code: namespace ElectraCDM { enum ECDMError { Success, Failure, NotSupported, CipherModeMismatch, } }


code: namespace ElectraCDM { enum ECDMState { Idle, WaitingForKey, Ready, InvalidKey, KeyExpired, ConfigurationError, } }


className: FCryptSkipPattern

code: struct FCryptSkipPattern


className: FMediaCDMSampleInfo

code: struct FMediaCDMSampleInfo

DefaultKID

type: TArray< uint8 >

KIDs

type: TArray<TArray<...

Pattern

type: FCryptSkipPatte...

SubSamples

type: TArray<FSubSam...


className: IElectraCDMModule

description: Interface for the `ElectraCDM_ module.

code: class IElectraCDMModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Create a single client from all the given candidates. Candidates are those whose capabilities said they are able to decrypt a particular stream. The object of this method is to settle on one CDM system (in case several claimed capability to decrypt). Returns Success or Failure if different types of streams would be using a different type of CDM.

code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) CreateDRMClient ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaCDMClient](API\Plugins\ElectraCDM\IMediaCDMClient), ESPMode::ThreadSafe > & OutClient, [IPlayerSession](API\Plugins\ElectraCDM\IMediaCDM\IPlayerSession) * InForPlayerSession, const [TArray](API\Runtime\Core\Containers\TArray)< [FCDMCandidate](API\Plugins\ElectraCDM\IMediaCDM\FCDMCandidate) > & InCandidates )


className: FCDMCandidate

code: struct FCDMCandidate

AdditionalElements

type: FString

DefaultKIDs

type: TArray<FString...


code: static [IMediaCDM](API\Plugins\ElectraCDM\IMediaCDM) & Get()


description: Obtains the CDM system's preference on how attributes and text properties should be prefixed in the JSON string passed to GetCDMCapabilitiesForScheme(..., InAdditionalElements) or in theFCDMCandidate.AdditionalElements.

code: void GetCDMCustomJSONPrefixes ( const [FString](API\Runtime\Core\Containers\FString) & InCDMScheme, const [FString](API\Runtime\Core\Containers\FString) & InValue, [FString](API\Runtime\Core\Containers\FString) & OutAttributePrefix, [FString](API\Runtime\Core\Containers\FString) & OutTextPropertyName, bool & bOutNoNamespaces )


description: Returns an interface to a CDM system's capabilities. The system is identified through its unique scheme id (a UUID). If there is no CDM system for the given scheme a nullptr is returned.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaCDMCapabilities](API\Plugins\ElectraCDM\IMediaCDMCapabilities), ESPMode::ThreadSafe > GetCDMCapabilitiesForScheme ( const [FString](API\Runtime\Core\Containers\FString) & InCDMScheme, const [FString](API\Runtime\Core\Containers\FString) & InValue, const [FString](API\Runtime\Core\Containers\FString) & InAdditionalElements )


description: State


className: IPlayerSession

code: struct IPlayerSession


description: CDM registration

code: void RegisterCDM ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IMediaCDMSystem](API\Plugins\ElectraCDM\IMediaCDMSystem), ESPMode::ThreadSafe > InCDMSystem )


description: Releases the specified player session and its associated keys.

code: void ReleasePlayerSessionID ( [IPlayerSession](API\Plugins\ElectraCDM\IMediaCDM\IPlayerSession) * InPlayerSessionToRelease )


description: Releases all license keys associated by the specified session. Must be called before callingReleasePlayerSessionID().

code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) ReleasePlayerSessionKeys ( [IPlayerSession](API\Plugins\ElectraCDM\IMediaCDM\IPlayerSession) * InPlayerSession )


className: ESupportResult

code: enum ESupportResult { Supported, NotSupported, CodecRequired, FeatureRequired, BadMIMEType, SecureDecoderRequired, SecureDecoderNotRequired, }


description: Returns if a secure decoder is required for the specified media type. This SHOULD be able to return the proper answer WITHOUT having acquired a license since this is may be used to select/deselect streams upfront.

code: [ESupportResult](API\Plugins\ElectraCDM\IMediaCDMCapabilities\ESupportResult) RequiresSecureDecoder ( const [FString](API\Runtime\Core\Containers\FString) & InMimeType )


description: Returns if a specified cipher (eg. "cenc" or "cbcs") is supported by this CDM.

code: [ESupportResult](API\Plugins\ElectraCDM\IMediaCDMCapabilities\ESupportResult) SupportsCipher ( const [FString](API\Runtime\Core\Containers\FString) & InCipherType )


description: Returns if a specified media type is supported by this CDM.

code: [ESupportResult](API\Plugins\ElectraCDM\IMediaCDMCapabilities\ESupportResult) SupportsType ( const [FString](API\Runtime\Core\Containers\FString) & InMimeType )


code: virtual ~IMediaCDMCapabilities()


className: IMediaCDMCapabilities

code: class IMediaCDMCapabilities


description: Creates a decrypter for the specified MIME type.

code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) CreateDecrypter ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaCDMDecrypter](API\Plugins\ElectraCDM\IMediaCDMDecrypter), ESPMode::ThreadSafe > & OutDecrypter, const [FString](API\Runtime\Core\Containers\FString) & InMimeType )


className: EDRMClientFlags

code: enum EDRMClientFlags { EDRMFlg_None = 0, EDRMFlg_AllowCustomKeyStorage = 1U << 31, }


description: Returns the data to send to the license server as well as the HTTP method and additional HTTP headers.

code: void GetLicenseKeyRequestData ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutKeyRequestData, [FString](API\Runtime\Core\Containers\FString) & OutHttpMethod, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutHttpHeaders, uint32 & OutFlags )


description: Returns the URL to the license server, either from configuration data or the overrride.

code: void GetLicenseKeyURL ( [FString](API\Runtime\Core\Containers\FString) & OutLicenseURL )


description: Prepares the client for license acquisition based on the configuration passed inIMediaCDM::CreateDRMClient()

code: void PrepareLicenses()


description: Registers an application event listener to receive OnCDMEvent() messages.

code: void RegisterEventListener ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IMediaCDMEventListener](API\Plugins\ElectraCDM\IMediaCDMEventListener), ESPMode::ThreadSafe > InEventListener )


description: Sets the license server's response data. This will, if successful, also update any already existing decrypters with the keys. The EventId must be the one received in OnCDMEvent().

code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) SetLicenseKeyResponseData ( void * InEventId, int32 HttpResponseCode, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InKeyResponseData )


description: Overrides the URL to the license server that may have been set in the initial configuration data.

code: void SetLicenseServerURL ( const [FString](API\Runtime\Core\Containers\FString) & InLicenseServerURL )


description: Unregisters a previously registered event listener.

code: void UnregisterEventListener ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IMediaCDMEventListener](API\Plugins\ElectraCDM\IMediaCDMEventListener), ESPMode::ThreadSafe > InEventListener )


className: IMediaCDMClient

description: CDM client This interfaces the application with the CDM system. An application can use multiple clients if necessary.

code: class IMediaCDMClient


code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) BlockStreamDecryptEnd ( IStreamDecryptHandle * InStreamDecryptContext )


code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) BlockStreamDecryptInPlace ( IStreamDecryptHandle * InOutStreamDecryptContext, int32 & OutNumBytesDecrypted, uint8 * InOutData, int32 InNumDataBytes, const [FMediaCDMSampleInfo](API\Plugins\ElectraCDM\FMediaCDMSampleInfo) & InSampleInfo, bool bIsLastBlock )


code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) BlockStreamDecryptStart ( IStreamDecryptHandle *& OutStreamDecryptContext )


description: Decrypt a non-block oriented cipher (eg. AES 128 CTR) in place.

code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) DecryptInPlace ( uint8 * InOutData, int32 InNumDataBytes, const [FMediaCDMSampleInfo](API\Plugins\ElectraCDM\FMediaCDMSampleInfo) & InSampleInfo )


description: State


description: Decryption

code: bool IsBlockStreamDecrypter()


description: Reinitializes the decrypter to its starting state. This should not normally be called unless an error occurred.

code: void Reinitialize()


description: Update from a URL and additional scheme specific elements.

code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) UpdateFromURL ( const [FString](API\Runtime\Core\Containers\FString) & InURL, const [FString](API\Runtime\Core\Containers\FString) & InAdditionalElements )


code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) UpdateInitDataFromMultiplePSSH ( const [TArray](API\Runtime\Core\Containers\TArray)< [TArray](API\Runtime\Core\Containers\TArray)< uint8 >> & InPSSHData )


description: Update from PSSH boxes encountered in the stream.

code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) UpdateInitDataFromPSSH ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InPSSHData )


className: IMediaCDMDecrypter

description: Decrypter instance.

code: class IMediaCDMDecrypter


className: ECDMEventType

code: enum ECDMEventType { ProvisionRequired, KeyRequired, KeyExpired, }


description: An event triggered by a CDM system that needs to be processed by the applicate. Please note that the InDrmClient may be an intermediate client your application did NOT create! Do not perform checks on the client pointer. Also do not use this client to perform any operation other than to return the requested data, if the event is a data request. You have to return the opaque InEventId in the reply (see SetLicenseKeyResponseData()).

code: void OnCDMEvent ( [ECDMEventType](API\Plugins\ElectraCDM\IMediaCDMEventListener\ECDMEventType) InEventType, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ElectraCDM::IMediaCDMClient](API\Plugins\ElectraCDM\IMediaCDMClient), ESPMode::ThreadSafe > InDrmClient, void * InEventId, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InCustomData )


code: virtual ~IMediaCDMEventListener()


className: IMediaCDMEventListener

description: Event listener to be registered with a CDM client. This must be implemented by the application to be notified about the CDM client's needs that need to be satisfied, like performing license acquisition.

code: class IMediaCDMEventListener


code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) CreateDRMClient ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaCDMClient](API\Plugins\ElectraCDM\IMediaCDMClient), ESPMode::ThreadSafe > & OutClient, [IMediaCDM::IPlayerSession](API\Plugins\ElectraCDM\IMediaCDM\IPlayerSession) * InForPlayerSession, const [TArray](API\Runtime\Core\Containers\TArray)< [IMediaCDM::FCDMCandidate](API\Plugins\ElectraCDM\IMediaCDM\FCDMCandidate) > & InCandidates )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaCDMCapabilities](API\Plugins\ElectraCDM\IMediaCDMCapabilities), ESPMode::ThreadSafe > GetCDMCapabilities ( const [FString](API\Runtime\Core\Containers\FString) & InValue, const [FString](API\Runtime\Core\Containers\FString) & InAdditionalElements )


code: void GetCDMCustomJSONPrefixes ( [FString](API\Runtime\Core\Containers\FString) & OutAttributePrefix, [FString](API\Runtime\Core\Containers\FString) & OutTextPropertyName, bool & bOutNoNamespaces )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetSchemeIDs()


code: [ECDMError](API\Plugins\ElectraCDM\ElectraCDM__ECDMError) ReleasePlayerSessionKeys ( [IMediaCDM::IPlayerSession](API\Plugins\ElectraCDM\IMediaCDM\IPlayerSession) * PlayerSession )


className: IMediaCDMSystem

code: class IMediaCDMSystem


description: Called to create a decoder for the given format.

module: ElectraCodecFactory

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IElectraDecoder](API\Plugins\ElectraDecoders\IElectraDecoder), ESPMode::ThreadSafe > CreateDecoderForFormat ( const [FString](API\Runtime\Core\Containers\FString) & InCodecFormat, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FVariant](API\Runtime\Core\Misc\FVariant) > & InOptions, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IElectraDecoderResourceDelegate](API\Plugins\ElectraDecoders\IElectraDecoderResourceDelegate), ESPMode::ThreadSafe > InResourceDelegate )


description: Returns 0 if not supported. If supported the return value indicates a priority value. If multiple factories are registered that claim support for the format the one with the highest priority is chosen.

code: int32 SupportsFormat ( const [FString](API\Runtime\Core\Containers\FString) & InCodecFormat, bool bInEncoder, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FVariant](API\Runtime\Core\Misc\FVariant) > & InOptions ) const


code: virtual ~IElectraCodecFactory()


description: Populates the provided map with decoder configuration options (see IElectraDecoderFeature). Some required options must be available through the factory prior to creating a decoder instance.

code: void GetConfigurationOptions ( [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FVariant](API\Runtime\Core\Misc\FVariant) > & OutOptions ) const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IElectraCodecFactory](API\Plugins\ElectraCodecFactory\IElectraCodecFactory), ESPMode::ThreadSafe > GetBestFactoryForFormat ( const [FString](API\Runtime\Core\Containers\FString) & InCodecFormat, bool bInEncoder, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FVariant](API\Runtime\Core\Misc\FVariant) > & InOptions )


className: IElectraCodecFactory

code: class IElectraCodecFactory


code: virtual ~IElectraCodecFactoryModule()


className: IElectraCodecFactoryModule

description: Interface for the `ElectraCodecFactory_ module.

code: class IElectraCodecFactoryModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


code: void GetListOfFactories ( [TArray](API\Runtime\Core\Containers\TArray)< [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IElectraCodecFactory](API\Plugins\ElectraCodecFactory\IElectraCodecFactory), ESPMode::ThreadSafe >> & OutCodecFactories )


code: virtual ~IElectraCodecModularFeature()


className: IElectraCodecModularFeature

code: class IElectraCodecModularFeature : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


code: void AddCodecFactory ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IElectraCodecFactory](API\Plugins\ElectraCodecFactory\IElectraCodecFactory), ESPMode::ThreadSafe > InCodecFactory )


className: IElectraCodecRegistry

code: class IElectraCodecRegistry


className: EElectraDecoderFlags

module: ElectraDecoders

code: enum EElectraDecoderFlags { None = 0, IsSyncSample = 0x01, IsReplaySample = 0x02, IsLastReplaySample = 0x04, InitCSDOnly = 0x08, }


className: EElectraDecoderPlatformOutputHandleType

code: enum EElectraDecoderPlatformOutputHandleType { }


description: Advance a pointer by a number of bytes.

code: namespace ElectraDecodersUtil { template<typename T, typename C> T ElectraDecodersUtil::AdvancePointer ( T pPointer, C numBytes ) }


code: namespace ElectraDecodersUtil { template<typename T> T ElectraDecodersUtil::AbsoluteValue ( T Value ) }


code: namespace ElectraDecodersUtil { uint32 ElectraDecodersUtil::BitReverse32 ( uint32 InValue ) }


code: namespace ElectraDecodersUtil { template<typename T> T ElectraDecodersUtil::Max ( T a, T b ) }


code: namespace ElectraDecodersUtil { template<typename T> T ElectraDecodersUtil::Min ( T a, T b ) }


className: FElectraVideoDecoderOutputCropValues

Bottom

description: Number of rows at the bottom that must not be displayed.

Left

description: Number of columns at the left that must not be displayed.

Right

description: Number of columns at the right that must not be displayed.

Top

description: Number of rows at the top that must not be displayed.


code: virtual ~IElectraCodecRegistry()


className: FMimeTypeAudioCodecInfo

code: struct FMimeTypeAudioCodecInfo : public [ElectraDecodersUtil::FMimeTypeCodecInfo](API\Plugins\ElectraDecoders\FMimeTypeCodecInfo)


className: FMimeTypeCodecInfo

code: struct FMimeTypeCodecInfo


className: FMimeTypeVideoCodecInfo

code: struct FMimeTypeVideoCodecInfo : public [ElectraDecodersUtil::FMimeTypeCodecInfo](API\Plugins\ElectraDecoders\FMimeTypeCodecInfo)


description: Closes the decoder instance. This must be called prior to dropping the last reference of the decoder resulting in the call to its destructor. This may already close internally used resources. The decoder instance can no longer be used and all decoding and output related methods will return an error.

code: void Close()


description: The return value indicates the following:

code: [EDecoderError](API\Plugins\ElectraDecoders\IElectraDecoder\EDecoderError) DecodeAccessUnit ( const [FInputAccessUnit](API\Plugins\ElectraDecoders\IElectraDecoder\FInputAccessUnit) & InInputAccessUnit, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FVariant](API\Runtime\Core\Misc\FVariant) > & InAdditionalOptions )


className: ECSDCompatibility

code: enum ECSDCompatibility { Compatible, Drain, DrainAndReset, }


className: EDecoderError

code: enum EDecoderError { None, EndOfData, NoBuffer, LostDecoder, Error, }


className: EOutputStatus

code: enum EOutputStatus { Available, NeedInput, TryAgainLater, EndOfData, Error, }


className: EType

code: enum EType { None, Video, Audio, Subtitle, }


code: int32 GetCode&40;&41; const


code: const FString & GetMessage&40;&41; const


code: uint32 GetSdkCode&40;&41; const


code: FError & SetCode &40; int32 InCode &41;


code: FError & SetMessage &40; const FString & InMessage &41;


className: FInputAccessUnit

code: struct FInputAccessUnit

Data

type: const void *...

DTS

type: FTimespan

Flags

type: EElectraDecoder...


code: FError & SetSdkCode &40; uint32 InSdkCode &41;


description: If no output information can be provided a nullptr will be returned.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IElectraDecoderDefaultOutputFormat](API\Plugins\ElectraDecoders\IElectraDecoderDefaultOutputForm-), ESPMode::ThreadSafe > GetDefaultOutputFormatFromCSD ( const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FVariant](API\Runtime\Core\Misc\FVariant) > & CSDAndAdditionalOptions )


description: Returns the most recent error that you should retrieve when either method returns failure.


description: Populates the provided map with decoder features or required options. See IElectraDecoderFeature and IElectraDecoderOption. Not all decoders will provide the same features.

code: void GetFeatures ( [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FVariant](API\Runtime\Core\Misc\FVariant) > & OutFeatures ) const


description: NOTE: Ownership of the decoded output stays with the decoder. You may hold on to the returned pointer but it is recommended the output is processed immediately. If the output is not returned to the decoder (by resetting the pointer) it may be possible for the decoder to be unable to produce additional output.


className: FError

code: struct FError


description: Returns the type of this decoder instance. This is useful to ensure that the correct type was indeed created and you did not get a different type of decoder from the factory if the format was ambiguous.


description: When a change in decoder specific data is detected, call this method to determine if the decoder can just continue decoding with the new CSD or if it needs to be drained or drained first and then reset.

code: [ECSDCompatibility](API\Plugins\ElectraDecoders\IElectraDecoder\ECSDCompatibility) IsCompatibleWith ( const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FVariant](API\Runtime\Core\Misc\FVariant) > & CSDAndAdditionalOptions )


description: Tries to reset the decoder to a clean start state. If this fails and 'false' is returned the decoder must be destroyed and a new instance created.

code: bool ResetToCleanStart()


code: virtual ~IElectraDecoder()


className: IElectraDecoder

code: class IElectraDecoder : public [TSharedFromThis< IElectraDecoder, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


className: EChannelPosition

description: Channel position as per ISO/IEC 23001-8 Table 7.

code: enum EChannelPosition { Invalid = -1, L =0, R, C, LFE, Ls, Rs, Lc, Rc, Lsr, Rsr, Cs, Lsd, Rsd, Lss, Rss, Lw, Rw, Lv, Rv, Cv, Lvr, Rvr, Cvr, Lvss, Rvss, Ts, LFE2, Lb, Rb, Cb, Lvs, Rvs, Undefined = 128, Disabled = 255, Unspec0 = 256, Unspec1, Unspec2, Unspec3, Unspec4, Unspec5, Unspec6, Unspec7, Unspec8, Unspec9, Unspec10, Unspec11, Unspec12, Unspec13, Unspec14, Unspec15, Unspec16, Unspec17, Unspec18, Unspec19, Unspec20, Unspec21, Unspec22, Unspec23, Unspec24, Unspec25, Unspec26, Unspec27, Unspec28, Unspec29, Unspec30, Unspec31, }


className: ESampleFormat

code: enum ESampleFormat { Int16, Float, }


description: Returns the number of bytes per decoded sample. This typically corresponds to the size of the decoded format, ie 2 for Int16 and 4 for Float.

code: int32 GetBytesPerSample() const


description: Returns the number of bytes per decoded frame. For channel interleaved data this is typicallyGetNumChannels()*GetBytesPerSample()while per-channel data typically returns the same asGetBytesPerSample()

code: int32 GetBytesPerFrame() const


description: Returns the position of the decoded channel. If a position is not inferred or described by the format it is set toUndefined_. If a channel failed to decode it may be included asDisabled_ with the sample data set to silence.

code: [EChannelPosition](API\Plugins\ElectraDecoders\IElectraDecoderAudioOutput\EChannelPosition) GetChannelPosition ( int32 InChannelNumber ) const


description: Returns a pointer to the start of the decoded data for the specified channel. This can be used for interleaved data as well although you would normally ask for the data pointer of channel 0 to get the base address of the interleaved data.

code: const void * GetData ( int32 InChannelNumber ) const


description: Returns the number of decoded channels.

code: int32 GetNumChannels() const


description: Returns the number of decoded samples per channel.

code: int32 GetNumFrames() const


description: Returns the format of the decoded samples. The data pointers shall be cast to the appropriate type.


description: Returns the decoded sampling rate. This may be different from what was known about the input.

code: int32 GetSampleRate() const


code: virtual [EType](API\Plugins\ElectraDecoders\IElectraDecoderOutput\EType) GetType() const


description: If samples are interleaved they appear in memory alternatingly per channel. Eg. L,R,L,R,L,R,... If they are not interleaved there will be separate buffers containing samples of a single channel each.

code: bool IsInterleaved() const


className: IElectraDecoderAudioOutput

code: class IElectraDecoderAudioOutput : public [IElectraDecoderOutput](API\Plugins\ElectraDecoders\IElectraDecoderOutput)


code: virtual ~IElectraDecoderAudioOutput()


description: Returns the number of channels the format will decode into. This could be different than what is known by the container format. For instance, a mono HE-AACv2 stream may decode into stereo.


description: Returns the number of frames one input access unit will decode into. This could be different than what is known by the container format. For instance, a HE-AAC stream may decode into twice the sampling rate and thus twice the number of decoded frames if the decoder supports it.


description: Returns the sampling rate the format will decode into. This could be different than what is known by the container format. For instance, a HE-AAC stream may decode into twice the sampling rate if the decoder supports it.


className: IElectraDecoderDefaultAudioOutputFormat

code: class IElectraDecoderDefaultAudioOutputFormat : public [IElectraDecoderDefaultOutputFormat](API\Plugins\ElectraDecoders\IElectraDecoderDefaultOutputForm-)


className: IElectraDecoderDefaultOutputFormat


className: IElectraDecoderDefaultVideoOutputFormat

code: class IElectraDecoderDefaultVideoOutputFormat : public [IElectraDecoderDefaultOutputFormat](API\Plugins\ElectraDecoders\IElectraDecoderDefaultOutputForm-)


code: enum EType { None, Video, Audio, Subtitle, }


code: uint64 GetUserValue() const


code: virtual ~IElectraDecoderOutput()


className: IElectraDecoderResourceDelegate


code: virtual [IDecoderPlatformResource](API\Plugins\ElectraDecoders\IElectraDecoderResourceDelegateB-\IDecoderPlatform-) * CreatePlatformResource ( void * InOwnerHandle, [EDecoderPlatformResourceType](API\Plugins\ElectraDecoders\IElectraDecoderResourceDelegateB-\EDecoderPlatform-) InDecoderResourceType, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FVariant](API\Runtime\Core\Misc\FVariant) > InOptions )


className: EDecoderPlatformResourceType

code: enum EDecoderPlatformResourceType { Video, }


className: IDecoderPlatformResource

description: Interface class for a platform specific resource allocated when a decoder is created and released when it is destroyed.

code: class IDecoderPlatformResource


code: virtual void ReleasePlatformResource ( void * InOwnerHandle, [IDecoderPlatformResource](API\Plugins\ElectraDecoders\IElectraDecoderResourceDelegateB-\IDecoderPlatform-) * InHandleToDestroy )


className: IElectraDecoderOutput

code: class IElectraDecoderOutput


className: IElectraDecoderResourceDelegateBase


className: IElectraDecoderResourceDelegateNull

code: class IElectraDecoderResourceDelegateNull : public [IElectraDecoderResourceDelegateBase](API\Plugins\ElectraDecoders\IElectraDecoderResourceDelegateB-)


code: void RegisterDecodersWithCodecFactory ( [IElectraCodecRegistry](API\Plugins\ElectraCodecFactory\IElectraCodecRegistry) * InCodecFactoryToRegisterWith )


code: virtual ~IElectraDecodersModule()


className: IElectraDecodersModule

description: Interface for the `ElectraDecodersModule_ module.

code: class IElectraDecodersModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Asks to create a copy of the image into a platform specific structure. Parameters for the operation are provided by a platform specific implementation of IElectraDecoderVideoOutputCopyResources provided to this method through which relevant parameters (eg. a device or texture handle, etc.) can be obtained.

code: [EImageCopyResult](API\Plugins\ElectraDecoders\IElectraDecoderVideoOutput\EImageCopyResult) CopyPlatformImage ( IElectraDecoderVideoOutputCopyResources * InCopyResources ) const


className: EImageCopyResult

code: enum EImageCopyResult { Succeeded, Failed, NotSupported, }


description: Returns the aspect ratio h value.

code: int32 GetAspectRatioH() const


description: Returns the aspect ratio w value.

code: int32 GetAspectRatioW() const


description: Returns the cropping values. This is useful in combination withGetDecodedWidth()andGetDecodedHeight()that give you the number of pixels created by the decoder.


description: Returns the number of decoded vertical pixels. This value may be greater thanGetHeight()since it does not take any cropping values into account. Note that this represents the actual dimension of the data returned, which may differ fromGetWidth()+ cropping offsets! (e.g. if the data is returned as RGBA pixels, but represents a YUYV 4:2:2 format)

code: int32 GetDecodedHeight() const


description: Returns the number of decoded horizontal pixels. This value may be different fromGetWidth()since it does not take any cropping values into account. Note that this represents the actual dimension of the data returned, which may differ fromGetWidth()+ cropping offsets! (e.g. if the data is returned as RGBA pixels, but represents a YUYV 4:2:2 format)

code: int32 GetDecodedWidth() const


description: Returns additional values specific to the decoder and format that are used in handling this output in a platform specific way.

code: void GetExtraValues ( [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FVariant](API\Runtime\Core\Misc\FVariant) > & OutExtraValues ) const


description: Returns the denominator of the frame rate, if known. If unknown this returns 0.

code: int32 GetFrameRateDenominator() const


description: Returns the numerator of the frame rate, if known. If unknown this returns 0.

code: int32 GetFrameRateNumerator() const


description: Returns the number of bits. Usually 8, 10, or 12.

code: int32 GetNumberOfBits() const


description: Returns the active number of vertical pixels. This has potential cropping values applied and does not include any pitch requirements.

code: int32 GetHeight() const


description: Returns the platform specific decoder output handle, if any. This value is specific to the decoder being used.

code: void * GetPlatformOutputHandle ( [EElectraDecoderPlatformOutputHandleType](API\Plugins\ElectraDecoders\EElectraDecoderPlatformOutputHan-) InTypeOfHandle ) const


description: USAGE TBD


code: virtual [EType](API\Plugins\ElectraDecoders\IElectraDecoderOutput\EType) GetType() const


description: Returns the active number of horizontal pixels. This has potential cropping values applied and does not include any pitch requirements.

code: int32 GetWidth() const


code: virtual ~IElectraDecoderVideoOutput()


className: IElectraDecoderVideoOutput

code: class IElectraDecoderVideoOutput : public [IElectraDecoderOutput](API\Plugins\ElectraDecoders\IElectraDecoderOutput)


className: operator&

code: constexpr [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) operator& ( [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) Lhs, [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) Rhs )


className: operator~

code: constexpr [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) operator~ ( [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) E )


className: operator&=

code: [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) & operator&= ( [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) & Lhs, [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) Rhs )


className: operator^

code: constexpr [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) operator^ ( [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) Lhs, [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) Rhs )


className: operator^=

code: [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) & operator^= ( [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) & Lhs, [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) Rhs )


className: operator!

code: constexpr bool operator! ( [EElectraDecoderFlags](API\Plugins\ElectraDecoders\EElectraDecoderFlags) E )


code: bool GetAlignedBytes ( uint8 * To, uint64 nBytes )


code: uint64 GetBits64 ( uint64 nBits )


code: uint32 GetBits ( uint64 nBits )


code: uint64 GetRemainingBits() const


code: uint64 GetRemainingByteLength() const


code: const void * GetRemainingData() const


code: bool IsByteAligned() const


code: uint32 PeekBits ( uint64 nBits )


code: void SetData ( const void * InData, uint64 InDataSize, uint64 StartBytePosition, uint32 StartBitPosition )


code: void SkipBits ( uint64 nBits )


code: FElectraBitstreamReader()


code: void SkipBytes ( uint64 nBytes )


code: FElectraBitstreamReader ( const void * InData, uint64 InDataSize, uint64 StartBytePosition, uint32 StartBitPosition )


className: FElectraBitstreamReader

code: class FElectraBitstreamReader


code: bool ReadByte ( uint8 & To )


code: int64 BytesRemaining() const


code: bool ReadByte ( uint16 & To )


code: bool ReadBytes ( uint8 * To, int64 num )


code: FElectraByteReader ( const void * InData, int64 DataSize )


className: FElectraByteReader

code: struct FElectraByteReader


code: struct FVP8UncompressedHeader


className: EColorRange

code: enum EColorRange { CR_StudioSwing = 0, CR_FullSwing = 1, }


className: EColorSpace

code: enum EColorSpace { CS_Unknown = 0, CS_BT_601 = 1, CS_BT_709 = 2, CS_SMPTE_170 = 3, CS_SMPTE_240 = 4, CS_BT_2020 = 5, CS_Reserved = 6, CS_RGB = 7, }


className: ESubSampling

code: enum ESubSampling { SS_YUV_444 = 0, SS_YUV_440 = 1, SS_YUV_422 = 2, SS_YUV_420 = 3, }


code: int32 GetBitDepth() const


code: struct FVP9UncompressedHeader


code: namespace ElectraDecodersUtil { static uint8 ElectraDecodersUtil::GetFromBigEndian ( uint8 value ) }


code: namespace ElectraDecodersUtil { static int8 ElectraDecodersUtil::GetFromBigEndian ( int8 value ) }


code: namespace ElectraDecodersUtil { static uint16 ElectraDecodersUtil::GetFromBigEndian ( uint16 value ) }


code: namespace ElectraDecodersUtil { static int16 ElectraDecodersUtil::GetFromBigEndian ( int16 value ) }


code: namespace ElectraDecodersUtil { static int32 ElectraDecodersUtil::GetFromBigEndian ( int32 value ) }


code: namespace ElectraDecodersUtil { static uint32 ElectraDecodersUtil::GetFromBigEndian ( uint32 value ) }


code: namespace ElectraDecodersUtil { static int64 ElectraDecodersUtil::GetFromBigEndian ( int64 value ) }


code: namespace ElectraDecodersUtil { static uint64 ElectraDecodersUtil::GetFromBigEndian ( uint64 value ) }


code: namespace ElectraDecodersUtil { static constexpr uint32 ElectraDecodersUtil::MakeMP4Atom ( const uint8 A, const uint8 B, const uint8 C, const uint8 D ) }


code: namespace ElectraDecodersUtil { namespace MPEG { enum ESEIStreamType { H264, H265, } } }


code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetCodecSpecificData() const


code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetRawData() const


code: bool ParseFrom ( const void * Data, int64 Size )


code: void SetRawData ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InRawData )


code: FAACDecoderConfigurationRecord()


code: uint8 GetAVCLevelIndication() const


className: FAACDecoderConfigurationRecord

code: class FAACDecoderConfigurationRecord


code: uint8 GetAVCProfileIndication() const


code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetCodecSpecificDataSPS() const


code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetCodecSpecificDataPPS() const


code: const [FISO14496_10_seq_parameter_set_data](API\Plugins\ElectraDecoders\Utils\MPEG\FISO14496_10_seq_parameter_set_d-) & GetParsedSPS ( int32 SpsIndex ) const


code: int32 GetNumberOfSPS() const


code: uint8 GetProfileCompatibility() const


code: void SetRawData ( const void * Data, int64 Size )


className: FAVCDecoderConfigurationRecord

description: ISO/IEC 14496-15:2014

code: class FAVCDecoderConfigurationRecord


code: FFractionalValue ( int64 InNumerator, uint32 InDenominator )


className: FFractionalValue

code: struct FFractionalValue


code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetCodecSpecificData() const


code: const [FISO23008_2_seq_parameter_set_data](API\Plugins\ElectraDecoders\Utils\MPEG\FISO23008_2_seq_parameter_set_da-) & GetParsedSPS ( int32 SpsIndex ) const


code: const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & GetRawData() const


className: FHEVCDecoderConfigurationRecord

code: class FHEVCDecoderConfigurationRecord


code: void GetAspect ( int32 & SarW, int32 & SarH ) const


code: void GetCrop ( int32 & Left, int32 & Right, int32 & Top, int32 & Bottom ) const


description: Sequence parameter set as per ISO/IEC 14496-10:2012, section 7.3.2.1.1


code: uint64 GetConstraintFlags() const


code: [FString](API\Runtime\Core\Containers\FString) GetRFC6381 ( const TCHAR * SampleTypePrefix ) const


code: const uint8 * GetCurrentDataPointer() const


code: int32 GetCurrentOffset() const


code: int32 GetNumBytesRemaining() const


code: bool ReadAsNumber ( float & OutValue )


code: template<typename T> bool Read ( T & value )


code: bool ReadAsNumber ( double & OutValue )


code: bool ReadAsNumber ( int64 & OutValue, int32 InNumBytes )


code: bool ReadAsNumber ( uint64 & OutValue, int32 InNumBytes )


code: bool ReadBytes ( void * Buffer, int32 NumBytes )


code: bool ReadString ( [FString](API\Runtime\Core\Containers\FString) & OutString, uint16 NumBytes )


code: bool ReadStringUTF16 ( [FString](API\Runtime\Core\Containers\FString) & OutString, int32 NumBytes )


code: bool ReadStringUTF8 ( [FString](API\Runtime\Core\Containers\FString) & OutString, int32 NumBytes )


code: FMP4AtomReader ( const void * InDataPtr, int32 InDataSize )


code: void SetCurrentOffset ( int32 InNewOffset )


className: FNaluInfo

description: Parses a H.264 (ISO/IEC 14496-10) bitstream for NALUs.

code: struct FNaluInfo


code: bool ParseFromMessage ( const [FSEIMessage](API\Plugins\ElectraDecoders\Utils\MPEG\FSEIMessage) & InMessage )


code: struct FSEIambient_viewing_environment


code: struct FSEIcontent_colour_volume


code: struct FSEIcontent_light_level_info


className: EPayloadType

code: enum EPayloadType { PT_user_data_registered_itu_t_t35 = 4, PT_mastering_display_colour_volume = 137, PT_content_light_level_info = 144, PT_alternative_transfer_characteristics = 147, PT_ambient_viewing_environment = 148, PT_content_colour_volume = 149, }


className: FSEIMessage

code: struct FSEIMessage


className: EElectraHTTPStreamNotificationReason

module: ElectraHTTPStream

code: enum EElectraHTTPStreamNotificationReason { ReceivedHeaders, ReadData, WriteData, Completed, }


code: virtual void AddData ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InNewData )


code: virtual void AddData ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > && InNewData )


code: virtual void AddData ( const TConstArrayView< const uint8 > & InNewData )


code: virtual void AddData ( const [IElectraHTTPStreamBuffer](API\Plugins\ElectraHTTPStream\IElectraHTTPStreamBuffer) & InOther, int64 Offset, int64 NumBytes )


code: virtual void ClearEOS()


code: virtual void GetBaseBuffer ( const uint8 *& OutBaseAddress, int64 & OutBytesInBuffer )


code: virtual bool GetEOS() const


code: virtual int64 GetLengthFromResponseHeader() const


code: virtual int64 GetNumBytesAvailableForRead() const


code: virtual int64 GetNumTotalBytesHandedOut() const


code: virtual int64 GetNumTotalBytesAdded() const


code: virtual bool HasAllDataBeenConsumed() const


code: virtual bool IsCachable() const


code: virtual void LockBuffer ( const uint8 *& OutNextReadAddress, int64 & OutNumBytesAvailable )


code: virtual bool RewindToBeginning()


code: [FElectraHTTPStreamBuffer](API\Plugins\ElectraHTTPStream\FElectraHTTPStreamBuffer) & operator= ( const [FElectraHTTPStreamBuffer](API\Plugins\ElectraHTTPStream\FElectraHTTPStreamBuffer) & )


code: virtual void SetIsCachable ( bool bInIsCachable )


code: virtual void SetLengthFromResponseHeader ( int64 InLengthFromResponseHeader )


code: virtual void UnlockBuffer ( int64 NumBytesConsumed )


code: FElectraHTTPStreamBuffer()


code: virtual ~FElectraHTTPStreamBuffer()


code: FElectraHTTPStreamBuffer ( const [FElectraHTTPStreamBuffer](API\Plugins\ElectraHTTPStream\FElectraHTTPStreamBuffer) & )


className: FElectraHTTPStreamBuffer

code: class FElectraHTTPStreamBuffer : public [IElectraHTTPStreamBuffer](API\Plugins\ElectraHTTPStream\IElectraHTTPStreamBuffer)


className: FElectraHTTPStreamHeader

code: struct FElectraHTTPStreamHeader


className: FElectraHTTPStreamNotificationDelegate


code: void AddThreadHandlerDelegate ( [FElectraHTTPStreamThreadHandlerDelegate](API\Plugins\ElectraHTTPStream\IElectraHTTPStream\FElectraHTTPStre-) InDelegate )


description: If the request fails the registered notification delegate will be invoked with the cause set to 'Completed' and the parameter set to 1. The error cause can be retrieved from the request via GetErrorMessage(). Please note that HTTP responses like 404, 503 etc. are not an error per se. Handling of such responses must be made by the caller.

code: void AddRequest ( [IElectraHTTPStreamRequestPtr](API\Plugins\ElectraHTTPStream\IElectraHTTPStreamRequestPtr) Request )


description: Creates an instance of the HTTP streamer class.

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IElectraHTTPStream](API\Plugins\ElectraHTTPStream\IElectraHTTPStream), ESPMode::ThreadSafe > Create ( const [Electra::FParamDict](API\Plugins\ElectraBase\FParamDict) & InOptions )


description: Closes this handler and all currently active or pending requests. This should be called before resetting the TSharedPtr<> returned byCreate().

code: void Close()


description: Creates a request. Use the request object's methods to configure the request with the necessary parameters and then pass the request for execution toAddRequest().


className: FElectraHTTPStreamThreadHandlerDelegate

description: Adds a method of your application to be called periodically from the worker thread of this handler. You may use this to drive another wrapping handler of yours that controls requests. For direct use of requests generated by this handler it is not necessary to add such a method. The NotificationDelegate() of the IElectraHTTPStreamRequestPtr request object should be all you need.

code: typedef TBaseDelegate_NoParams< void > FElectraHTTPStreamThreadHandlerDelegate


code: void RemoveThreadHandlerDelegate()


code: virtual ~IElectraHTTPStream()


className: IElectraHTTPStream

code: class IElectraHTTPStream


code: void AddData ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InNewData )


code: void AddData ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > && InNewData )


code: void AddData ( const TConstArrayView< const uint8 > & InNewData )


code: void AddData ( const [IElectraHTTPStreamBuffer](API\Plugins\ElectraHTTPStream\IElectraHTTPStreamBuffer) & Other, int64 Offset, int64 NumBytes )


code: void GetBaseBuffer ( const uint8 *& OutBaseAddress, int64 & OutBytesInBuffer )


code: int64 GetNumTotalBytesAdded() const


code: bool IsCachable() const


code: int64 GetNumTotalBytesHandedOut() const


code: bool HasAllDataBeenConsumed() const


code: void LockBuffer ( const uint8 *& OutNextReadAddress, int64 & OutNumBytesAvailable )


code: bool RewindToBeginning()


code: [IElectraHTTPStreamBuffer](API\Plugins\ElectraHTTPStream\IElectraHTTPStreamBuffer) & operator= ( const [IElectraHTTPStreamBuffer](API\Plugins\ElectraHTTPStream\IElectraHTTPStreamBuffer) & )


code: void SetIsCachable ( bool bInIsCachable )


code: void SetLengthFromResponseHeader ( int64 InLengthFromResponseHeader )


code: void UnlockBuffer ( int64 NumBytesConsumed )


code: IElectraHTTPStreamBuffer()


code: IElectraHTTPStreamBuffer ( const [IElectraHTTPStreamBuffer](API\Plugins\ElectraHTTPStream\IElectraHTTPStreamBuffer) & )


code: virtual ~IElectraHTTPStreamBuffer()


className: IElectraHTTPStreamBuffer

code: class IElectraHTTPStreamBuffer


code: virtual ~IElectraHTTPStreamModule()


className: IElectraHTTPStreamModule

description: Interface for the 'ElectraHTTPStream' module.

code: class IElectraHTTPStreamModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Adds a request header. Only one header of a type is allowed. If one already exists it will be replaced with the new value unless bAppendIfExists is true which will append the value to the existing value with a ", " sequence. An existing header can be removed by passing an empty value with bAppendIfExists set to false. This may not be useful since you can always just not add the header to begin with.

code: void AddHeader ( const [FString](API\Runtime\Core\Containers\FString) & Header, const [FString](API\Runtime\Core\Containers\FString) & Value, bool bAppendIfExists )


description: Allows for GET requests to return a compressed response using one of the platform supported algorithms.

code: void AllowCompression ( bool bAllowCompression )


description: Cancels the request and unbinds your notification delegate.

code: void Cancel()


description: Enables collection of timing traces. (disabled by default)

code: void EnableTimingTraces()


description: Returns the reason the request has failed.


description: Returns the response object which is created with this request immediately and always accessible.


description: Returns the notification delegate to which you bind a progress callback. This must be used only to add a delegate before adding the request for execution. Accessing this delegate while the request is running is not considered thread safe. Do not unbind your callback! UseCancel()instead.


description: Returns whether the request has failed. Please note that HTTP responses in the 4xx and 5xx range are not failures since a communication was established and a response was received. Such errors must be detected and handled by your application examining the response status!

code: bool HasFailed()


description: Sets a range for a GET request. Must be a valid range string.

code: void SetRange ( const [FString](API\Runtime\Core\Containers\FString) & Range )


description: Returns the buffer holding the data to be POSTed to the server. Make sure to include a suitable "Content-Type: xxx" header viaAddHeader()


description: Sets the URL to issue the request to. Must not contain an URL fragment and must be appropriately escaped.

code: void SetURL ( const [FString](API\Runtime\Core\Containers\FString) & URL )


description: Sets a user agent for this request. If not specified an application specific default is used.

code: void SetUserAgent ( const [FString](API\Runtime\Core\Containers\FString) & UserAgent )


code: virtual ~IElectraHTTPStreamRequest()


description: Call this to allow unsafe connections for debugging purposes. Not enabled in shipping builds.

code: void AllowUnsafeRequestsForDebugging()


description: Set verb, GET, HEAD or POST. If not set GET is used by default.

code: void SetVerb ( const [FString](API\Runtime\Core\Containers\FString) & Verb )


className: IElectraHTTPStreamRequestPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IElectraHTTPStreamRequest](API\Plugins\ElectraHTTPStream\IElectraHTTPStreamRequest), ESPMode::ThreadSafe > IElectraHTTPStreamRequestPtr


className: IElectraHTTPStreamRequest

description: HTTP request instance created byIElectraHTTPStream::CreateRequest()

code: class IElectraHTTPStreamRequest


className: EState

description: This enum needs to be kept in order of data flow so states can be compared with < and >

code: enum EState { Connecting, SendingRequestData, WaitingForResponseHeaders, ReceivedResponseHeaders, ReceivingResponseData, Finished, }


className: EStatus

code: enum EStatus { NotRunning, Running, Completed, Canceled, Failed, }


className: FTimingTrace

code: struct FTimingTrace

NumBytesAdded

description: Bytes added with the most recent chunk.

TimeSinceStart

type: double

description: Seconds since the request started.

TotalBytesAdded

description: Total bytes added to the buffer including the most recent chunk.


code: int32 GetHTTPResponseCode()


code: void GetAllHeaders ( [TArray](API\Runtime\Core\Containers\TArray)< [FElectraHTTPStreamHeader](API\Plugins\ElectraHTTPStream\FElectraHTTPStreamHeader) > & OutHeaders )


code: int64 GetNumRequestBytesSent()


code: int64 GetNumResponseBytesReceived()


code: double GetTimeElapsed()


code: double GetTimeSinceLastDataArrived()


code: double GetTimeUntilConnected()


code: double GetTimeUntilFinished()


code: double GetTimeUntilFirstByte()


code: double GetTimeUntilHeadersAvailable()


code: double GetTimeUntilRequestSent()


description: Static timings as progressing through states.

code: double GetTimeUntilNameResolved()


description: Appends a copy of the timing traces to the provided array and optionally removes the first n elements. Pass a nullptr to only remove elements without copying them. This is useful to first get the traces and in a second call remove those that are no longer needed. Returns number appended or removed.

code: int32 GetTimingTraces ( [TArray](API\Runtime\Core\Containers\TArray)< [FTimingTrace](API\Plugins\ElectraHTTPStream\IElectraHTTPStreamResponse\FTimingTrace) > * OutTraces, int32 InNumToRemove )


code: void SetEnableTimingTraces()


className: IElectraHTTPStreamResponse

code: class IElectraHTTPStreamResponse


code: virtual ~IElectraHTTPStreamResponse()


className: IElectraHTTPStreamResponsePtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IElectraHTTPStreamResponse](API\Plugins\ElectraHTTPStream\IElectraHTTPStreamResponse), ESPMode::ThreadSafe > IElectraHTTPStreamResponsePtr


code: bool Equals ( const [FHttpRange](API\Plugins\ElectraHTTPStream\Utilities\FHttpRange) & Other )


code: int64 GetEndIncluding() const


code: int64 GetDocumentSize() const


description: Returns the number of bytes in the range, which must be fully specified. An unset or partially open range will return -1.

code: int64 GetNumberOfBytes() const


description: Check if the range would result in "0-" for the entire resource in which case we don't need to use range request.

code: bool IsEverything() const


code: [FString](API\Runtime\Core\Containers\FString) GetString ( bool bWithUnitPrefix ) const


code: bool IsOpenEnded() const


code: bool ParseFromContentRangeResponse ( const [FString](API\Runtime\Core\Containers\FString) & ContentRangeHeader )


code: void Set ( const [FString](API\Runtime\Core\Containers\FString) & InString )


code: void SetEndIncluding ( int64 InEndIncluding )


code: void SetStart ( int64 InStart )


className: FHttpRange

code: struct FHttpRange


module: ElectraPlayerPlugin

code: virtual [IMediaOptions](API\Runtime\Media\IMediaOptions) * GetMediaOptionInterface()


code: virtual void Unlock()


code: FElectraSafeMediaOptionInterface ( [IMediaOptions](API\Runtime\Media\IMediaOptions) * InOwner )


className: FElectraSafeMediaOptionInterface

description: A ready to use implementation of theIElectraSafeMediaOptionInterface

code: class FElectraSafeMediaOptionInterface : public [IElectraSafeMediaOptionInterface](API\Plugins\ElectraPlayerPlugin\IElectraSafeMediaOptionInterface)


code: FElectraSeekablePositions ( const [TArray](API\Runtime\Core\Containers\TArray)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > & InData )


className: FElectraSeekablePositions

description: Data type for use with media options interface.

code: class FElectraSeekablePositions : public [IMediaOptions::FDataContainer](API\Runtime\Media\IMediaOptions\FDataContainer)

Data

type: TArray<FTimesp...


code: virtual ~FElectraSeekablePositions()


description:
Creates a media player
A new media player, or nullptr if a player couldn't be created.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMediaPlayer](API\Runtime\Media\IMediaPlayer), ESPMode::ThreadSafe > CreatePlayer ( [IMediaEventSink](API\Runtime\Media\IMediaEventSink) & EventSink )


description:
Is the ElectraPlayerPlugin module initialized?
True if the module is initialized.

code: bool IsInitialized() const


code: void ReportSubtitlesMetrics ( const [FGuid](API\Runtime\Core\Misc\FGuid) & PlayerGuid, const [FString](API\Runtime\Core\Containers\FString) & URL, double ResponseTime, const [FString](API\Runtime\Core\Containers\FString) & LastError )


code: void ReportVideoStreamingError ( const [FGuid](API\Runtime\Core\Misc\FGuid) & PlayerGuid, const [FString](API\Runtime\Core\Containers\FString) & LastError )


code: void SendAnalyticMetricsPerMinute ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalyticsProviderET](API\Runtime\AnalyticsET\IAnalyticsProviderET) > & AnalyticsProvider )


code: void SendAnalyticMetrics ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalyticsProviderET](API\Runtime\AnalyticsET\IAnalyticsProviderET) > & AnalyticsProvider, const [FGuid](API\Runtime\Core\Misc\FGuid) & PlayerGuid )


code: virtual ~IElectraPlayerPluginModule()


className: IElectraPlayerPluginModule

description: Interface for the ElectraPlayerPlugin module.

code: class IElectraPlayerPluginModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


code: FScopedLock &40; const TSharedPtr< IElectraSafeMediaOptionInterface, ESPMode::ThreadSafe > & InSafeMediaOptionInterface &41;


className: FScopedLock

code: class FScopedLock


className: IElectraSafeMediaOptionInterface

description: This class is used to get safe access to anIMediaOptionsinterface. When passingIMediaOptionsthrough media framework as a POD pointer there is the risk that it is actually from a derived class likeUMediaSourcewhich is subject to GC. Thus it is not safe to keep the PODIMediaOptionsaround. This class is intended to be derived and instantiated from and stored as aTSharedPtrin a derivedUMediaSourceclass. Then, as the media player is opened and the PODIMediaOptionsis passed along, a GetMediaOption("GetSafeMediaOptions") query will be made on it to get this instance. If future access to theIMediaOptionsis needed it will be made through this class by first locking, getting and using theIMediaOptionspointer returned here if it not null and unlocking afterwards.

code: class IElectraSafeMediaOptionInterface : public [IMediaOptions::FDataContainer](API\Runtime\Media\IMediaOptions\FDataContainer)


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

module: ElectraPlayerPluginHandler

code: virtual void ShutdownModule()


description: IModuleInterfaceimplementation

code: virtual void StartupModule()


className: FElectraPlayerPluginHandlerModule

code: class FElectraPlayerPluginHandlerModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: FElectraPlayerPlatform

module: ElectraPlayerRuntime

code: class FElectraPlayerPlatform


code: static bool StartupPlatformResources ( const [Electra::FParamDict](API\Plugins\ElectraBase\FParamDict) & Params )


code: typedef TMulticastDelegate_TwoParams< void, const [FGuid](API\Runtime\Core\Misc\FGuid) &, const [FString](API\Runtime\Core\Containers\FString) & > FElectraPlayerReportVideoStreamingErrorDelegate


code: static [IElectraPlayerInterface](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface) * CreatePlayer ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IElectraPlayerAdapterDelegate](API\Plugins\ElectraPlayerRuntime\IElectraPlayerAdapterDelegate), ESPMode::ThreadSafe > & AdapterDelegate, FElectraPlayerSendAnalyticMetricsDelegate & InSendAnalyticMetricsDelegate, FElectraPlayerSendAnalyticMetricsPerMinuteDelegate & InSendAnalyticMetricsPerMinuteDelegate, FElectraPlayerReportVideoStreamingErrorDelegate & InReportVideoStreamingErrorDelegate, FElectraPlayerReportSubtitlesMetricsDelegate & InReportSubtitlesFileMetricsDelegate )


className: FElectraPlayerRuntimeFactory

code: class FElectraPlayerRuntimeFactory


code: typedef TMulticastDelegate_OneParam< void, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalyticsProviderET](API\Runtime\AnalyticsET\IAnalyticsProviderET) > & > FElectraPlayerSendAnalyticMetricsPerMinuteDelegate


code: typedef TMulticastDelegate_TwoParams< void, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalyticsProviderET](API\Runtime\AnalyticsET\IAnalyticsProviderET) > &, const [FGuid](API\Runtime\Core\Misc\FGuid) & > FElectraPlayerSendAnalyticMetricsDelegate


className: IAudioDecoderOutputPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAudioDecoderOutput](API\Plugins\ElectraBase\IAudioDecoderOutput), ESPMode::ThreadSafe > IAudioDecoderOutputPtr


code: void BlobReceived ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TArray](API\Runtime\Core\Containers\TArray)< uint8 >, ESPMode::ThreadSafe > & InBlobData, [EBlobResultType](API\Plugins\ElectraPlayerRuntime\IElectraPlayerAdapterDelegate\EBlobResultType) InResultType, int32 InResultCode, const [Electra::FParamDict](API\Plugins\ElectraBase\FParamDict) * InExtraInfo )


code: bool CanReceiveAudioSamples ( int32 NumFrames )


code: bool CanReceiveVideoSamples ( int32 NumFrames )


code: typedef TMulticastDelegate_FourParams< void, const [FGuid](API\Runtime\Core\Misc\FGuid) &, const [FString](API\Runtime\Core\Containers\FString) &, double, const [FString](API\Runtime\Core\Containers\FString) & > FElectraPlayerReportSubtitlesMetricsDelegate


className: EBlobResultType

code: enum EBlobResultType { Success, TimedOut, HttpFailure, }


className: EOptionType

code: enum EOptionType { MaxVerticalStreamResolution = 0, MaxBandwidthForStreaming, PlayListData, LicenseKeyData, PlaystartPosFromSeekPositions, MediaMetadataUpdate, CustomAnalyticsMetric, Android_VideoSurface, }


className: EPlayerEvent

code: enum EPlayerEvent { MediaBuffering = 0, MediaClosed, MediaConnecting, MediaOpened, MediaOpenFailed, PlaybackEndReached, PlaybackResumed, PlaybackSuspended, SeekCompleted, TracksChanged, MetadataChanged, Internal_Start, Internal_PurgeVideoSamplesHint = Internal_Start, Internal_ResetForDiscontinuity, Internal_RenderClockStart, Internal_RenderClockStop, Internal_VideoSamplesAvailable, Internal_VideoSamplesUnavailable, Internal_AudioSamplesAvailable, Internal_AudioSamplesUnavailable, }


className: FVideoDecoderOutputPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FVideoDecoderOutput](API\Plugins\ElectraBase\FVideoDecoderOutput), ESPMode::ThreadSafe > FVideoDecoderOutputPtr


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< IElectraPlayerResourceDelegate, ESPMode::ThreadSafe > GetResourceDelegate() const


code: void OnSubtitleFlush()


code: void PrepareForDecoderShutdown()


code: void PresentAudioFrame ( const [IAudioDecoderOutputPtr](API\Plugins\ElectraBase\IAudioDecoderOutputPtr) & InAudioFrame )


code: void PresentMetadataSample ( const [IMetaDataDecoderOutputPtr](API\Plugins\ElectraBase\IMetaDataDecoderOutputPtr) & InMetadataSample )


code: void PresentSubtitleSample ( const [ISubtitleDecoderOutputPtr](API\Plugins\ElectraBase\ISubtitleDecoderOutputPtr) & InSubtitleSample )


code: void PresentVideoFrame ( const [FVideoDecoderOutputPtr](API\Plugins\ElectraBase\FVideoDecoderOutputPtr) & InVideoFrame )


code: [Electra::FVariantValue](API\Plugins\ElectraBase\FVariantValue) QueryOptions ( [EOptionType](API\Plugins\ElectraPlayerRuntime\IElectraPlayerAdapterDelegate\EOptionType) Type, const [Electra::FVariantValue](API\Plugins\ElectraBase\FVariantValue) & Param )


code: void SendMediaEvent ( [EPlayerEvent](API\Plugins\ElectraPlayerRuntime\IElectraPlayerAdapterDelegate\EPlayerEvent) Event )


className: IElectraPlayerAdapterDelegate

code: class IElectraPlayerAdapterDelegate : public [TSharedFromThis< IElectraPlayerAdapterDelegate, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


description: This method should not block to wait until the cache has been updated. It should merely schedule an asynchronous update and defer writing the data to the storage to some asynchronous task.

code: void AddElementToCache ( const [FItemInfo](API\Plugins\ElectraPlayerRuntime\IElectraPlayerDataCache\FItemInfo) & ItemInfoToCache, [FCacheDataPtr](API\Plugins\ElectraPlayerRuntime\IElectraPlayerDataCache\FCacheDataPtr) DataToCache )


className: ECacheResult

code: enum ECacheResult { Miss, Hit, }


className: FCacheDataPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TArray](API\Runtime\Core\Containers\TArray)< uint8 >, ESPMode::ThreadSafe > FCacheDataPtr


className: FCachedDataReadCompleted


className: EStreamType

code: enum EStreamType { Video, Audio, Other, }


description: Asks to get an item from the cache. The item to get is described byInItemToGetFromCache_, with the exception of the.Range.TotalSize_ member which is not known ahead of time. If the cache fulfills the request theOutCachedItemInfo_ is expected to be set up, including the.Range.TotalSize_ member.

code: void GetElementFromCache ( const [FItemInfo](API\Plugins\ElectraPlayerRuntime\IElectraPlayerDataCache\FItemInfo) & ItemToGetFromCache, [FCachedDataReadCompleted](API\Plugins\ElectraPlayerRuntime\IElectraPlayerDataCache\FCachedDataReadCompleted) CompletionDelegate )


className: FItemInfo

code: struct FItemInfo

MaxQualityIndex

description: The maximum quality index of this stream.

QualityIndex

description: The quality index of this stream.

Range

type: FRange

description: Possible sub-range within the resource.

StreamType

type: EStreamType

description: Type of elementary stream this request is for.

URI

description: Unique resource identifier. Typically a URL.


code: virtual ~IElectraPlayerDataCache()


className: IElectraPlayerDataCache

code: class IElectraPlayerDataCache : public [TSharedFromThis< IElectraPlayerDataCache, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


code: typedef TBaseDelegate_ThreeParams< void, [FResponseDataPtr](API\Plugins\ElectraPlayerRuntime\IElectraPlayerExternalDataReader\FResponseDataPtr), int64, const [FReadParam](API\Plugins\ElectraPlayerRuntime\IElectraPlayerExternalDataReader\FReadParam) &FromRequestParams > FElectraPlayerExternalDataReaderOnRequestCompleted


className: FReadParam

code: struct FReadParam

Custom

type: void *


description: Called to read data by some external means. When done the provided completion delegate must be called. Passing a nullptr for the response data will trigger a read error and a subsequent playback error. Returning fewer bytes than requested implicitly means the end of the file was reached while reading. If a read request for 0 bytes at offset 0 is made you are to return the total size of the file. For this request it is permitted to return a nullptr for response data without resulting in an error. Read requests may set the number of bytes to read to MAX_INT64 to indicate reading until the end of the file. The player has no upfront knowledge about the size of the file so it cannot always adjust the number of bytes to be read. Even when returning the size of the file in an earlier read there is no guarantee that the number of bytes to be read will be adjusted accordingly. Returning a negative value for the total size of the file is treated as an error and will be handled like a file-not-found error, even though that should not be possible. You are providing this reader class to the player knowing that the URL to play exists and is valid. If the offset to read from is given as a negative value this is an indication that you may close the file, but such a call is optional. You may close the file after having closed the player. You may however open and close the file with every read request if that is more convenient for you. The player will wait indefinitely for the response data to be provided. There are no timeouts. Youmustcall the provided delegate even for failures.

code: void ReadDataFromFile ( const [FReadParam](API\Plugins\ElectraPlayerRuntime\IElectraPlayerExternalDataReader\FReadParam) & InReadParam, [FElectraPlayerExternalDataReaderOnRequestCompleted](API\Plugins\ElectraPlayerRuntime\IElectraPlayerExternalDataReader\FElectraPlayerEx-) OutCompletionDelegate )


className: IElectraPlayerExternalDataReader

code: class IElectraPlayerExternalDataReader : public [TSharedFromThis< IElectraPlayerExternalDataReader, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


code: void CloseInternal ( bool bKillAfterClose )


className: EOpenType

code: enum EOpenType { Media, Blob, }


className: EPlayerState

code: enum EPlayerState { Closed = 0, Error, Paused, Playing, Preparing, Stopped, }


className: EPlayerTrackType

code: enum EPlayerTrackType { Audio = 0, Caption, Metadata, Script, Subtitle, Text, Video, }


className: EPlayerStatus

code: enum EPlayerStatus { None = 0x0, Buffering = 0x1, Connecting = 0x2, }


className: EPlayRateType

code: enum EPlayRateType { Thinned, Unthinned, }


className: FAudioTrackFormat

code: struct FAudioTrackFormat


className: FResponseDataPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TArray](API\Runtime\Core\Containers\TArray)< uint8 >, ESPMode::ThreadSafe > FResponseDataPtr


className: FPlaybackRange

code: struct FPlaybackRange

End

type: TOptional<FTim...


className: FPlaystartOptions

code: struct FPlaystartOptions

bDoNotPreload

type: bool

ExternalDataCache

type: TSharedPtr<IEl...

InitialAudioTrackAttributes

type: FStreamSelectio...

MaxBandwidthForStreaming

type: TOptional< int3...


className: FSeekParam

code: struct FSeekParam

bOptimizeForScrubbing

type: TOptional< bool...

DistanceThreshold

type: TOptional< doub...


className: FStreamSelectionAttributes

code: struct FStreamSelectionAttributes

Codec

type: TOptional<FStr...


className: FVideoStreamFormat

code: struct FVideoStreamFormat

Resolution

type: FIntPoint


className: FVideoTrackFormat

code: struct FVideoTrackFormat

FrameRate

type: float

FrameRates

type: TRange< float >

TypeName

type: FString


code: bool GetActiveVideoStreamFormat ( [FVideoStreamFormat](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\FVideoStreamFormat) & OutFormat ) const


code: bool GetAudioTrackFormat ( int32 TrackIndex, int32 FormatIndex, [FAudioTrackFormat](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\FAudioTrackFormat) & OutFormat ) const


code: int32 GetLoopCount() const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [Electra::IMediaStreamMetadata::IItem](API\Plugins\ElectraBase\IMediaStreamMetadata\IItem), ESPMode::ThreadSafe > > >, ESPMode::ThreadSafe > GetMediaMetadata() const


code: int32 GetNumTrackFormats ( [EPlayerTrackType](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\EPlayerTrackType) TrackType, int32 TrackIndex ) const


code: int32 GetNumTracks ( [EPlayerTrackType](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\EPlayerTrackType) TrackType ) const


code: int32 GetNumVideoStreams ( int32 TrackIndex ) const


code: void GetPlaybackRange ( [FPlaybackRange](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\FPlaybackRange) & OutPlaybackRange ) const


code: float GetRate() const


code: int32 GetSelectedTrack ( [EPlayerTrackType](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\EPlayerTrackType) TrackType ) const


code: [TRangeSet](API\Runtime\Core\Math\TRangeSet)< float > GetSupportedRates ( [EPlayRateType](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\EPlayRateType) InPlayRateType ) const


code: [FText](API\Runtime\Core\Internationalization\FText) GetTrackDisplayName ( [EPlayerTrackType](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\EPlayerTrackType) TrackType, int32 TrackIndex ) const


code: int32 GetTrackFormat ( [EPlayerTrackType](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\EPlayerTrackType) TrackType, int32 TrackIndex ) const


code: [FString](API\Runtime\Core\Containers\FString) GetTrackLanguage ( [EPlayerTrackType](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\EPlayerTrackType) TrackType, int32 TrackIndex ) const


code: [FString](API\Runtime\Core\Containers\FString) GetTrackName ( [EPlayerTrackType](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\EPlayerTrackType) TrackType, int32 TrackIndex ) const


code: bool GetVideoStreamFormat ( [FVideoStreamFormat](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\FVideoStreamFormat) & OutFormat, int32 InTrackIndex, int32 InStreamIndex ) const


code: bool GetVideoTrackFormat ( int32 TrackIndex, int32 FormatIndex, [FVideoTrackFormat](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\FVideoTrackFormat) & OutFormat ) const


code: void Signal &40; uint32 ResourceFlags &41;


className: IAsyncResourceReleaseNotifyContainer


code: bool IsKillAfterCloseAllowed() const


code: bool IsLooping() const


code: void ModifyOptions ( const [Electra::FParamDict](API\Plugins\ElectraBase\FParamDict) & InOptionsToSetOrChange, const [Electra::FParamDict](API\Plugins\ElectraBase\FParamDict) & InOptionsToClear )


code: void NotifyOfOptionChange()


code: bool OpenInternal ( const [FString](API\Runtime\Core\Containers\FString) & Url, const [Electra::FParamDict](API\Plugins\ElectraBase\FParamDict) & PlayerOptions, const [FPlaystartOptions](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\FPlaystartOptions) & InPlaystartOptions, [EOpenType](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\EOpenType) InOpenType )


code: enum { ResourceFlags_Any = ResourceFlags_All }


code: enum { ResourceFlags_All = (1 << 2) - 1 }


code: enum { ResourceFlags_Decoder = 1 << 0 }


code: enum { ResourceFlags_OutputBuffers = 1 << 1 }


code: bool Seek ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Time )


code: bool Seek ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Time, const [FSeekParam](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\FSeekParam) & Param )


code: bool SelectTrack ( [EPlayerTrackType](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\EPlayerTrackType) TrackType, int32 TrackIndex )


code: void SetAsyncResourceReleaseNotification ( [IAsyncResourceReleaseNotifyContainer](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\IAsyncResourceRe-) * AsyncResourceReleaseNotification )


code: void SetFrameAccurateSeekMode ( bool bEnableFrameAccuracy )


code: void SetGuid ( const [FGuid](API\Runtime\Core\Misc\FGuid) & Guid )


code: bool SetLooping ( bool bLooping )


code: void SetPlaybackRange ( const [FPlaybackRange](API\Plugins\ElectraPlayerRuntime\IElectraPlayerInterface\FPlaybackRange) & InPlaybackRange )


code: bool SetRate ( float Rate )


description: Suspends or resumes decoder instances. Not supported on all platforms.

code: void SuspendOrResumeDecoders ( bool bSuspend, const [Electra::FParamDict](API\Plugins\ElectraBase\FParamDict) & InOptions )


code: void Tick ( [FTimespan](API\Runtime\Core\Misc\FTimespan) DeltaTime, [FTimespan](API\Runtime\Core\Misc\FTimespan) Timecode )


code: virtual ~IElectraPlayerInterface()


className: IElectraPlayerInterface

code: class IElectraPlayerInterface : public [TSharedFromThis< IElectraPlayerInterface, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


description:
Is the ElectraPlayerRuntime module initialized?
True if the module is initialized.

code: bool IsInitialized() const


code: virtual ~IElectraPlayerRuntimeModule()


className: IElectraPlayerRuntimeModule

description: Interface for the ElectraPlayerRuntime module.

code: class IElectraPlayerRuntimeModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: IMetaDataDecoderOutputPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMetaDataDecoderOutput](API\Plugins\ElectraBase\IMetaDataDecoderOutput), ESPMode::ThreadSafe > IMetaDataDecoderOutputPtr


code: void * GetPointer() const


code: virtual ~IOptionPointerValueContainer()


className: IOptionPointerValueContainer

description: Container class to be passed through options as shared pointer to allow passing any non-standard ref-counted entities to the player.

code: class IOptionPointerValueContainer


className: ISubtitleDecoderOutputPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISubtitleDecoderOutput](API\Plugins\ElectraBase\ISubtitleDecoderOutput), ESPMode::ThreadSafe > ISubtitleDecoderOutputPtr


module: ElectraSamples

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IVideoDecoderTexture](API\Plugins\ElectraBase\IVideoDecoderTexture), ESPMode::ThreadSafe > CreateTexture ( const FIntPoint & Dim, EPixelFormat Fmt )


code: FTextureRHIRef GetRHITextureFromPlatformTexture ( void * PlatformTexture )


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IVideoDecoderTexture](API\Plugins\ElectraBase\IVideoDecoderTexture), ESPMode::ThreadSafe > PlatformCreateTexture ( const FIntPoint & Dim, EPixelFormat Fmt )


code: void PlatformAddSharedTextureRef ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IVideoDecoderTexture](API\Plugins\ElectraBase\IVideoDecoderTexture), ESPMode::ThreadSafe > InTextureRef )


code: void * PlatformGetTexturePlatform ( [IVideoDecoderTexture](API\Plugins\ElectraBase\IVideoDecoderTexture) * Texture )


code: FTextureRHIRef PlatformGetTextureRHI ( [IVideoDecoderTexture](API\Plugins\ElectraBase\IVideoDecoderTexture) * Texture )


code: void PlatformRemoveSharedTextureRef ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IVideoDecoderTexture](API\Plugins\ElectraBase\IVideoDecoderTexture), ESPMode::ThreadSafe > InTextureRef )


code: FElectraSamplesTextureManager()


className: EDispatchedMode

code: enum EDispatchedMode { OnReceive, OnStart, }


className: FElectraSamplesTextureManager

code: class FElectraSamplesTextureManager


className: EOrigin

code: enum EOrigin { EventStream, InbandEventStream, TimedMetadata, }


description: GetTime

code: const void * GetData()


description: Returns the type with which this event was dispatched.


description: GetTime


description: Get the GUID identifying the derived type that may implement additional, type specific methods. If the GUID matches a type known type it is safe to static cast this class to the derived type. This is usually done to identify the format of the binary data carried here.


description: Returns the event's ID.

code: const [FString](API\Runtime\Core\Containers\FString) & GetID() const


description: Returns where the event originated from.


description: Returns the event's scheme id URI.

code: const [FString](API\Runtime\Core\Containers\FString) & GetSchemeIdUri() const


description: GetTime

code: uint32 GetSize() const


description: Returns the base time (the "zero point") of the track, if available, to calculate the relative time of this metadata fromGetTime()if this is based on some non-zero anchor.

code: [TOptional](API\Runtime\Core\IO\TOptional)< [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) > GetTrackBaseTime() const


description: Returns the event's value.

code: const [FString](API\Runtime\Core\Containers\FString) & GetValue() const


code: virtual ~IElectraBinarySample()


className: IElectraBinarySample

description: Extension of the media binary sample to carry Electra specific events.

code: class IElectraBinarySample : public [IMediaBinarySample](API\Runtime\Media\IMediaBinarySample)


code: virtual ~IElectraSamplesModule()


className: IElectraSamplesModule

description: Interface for the `ElectraBase_ module.

code: class IElectraSamplesModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Get the GUID identifying the derived type that may implement additional, type specific methods. If the GUID matches a type known type it is safe to static cast this class to the derived type.


description:
Get the amount of time for which the sample should be displayed.
Sample duration.


description: GetText

code: [TOptional](API\Runtime\Core\IO\TOptional)< FVector2D > GetPosition() const


description:
This value is used primarily for debugging purposes.
Sample time.


description: GetType


description: VirtualTOptionalGetTimecode() const{ returnTOptional(); }

code: EMediaOverlaySampleType GetType() const


code: virtual ~IElectraSubtitleSample()


className: IElectraSubtitleSample

description: Extension of the media overlay sample to carry Electra specific values.

code: class IElectraSubtitleSample : public [IMediaOverlaySample](API\Runtime\Media\IMediaOverlaySample)


description:
Get pixel aspect ratio
Pixel aspect ratio

code: virtual double GetAspectRatio() const


description: GetTime

code: virtual FIntPoint GetDim() const


code: virtual FVector2f GetDisplayPrimaryBlue() const


description: GetTime

code: virtual [FTimespan](API\Runtime\Core\Misc\FTimespan) GetDuration() const


code: virtual FVector2f GetDisplayPrimaryGreen() const


code: virtual FVector2f GetDisplayPrimaryRed() const


description: Get EOTF / "Gamma" / encoding type of data

code: virtual [UE::Color::EEncoding](API\Runtime\ColorManagement\UE__Color__EEncoding) GetEncodingType() const


description: Get full range color flag

code: virtual bool GetFullRange() const


description:
Get Colorspace conversion matrix to convert to CIE1931 XYZ space
Conversion Matrix

code: virtual FMatrix44f GetGamutToXYZMatrix() const


description:
Get image orientation vs. physically returned image data
Image orientation

code: virtual EMediaOrientation GetOrientation() const


description: GetTime

code: virtual FIntPoint GetOutputDim() const


code: virtual float GetSampleDataScale ( bool b10Bit ) const


description:
Get complete 4x4 matrix to apply to the sample's pixels to yield RGB data in the sample's gamut
Conversion Matrix

code: virtual FMatrix44f GetSampleToRGBMatrix() const


description: GetTexture

code: virtual [FMediaTimeStamp](API\Runtime\Media\FMediaTimeStamp) GetTime() const


description:
Get white point of color space of the data contain in the sample
White point

code: virtual FVector2f GetWhitePoint() const


description:
Default is equivalent to MediaShaders::YuvToRgbRec709Scaled Matrix. NOTE: previously in UE4 this was YuvToRgbRec601Scaled
Conversion Matrix

code: virtual const FMatrix & GetYUVToRGBMatrix() const


code: void Initialize ( [FVideoDecoderOutput](API\Plugins\ElectraBase\FVideoDecoderOutput) * InVideoDecoderOutput )


description:
Non-cacheable video samples become invalid when the next sample is available, and only the latest sample should be kept by video sample consumers.
true if cacheable, false otherwise.

code: virtual bool IsCacheable() const


description: ShutdownPoolable

code: virtual void InitializePoolable()


description:
Whether the output of the sample is in sRGB color space.
true if sRGB, false otherwise.

code: virtual bool IsOutputSrgb() const


description: InitializePoolable

code: virtual void ShutdownPoolable()


className: IElectraTextureSampleBase

code: class IElectraTextureSampleBase : public [IMediaTextureSample](API\Runtime\Media\IMediaTextureSample), public [IMediaPoolable](API\Runtime\MediaUtils\IMediaPoolable)

Colorimetry

type: TWeakPtr< const...

HDRInfo

description: Quick access for some HDR related info

VideoDecoderOutput

type: TSharedPtr<FVi...

description: Output data from video decoder.

YuvToRgbMtx

description: YUV matrix, adjusted to compensate for decoder output specific scale


description: Adds streamed subtitle data.

module: ElectraSubtitles

code: void AddStreamedSubtitleData ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InData, [Electra::FTimeValue](API\Plugins\ElectraBase\FTimeValue) InAbsoluteTimestamp, [Electra::FTimeValue](API\Plugins\ElectraBase\FTimeValue) InDuration, const [Electra::FParamDict](API\Plugins\ElectraBase\FParamDict) & InAdditionalInfo )


description: Flushes all input and output.

code: void Flush()


className: FOnSubtitleReceivedDelegate

description: Delegate to which the application can subscribe to receive parsed subtitles.

code: typedef TMulticastDelegate_OneParam< void, [ISubtitleDecoderOutputPtr](API\Plugins\ElectraBase\ISubtitleDecoderOutputPtr) > FOnSubtitleReceivedDelegate


description: Returns a time offset at which streamed subtitles should be delivered ahead of their actual timestamp (if they are available earlier)


description: Initializes with codec specific data and additional attributes.

code: bool InitializeStreamWithCSD ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InCSD, const [Electra::FParamDict](API\Plugins\ElectraBase\FParamDict) & InAdditionalInfo )


description: Signals no more streamed subtitles will be arriving.

code: void SignalStreamedSubtitleEOD()


description: Handling methods

code: void Start()


code: void UpdatePlaybackPosition ( [Electra::FTimeValue](API\Plugins\ElectraBase\FTimeValue) InAbsolutePosition, [Electra::FTimeValue](API\Plugins\ElectraBase\FTimeValue) InLocalPosition )


code: virtual ~IElectraSubtitleDecoder()


className: IElectraSubtitleDecoder

description: Base class of a subtitle decoder.

code: class IElectraSubtitleDecoder


description: Called to create a decoder for the given format from this plugin's modular feature.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IElectraSubtitleDecoder](API\Plugins\ElectraSubtitles\IElectraSubtitleDecoder), ESPMode::ThreadSafe > CreateDecoderForFormat ( const [FString](API\Runtime\Core\Containers\FString) & SubtitleCodecName )


description: Returns a priority for this plugin's subtitle format feature. The return value is not standardized, but the decoder returning the largest value for a format will be used to handle the subtitles. This is mainly used if you provide a plugin of your own that handles a format better than another plugin does and you want to make sure yours will be used.

code: int32 GetPriorityForFormat ( const [FString](API\Runtime\Core\Containers\FString) & SubtitleCodecName ) const


description: Returns a list of the supported subtitle codecs.

code: void GetSupportedFormats ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutSupportedCodecNames ) const


description: Queries whether or not this plugin's modular feature is capable of handling subtitles of the specified format. The codec string is a commonly known format like "wvtt", "tx3g", "imsc1", etc. but may also be a MIME type like "application/ttml+xml" for sideloaded subtitles.

code: bool SupportsFormat ( const [FString](API\Runtime\Core\Containers\FString) & SubtitleCodecName ) const


className: IElectraSubtitleModularFeature

code: class IElectraSubtitleModularFeature : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


code: virtual ~IElectraSubtitlesModule()


className: IElectraSubtitlesModule

description: Interface for the `ElectraSubtitles_ module.

code: class IElectraSubtitlesModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Merging.

module: EngineAssetDefinitions

code: virtual bool CanMerge() const


code: virtual [TSoftClassPtr](API\Runtime\CoreUObject\UObject\TSoftClassPtr)< [UObject](API\Runtime\CoreUObject\UObject\UObject) > GetAssetClass() const


description: Gets a list of categories this asset is in, these categories are used to help organize

code: virtual TConstArrayView< [FAssetCategoryPath](API\Editor\AssetDefinition\Misc\FAssetCategoryPath) > GetAssetCategories() const


code: virtual [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetAssetColor() const


description: Returns additional tooltip information for the specified asset, if it has any.

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetAssetDescription ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & AssetData ) const


description: UAssetDefinitionImplementation.

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetAssetDisplayName() const


description: Returns the name of this type

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetAssetDisplayName ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & AssetData ) const


description: UAssetDefinition_ClassTypeBaseImplementation.

code: virtual [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IClassTypeActions](API\Developer\AssetTools\IClassTypeActions) > GetClassTypeActions ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & AssetData ) const


code: virtual [UFactory](API\Editor\UnrealEd\Factories\UFactory) * GetFactoryForBlueprintType ( [UBlueprint](API\Runtime\Engine\Engine\UBlueprint) * InBlueprint ) const


description: Returns the thumbnail info for the specified asset, if it has one. This typically requires loading the asset.

code: virtual [UThumbnailInfo](API\Runtime\Engine\EditorFramework\UThumbnailInfo) * LoadThumbnailInfo ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAssetData ) const


code: virtual EAssetCommandResult Merge ( const [FAssetAutomaticMergeArgs](API\Editor\AssetDefinition\FAssetAutomaticMergeArgs) & MergeArgs ) const


code: virtual EAssetCommandResult Merge ( const [FAssetManualMergeArgs](API\Editor\AssetDefinition\FAssetManualMergeArgs) & MergeArgs ) const


description: UAssetDefinitionBegin.

code: virtual EAssetCommandResult OpenAssets ( const [FAssetOpenArgs](API\Editor\AssetDefinition\FAssetOpenArgs) & OpenArgs ) const


description: Diffing Assets.

code: virtual EAssetCommandResult PerformAssetDiff ( const [FAssetDiffArgs](API\Editor\AssetDefinition\FAssetDiffArgs) & DiffArgs ) const


description: UAssetDefinitionBegin.

code: virtual [FAssetSupportResponse](API\Editor\AssetDefinition\FAssetSupportResponse) CanLocalize ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAsset ) const


description: Get the class type actions for this asset


description: Base class for "class type" assets (C++ classes and Blueprints


description: Optionally returns a custom widget to overlay on top of this assets' thumbnail

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetThumbnailOverlay ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAssetData ) const


description: UAssetDefinitionImplementation.


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UAssetDefinition_DataAsset : public [UAssetDefinitionDefault](API\Editor\UnrealEd\UAssetDefinitionDefault)


code: virtual EAssetCommandResult ActivateAssets ( const [FAssetActivateArgs](API\Editor\AssetDefinition\FAssetActivateArgs) & ActivateArgs ) const


code: virtual [TSoftClassPtr](API\Runtime\CoreUObject\UObject\TSoftClassPtr)< [UObject](API\Runtime\CoreUObject\UObject\UObject) > GetAssetClass() const


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UAssetDefinition_Redirector : public [UAssetDefinitionDefault](API\Editor\UnrealEd\UAssetDefinitionDefault)


description: UAssetDefinitionImplementation.


code: virtual [FAssetSupportResponse](API\Editor\AssetDefinition\FAssetSupportResponse) CanDuplicate ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAsset ) const


description: Common Queries.

code: virtual [FAssetSupportResponse](API\Editor\AssetDefinition\FAssetSupportResponse) CanRename ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAsset ) const


code: virtual [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetAssetColor() const


description: UAssetDefinitionBegin.

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetAssetDisplayName() const


code: bool IsPartitionWorldInUse ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & InAsset ) const


description: UAssetDefinitionBegin.


description: Common Operations.

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > PrepareToActivateAssets ( const [FAssetActivateArgs](API\Editor\AssetDefinition\FAssetActivateArgs) & ActivateArgs ) const


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UAssetDefinition_World : public [UAssetDefinitionDefault](API\Editor\UnrealEd\UAssetDefinitionDefault)


code: void MarkResolved()


code: virtual TConstArrayView< [FAssetCategoryPath](API\Editor\AssetDefinition\Misc\FAssetCategoryPath) > GetAssetCategories() const


description: Called after applying a transaction to the object. Default implementation simply calls PostEditChange.

code: virtual void PostEditUndo()


code: void SetManagedObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


className: UUndoableResolveHandler

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UUndoableResolveHandler : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: EFOVScalingType

module: EnhancedInput

code: enum EFOVScalingType { Standard, UE4_BackCompat, }


className: EDeadZoneType

code: enum EDeadZoneType { Axial, Radial, }


className: EInputActionAccumulationBehavior

description: This is an advanced setting that allows you to change how the value of an Input Action is calculated when there are multiple mappings to the same Input Action. The default behavior is to accept highest absolute value.

code: enum EInputActionAccumulationBehavior { TakeHighestAbsoluteValue, Cumulative, }


className: EInputAxisSwizzle

code: enum EInputAxisSwizzle { YXZ, ZYX, XZY, YZX, ZXY, }


className: EInputActionValueType

code: enum EInputActionValueType { Boolean, Axis1D, Axis2D, Axis3D, }


className: EInputBindingClone

description: Used to force clone constructor calls only.

code: enum EInputBindingClone { ForceClone, }


className: EInputMappingRebuildType

code: enum EInputMappingRebuildType { None, Rebuild, RebuildWithFlush, }


className: EMappingQueryIssue

description: Mapping issues arising from a QueryMapKeyIn... call.

code: enum EMappingQueryIssue { NoIssue = 0x00, ReservedByAction = 0x01, HidesExistingMapping = 0x02, HiddenByExistingMapping = 0x04, CollisionWithMappingInSameContext = 0x08, ForcesTypePromotion = 0x10, ForcesTypeDemotion = 0x20, }


className: EMappingQueryResult

description: Result summary from a QueryMapKeyIn... call.

code: enum EMappingQueryResult { Error_EnhancedInputNotEnabled, Error_InputContextNotInActiveContexts, Error_InvalidAction, NotMappable, MappingAvailable, }


className: ETriggerEvent

description: Trigger events are the Action's interpretation of all Trigger State transitions that occurred for the action in the last tick

code: enum ETriggerEvent { None = (0x0), Triggered = (1 << 0), Started = (1 << 1), Ongoing = (1 << 2), Canceled = (1 << 3), Completed = (1 << 4), }


className: EPlayerMappableKeySettingBehaviors

description: Defines which Player Mappable Key Setting to use for a Action Key Mapping.

code: enum EPlayerMappableKeySettingBehaviors { InheritSettingsFromAction, OverrideSettings, IgnoreSettings, }


className: ETriggerEventsSupported

description: Represents what ETriggerEvent types can be triggered off of a giveUInputTrigger. Used to determine if a warning should be placed on a exec pin that would never get called on a K2Node_EnhancedInputAction node

code: enum ETriggerEventsSupported { None = (0x0), Instant = (1 << 0), Uninterruptible = (1 << 1), Ongoing = (1 << 2), All = (Instant | Uninterruptible | Ongoing), }


className: ETriggerState

description: Trigger states are a light weight interpretation of the provided input values used in trigger UpdateState responses.

code: enum ETriggerState { None, Ongoing, Triggered, }


className: ETriggerType

description: Trigger type determine how the trigger contributes to an action's overall trigger event the behavior of the trigger

code: enum ETriggerType { Explicit, Implicit, Blocker, }


className: FBlueprintEnhancedInputActionBinding

FunctionNameToBind

type: FName

InputAction

type: TObjectPtr< con...

TriggerEvent

type: ETriggerEvent


className: FBlueprintInputDebugKeyDelegateBinding

InputChord

type: FInputChord

InputKeyEvent

type: TEnumAsByte< EI...


className: FDefaultContextSetting

description: Represents a single input mapping context and the priority that it should be applied with

InputMappingContext

type: TSoftObjectPtr<...

description: Input Mapping Context that should be Added to the EnhancedInputEditorSubsystem when it starts listening for input

Priority

description: The prioirty that should be given to this mapping context when it is added


description: This is needed becauseTArray::operator==returns false when the objects' inner values differ. And for keeping old Trigger states, we need their comparison to ignore their current values.

code: template<typename T> static bool CompareByObjectTypes ( const [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< T >> & A, const [TArray](API\Runtime\Core\Containers\TArray)< [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< T >> & B )


description: If the template bIgnoreModifierAndTriggerValues is true, compare to Other ignoring different trigger states, like pending activation time, but only accept both as equal if the Trigger types are the same and in the same order.

code: template<bool bIgnoreModifierAndTriggerValues> bool Equals ( const [FEnhancedActionKeyMapping](API\Plugins\EnhancedInput\FEnhancedActionKeyMapping) & Other ) const


description: The localized display category of this key mapping

code: const [FText](API\Runtime\Core\Internationalization\FText) & GetDisplayCategory() const


description: The localized display name of this key mapping

code: const [FText](API\Runtime\Core\Internationalization\FText) & GetDisplayName() const


description: Returns the name of the mapping based on setting behavior used. If no name is found in the Mappable Key Settings it will return the name set in Player Mappable Options if bIsPlayerMappable is true.


code: template<typename T> T * GetPlayerMappableKeySettings() const


description: Returns the Player Mappable Key Settings owned by the Action Key Mapping or by the referenced Input Action, or nothing based of the Setting Behavior.


code: EDataValidationResult IsDataValid ( [FDataValidationContext](API\Runtime\CoreUObject\Misc\FDataValidationContext) & Context ) const


description: Returns true if this Action Key Mapping either holds a Player Mappable Key Settings or is set bIsPlayerMappable.

code: bool IsPlayerMappable() const


description: Identical comparison, including Triggers and Modifiers current inner values.

code: bool operator== ( const [FEnhancedActionKeyMapping](API\Plugins\EnhancedInput\FEnhancedActionKeyMapping) & Other ) const


code: FEnhancedActionKeyMapping ( const [UInputAction](API\Plugins\EnhancedInput\UInputAction) * InAction, const [FKey](API\Runtime\InputCore\FKey) InKey )


className: FEnhancedActionKeyMapping

description: Defines a mapping between a key activation and the resulting enhanced action An key could be a button press, joystick axis movement, etc. An enhanced action could be MoveForward, Jump, Fire, etc.

Action

description: Action to be affected by the key

bShouldBeIgnored

type: uint8:  1

description: If true, then this Key Mapping should be ignored.

Key

type: FKey

description: Key that affect the action.

Modifiers

type: TArray<TObject...

description: Modifiers applied to the raw key value.

PlayerMappableKeySettings

type: TObjectPtr<UPl...

description: Used to expose this mapping or to opt-out of settings completely.

SettingBehavior

type: EPlayerMappable...

Triggers

description: Trigger qualifiers.


code: void Execute ( const [FInputActionInstance](API\Plugins\EnhancedInput\FInputActionInstance) & ActionData ) const


code: const [UInputAction](API\Plugins\EnhancedInput\UInputAction) * GetAction() const


code: bool IsBoundToObject ( void const * Object ) const


code: void SetShouldFireWithEditorScriptGuard ( const bool bNewValue )


code: FEnhancedInputActionEventBinding()


code: FEnhancedInputActionEventBinding ( const [UInputAction](API\Plugins\EnhancedInput\UInputAction) * InAction, [ETriggerEvent](API\Plugins\EnhancedInput\ETriggerEvent) InTriggerEvent )