IMediaOptions Class Reference

#include <IMediaOptions.h>

Inheritance diagram for IMediaOptions:

Classes
class	FDataContainer

Public Member Functions
virtual FName	GetDesiredPlayerName () const =0
virtual bool	GetMediaOption (const FName &Key, bool DefaultValue) const =0
virtual double	GetMediaOption (const FName &Key, double DefaultValue) const =0
virtual int64	GetMediaOption (const FName &Key, int64 DefaultValue) const =0
virtual FString	GetMediaOption (const FName &Key, const FString &DefaultValue) const =0
virtual FText	GetMediaOption (const FName &Key, const FText &DefaultValue) const =0
virtual TSharedPtr< FDataContainer, ESPMode::ThreadSafe >	GetMediaOption (const FName &Key, const TSharedPtr< FDataContainer, ESPMode::ThreadSafe > &DefaultValue) const
virtual bool	HasMediaOption (const FName &Key) const =0
virtual const UObject *	ToUObject () const =0

Detailed Description

Interface for media options.

Member Function Documentation

GetDesiredPlayerName()

virtual FName IMediaOptions::GetDesiredPlayerName ( ) const

pure virtual

Get the name of the desired native player.

Returns

Native player name, or NAME_None to auto select.

Implemented in UBaseMediaSource, UMediaSource, and UPlatformMediaSource.

GetMediaOption() [1/6]

virtual bool IMediaOptions::GetMediaOption ( const FName &  Key, bool  DefaultValue  ) const

pure virtual

Get a Boolean media option.

Parameters

Key	The name of the option to get.
DefaultValue	The default value to return if the option is not set.

Returns

The option value.

Implemented in UFileMediaSource, UMediaSource, UPlatformMediaSource, and UTimeSynchronizableMediaSource.

GetMediaOption() [2/6]

virtual FString IMediaOptions::GetMediaOption ( const FName &  Key, const FString &  DefaultValue  ) const

pure virtual

Get a string media option.

Parameters

Key	The name of the option to get.
DefaultValue	The default value to return if the option is not set.

Returns

The option value.

Implemented in UMediaSource, UPlatformMediaSource, and UTimeSynchronizableMediaSource.

GetMediaOption() [3/6]

virtual FText IMediaOptions::GetMediaOption ( const FName &  Key, const FText &  DefaultValue  ) const

pure virtual

Get a localized text media option.

Parameters

Key	The name of the option to get.
DefaultValue	The default value to return if the option is not set.

Returns

The option value.

Implemented in UMediaSource, and UPlatformMediaSource.

GetMediaOption() [4/6]

virtual TSharedPtr< FDataContainer, ESPMode::ThreadSafe > IMediaOptions::GetMediaOption ( const FName &  Key, const TSharedPtr< FDataContainer, ESPMode::ThreadSafe > &  DefaultValue  ) const

inlinevirtual

Get a complex data type media option.

Parameters

Key	The name of the option to get.
DefaultValue	The default value to return if the option is not set.

Returns

The option value.

Reimplemented in UMediaSource.

GetMediaOption() [5/6]

virtual double IMediaOptions::GetMediaOption ( const FName &  Key, double  DefaultValue  ) const

pure virtual

Get a double precision floating point media option.

Parameters

Key	The name of the option to get.
DefaultValue	The default value to return if the option is not set.

Returns

The option value.

Implemented in UMediaSource, UPlatformMediaSource, and UTimeSynchronizableMediaSource.

GetMediaOption() [6/6]

virtual int64 IMediaOptions::GetMediaOption ( const FName &  Key, int64  DefaultValue  ) const

pure virtual

Get a signed integer media option.

Parameters

Key	The name of the option to get.
DefaultValue	The default value to return if the option is not set.

Returns

The option value.

Implemented in UMediaSource, UPlatformMediaSource, and UTimeSynchronizableMediaSource.

HasMediaOption()

virtual bool IMediaOptions::HasMediaOption ( const FName &  Key ) const

pure virtual

Check whether the specified option is set.

Parameters

Key	The name of the option to check.

Returns

true if the option is set, false otherwise.

Implemented in UFileMediaSource, UMediaSource, UPlatformMediaSource, and UTimeSynchronizableMediaSource.

ToUObject()

virtual const UObject * IMediaOptions::ToUObject ( ) const

pure virtual

Returns

a object that can be used by the UObject garbage collection system to keep this object alive. Players should not store a pointer of the interface but some players use the interface in async functionality and the object needs to be kept alive during those.

Implemented in UMediaSource.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Media/Public/IMediaOptions.h