Engine.StreamPlaylistManager

Extends: StreamBase
Modifiers: Config ( UPlaylists )

Core.Object
|   
+-- Engine.StreamBase
   |   
   +-- Engine.StreamPlaylistManager

Constants Summary

Inherited Contants from Core.Object
MaxInt, Pi, RF_NotForClient, RF_NotForEdit, RF_NotForServer, RF_Public, RF_Standalone, RF_Transactional, RF_Transient

Variables Summary
StreamPlaylistManager
bool	bDirty
bool	bDisableNotification
bool	bRepeat
bool	bRepeatAll
bool	bShuffle
bool	bShuffleAll
int	CurrentPlaylist
string	DefaultPlaylistName
StreamInterface	FileManager
array<PlaylistParserBase>	Parsers
array<PlaylistParser>	ParserType
array<StreamPlaylist>	Playlists

Inherited Variables from Core.Object
Class, Name, ObjectFlags, ObjectInternal[7], Outer

Enumerations Summary

Inherited Enumerations from Engine.StreamBase
EFileType, EStreamPlaylistType

Inherited Enumerations from Core.Object
EAxis, ECamOrientation, EDetailMode, EDrawPivot, ESheerAxis

Structures Summary
PlaylistParser Type, ParserClass

Inherited Structures from Engine.StreamBase
FilePath, ID3Field

Inherited Structures from Core.Object
BoundingVolume, Box, Color, CompressedPosition, Coords, FloatBox, Guid, IntBox, InterpCurve, InterpCurvePoint, Matrix, Plane, Quat, Range, RangeVector, Rotator, Scale, TMultiMap, Vector

Delegates Summary
		ChangedActivePlaylist (StreamPlaylist NewPlaylist)

Functions Summary
	bool	ActivatePlaylist (int ListIndex, optional bool bNoFail)
	bool	AddDirectory (int PlaylistIndex, int InsertPosition, string Path, bool bRecurseDirectories)
	int	AddPlaylist (out string NewPlaylistName)
	bool	AddToPlaylist (int PlaylistIndex, string Path, optional bool bSkipNotification)
	int	AppendPlaylist (StreamPlaylist Playlist)
	bool	ClearCurrentPlaylist ()
	StreamPlaylist	CreateDefaultPlaylist ()
	StreamPlaylist	CreatePlaylist (string PlaylistName)
	int	FindNameIndex (string PlaylistName)
	int	FindPlaylistIndex (StreamPlaylist Playlist)
	int	GetCurrentIndex ()
	StreamPlaylist	GetCurrentPlaylist ()
	string	GetCurrentTitle ()
	StreamPlaylist	GetPlaylistAt (int idx)
	int	GetPlaylistCount ()
	EStreamPlaylistType	GetPlaylistType (string Path)
	StreamPlaylist	GetRandomPlaylist ()
	string	GetRandomSong ()
	bool	GetRepeat ()
	bool	GetRepeatAll ()
	bool	GetShuffle ()
	bool	GetShuffleAll ()
	bool	HandleDebugExec (string Command, string Param)
	bool	ImportPlaylist (int PlaylistIndex, int InsertPosition, string Path)
		Initialize (StreamInterface InFileManager)
		InitializeParsers ()
		InitializePlaylists ()
	bool	InsertInPlaylist (int PlaylistIndex, int InsertPosition, string Path, optional bool bSkipNotification)
	string	NextSong (optional bool bForce)
	string	PrevSong (optional bool bForce)
	bool	RemoveFromCurrentPlaylist (string Path, optional bool bSkipNotification)
	bool	RemovePlaylist (string PlaylistName)
	bool	RemovePlaylistAt (int Index)
	bool	RenamePlaylist (int Index, out string NewName)
		Save ()
		SetRepeat (bool bEnable)
		SetRepeatAll (bool bEnable)
		SetShuffle (bool bEnable)
		SetShuffleAll (bool bEnable)
	bool	ValidIndex (int Index)
	bool	ValidName (string Test)

Inherited Functions from Engine.StreamBase
, =, CompareNames, ConvertToFileExtension, ConvertToFileType, FormatTimeDisplay, GetPathRoot, GetPathSeparator, HandleDebugExec, HasExtension, IsCaseSensitive, ParseDirectories, ParseExtension, ParsePath, RevInStr

Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, , , =, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, AllObjects, Asc, Asin, Atan, BeginState, Caps, Ceil, Chr, Clamp, ClassIsChildOf, ClearConfig, ClockwiseFrom, Cos, Created, Cross, Disable, Divide, Dot, DynamicLoadObject, EatStr, Enable, EndState, Eval, Exp, FClamp, FindObject, FMax, FMin, FRand, GetAxes, GetEnum, GetItemName, GetPerObjectNames, GetPropertyText, GetReferencers, GetStateName, GetUnAxes, GotoState, InStr, InterpCurveEval, InterpCurveGetInputDomain, InterpCurveGetOutputRange, Invert, IsA, IsInState, IsOnConsole, IsSoaking, Left, Len, Lerp, Localize, Locs, Log, Loge, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, OrthoRotation, PlatformIs64Bit, PlatformIsMacOS, PlatformIsUnix, PlatformIsWindows, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RandRange, Repl, ReplaceText, ResetConfig, Right, RotRand, Round, SaveConfig, SetPropertyText, Sin, Smerp, Split, Sqrt, Square, StaticClearConfig, StaticSaveConfig, StopWatch, StrCmp, Tan, VRand, VSize, Warn, ^, ^^, \|, \|\|, ~, ~=

Inherited Functions from Core.Object

!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, AllObjects, Asc, Asin, Atan, BeginState, Caps, Ceil, Chr, Clamp, ClassIsChildOf, ClearConfig, ClockwiseFrom, Cos, Created, Cross, Disable, Divide, Dot, DynamicLoadObject, EatStr, Enable, EndState, Eval, Exp, FClamp, FindObject, FMax, FMin, FRand, GetAxes, GetEnum, GetItemName, GetPerObjectNames, GetPropertyText, GetReferencers, GetStateName, GetUnAxes, GotoState, InStr, InterpCurveEval, InterpCurveGetInputDomain, InterpCurveGetOutputRange, Invert, IsA, IsInState, IsOnConsole, IsSoaking, Left, Len, Lerp, Localize, Locs, Log, Loge, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, OrthoRotation, PlatformIs64Bit, PlatformIsMacOS, PlatformIsUnix, PlatformIsWindows, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RandRange, Repl, ReplaceText, ResetConfig, Right, RotRand, Round, SaveConfig, SetPropertyText, Sin, Smerp, Split, Sqrt, Square, StaticClearConfig, StaticSaveConfig, StopWatch, StrCmp, Tan, VRand, VSize, Warn, ^, ^^, |, ||, ~, ~=

Variables Detail

StreamPlaylistManager

bDirty Source code

var(StreamPlaylistManager) transient noexport protected bool bDirty;

bDisableNotification Source code

var(StreamPlaylistManager) protected bool bDisableNotification;

bRepeat Source code

var(StreamPlaylistManager) protected config bool bRepeat;

bRepeatAll Source code

var(StreamPlaylistManager) protected config bool bRepeatAll;

bShuffle Source code

var(StreamPlaylistManager) protected config bool bShuffle;

bShuffleAll Source code

var(StreamPlaylistManager) protected config bool bShuffleAll;

CurrentPlaylist Source code

var(StreamPlaylistManager) editconst protected config int CurrentPlaylist;

DefaultPlaylistName Source code

var(StreamPlaylistManager) localized string DefaultPlaylistName;

FileManager Source code

var(StreamPlaylistManager) editinline editconst noexport StreamInterface FileManager;

Parsers Source code

var(StreamPlaylistManager) editconst noexport editinline editconstarray array<PlaylistParserBase> Parsers;

ParserType Source code

var(StreamPlaylistManager) config array<PlaylistParser> ParserType;

Playlists Source code

var(StreamPlaylistManager) editinline editconstarray protected array<StreamPlaylist> Playlists;

Structures Detail

PlaylistParser Source code

struct PlaylistParser
{

var(StreamPlaylistManager) string ParserClass;
var(StreamPlaylistManager) EStreamPlaylistType Type;

};

Delegates Detail

ChangedActivePlaylist Source code

delegate ChangedActivePlaylist ( StreamPlaylist NewPlaylist )

Functions Detail

ActivatePlaylist Source code

function bool ActivatePlaylist ( int ListIndex, optional bool bNoFail )

AddDirectory Source code

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

AddPlaylist Source code

function int AddPlaylist ( out string NewPlaylistName )

AddToPlaylist Source code

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

AppendPlaylist Source code

protected function int AppendPlaylist ( StreamPlaylist Playlist )

ClearCurrentPlaylist Source code

function bool ClearCurrentPlaylist ( )

CreateDefaultPlaylist Source code

protected function StreamPlaylist CreateDefaultPlaylist ( )

CreatePlaylist Source code

protected function StreamPlaylist CreatePlaylist ( string PlaylistName )

FindNameIndex Source code

function int FindNameIndex ( string PlaylistName )

FindPlaylistIndex Source code

function int FindPlaylistIndex ( StreamPlaylist Playlist )

GetCurrentIndex Source code

function int GetCurrentIndex ( )

GetCurrentPlaylist Source code

function StreamPlaylist GetCurrentPlaylist ( )

GetCurrentTitle Source code

function string GetCurrentTitle ( )

GetPlaylistAt Source code

function StreamPlaylist GetPlaylistAt ( int idx )

GetPlaylistCount Source code

function int GetPlaylistCount ( )

GetPlaylistType Source code

function EStreamPlaylistType GetPlaylistType ( string Path )

GetRandomPlaylist Source code

function StreamPlaylist GetRandomPlaylist ( )

GetRandomSong Source code

function string GetRandomSong ( )

GetRepeat Source code

function bool GetRepeat ( )

GetRepeatAll Source code

function bool GetRepeatAll ( )

GetShuffle Source code

function bool GetShuffle ( )

GetShuffleAll Source code

function bool GetShuffleAll ( )

HandleDebugExec Source code

function bool HandleDebugExec ( string Command, string Param )

ImportPlaylist Source code

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

Initialize Source code

function Initialize ( StreamInterface InFileManager )

InitializeParsers Source code

protected function InitializeParsers ( )

InitializePlaylists Source code

protected function InitializePlaylists ( )

InsertInPlaylist Source code

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

NextSong Source code

function string NextSong ( optional bool bForce )

PrevSong Source code

function string PrevSong ( optional bool bForce )

RemoveFromCurrentPlaylist Source code

function bool RemoveFromCurrentPlaylist ( string Path, optional bool bSkipNotification )

RemovePlaylist Source code

function bool RemovePlaylist ( string PlaylistName )

RemovePlaylistAt Source code

function bool RemovePlaylistAt ( int Index )

RenamePlaylist Source code

function bool RenamePlaylist ( int Index, out string NewName )

Save Source code

function Save ( )

SetRepeat Source code

function SetRepeat ( bool bEnable )

SetRepeatAll Source code

function SetRepeatAll ( bool bEnable )

SetShuffle Source code

function SetShuffle ( bool bEnable )

SetShuffleAll Source code

function SetShuffleAll ( bool bEnable )

ValidIndex Source code

function bool ValidIndex ( int Index )

ValidName Source code

function bool ValidName ( string Test )

Defaultproperties

defaultproperties
{
     bRepeatAll=True
     DefaultPlaylistName="New Playlist"
     ParserType(0)=(Type=SPT_B4S,ParserClass="Engine.B4SParser")
     ParserType(1)=(Type=SPT_M3U,ParserClass="Engine.M3UParser")
     ParserType(2)=(Type=SPT_PLS,ParserClass="Engine.PLSParser")
}

Creation time: Wed 7/2/2007 19:16:17.421 - Created with UnCodeX