Navigation
API > API/Runtime > API/Runtime/Media > API/Runtime/Media/IMediaOptions
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetMediaOption
(
const FName& Key, |
Get a Boolean media option. | IMediaOptions.h | |
double GetMediaOption
(
const FName& Key, |
Get a double precision floating point media option. | IMediaOptions.h | |
int64 GetMediaOption
(
const FName& Key, |
Get a signed integer media option. | IMediaOptions.h | |
FString GetMediaOption
(
const FName& Key, |
Get a string media option. | IMediaOptions.h | |
FText GetMediaOption
(
const FName& Key, |
Get a localized text media option. | IMediaOptions.h | |
virtual TSharedPtr< FDataContainer, ESPMode::ThreadSafe > GetMediaOption
(
const FName& Key, |
Get a complex data type media option. | IMediaOptions.h |
GetMediaOption(const FName &, bool)
Description
Get a Boolean media option.
| Name | GetMediaOption |
| Type | function |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaOptions.h |
| Include Path | #include "IMediaOptions.h" |
bool GetMediaOption
(
const FName & Key,
bool DefaultValue
) const
The option value.
Parameters
| Name | Remarks |
|---|---|
| Key | The name of the option to get. |
| DefaultValue | The default value to return if the option is not set. |
GetMediaOption(const FName &, double)
Description
Get a double precision floating point media option.
| Name | GetMediaOption |
| Type | function |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaOptions.h |
| Include Path | #include "IMediaOptions.h" |
double GetMediaOption
(
const FName & Key,
double DefaultValue
) const
The option value.
Parameters
| Name | Remarks |
|---|---|
| Key | The name of the option to get. |
| DefaultValue | The default value to return if the option is not set. |
GetMediaOption(const FName &, int64)
Description
Get a signed integer media option.
| Name | GetMediaOption |
| Type | function |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaOptions.h |
| Include Path | #include "IMediaOptions.h" |
int64 GetMediaOption
(
const FName & Key,
int64 DefaultValue
) const
The option value.
Parameters
| Name | Remarks |
|---|---|
| Key | The name of the option to get. |
| DefaultValue | The default value to return if the option is not set. |
GetMediaOption(const FName &, const FString &)
Description
Get a string media option.
| Name | GetMediaOption |
| Type | function |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaOptions.h |
| Include Path | #include "IMediaOptions.h" |
FString GetMediaOption
(
const FName & Key,
const FString & DefaultValue
) const
The option value.
Parameters
| Name | Remarks |
|---|---|
| Key | The name of the option to get. |
| DefaultValue | The default value to return if the option is not set. |
GetMediaOption(const FName &, const FText &)
Description
Get a localized text media option.
| Name | GetMediaOption |
| Type | function |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaOptions.h |
| Include Path | #include "IMediaOptions.h" |
FText GetMediaOption
(
const FName & Key,
const FText & DefaultValue
) const
The option value.
Parameters
| Name | Remarks |
|---|---|
| Key | The name of the option to get. |
| DefaultValue | The default value to return if the option is not set. |
GetMediaOption(const FName &, const TSharedPtr< FDataContainer, ESPMode::ThreadSafe > &)
Description
Get a complex data type media option.
| Name | GetMediaOption |
| Type | function |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaOptions.h |
| Include Path | #include "IMediaOptions.h" |
virtual TSharedPtr < FDataContainer , ESPMode::ThreadSafe > GetMediaOption
(
const FName & Key,
const TSharedPtr < FDataContainer , ESPMode::ThreadSafe > & DefaultValue
) const
The option value.
Parameters
| Name | Remarks |
|---|---|
| Key | The name of the option to get. |
| DefaultValue | The default value to return if the option is not set. |