Engine.OnlineVoiceInterface

Modifiers

dependson ( OnlineSubsystem )

This interface deals with voice over IP. It is responsible for registering, unregistering, and filtering talkers. It also handles special voice effects. This interface also provides hooks for accessing the raw data to perform operations on it, such as speech recognition, lip sync, etc.

Engine.OnlineVoiceInterface

Delegates Summary
		OnPlayerTalking (UniqueNetId Player)
		OnRecognitionComplete ()

Functions Summary
		AddPlayerTalkingDelegate (delegate<OnPlayerTalking> TalkerDelegate)
		AddRecognitionCompleteDelegate (byte LocalUserNum, elegate<OnRecognitionComplete> RecognitionDelegate)
		ClearPlayerTalkingDelegate (delegate<OnPlayerTalking> TalkerDelegate)
		ClearRecognitionCompleteDelegate (byte LocalUserNum, elegate<OnRecognitionComplete> RecognitionDelegate)
	bool	GetRecognitionResults (byte LocalUserNum, ut array<SpeechRecognizedWord> Words)
	bool	IsHeadsetPresent (byte LocalUserNum)
	bool	IsLocalPlayerTalking (byte LocalUserNum)
	bool	IsRemotePlayerTalking (UniqueNetId PlayerId)
	bool	MuteAll (byte LocalUserNum, ool bAllowFriends)
	bool	MuteRemoteTalker (byte LocalUserNum, niqueNetId PlayerId)
	bool	RegisterLocalTalker (byte LocalUserNum)
	bool	RegisterRemoteTalker (UniqueNetId PlayerId)
	bool	SelectVocabulary (byte LocalUserNum, nt VocabularyId)
	bool	SetRemoteTalkerPriority (byte LocalUserNum, niqueNetId PlayerId, nt Priority)
	bool	SetSpeechRecognitionObject (byte LocalUserNum, peechRecognition SpeechRecogObj)
		StartNetworkedVoice (byte LocalUserNum)
	bool	StartSpeechRecognition (byte LocalUserNum)
		StopNetworkedVoice (byte LocalUserNum)
	bool	StopSpeechRecognition (byte LocalUserNum)
	bool	UnmuteAll (byte LocalUserNum)
	bool	UnmuteRemoteTalker (byte LocalUserNum, niqueNetId PlayerId)
	bool	UnregisterLocalTalker (byte LocalUserNum)
	bool	UnregisterRemoteTalker (UniqueNetId PlayerId)

OnPlayerTalking Source code

Called when a player is talking either locally or remote. This will be called once for each active talker each frame.
@param Player the player that is talking

OnRecognitionComplete Source code

Called when speech recognition for a given player has completed. The consumer of the notification can call GetRecognitionResults() to get the words that were recognized

AddPlayerTalkingDelegate Source code

Adds a talker delegate to the list of notifications
@param TalkerDelegate the delegate to call when a player is talking

AddRecognitionCompleteDelegate Source code

Adds the speech recognition notification callback to list of callbacks for the specified user
@param LocalUserNum the local user to receive notifications for
@param RecognitionDelegate the delegate to call when recognition is complete

ClearPlayerTalkingDelegate Source code

Removes a talker delegate to the list of notifications
@param TalkerDelegate the delegate to remove from the notification list

ClearRecognitionCompleteDelegate Source code

Clears the speech recognition notification callback to use for the specified user
@param LocalUserNum the local user to receive notifications for
@param RecognitionDelegate the delegate to call when recognition is complete

GetRecognitionResults Source code

Gets the results of the voice recognition Will not return results that were below the SpeechRecognition's ConfidenceThreshold, so you may get an empty array back
@param LocalUserNum the local user to read the results of
@param Words the set of words that were recognized by the voice analyzer
@return true upon success, false otherwise

IsHeadsetPresent Source code

Determines if the specified player has a headset connected
@param LocalUserNum the local player index being queried
@return TRUE if the player has a headset plugged in, FALSE otherwise

IsLocalPlayerTalking Source code

Determines if the specified player is actively talking into the mic
@param LocalUserNum the local player index being queried
@return TRUE if the player is talking, FALSE otherwise

IsRemotePlayerTalking Source code

Determines if the specified remote player is actively talking into the mic NOTE: Network latencies will make this not 100% accurate
@param PlayerId the unique id of the remote player being queried
@return TRUE if the player is talking, FALSE otherwise

MuteAll Source code

Mutes all voice or all but friends
@param LocalUserNum the local user that is making the change
@param bAllowFriends whether to mute everyone or allow friends

MuteRemoteTalker Source code

Mutes a remote talker for the specified local player. NOTE: This is separate from the user's permanent online mute list
@param LocalUserNum the user that is muting the remote talker
@param PlayerId the remote talker that is being muted
@return TRUE if the function succeeds, FALSE otherwise

RegisterLocalTalker Source code

Registers the user as a talker
@param LocalUserNum the local player index that is a talker
@return TRUE if the call succeeded, FALSE otherwise

RegisterRemoteTalker Source code

Registers a remote player as a talker
@param PlayerId the unique id of the remote player that is a talker
@return TRUE if the call succeeded, FALSE otherwise

SelectVocabulary Source code

Changes the vocabulary id that is currently being used
@param LocalUserNum the local user that is making the change
@param VocabularyId the new id to use
@return true if successful, false otherwise

SetRemoteTalkerPriority Source code

Sets the relative priority for a remote talker. 0 is highest
@param LocalUserNum the user that controls the relative priority
@param PlayerId the remote talker that is having their priority changed for
@param Priority the relative priority to use (0 highest, < 0 is muted)
@return TRUE if the function succeeds, FALSE otherwise

SetSpeechRecognitionObject Source code

Changes the object that is in use to the one specified
@param LocalUserNum the local user that is making the change
@param SpeechRecogObj the new object use
@param true if successful, false otherwise

StartNetworkedVoice Source code

Tells the voice layer that networked processing of the voice data is allowed for the specified player. This allows for push-to-talk style voice communication
@param LocalUserNum the local user to allow network transimission for

StartSpeechRecognition Source code

Tells the voice system to start tracking voice data for speech recognition
@param LocalUserNum the local user to recognize voice data for
@return true upon success, false otherwise

StopNetworkedVoice Source code

Tells the voice layer to stop processing networked voice support for the specified player. This allows for push-to-talk style voice communication
@param LocalUserNum the local user to disallow network transimission for

StopSpeechRecognition Source code

Tells the voice system to stop tracking voice data for speech recognition
@param LocalUserNum the local user to recognize voice data for
@return true upon success, false otherwise

UnmuteAll Source code

Allows all speakers to send voice
@param LocalUserNum the local user that is making the change

UnmuteRemoteTalker Source code

Allows a remote talker to talk to the specified local player. NOTE: This call will fail for remote talkers on the user's permanent online mute list
@param LocalUserNum the user that is allowing the remote talker to talk
@param PlayerId the remote talker that is being restored to talking
@return TRUE if the function succeeds, FALSE otherwise

UnregisterLocalTalker Source code

Unregisters the user as a talker
@param LocalUserNum the local player index to be removed
@return TRUE if the call succeeded, FALSE otherwise

UnregisterRemoteTalker Source code

Unregisters a remote player as a talker
@param PlayerId the unique id of the remote player to be removed
@return TRUE if the call succeeded, FALSE otherwise

defaultproperties
{
   Name="Default__OnlineVoiceInterface"
   ObjectArchetype=Interface'Core.Default__Interface'
}