UE2:StreamInteraction (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

INVALIDSONGHANDLE

Value: 0

Properties

Property group 'StreamInteraction'

bAutoStart

Type: bool

Modifiers: config

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

bDisplayTrackChanges

Type: bool

Modifiers: config

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

bRestartTrack

Type: bool

Modifiers: transient, editconst, noexport, protected

Used to restart stream after level change

bTrackWaiting

Type: bool

Modifiers: transient, editconst, noexport, protected

Used to switch tracks

CurrentSong

Type: string

Modifiers: editconst, noexport, protected

CurrentSongDuration

Type: float

Modifiers: editconst, noexport, protected

CurrentSongHandle

Type: int

Modifiers: editconst, noexport, protected

CurrentSongPosition

Type: float

Modifiers: editconst, noexport, protected

CurrentStreamAttachment

Type: Stream

Modifiers: editconst, noexport

FadeInSeconds

Type: float

Modifiers: config

Default value: 0.5

FadeOutSeconds

Type: float

Modifiers: config

Default value: 0.5

FileManager

Type: StreamInterface

Modifiers: editconst, noexport, editinline

LastPlayTime

Type: float

Modifiers: editconst, noexport, protected

PlaylistManager

Type: StreamPlaylistManager

Modifiers: editconst, noexport, editinline

PlaylistManagerType

Type: string

Modifiers: config

Default values

Property	Value
bRequiresTick	True

Delegates

OnAdjustVolume

delegate OnAdjustVolume (float NewVolume)

OnStreamChanged

delegate OnStreamChanged (string NewStreamFileName)

OnStreamingStopped

delegate OnStreamingStopped ()

Functions

Exec functions

GetCurrentStream

exec function string GetCurrentStream ()

NextSong

exec function NextSong (optional bool bForce)

PauseSong

exec function PauseSong ()

PlaySong

exec function PlaySong (string SongName, float InitialTime)

PrevSong

exec function PrevSong (optional bool bForce)

SeekStream

exec function SeekStream (float Seconds)

SetMusicVolume

exec function SetMusicVolume (float NewVolume)

StopSong

exec function StopSong ()

streamdebug

exec function streamdebug (string Command, string Param)

Native functions

IsPaused

native final function bool IsPaused (optional int SongHandle)

Events

Initialized

event Initialized ()

Overrides: Interaction.Initialized

NotifyLevelChange

event NotifyLevelChange ()

Overrides: Interaction.NotifyLevelChange

Tick

event Tick (float DeltaTime)

Overrides: Interaction.Tick

Other instance functions

ClearSongInfo

function ClearSongInfo ()

CreateFileManager

function StreamInterface CreateFileManager ()

CreatePlaylistManager

function StreamPlaylistManager CreatePlaylistManager ()

CurrentHandle

function int CurrentHandle ()

GetStreamDuration

function float GetStreamDuration ()

GetStreamPosition

function float GetStreamPosition ()

GetStreamVolume

function float GetStreamVolume ()

HasPlayer

function bool HasPlayer ()

IsPlaying

function bool IsPlaying ()

KillMusic

protected function KillMusic ()

PC

protected function PlayerController PC ()

PlayStream

function PlayStream (string FileName, optional int SeekSeconds)

QueueNextSong

function QueueNextSong ()

Seek

function bool Seek (float SeekSeconds)

SetStreamAttachment

function SetStreamAttachment (Stream StreamObj)

StreamFinished

function StreamFinished (int Handle, Interactions.EStreamFinishReason Reason)

Overrides: Interaction.StreamFinished