API reference
API reference
Select your platform
No SDKs available
No versions available

VoipAudioSourceHiLevel Class

Extends MonoBehaviour
A class that is used in OculusPlatform SDK to provide audio source helper functions and fields for high-level audio processing. Is used to hold a PCM source for receiving and decoding VoIP data. Read more about VoIP options here.

Protected Fields

pcmSource : IVoipPCMSource
Represents the PCM source that is used to read analogue data. It is of type IVoipPCMSource.
Signature
IVoipPCMSource Oculus.Platform.VoipAudioSourceHiLevel.pcmSource

Fields

audioSource : AudioSource
The AudioSource object that will be used to control the audio source such as muting and unmuting.
Signature
AudioSource Oculus.Platform.VoipAudioSourceHiLevel.audioSource
peakAmplitude : float
This field is used to indicate the peak ampltitude value of the audio source data.
Signature
float Oculus.Platform.VoipAudioSourceHiLevel.peakAmplitude

Properties

senderID : UInt64
[Set]
The ID of the sender of the PCM source. This is the User who is the source for the audio.
Signature
UInt64 Oculus.Platform.VoipAudioSourceHiLevel.senderID

Protected Methods

Awake ()
This function is used to initialize the VoipAudioSourceHiLevel. It is used to set up the PCM source and the audio source component attached to the game object.
Signature
void Oculus.Platform.VoipAudioSourceHiLevel.Awake()
Returns
void
CreatePCMSource ()
Signature
virtual void Oculus.Platform.VoipAudioSourceHiLevel.CreatePCMSource()
Returns
void
Stop ()
Signature
void Oculus.Platform.VoipAudioSourceHiLevel.Stop()
Returns
void

Protected Static Methods

MSToElements ( ms )
Converts delay in milliseconds to number of PCM elements to compare against PCM buffer to determine when to initiate playback.
Signature
static int Oculus.Platform.VoipAudioSourceHiLevel.MSToElements(int ms)
Parameters
ms: int
Returns
int

Inner Class

FilterReadDelegate Class

Extends MonoBehaviour
This is a delegate that exists as a surface for OnAudioFilterRead It will be called on unity's audio thread and has a custom filter to determine whether the audio system is able to handle the ring buffer size. It is a subclass of VoipAudioSourceHiLevel.

Fields

This field is used to hold a reference to the parent object which is a class type of VoipAudioSourceHiLevel.
Signature
VoipAudioSourceHiLevel Oculus.Platform.VoipAudioSourceHiLevel.FilterReadDelegate.parent