UE2:StreamPlaylistManager (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
(Redirected from UE2:PlaylistParser (UT2004))
Jump to navigation Jump to search
UT2004 Object >> StreamBase >> StreamPlaylistManager
Package: 
Engine

Created on: 10/14/2003 Manages custom playlists

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

Properties

Property group 'StreamPlaylistManager'

bDirty

Type: bool

Modifiers: transient, noexport, protected


bDisableNotification

Type: bool

Modifiers: protected


bRepeat

Type: bool

Modifiers: protected, config


bRepeatAll

Type: bool

Modifiers: protected, config


Default value: True

bShuffle

Type: bool

Modifiers: protected, config


bShuffleAll

Type: bool

Modifiers: protected, config


CurrentPlaylist

Type: int

Modifiers: editconst, protected, config

Index of current playlist

DefaultPlaylistName

Type: string

Modifiers: localized


Default value: "New Playlist"

FileManager

Type: StreamInterface

Modifiers: editinline, editconst, noexport


Parsers

Type: array<PlaylistParserBase>

Modifiers: editconst, noexport, editinline, editconstarray


ParserType

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

Type: array<StreamPlaylist>

Modifiers: editinline, editconstarray, protected


Structs

PlaylistParser

StreamBase.EStreamPlaylistType Type 
string ParserClass 

Delegates

ChangedActivePlaylist

delegate ChangedActivePlaylist (StreamPlaylist NewPlaylist)


Instance functions

ActivatePlaylist

function bool ActivatePlaylist (int ListIndex, optional bool bNoFail)


AddDirectory

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


AddPlaylist

function int AddPlaylist (out string NewPlaylistName)


AddToPlaylist

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


AppendPlaylist

protected function int AppendPlaylist (StreamPlaylist Playlist)


ClearCurrentPlaylist

function bool ClearCurrentPlaylist ()


CreateDefaultPlaylist

protected function StreamPlaylist CreateDefaultPlaylist ()


CreatePlaylist

protected function StreamPlaylist CreatePlaylist (string PlaylistName)


FindNameIndex

function int FindNameIndex (string PlaylistName)


FindPlaylistIndex

function int FindPlaylistIndex (StreamPlaylist Playlist)


GetCurrentIndex

function int GetCurrentIndex ()


GetCurrentPlaylist

function StreamPlaylist GetCurrentPlaylist ()


GetCurrentTitle

function string GetCurrentTitle ()


GetPlaylistAt

function StreamPlaylist GetPlaylistAt (int idx)


GetPlaylistCount

function int GetPlaylistCount ()


GetPlaylistType

function StreamBase.EStreamPlaylistType GetPlaylistType (string Path)


GetRandomPlaylist

function StreamPlaylist GetRandomPlaylist ()


GetRandomSong

function string GetRandomSong ()


GetRepeat

function bool GetRepeat ()


GetRepeatAll

function bool GetRepeatAll ()


GetShuffle

function bool GetShuffle ()


GetShuffleAll

function bool GetShuffleAll ()


HandleDebugExec

function bool HandleDebugExec (string Command, string Param)

Overrides: StreamBase.HandleDebugExec


ImportPlaylist

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


Initialize

function Initialize (StreamInterface InFileManager)


InitializeParsers

protected function InitializeParsers ()


InitializePlaylists

protected function InitializePlaylists ()


InsertInPlaylist

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


NextSong

function string NextSong (optional bool bForce)


PrevSong

function string PrevSong (optional bool bForce)


RemoveFromCurrentPlaylist

function bool RemoveFromCurrentPlaylist (string Path, optional bool bSkipNotification)


RemovePlaylist

function bool RemovePlaylist (string PlaylistName)


RemovePlaylistAt

function bool RemovePlaylistAt (int Index)


RenamePlaylist

function bool RenamePlaylist (int Index, out string NewName)


Save

function Save ()


SetRepeat

function SetRepeat (bool bEnable)


SetRepeatAll

function SetRepeatAll (bool bEnable)


SetShuffle

function SetShuffle (bool bEnable)


SetShuffleAll

function SetShuffleAll (bool bEnable)


ValidIndex

function bool ValidIndex (int Index)


ValidName

function bool ValidName (string Test)