I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

UE2:StreamInteraction (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2004 Object >> Interactions >> Interaction >> StreamInteraction
Package: 
Engine

Created on: 10/12/2003 Relays player input to the appropriate handlers on behalf of the streaming music system Relays notification of streaming music events to the appropriate handlers

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

Constants[edit]

INVALIDSONGHANDLE[edit]

Value: 0


Properties[edit]

Property group 'StreamInteraction'[edit]

bAutoStart[edit]

Type: bool

Modifiers: config

Whether to automatically start the stream player when the game is started

bDisplayTrackChanges[edit]

Type: bool

Modifiers: config

When new song begins, display the track name on the HUD for a few seconds

bRestartTrack[edit]

Type: bool

Modifiers: transient, editconst, noexport, protected

Used to restart stream after level change

bTrackWaiting[edit]

Type: bool

Modifiers: transient, editconst, noexport, protected

Used to switch tracks

CurrentSong[edit]

Type: string

Modifiers: editconst, noexport, protected


CurrentSongDuration[edit]

Type: float

Modifiers: editconst, noexport, protected


CurrentSongHandle[edit]

Type: int

Modifiers: editconst, noexport, protected


CurrentSongPosition[edit]

Type: float

Modifiers: editconst, noexport, protected


CurrentStreamAttachment[edit]

Type: Stream

Modifiers: editconst, noexport


FadeInSeconds[edit]

Type: float

Modifiers: config


Default value: 0.5

FadeOutSeconds[edit]

Type: float

Modifiers: config


Default value: 0.5

FileManager[edit]

Type: StreamInterface

Modifiers: editconst, noexport, editinline


LastPlayTime[edit]

Type: float

Modifiers: editconst, noexport, protected


PlaylistManager[edit]

Type: StreamPlaylistManager

Modifiers: editconst, noexport, editinline


PlaylistManagerType[edit]

Type: string

Modifiers: config


Default values[edit]

Property Value
bRequiresTick True

Delegates[edit]

OnAdjustVolume[edit]

delegate OnAdjustVolume (float NewVolume)


OnStreamChanged[edit]

delegate OnStreamChanged (string NewStreamFileName)


OnStreamingStopped[edit]

delegate OnStreamingStopped ()


Functions[edit]

Exec functions[edit]

GetCurrentStream[edit]

exec function string GetCurrentStream ()


NextSong[edit]

exec function NextSong (optional bool bForce)


PauseSong[edit]

exec function PauseSong ()


PlaySong[edit]

exec function PlaySong (string SongName, float InitialTime)


PrevSong[edit]

exec function PrevSong (optional bool bForce)


SeekStream[edit]

exec function SeekStream (float Seconds)


SetMusicVolume[edit]

exec function SetMusicVolume (float NewVolume)


StopSong[edit]

exec function StopSong ()


streamdebug[edit]

exec function streamdebug (string Command, string Param)


Native functions[edit]

IsPaused[edit]

native final function bool IsPaused (optional int SongHandle)


Events[edit]

Initialized[edit]

event Initialized ()

Overrides: Interaction.Initialized


NotifyLevelChange[edit]

event NotifyLevelChange ()

Overrides: Interaction.NotifyLevelChange


Tick[edit]

event Tick (float DeltaTime)

Overrides: Interaction.Tick


Other instance functions[edit]

ClearSongInfo[edit]

function ClearSongInfo ()


CreateFileManager[edit]

function StreamInterface CreateFileManager ()


CreatePlaylistManager[edit]

function StreamPlaylistManager CreatePlaylistManager ()


CurrentHandle[edit]

function int CurrentHandle ()


GetStreamDuration[edit]

function float GetStreamDuration ()


GetStreamPosition[edit]

function float GetStreamPosition ()


GetStreamVolume[edit]

function float GetStreamVolume ()


HasPlayer[edit]

function bool HasPlayer ()


IsPlaying[edit]

function bool IsPlaying ()


KillMusic[edit]

protected function KillMusic ()


PC[edit]

protected function PlayerController PC ()


PlayStream[edit]

function PlayStream (string FileName, optional int SeekSeconds)


QueueNextSong[edit]

function QueueNextSong ()


Seek[edit]

function bool Seek (float SeekSeconds)


SetStreamAttachment[edit]

function SetStreamAttachment (Stream StreamObj)


StreamFinished[edit]

function StreamFinished (int Handle, Interactions.EStreamFinishReason Reason)

Overrides: Interaction.StreamFinished