Interface IVoiceService
An interface that represents the voice service.
Inherited Members
Namespace: Unity.Cloud.Presence
Syntax
public interface IVoiceService : IParticipantProvider<VoiceParticipant?>Properties
Connected
If the service is connected
Declaration
bool Connected { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Muted
Sets the local participant Mute status.
Declaration
bool Muted { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
MyVoiceParticipant
Gets the instance for the local VoiceParticipant. Sets to Null if participant is not connected.
Declaration
VoiceParticipant? MyVoiceParticipant { get; }Property Value
| Type | Description |
|---|---|
| Nullable<VoiceParticipant> |
VoiceId
Gets the local Vivox IParticipant.ParticipantId.
Declaration
VoiceId VoiceId { get; }Property Value
| Type | Description |
|---|---|
| VoiceId |
VoiceIntensity
Sets the intensity of the local participant voice. Normalized from 0.0 to 1.0.
Declaration
double VoiceIntensity { get; }Property Value
| Type | Description |
|---|---|
| Double |
Methods
JoinAsync()
Joins the voice service for the current room.
Declaration
Task JoinAsync()Returns
| Type | Description |
|---|---|
| Task | Returns a task representing the request to join the voice channel for the current room. |
LeaveAsync()
Leaves the current voice room.
Declaration
Task LeaveAsync()Returns
| Type | Description |
|---|---|
| Task | Returns a task representing the request to leave the current voice channel. |
Events
VoiceUpdated
Calls the methods in its invocation list when there is any change on any participant connected to the same voice channel.
Declaration
event Action<IEnumerable<VoiceParticipant>> VoiceUpdatedEvent Type
| Type | Description |
|---|---|
| Action<IEnumerable<VoiceParticipant>> |