Worst-case scenario: the UEd Goblin wipes the map and burns down your house.

UE2:StreamInteraction (UT2004)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT2004 Object >> Interactions >> Interaction >> StreamInteraction

Contents
Package: 
Engine
This is an auto-generated page and may need human attention.
Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

[edit] Constants

[edit] INVALIDSONGHANDLE

Value: 0


[edit] Properties

[edit] Property group 'StreamInteraction'

[edit] bAutoStart

Type: bool

Modifiers: config

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

[edit] bDisplayTrackChanges

Type: bool

Modifiers: config

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

[edit] bRestartTrack

Type: bool

Modifiers: transient, editconst, noexport, protected

Used to restart stream after level change

[edit] bTrackWaiting

Type: bool

Modifiers: transient, editconst, noexport, protected

Used to switch tracks

[edit] CurrentSong

Type: string

Modifiers: editconst, noexport, protected


[edit] CurrentSongDuration

Type: float

Modifiers: editconst, noexport, protected


[edit] CurrentSongHandle

Type: int

Modifiers: editconst, noexport, protected


[edit] CurrentSongPosition

Type: float

Modifiers: editconst, noexport, protected


[edit] CurrentStreamAttachment

Type: Stream

Modifiers: editconst, noexport


[edit] FadeInSeconds

Type: float

Modifiers: config


Default value: 0.5

[edit] FadeOutSeconds

Type: float

Modifiers: config


Default value: 0.5

[edit] FileManager

Type: StreamInterface

Modifiers: editconst, noexport, editinline


[edit] LastPlayTime

Type: float

Modifiers: editconst, noexport, protected


[edit] PlaylistManager

Type: StreamPlaylistManager

Modifiers: editconst, noexport, editinline


[edit] PlaylistManagerType

Type: string

Modifiers: config


[edit] Default values

Property Value
bRequiresTick True

[edit] Delegates

[edit] OnAdjustVolume

delegate OnAdjustVolume (float NewVolume)


[edit] OnStreamChanged

delegate OnStreamChanged (string NewStreamFileName)


[edit] OnStreamingStopped

delegate OnStreamingStopped ()


[edit] Functions

[edit] Exec functions

[edit] GetCurrentStream

exec function string GetCurrentStream ()


[edit] NextSong

exec function NextSong (optional bool bForce)


[edit] PauseSong

exec function PauseSong ()


[edit] PlaySong

exec function PlaySong (string SongName, float InitialTime)


[edit] PrevSong

exec function PrevSong (optional bool bForce)


[edit] SeekStream

exec function SeekStream (float Seconds)


[edit] SetMusicVolume

exec function SetMusicVolume (float NewVolume)


[edit] StopSong

exec function StopSong ()


[edit] streamdebug

exec function streamdebug (string Command, string Param)


[edit] Native functions

[edit] IsPaused

native final function bool IsPaused (optional int SongHandle)


[edit] Events

[edit] Initialized

event Initialized ()

Overrides: Interaction.Initialized


[edit] NotifyLevelChange

event NotifyLevelChange ()

Overrides: Interaction.NotifyLevelChange


[edit] Tick

event Tick (float DeltaTime)

Overrides: Interaction.Tick


[edit] Other instance functions

[edit] ClearSongInfo

function ClearSongInfo ()


[edit] CreateFileManager

function StreamInterface CreateFileManager ()


[edit] CreatePlaylistManager

function StreamPlaylistManager CreatePlaylistManager ()


[edit] CurrentHandle

function int CurrentHandle ()


[edit] GetStreamDuration

function float GetStreamDuration ()


[edit] GetStreamPosition

function float GetStreamPosition ()


[edit] GetStreamVolume

function float GetStreamVolume ()


[edit] HasPlayer

function bool HasPlayer ()


[edit] IsPlaying

function bool IsPlaying ()


[edit] KillMusic

protected function KillMusic ()


[edit] PC

protected function PlayerController PC ()


[edit] PlayStream

function PlayStream (string FileName, optional int SeekSeconds)


[edit] QueueNextSong

function QueueNextSong ()


[edit] Seek

function bool Seek (float SeekSeconds)


[edit] SetStreamAttachment

function SetStreamAttachment (Stream StreamObj)


[edit] StreamFinished

function StreamFinished (int Handle, Interactions.EStreamFinishReason Reason)

Overrides: Interaction.StreamFinished


Retrieved from "http://wiki.beyondunreal.com/UE2:StreamInteraction_(UT2004)"