Mostly Harmless

UE2:StreamPlaylistManager (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2004 Object >> StreamBase >> StreamPlaylistManager
Package: 
Engine
Known classes within StreamPlaylistManager:
B4SParser, M3UParser, PlaylistParserBase, PLSParser

Created on: 10/14/2003 Manages custom playlists

Written by Ron Prestenback © 2003, Epic Games, Inc. All Rights Reserved

Properties[edit]

Property group 'StreamPlaylistManager'[edit]

bDirty[edit]

Type: bool

Modifiers: transient, noexport, protected


bDisableNotification[edit]

Type: bool

Modifiers: protected


bRepeat[edit]

Type: bool

Modifiers: protected, config


bRepeatAll[edit]

Type: bool

Modifiers: protected, config


Default value: True

bShuffle[edit]

Type: bool

Modifiers: protected, config


bShuffleAll[edit]

Type: bool

Modifiers: protected, config


CurrentPlaylist[edit]

Type: int

Modifiers: editconst, protected, config

Index of current playlist

DefaultPlaylistName[edit]

Type: string

Modifiers: localized


Default value: "New Playlist"

FileManager[edit]

Type: StreamInterface

Modifiers: editinline, editconst, noexport


Parsers[edit]

Type: array<PlaylistParserBase>

Modifiers: editconst, noexport, editinline, editconstarray


ParserType[edit]

Type: array<PlaylistParser>

Modifiers: config


Default value, index 0:

Member Value
ParserClass "Engine.B4SParser"
Type SPT_B4S

Default value, index 1:

Member Value
ParserClass "Engine.M3UParser"
Type SPT_M3U

Default value, index 2:

Member Value
ParserClass "Engine.PLSParser"
Type SPT_PLS

Playlists[edit]

Type: array<StreamPlaylist>

Modifiers: editinline, editconstarray, protected


Structs[edit]

PlaylistParser[edit]

StreamBase.EStreamPlaylistType Type 
string ParserClass 

Delegates[edit]

ChangedActivePlaylist[edit]

delegate ChangedActivePlaylist (StreamPlaylist NewPlaylist)


Instance functions[edit]

ActivatePlaylist[edit]

function bool ActivatePlaylist (int ListIndex, optional bool bNoFail)


AddDirectory[edit]

function bool AddDirectory (int PlaylistIndex, int InsertPosition, string Path, bool bRecurseDirectories)


AddPlaylist[edit]

function int AddPlaylist (out string NewPlaylistName)


AddToPlaylist[edit]

function bool AddToPlaylist (int PlaylistIndex, string Path, optional bool bSkipNotification)


AppendPlaylist[edit]

protected function int AppendPlaylist (StreamPlaylist Playlist)


ClearCurrentPlaylist[edit]

function bool ClearCurrentPlaylist ()


CreateDefaultPlaylist[edit]

protected function StreamPlaylist CreateDefaultPlaylist ()


CreatePlaylist[edit]

protected function StreamPlaylist CreatePlaylist (string PlaylistName)


FindNameIndex[edit]

function int FindNameIndex (string PlaylistName)


FindPlaylistIndex[edit]

function int FindPlaylistIndex (StreamPlaylist Playlist)


GetCurrentIndex[edit]

function int GetCurrentIndex ()


GetCurrentPlaylist[edit]

function StreamPlaylist GetCurrentPlaylist ()


GetCurrentTitle[edit]

function string GetCurrentTitle ()


GetPlaylistAt[edit]

function StreamPlaylist GetPlaylistAt (int idx)


GetPlaylistCount[edit]

function int GetPlaylistCount ()


GetPlaylistType[edit]

function StreamBase.EStreamPlaylistType GetPlaylistType (string Path)


GetRandomPlaylist[edit]

function StreamPlaylist GetRandomPlaylist ()


GetRandomSong[edit]

function string GetRandomSong ()


GetRepeat[edit]

function bool GetRepeat ()


GetRepeatAll[edit]

function bool GetRepeatAll ()


GetShuffle[edit]

function bool GetShuffle ()


GetShuffleAll[edit]

function bool GetShuffleAll ()


HandleDebugExec[edit]

function bool HandleDebugExec (string Command, string Param)

Overrides: StreamBase.HandleDebugExec


ImportPlaylist[edit]

function bool ImportPlaylist (int PlaylistIndex, int InsertPosition, string Path)


Initialize[edit]

function Initialize (StreamInterface InFileManager)


InitializeParsers[edit]

protected function InitializeParsers ()


InitializePlaylists[edit]

protected function InitializePlaylists ()


InsertInPlaylist[edit]

function bool InsertInPlaylist (int PlaylistIndex, int InsertPosition, string Path, optional bool bSkipNotification)


NextSong[edit]

function string NextSong (optional bool bForce)


PrevSong[edit]

function string PrevSong (optional bool bForce)


RemoveFromCurrentPlaylist[edit]

function bool RemoveFromCurrentPlaylist (string Path, optional bool bSkipNotification)


RemovePlaylist[edit]

function bool RemovePlaylist (string PlaylistName)


RemovePlaylistAt[edit]

function bool RemovePlaylistAt (int Index)


RenamePlaylist[edit]

function bool RenamePlaylist (int Index, out string NewName)


Save[edit]

function Save ()


SetRepeat[edit]

function SetRepeat (bool bEnable)


SetRepeatAll[edit]

function SetRepeatAll (bool bEnable)


SetShuffle[edit]

function SetShuffle (bool bEnable)


SetShuffleAll[edit]

function SetShuffleAll (bool bEnable)


ValidIndex[edit]

function bool ValidIndex (int Index)


ValidName[edit]

function bool ValidName (string Test)