Navigation
API > API/Plugins > API/Plugins/MediaViewer
Groups are identified by a single GUID. Items are identified by a single GUID. Library Items associate an item's GUID with a position in the Library. They are uniquely identified by an item GUID and a group GUID.
| Name | IMediaViewerLibrary |
| Type | class |
| Header File | /Engine/Plugins/Media/MediaViewer/Source/MediaViewer/Public/Library/IMediaViewerLibrary.h |
| Include Path | #include "Library/IMediaViewerLibrary.h" |
Syntax
class IMediaViewerLibrary
Structs
| Name | Remarks |
|---|---|
| FGroupItem |
Enums
Public
| Name | Remarks |
|---|---|
| EChangeType |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnChanged | TMulticastDelegate_TwoParams< void, TSharedRef< IMediaViewerLibrary >, EChangeType > | Library/IMediaViewerLibrary.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddGroup
(
const TSharedRef< FMediaViewerLibraryGroup >& InNewGroup |
Add a custom group to the Library. | Library/IMediaViewerLibrary.h | |
bool AddItem
(
const TSharedRef< FMediaViewerLibraryItem >& InNewItem |
Adds an item to the Library without place it in a group | Library/IMediaViewerLibrary.h | |
bool AddItemBelowItem
(
const TSharedRef< FMediaViewerLibraryItem >& InNewItem, |
Add an item below another item. | Library/IMediaViewerLibrary.h | |
bool AddItemToGroup
(
const TSharedRef< FMediaViewerLibraryItem >& InNewItem, |
Add an item to a group. | Library/IMediaViewerLibrary.h | |
bool CanRemoveGroup
(
const FGuid& InGroupIdToRemove |
Returns true if the group with this id can be removed. | Library/IMediaViewerLibrary.h | |
bool CanRemoveItem
(
const FGuid& InItemIdToRemove |
Returns true if this item can be removed from every group. | Library/IMediaViewerLibrary.h | |
bool CanRemoveItemFromGroup
(
const FGroupItem& InItemToRemove |
Returns true if this item can be removed from the group. | Library/IMediaViewerLibrary.h | |
int32 EmptyGroup
(
const FGuid& InGroupId |
Removes all items from a group. | Library/IMediaViewerLibrary.h | |
TSharedPtr< FMediaViewerLibraryItem > FindItemByValue
(
FName InItemType, |
Returns the first item that matches the item type and string value. | Library/IMediaViewerLibrary.h | |
const FGuid & GetDefaultGroupId() |
Library/IMediaViewerLibrary.h | ||
TSharedPtr< FMediaViewerLibraryGroup > GetGroup
(
const FGuid& InGroupId |
Return the group with the given id. Do not change guid or items manually. | Library/IMediaViewerLibrary.h | |
const TArray< TSharedRef< const FMediaViewerLibraryGroup > > & GetGroups() |
Return the list of groups. | Library/IMediaViewerLibrary.h | |
const FGuid & GetHistoryGroupId() |
Library/IMediaViewerLibrary.h | ||
TSharedPtr< FMediaViewerLibraryItem > GetItem
(
const FGuid& InItemId |
Retrieve the existing item for a given unique identifier. Do not change guid or group manually. | Library/IMediaViewerLibrary.h | |
TSharedPtr< FMediaViewerLibraryGroup > GetItemGroup
(
const FGuid& InItemId |
Finds the first group containing the given Item Id. | Library/IMediaViewerLibrary.h | |
FOnChanged::RegistrationType & GetOnChanged() |
When a changed is triggered, this event is triggered. | Library/IMediaViewerLibrary.h | |
const FGuid & GetSnapshotsGroupId() |
Library/IMediaViewerLibrary.h | ||
bool MoveItemBelowItem
(
const FGroupItem& InItemToMove, |
Move an already existing item below another, potentially changing its group. | Library/IMediaViewerLibrary.h | |
bool MoveItemToGroup
(
const FGroupItem& InItemToMove, |
Move an already existing to another group, adding it to the end of the group. | Library/IMediaViewerLibrary.h | |
bool MoveItemWithinGroup
(
const FGroupItem& InItemToMove, |
Move an already existing to another place inside its group. | Library/IMediaViewerLibrary.h | |
TSharedPtr< FMediaViewerLibraryGroup > RemoveGroup
(
const FGuid& InGroupIdToRemove |
Remove an existing group and any items in the group. | Library/IMediaViewerLibrary.h | |
void RemoveInvalidGroupItems
(
const FGuid& InGroup |
Scans the group and removes invalid entries. | Library/IMediaViewerLibrary.h | |
TSharedPtr< FMediaViewerLibraryItem > RemoveItem
(
const FGuid& InItemIdToRemove |
Return true if the item was removed from every group. | Library/IMediaViewerLibrary.h | |
bool RemoveItemFromGroup
(
const FGroupItem& InItemToRemove |
Return true if the item was removed from the group. | Library/IMediaViewerLibrary.h |