UE2:VoiceChatReplicationInfo (UT2004)

Object >> Actor >> Info >> ReplicationInfo >> VoiceChatReplicationInfo

Package:

Engine

Direct subclass:

UnrealVoiceReplicationInfo

Contains information about the existing voice chat channels on the server. This class is simply a placeholder for the VoiceReplicationInfo, and should be implemented in a multi-player capable subclass.

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

Constants

NUMPROPS

Value: 6

Properties

bAllowLocalBroadcast

Type: bool

Modifiers: globalconfig

Whether this server allows local channels

Default value: True

bEnableVoiceChat

Type: bool

Modifiers: globalconfig

Whether voice over IP is enabled on this server

Default value: True

bPrivateChat

Type: bool

Set by UnrealMPGameInfo.InitVoiceReplicationInfo()

bRefresh

Type: bool

Indicates a chat room has destroyed itself

BroadcastRadius

Type: float

Channels

Type: array<VoiceChatRoom>

Modifiers: protected

ChatRoomClass

Type: class<VoiceChatRoom>

Default value: Class'Engine.VoiceChatRoom'

DefaultBroadcastRadius

Type: float

Modifiers: globalconfig

Distance at which broadcast volume begins to fade

Default value: 20.0

DefaultChannel

Type: int

Channel that should be the default active channel for incoming clients that don't specify a default active channel

GRI

Type: GameReplicationInfo

InstalledCodec

Type: array<VoiceChatCodec>

Default value, index 0:

Member	Value
Codec	"CODEC_48NB"
CodecDescription	"(4.8kbps) - Uses less bandwidth, but sound is not as clear."
CodecName	"Less Bandwidth"

Default value, index 1:

Member	Value
Codec	"CODEC_96WB"
CodecDescription	"(9.6kbps) - Uses more bandwidth, but sound is much clearer."
CodecName	"Better Quality"

LocalBroadcastRange

Type: float

Modifiers: globalconfig

Maximum distance a local broadcast can be heard

Default value: 1000.0

LocalMask

Type: int

MaxChatters

Type: int

Modifiers: globalconfig

Max number of chatters allowed in a chatroom (0 - unlimited)

PublicChannelNames

Type: array<string>

Modifiers: localized

Default value, index 0: "Public"

Default value, index 1: "Local"

PublicMask

Type: int

VCDescText

Type: string

Array size: 6 (NUMPROPS)

Modifiers: localized

Default value, index 0: "Enable voice chat on the server."

Default value, index 1: "Determines whether the \"local\" voice chat channel is created, which allows players to broadcast voice transmissions to all players in the immediate vicinity."

Default value, index 2: "Maximum distance at which a broadcast on the local channel may be heard"

Default value, index 3: "Distance at which local broadcasts begin to fade"

Default value, index 4: "Configure which codecs exist on the server and should be used in Internet games."

Default value, index 5: "Configure which codecs exist on the server and should be used in LAN games."

VCDisplayText

Type: string

Array size: 6 (NUMPROPS)

Modifiers: localized

Default value, index 0: "Enable Voice Chat"

Default value, index 1: "Enable local Channel"

Default value, index 2: "Local Chat Range"

Default value, index 3: "Local Chat Radius"

Default value, index 4: "Allowed VoIP Codecs"

Default value, index 5: "Allowed VoIP LAN Codecs"

VoIPInternetCodecs

Type: array<string>

Modifiers: globalconfig

Default value: "CODEC_48NB"

VoIPLANCodecs

Type: array<string>

Modifiers: globalconfig

Default value, index 0: "CODEC_48NB"

Default value, index 1: "CODEC_96WB"

Default values

Property	Value
NetPriority	3.001

Structs

VoiceChatCodec

Modifiers: native

string Codec

string CodecName

string CodecDescription

Functions

Static events

GetDescriptionText

static event string GetDescriptionText (string PropName)

Overrides: Info.GetDescriptionText

Other static functions

FillPlayInfo

static function FillPlayInfo (PlayInfo PlayInfo)

Overrides: Info.FillPlayInfo

GetCodecInfo

static function bool GetCodecInfo (string Codec, out string CodecName, out string CodecDescription)

GetInstalledCodecs

static function GetInstalledCodecs (out array<string> Codecs)

Events

GetChannelCount

simulated event int GetChannelCount ()

GetChannelIndex

simulated event int GetChannelIndex (string ChannelTitle, optional int TeamIndex)

PostBeginPlay

event PostBeginPlay ()

Overrides: Actor.PostBeginPlay

PostNetBeginPlay

simulated event PostNetBeginPlay ()

Overrides: Actor.PostNetBeginPlay

Timer

event Timer ()

Overrides: Actor.Timer

Other instance functions

AddVoiceChannel

simulated function VoiceChatRoom AddVoiceChannel (optional PlayerReplicationInfo PRI)

AddVoiceChatter

simulated function AddVoiceChatter (PlayerReplicationInfo NewPRI)

CanJoinChannel

simulated function bool CanJoinChannel (string ChannelTitle, PlayerReplicationInfo PRI)

CheckChannels

simulated private function CheckChannels ()

CreateNewVoiceChannel

simulated protected function VoiceChatRoom CreateNewVoiceChannel (optional PlayerReplicationInfo PRI)

DestroyVoiceChannel

simulated protected function DestroyVoiceChannel (VoiceChatRoom Channel)

GetChannel

simulated function VoiceChatRoom GetChannel (string ChatRoomName, optional int TeamIndex)

GetChannelAt

simulated function VoiceChatRoom GetChannelAt (int Index)

GetChannelMembers

simulated function array<int> GetChannelMembers (string ChatRoomName, optional int TeamIndex)

GetChannelMembersAt

simulated function array<int> GetChannelMembersAt (int Index)

GetChannels

simulated function array<VoiceChatRoom> GetChannels ()

GetDefaultChannel

simulated function string GetDefaultChannel ()

GetMask

simulated function int GetMask (VoiceChatRoom Room)

GetMemberChannels

simulated function array<int> GetMemberChannels (PlayerReplicationInfo PRI)

GetPlayerChannelCount

simulated function int GetPlayerChannelCount ()

GetPlayerChannels

simulated function array<VoiceChatRoom> GetPlayerChannels ()

GetPublicChannelCount

simulated function int GetPublicChannelCount (optional bool bSingleTeam)

GetPublicChannels

simulated function array<VoiceChatRoom> GetPublicChannels ()

GetTitle

simulated function string GetTitle (VoiceChatRoom Room)

InitChannels

simulated function InitChannels ()

IsMember

simulated function bool IsMember (PlayerReplicationInfo TestPRI, int ChannelIndex, optional bool bNoCascade)

JoinChannel

function VoiceChatRoom.EJoinChatResult JoinChannel (string ChannelTitle, PlayerReplicationInfo PRI, string Password)

JoinChannelAt

function VoiceChatRoom.EJoinChatResult JoinChannelAt (int ChannelIndex, PlayerReplicationInfo PRI, string Password)

LeaveChannel

function bool LeaveChannel (string ChannelTitle, PlayerReplicationInfo PRI)

NotifyTeamChange

simulated function NotifyTeamChange (PlayerReplicationInfo PRI, int TeamIndex)

RemoveVoiceChannel

simulated function bool RemoveVoiceChannel (PlayerReplicationInfo PRI)

RemoveVoiceChatter

simulated function RemoveVoiceChatter (PlayerReplicationInfo PRI)

SetMask

function SetMask (VoiceChatRoom Room, int NewMask)

ValidRoom

simulated function bool ValidRoom (VoiceChatRoom Room)