Photon Voice  v2.8
English | 日本語 | 한국
Public Member Functions | Static Public Member Functions | Properties | List of all members
VoiceInfo Struct Reference

Describes stream properties. More...

Public Member Functions

override string ToString ()
 

Static Public Member Functions

static VoiceInfo CreateAudioOpus (POpusCodec.Enums.SamplingRate samplingRate, int channels, OpusCodec.FrameDuration frameDurationUs, int bitrate, object userdata=null)
 Create stream info for an Opus audio stream. More...
 

Properties

Codec Codec [get, set]
 
int SamplingRate [get, set]
 Audio sampling rate (frequency, in Hz). More...
 
int Channels [get, set]
 Source audio sampling rate (to be resampled to SamplingRate; in Hz). More...
 
int FrameDurationUs [get, set]
 Uncompressed frame (audio packet) size in microseconds. More...
 
int Bitrate [get, set]
 Target bitrate (in bits/second). More...
 
object UserData [get, set]
 Optional user data. Should be serializable by Photon. More...
 
int FrameDurationSamples [get]
 Uncompressed frame (data packet) size in samples. More...
 
int FrameSize [get]
 Uncompressed frame (data packet) array size. More...
 
int Width [get, set]
 Video width (optional). More...
 
int Height [get, set]
 Video height (optional) More...
 

Detailed Description

Describes stream properties.

Member Function Documentation

static VoiceInfo CreateAudioOpus ( POpusCodec.Enums.SamplingRate  samplingRate,
int  channels,
OpusCodec.FrameDuration  frameDurationUs,
int  bitrate,
object  userdata = null 
)
static

Create stream info for an Opus audio stream.

Parameters
samplingRateAudio sampling rate.
channelsNumber of channels.
frameDurationUsUncompressed frame (audio packet) size in microseconds.
bitrateStream bitrate (in bits/second).
userdataOptional user data. Should be serializable by Photon.
Returns
VoiceInfo instance.

Property Documentation

int Bitrate
getset

Target bitrate (in bits/second).

int Channels
getset

Source audio sampling rate (to be resampled to SamplingRate; in Hz).

int FrameDurationSamples
get

Uncompressed frame (data packet) size in samples.

int FrameDurationUs
getset

Uncompressed frame (audio packet) size in microseconds.

int FrameSize
get

Uncompressed frame (data packet) array size.

int Height
getset

Video height (optional)

int SamplingRate
getset

Audio sampling rate (frequency, in Hz).

object UserData
getset

Optional user data. Should be serializable by Photon.

int Width
getset

Video width (optional).