PSN category

Description

This category contains API elements related to PlayStation 4 games networked over the PlayStation Network (PSN).

Other related reference items

stingray.Network

Namespaces

stingray.QoSVoiceChat The interface to access QoSVoiceChat functionality on PlayStation 4.

Objects

stingray.PsnClient Represents a network node in a PlayStation Network (PSN) game.

stingray.PsnRoom Represents a room in a PlayStation Network (PSN) game.

stingray.PsnRoomBrowser The PsnRoomBrowser provides access to the list of game rooms available on the PlayStation Network (PSN).

Functions

init ( client, user_id ) Initializes QoSVoiceChat for the specified user.

Parameters

client :	stingray.PsnClient	The PSN client.
user_id :	integer	ID of the user with whom to init QoSVoiceChat.

Returns

This function does not return any values.

Note that QoSVoiceChat only works for one local user at a time.

Other related reference items

PSN

local_mute_status ( ) : boolean Returns the mute status of the local user.

Parameters

This function does not accept any parameters.

Returns

boolean

True if muted.

Other related reference items

PSN

mute_local ( mute ) Mutes or unmutes the local user.

Parameters

mute :

boolean

True for mute, false for unmute.

Returns

This function does not return any values.

Other related reference items

PSN

mute_remote ( peer_id, mute ) Mutes or unmutes a remote peer.

Parameters

peer_id :	string	Id of the peer to mute.
mute :	boolean	True for mute, false for unmute.

Returns

This function does not return any values.

Other related reference items

PSN

remote_mute_status ( peer_id ) : boolean Returns the mute status of a remote peer.

Parameters

peer_id :

string

Id of the peer to get mute status for.

Returns

boolean

True if muted.

Other related reference items

PSN

set_speaker_volume ( volume ) Sets the QoSVoiceChat speaker volume.

Parameters

volume :

number

Volume level to use.

Returns

This function does not return any values.

Other related reference items

PSN

shutdown ( ) Shuts down QoSVoiceChat and frees related resources.

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

Other related reference items

PSN

speaker_volume ( ) : number Returns the QoSVoiceChat speaker volume.

Parameters

This function does not accept any parameters.

Returns

number

Speaker volume level.

Other related reference items

PSN

Tables

network_psn_room_info Contains details about a single available room, returned by each call to stingray.PsnRoomBrowser.room().

network_psn_room_member Contains information about a single member of a PSN room, returned by each call to stingray.PsnRoom.member().