Class ClientSession<T>

Handles a client session. Requires an implementation of IAudioClient<T>, IAudioInput and IAudioOutputFactory each. Allows adding input and output filters and handles their execution.

Inheritance

System.Object

ClientSession<T>

Namespace: Adrenak.UniVoice

Assembly: cs.temp.dll.dll

Syntax

public class ClientSession<T> : IDisposable

Type Parameters

Name	Description
T

Constructors

ClientSession(IAudioClient<T>, IAudioInput, IAudioOutputFactory)

Declaration

public ClientSession(IAudioClient<T> client, IAudioInput input, IAudioOutputFactory outputFactory)

Parameters

Type	Name	Description
IAudioClient<T>	client
IAudioInput	input
IAudioOutputFactory	outputFactory

Properties

Client

Declaration

public IAudioClient<T> Client { get; set; }

Property Value

Type	Description
IAudioClient<T>

Input

The IAudioInput that's used for sourcing outgoing audio

Declaration

public IAudioInput Input { get; set; }

Property Value

Type	Description
IAudioInput

InputEnabled

Whether input audio will be processed. If set to false, any input audio captured by Input would be ignored and would neither be processed by the InputFilters nor send via the Client This can be used to create "Push to talk" style features without having to use YourVoiceSettings

Declaration

public bool InputEnabled { get; set; }

Property Value

Type	Description
System.Boolean

InputFilters

The input IAudioFilter that will be applied to the outgoing audio for all the peers. Note that filters are executed in the order they are present in this list

Declaration

public List<IAudioFilter> InputFilters { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<IAudioFilter>

OutputFactory

The IAudioOutputFactory that creates the IAudioOutput of peers

Declaration

public IAudioOutputFactory OutputFactory { get; set; }

Property Value

Type	Description
IAudioOutputFactory

OutputFilters

The output IAudioFilter that will be applied to the incoming audio for all the peers. Note that filters are executed in the order they are present in this list.

Declaration

public List<IAudioFilter> OutputFilters { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<IAudioFilter>

OutputsEnabled

Whether any incoming audio from peers would be processed. If set to false, all incoming peer audio is ignored, and would neither be processed by the OutputFilters nor outputted to the IAudioOutput of any peer. This can be used to easily mute all the peers on the network. Note that this doesn't stop the audio data from arriving and would consume bandwidth. Do stop reception completely use YourVoiceSettings

Declaration

public bool OutputsEnabled { get; set; }

Property Value

Type	Description
System.Boolean

PeerOutputs

The IAudioOutput instances of each peer in the session

Declaration

public Dictionary<T, IAudioOutput> PeerOutputs { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<T, IAudioOutput>

Methods

Dispose()

Declaration

public void Dispose()