Engine.StreamPlaylist

Extends: StreamBase
Modifiers: PerObjectConfig Config ( UPlaylists )

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

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
StreamPlaylist
bool	bNeedSave
int	Current
StreamInterface	FileManager
array<string>	Playlist
array<int>	RandomPool
array<Stream>	Songs
string	Title

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

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
		OnPlaylistChanged ()

Functions Summary
	int	AddSong (string SongFileName, optional bool bSkipNotification)
	int	AddStream (int Index, Stream NewStream, optional bool bSkipNotification)
	bool	ClearPlaylist ()
	Stream	CreateStream (string FileName)
		DebugInfo ()
	int	FindIndexByFileName (string Test)
	int	FindIndexByFullName (string Test)
	int	FindIndexByName (string Test)
	int	FindIndexByPath (string Test)
	int	GetCurrent ()
	Stream	GetCurrentStream ()
	int	GetPlaylistLength ()
	string	GetRandomSong ()
		GetSongs (out array<Stream> SongArray)
	Stream	GetStream (string StreamName)
	Stream	GetStreamAt (int Index)
	string	GetTitle ()
	bool	HandleDebugExec (string Command, string Param)
	bool	InitializePlaylist (StreamInterface InManager)
	int	InsertSong (int idx, string Path, optional bool bSkipNotification)
	bool	IsInitialized ()
	bool	LoadPlaylist ()
	string	NextSong (bool bMayRepeat)
	string	PrevSong (bool bMayRepeat)
	bool	RemoveSong (string SongFileName, optional bool bSkipNotification)
	bool	RemoveSongAt (int idx, optional bool bSkipNotification)
		ReplaceWith (StreamPlaylist Other)
		ResetRandomPool ()
		Save ()
	bool	SetCurrent (int Index)
	bool	SetSongs (array<Stream> NewSongs)
	bool	SetTitle (string NewTitle)
	bool	ValidStreamIndex (int Index)
	bool	ValidStreamName (string FileName)

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

StreamPlaylist

bNeedSave Source code

var(StreamPlaylist) protected config bool bNeedSave;

Current Source code

var(StreamPlaylist) protected config int Current;

FileManager Source code

var(StreamPlaylist) editinline editconst noexport protected StreamInterface FileManager;

Playlist Source code

var(StreamPlaylist) protected config array<string> Playlist;

RandomPool Source code

var(StreamPlaylist) editinline editconst noexport private editconstarray transient array<int> RandomPool;

Songs Source code

var(StreamPlaylist) editinline editconst noexport protected editconstarray array<Stream> Songs;

Title Source code

var(StreamPlaylist) protected string Title;

Delegates Detail

OnPlaylistChanged Source code

delegate OnPlaylistChanged ( )

Functions Detail

AddSong Source code

function int AddSong ( string SongFileName, optional bool bSkipNotification )

AddStream Source code

function int AddStream ( int Index, Stream NewStream, optional bool bSkipNotification )

ClearPlaylist Source code

function bool ClearPlaylist ( )

CreateStream Source code

function Stream CreateStream ( string FileName )

DebugInfo Source code

function DebugInfo ( )

FindIndexByFileName Source code

function int FindIndexByFileName ( string Test )

FindIndexByFullName Source code

function int FindIndexByFullName ( string Test )

FindIndexByName Source code

function int FindIndexByName ( string Test )

FindIndexByPath Source code

function int FindIndexByPath ( string Test )

GetCurrent Source code

function int GetCurrent ( )

GetCurrentStream Source code

function Stream GetCurrentStream ( )

GetPlaylistLength Source code

function int GetPlaylistLength ( )

GetRandomSong Source code

function string GetRandomSong ( )

GetSongs Source code

function GetSongs ( out array<Stream> SongArray )

GetStream Source code

function Stream GetStream ( string StreamName )

GetStreamAt Source code

function Stream GetStreamAt ( int Index )

GetTitle Source code

function string GetTitle ( )

HandleDebugExec Source code

function bool HandleDebugExec ( string Command, string Param )

InitializePlaylist Source code

function bool InitializePlaylist ( StreamInterface InManager )

InsertSong Source code

function int InsertSong ( int idx, string Path, optional bool bSkipNotification )

IsInitialized Source code

function bool IsInitialized ( )

LoadPlaylist Source code

function bool LoadPlaylist ( )

NextSong Source code

function string NextSong ( bool bMayRepeat )

PrevSong Source code

function string PrevSong ( bool bMayRepeat )

RemoveSong Source code

function bool RemoveSong ( string SongFileName, optional bool bSkipNotification )

RemoveSongAt Source code

function bool RemoveSongAt ( int idx, optional bool bSkipNotification )

ReplaceWith Source code

function ReplaceWith ( StreamPlaylist Other )

ResetRandomPool Source code

function ResetRandomPool ( )

Save Source code

function Save ( )

SetCurrent Source code

function bool SetCurrent ( int Index )

SetSongs Source code

function bool SetSongs ( array<Stream> NewSongs )

SetTitle Source code

function bool SetTitle ( string NewTitle )

ValidStreamIndex Source code

function bool ValidStreamIndex ( int Index )

ValidStreamName Source code

function bool ValidStreamName ( string FileName )

Defaultproperties

defaultproperties
{
     bNeedSave=True
}

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