Class MediaPlaylist
Implements a media play list.
Inherited Members
Namespace: UE4.MediaAssets
Assembly: UE4DotNet.dll
Syntax
public class MediaPlaylist : UObject
Properties
| Improve this Doc View SourceDefaultObject
Get UE4 Default Object for this Class
Declaration
public static MediaPlaylist DefaultObject { get; }
Property Value
Type | Description |
---|---|
MediaPlaylist |
Items
List of media sources to play.
Declaration
public ObjectArrayField<MediaSource> Items { get; }
Property Value
Type | Description |
---|---|
ObjectArrayField<MediaSource> |
StaticClass
Get UE4 Class
Declaration
public static Class StaticClass { get; }
Property Value
Type | Description |
---|---|
Class |
Methods
| Improve this Doc View SourceAdd(MediaSource)
Add a media source to the play list.
Declaration
public bool Add(MediaSource MediaSource)
Parameters
Type | Name | Description |
---|---|---|
MediaSource | MediaSource |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
@param MediaSource The media source to append. @return true if the media source was added, false otherwise. @see AddFile, AddUrl, Insert, RemoveAll, Remove, Replace
AddFile(String)
Add a media file path to the play list.
Declaration
public bool AddFile(string FilePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | FilePath |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
@param FilePath The file path to add. @return true if the file was added, false otherwise. @see Add, AddUrl, Insert, RemoveAll, Remove, Replace
AddUrl(String)
Add a media URL to the play list.
Declaration
public bool AddUrl(string Url)
Parameters
Type | Name | Description |
---|---|---|
System.String | Url |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
@param Url The URL to add. @return true if the URL was added, false otherwise. @see Add, AddFile, Insert, RemoveAll, Remove, Replace
Get(Int32)
Get the media source at the specified index.
Declaration
public MediaSource Get(int Index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Index |
Returns
Type | Description |
---|---|
MediaSource |
Remarks
@param Index The index of the media source to get. @return The media source, or nullptr if the index doesn't exist. @see GetNext, GetRandom
GetNext()
Get the next media source in the play list.
Declaration
public (int, MediaSource) GetNext()
Returns
Type | Description |
---|---|
System.ValueTuple<System.Int32, MediaSource> |
Remarks
@param InOutIndex Index of the current media source (will contain the new index). @return The media source after the current one, or nullptr if the list is empty. @see , GetPrevious, GetRandom
GetPrevious()
Get the previous media source in the play list.
Declaration
public (int, MediaSource) GetPrevious()
Returns
Type | Description |
---|---|
System.ValueTuple<System.Int32, MediaSource> |
Remarks
@param InOutIndex Index of the current media source (will contain the new index). @return The media source before the current one, or nullptr if the list is empty. @see , GetNext, GetRandom
GetRandom()
Get a random media source in the play list.
Declaration
public (int, MediaSource) GetRandom()
Returns
Type | Description |
---|---|
System.ValueTuple<System.Int32, MediaSource> |
Remarks
@param OutIndex Will contain the index of the returned media source. @return The random media source, or nullptr if the list is empty. @see Get, GetNext, GetPrevious
Insert(MediaSource, Int32)
Insert a media source into the play list at the given position.
Declaration
public void Insert(MediaSource MediaSource, int Index)
Parameters
Type | Name | Description |
---|---|---|
MediaSource | MediaSource | |
System.Int32 | Index |
Remarks
@param MediaSource The media source to insert. @param Index The index to insert into. @see Add, Remove, RemoveAll, Replace
New(UObject, Name)
Spawn an object of this class
Declaration
public static MediaPlaylist New(UObject obj = null, Name name = default(Name))
Parameters
Type | Name | Description |
---|---|---|
UObject | obj | |
Name | name |
Returns
Type | Description |
---|---|
MediaPlaylist |
Num()
Get the number of media sources in the play list.
Declaration
public int Num()
Returns
Type | Description |
---|---|
System.Int32 |
Remarks
@return Number of media sources.
Remove(MediaSource)
Remove all occurrences of the given media source in the play list.
Declaration
public bool Remove(MediaSource MediaSource)
Parameters
Type | Name | Description |
---|---|---|
MediaSource | MediaSource |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
@param MediaSource The media source to remove. @return true if the media source was removed, false otherwise. @see Add, Insert, Remove, Replace
RemoveAt(Int32)
Remove the media source at the specified position.
Declaration
public bool RemoveAt(int Index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Index |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
@param Index The index of the media source to remove. @return true if the media source was removed, false otherwise. @see Add, Insert, RemoveAll, Replace
Replace(Int32, MediaSource)
Replace the media source at the specified position.
Declaration
public bool Replace(int Index, MediaSource Replacement)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | Index | |
MediaSource | Replacement |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
@param Index The index of the media source to replace. @param Replacement The replacement media source. @return true if the media source was replaced, false otherwise. @see Add, Insert, RemoveAll, RemoveAt
Operators
| Improve this Doc View SourceImplicit(IntPtr to MediaPlaylist)
Convert from IntPtr to UObject
Declaration
public static implicit operator MediaPlaylist(IntPtr p)
Parameters
Type | Name | Description |
---|---|---|
System.IntPtr | p |
Returns
Type | Description |
---|---|
MediaPlaylist |