Photon Voice  v2.8
English | 日本語 | 한국
Public Attributes | Protected Member Functions | Properties | List of all members
PhotonVoiceView Class Reference

Component that should be attached to a networked PUN prefab that has PhotonView. It will bind remote Recorder with local Speaker of the same networked prefab. This component makes automatic voice stream routing easy for players' characters/avatars. More...

Inherits VoiceComponent.

Public Attributes

bool AutoCreateRecorderIfNotFound
 If true, a Recorder component will be added to the same GameObject if not found already. More...
 
bool UsePrimaryRecorder
 If true, PhotonVoiceNetwork.PrimaryRecorder will be used by this PhotonVoiceView More...
 
bool SetupDebugSpeaker
 If true, a Speaker component will be setup to be used for the DebugEcho mode More...
 

Protected Member Functions

override void Awake ()
 

Properties

Recorder RecorderInUse [get, set]
 The Recorder component currently used by this PhotonVoiceView More...
 
Speaker SpeakerInUse [get, set]
 The Speaker component currently used by this PhotonVoiceView More...
 
bool IsSetup [get, protected set]
 If true, this PhotonVoiceView is setup and ready to be used More...
 
bool IsSpeaker [get, protected set]
 If true, this PhotonVoiceView has a Speaker setup for playback of received audio frames from remote audio source More...
 
bool IsSpeaking [get]
 If true, this PhotonVoiceView has a Speaker that is currently playing received audio frames from remote audio source More...
 
bool IsRecorder [get, protected set]
 If true, this PhotonVoiceView has a Recorder setup for transmission of audio stream from local audio source More...
 
bool IsRecording [get]
 If true, this PhotonVoiceView has a Recorder that is currently transmitting audio stream from local audio source More...
 
- Properties inherited from VoiceComponent
VoiceLogger Logger [get, protected set]
 
DebugLevel LogLevel [get, set]
 
- Properties inherited from ILoggable
DebugLevel LogLevel [get, set]
 
VoiceLogger Logger [get]
 

Additional Inherited Members

- Protected Attributes inherited from VoiceComponent
DebugLevel logLevel = DebugLevel.ERROR
 

Detailed Description

Component that should be attached to a networked PUN prefab that has PhotonView. It will bind remote Recorder with local Speaker of the same networked prefab. This component makes automatic voice stream routing easy for players' characters/avatars.

Member Data Documentation

bool AutoCreateRecorderIfNotFound

If true, a Recorder component will be added to the same GameObject if not found already.

bool SetupDebugSpeaker

If true, a Speaker component will be setup to be used for the DebugEcho mode

bool UsePrimaryRecorder

If true, PhotonVoiceNetwork.PrimaryRecorder will be used by this PhotonVoiceView

Property Documentation

bool IsRecorder
getprotected set

If true, this PhotonVoiceView has a Recorder setup for transmission of audio stream from local audio source

bool IsRecording
get

If true, this PhotonVoiceView has a Recorder that is currently transmitting audio stream from local audio source

bool IsSetup
getprotected set

If true, this PhotonVoiceView is setup and ready to be used

bool IsSpeaker
getprotected set

If true, this PhotonVoiceView has a Speaker setup for playback of received audio frames from remote audio source

bool IsSpeaking
get

If true, this PhotonVoiceView has a Speaker that is currently playing received audio frames from remote audio source

Recorder RecorderInUse
getset

The Recorder component currently used by this PhotonVoiceView

Speaker SpeakerInUse
getset

The Speaker component currently used by this PhotonVoiceView