Interface IVivoxService#

The interface used to interact with the VivoxService

Namespace: Unity.Services.Vivox#

Syntax#

public interface IVivoxService

Properties#

ActiveChannels#

A Dictionary of channels the user is currently connected to and a list of the VivoxParticipants in each the channel. The key is the channel name used to connect with. The value is a maintained list of each VivoxParticipant in the channel.

Declaration#

ReadOnlyDictionary<string, ReadOnlyCollection<VivoxParticipant>> ActiveChannels { get; }

Property Value#

ActiveInputDevice#

The active input device being used by the local user.

Declaration#

VivoxInputDevice ActiveInputDevice { get; }

Property Value#

ActiveOutputDevice#

The active output device being used by the local user.

Declaration#

VivoxOutputDevice ActiveOutputDevice { get; }

Property Value#

AvailableInputDevices#

A collection of all available input devices for the local user.

Declaration#

ReadOnlyCollection<VivoxInputDevice> AvailableInputDevices { get; }

Property Value#

AvailableOutputDevices#

A collection of all available output devices for the local user.

Declaration#

ReadOnlyCollection<VivoxOutputDevice> AvailableOutputDevices { get; }

Property Value#

EffectiveInputDevice#

The real active input device being used by the local user. If the active input device that's in-use is a specific device, the value provided will match the ActiveInputDevice If the active input device is a virtual device such as default system device then this will provide the name of the underlying input device being used.

Declaration#

VivoxInputDevice EffectiveInputDevice { get; }

Property Value#

EffectiveOutputDevice#

The real active output device being used by the local user. If the active output device that's in-use is a specific device, the value provided will match the ActiveOutputDevice If the active output device is a virtual device such as default system device then this will provide the name of the underlying output device being used.

Declaration#

VivoxOutputDevice EffectiveOutputDevice { get; }

Property Value#

InputDeviceVolume#

The volume of your input.

Declaration#

int InputDeviceVolume { get; }

Property Value#

IsAudioEchoCancellationEnabled#

Indicates whether Vivox's software echo cancellation feature is enabled. Note: This is completely independent of any hardware-provided acoustic echo cancellation that might be available for a device.

Declaration#

bool IsAudioEchoCancellationEnabled { get; }

Property Value#

IsInjectingAudio#

Indicates whether audio is being injected or not.

Declaration#

bool IsInjectingAudio { get; }

Property Value#

IsInputDeviceMuted#

Indicates if input devices are muted.

Declaration#

bool IsInputDeviceMuted { get; }

Property Value#

IsLoggedIn#

Checks whether the user is logged in.

Declaration#

bool IsLoggedIn { get; }

Property Value#

IsOutputDeviceMuted#

Indicates if output devices are muted.

Declaration#

bool IsOutputDeviceMuted { get; }

Property Value#

OutputDeviceVolume#

The volume of your output.

Declaration#

int OutputDeviceVolume { get; }

Property Value#

SignedInPlayerId#

Declaration#

string SignedInPlayerId { get; }

Property Value#

TextToSpeechAvailableVoices#

A collection of all available voice profiles that can be used with text-to-speech. These values within can be used to set the current voice profile when provided to TextToSpeechSetVoice(String).

Declaration#

ReadOnlyCollection<string> TextToSpeechAvailableVoices { get; }

Property Value#

TextToSpeechCurrentVoice#

The name of the current voice being used when playback of a message occurs.

Declaration#

string TextToSpeechCurrentVoice { get; }

Property Value#

TransmittingChannels#

A collection of all channels that are transmitting. If the current transmission mode is set to Single, this will only show a single transmitting channel.

Declaration#

ReadOnlyCollection<string> TransmittingChannels { get; }

Property Value#

Methods#

BlockPlayerAsync(String)#

"Block" a player, bidirectionally muting audio/text between that player and the local user.

Declaration#

Task BlockPlayerAsync(string playerId)

Parameters#

Returns#

DeleteChannelTextMessageAsync(String, String)#

Deletes an already sent message in a Channel.

Declaration#

Task DeleteChannelTextMessageAsync(string channelName, string messageId)

Parameters#

Returns#

DeleteDirectTextMessageAsync(String)#

Deletes an already sent message in a Direct Message.

Declaration#

Task DeleteDirectTextMessageAsync(string messageId)

Parameters#

Returns#

DisableAcousticEchoCancellation()#

Disables Vivox's acoustic echo cancellation feature.

Declaration#

void DisableAcousticEchoCancellation()

DisableAutoVoiceActivityDetectionAsync()#

Disables automatic voice activity detection. Must be logged in to perform this action.

Declaration#

Task DisableAutoVoiceActivityDetectionAsync()

Returns#

EditChannelTextMessageAsync(String, String, String)#

Edits an already sent message in a Channel.

Declaration#

Task EditChannelTextMessageAsync(string channelName, string messageId, string newMessage)

Parameters#

Returns#

EditDirectTextMessageAsync(String, String)#

Edits an already sent message in a Direct Message.

Declaration#

Task EditDirectTextMessageAsync(string messageId, string newMessage)

Parameters#

Returns#

EnableAcousticEchoCancellation()#

Enables Vivox's acoustic echo cancellation feature.

Declaration#

void EnableAcousticEchoCancellation()

EnableAutoVoiceActivityDetectionAsync()#

Enables automatic configuration of voice activity detection properties by the SDK. If Automatic Voice Activity Detection is enabled, the properties set in SetVoiceActivityDetectionPropertiesAsync(Int32, Int32, Int32) will have no effect. Must be logged in to perform this action.

Declaration#

Task EnableAutoVoiceActivityDetectionAsync()

Returns#

GetChannelTextMessageHistoryAsync(String, Int32, ChatHistoryQueryOptions)#

Fetch Channel Text Messages for a given channel. Use ChatHistoryQueryOptions to filter what is returned.

Declaration#

Task<ReadOnlyCollection<VivoxMessage>> GetChannelTextMessageHistoryAsync(string channelName, int requestSize = 10, ChatHistoryQueryOptions chatHistoryQueryOptions = null)

Parameters#

Returns#

GetConversationsAsync(ConversationQueryOptions)#

Provides a collection of VivoxConversation objects representing conversations that the locally signed-in user has participated in. This can return a combination of channel conversations and directed message conversations. The VivoxConversation objects provided can be used to distinguish between the different ConversationType types.

Declaration#

Task<ReadOnlyCollection<VivoxConversation>> GetConversationsAsync(ConversationQueryOptions options = null)

Parameters#

Returns#

GetDirectTextMessageHistoryAsync(String, Int32, ChatHistoryQueryOptions)#

Fetch Direct Text Messages at an account level. Use ChatHistoryQueryOptions to filter what is returned.

Declaration#

Task<ReadOnlyCollection<VivoxMessage>> GetDirectTextMessageHistoryAsync(string playerId = null, int requestSize = 10, ChatHistoryQueryOptions chatHistoryQueryOptions = null)

Parameters#

Returns#

InitializeAsync(VivoxConfigurationOptions)#

Initializes the Client object which will enable a user to login and check/manage audio devices.

Declaration#

Task InitializeAsync(VivoxConfigurationOptions options = null)

Parameters#

Returns#

IsSpeechToTextEnabled(String)#

Indicates if Speech-to-Text transcription is enabled for a specific channel.

Declaration#

bool IsSpeechToTextEnabled(string channelName)

Parameters#

Returns#

JoinEchoChannelAsync(String, ChatCapability, ChannelOptions)#

Puts the user in an echo channel using channelName as the unique identifier. In this channel you will hear only your own voice played back at you. If you are not logged into the Vivox service when this is called, you will be automatically logged in.

Declaration#

Task JoinEchoChannelAsync(string channelName, ChatCapability chatCapability, ChannelOptions channelOptions = null)

Parameters#

Returns#

JoinGroupChannelAsync(String, ChatCapability, ChannelOptions)#

Puts the user in a 2-D group channel using channelName as the unique identifier. This channel type is similar to a traditional non-positional voice call. If you are not logged into the Vivox service when this is called, you will be automatically logged in.

Declaration#

Task JoinGroupChannelAsync(string channelName, ChatCapability chatCapability, ChannelOptions channelOptions = null)

Parameters#

Returns#

JoinPositionalChannelAsync(String, ChatCapability, Channel3DProperties, ChannelOptions)#

Puts the user in a 3-D/positional group channel using channelName as the unique identifier. This channel type is similar to having a conversation in-person involving nuances such as audio attenutation and falloff. The features of a positional channel can be configured by using the Channel3DProperties class. See this class for an in-depth explanation of these features. If you are not logged into the Vivox service when this is called, you will be automatically logged in.

Declaration#

Task JoinPositionalChannelAsync(string channelName, ChatCapability chatCapability, Channel3DProperties positionalChannelProperties, ChannelOptions channelOptions = null)

Parameters#

Returns#

LeaveAllChannelsAsync()#

Leaves all channels the currently logged in user is connected to, removing the user from text and voice for those channels.

Declaration#

Task LeaveAllChannelsAsync()

Returns#

LeaveChannelAsync(String)#

Leaves a specific channel, removing the user from text and voice for that channel.

Declaration#

Task LeaveChannelAsync(string channelName)

Parameters#

Returns#

LoginAsync(LoginOptions)#

Logs into the Vivox Service, enabling Vivox to perform actions like joining channels or sending directed messages.

Declaration#

Task LoginAsync(LoginOptions options = null)

Parameters#

Returns#

LogoutAsync()#

Logs out of the Vivox Service.

Declaration#

Task LogoutAsync()

Returns#

MuteInputDevice()#

Mutes the local user's input devices preventing the transmission of audio from any local input device.

Declaration#

void MuteInputDevice()

MuteOutputDevice()#

Mutes the local user's output devices preventing them from hearing incoming audio from any local output device.

Declaration#

void MuteOutputDevice()

SendChannelTextMessageAsync(String, String, MessageOptions)#

Sends a text message to a channel the user is connected to.

Declaration#

Task SendChannelTextMessageAsync(string channelName, string message, MessageOptions options = null)

Parameters#

Returns#

SendDirectTextMessageAsync(String, String, MessageOptions)#

Sends a text message to another logged in user.

Declaration#

Task SendDirectTextMessageAsync(string playerId, string message, MessageOptions options = null)

Parameters#

Returns#

Set3DPosition(GameObject, String, Boolean)#

Set the location of the local user for a specific positonail channel. Note: This version of Set3DPosition will use the same position for the user's "ears" and "mouth", making a slightly less accurate version of positional audio.

Declaration#

void Set3DPosition(GameObject participantObject, string channelName, bool allowPanning = true)

Parameters#

Set3DPosition(Vector3, Vector3, Vector3, Vector3, String, Boolean)#

Set the location of the local user for a specific positional channel.

Declaration#

void Set3DPosition(Vector3 speakerPos, Vector3 listenerPos, Vector3 listenerAtOrient, Vector3 listenerUpOrient, string channelName, bool allowPanning = true)

Parameters#

SetActiveInputDeviceAsync(VivoxInputDevice)#

Sets the specified input device as the active input device for the local user.

Declaration#

Task SetActiveInputDeviceAsync(VivoxInputDevice device)

Parameters#

Returns#

SetActiveOutputDeviceAsync(VivoxOutputDevice)#

Sets the specified output device as the active output device for the local user.

Declaration#

Task SetActiveOutputDeviceAsync(VivoxOutputDevice device)

Parameters#

Returns#

SetChannelTransmissionModeAsync(TransmissionMode, String)#

Changes the channel the local user is currently transmitting into. Options of transmission are all channels, no channels, or a single channel. If you are specifying a single channel, the channelName parameter is mandatory.

Declaration#

Task SetChannelTransmissionModeAsync(TransmissionMode transmissionMode, string channelName = null)

Parameters#

Returns#

SetChannelVolumeAsync(String, Int32)#

Sets the volume of an entire channel for the local user. This will adjust the volume of player audio for all players in a channel for the local user. Volume value is clamped between -50 and 50 with a default of 0.

Declaration#

Task SetChannelVolumeAsync(string channelName, int value)

Parameters#

Returns#

SetInputDeviceVolume(Int32)#

Sets the input device volume for the local user. This applies to all active audio sessions. Volume value is clamped between -50 and 50 with a default of 0.

Declaration#

void SetInputDeviceVolume(int value)

Parameters#

SetMessageAsReadAsync(VivoxMessage, Nullable<DateTime>)#

Declaration#

Task SetMessageAsReadAsync(VivoxMessage message, DateTime? seenAt = null)

Parameters#

Returns#

SetOutputDeviceVolume(Int32)#

Sets the output device volume for the local user. This applies to all active audio sessions. Volume value is clamped between -50 and 50 with a default of 0.

Declaration#

void SetOutputDeviceVolume(int value)

Parameters#

SetTokenProvider(IVivoxTokenProvider)#

Registers an IVivoxTokenProvider implementation that will be used to vend tokens for Vivox actions. Must be called before initializing the Vivox Service.

Declaration#

void SetTokenProvider(IVivoxTokenProvider tokenProvider)

Parameters#

SetVoiceActivityDetectionPropertiesAsync(Int32, Int32, Int32)#

Sets voice activity detection parameters. Parameters will be defaulted to their original default value if not provided. Call this with no parameters provided if you wish to reset the VAD settings. It is recommended to cache the settings and apply all of them each time this method is called. Must be logged in to perform this action.

Declaration#

Task SetVoiceActivityDetectionPropertiesAsync(int hangover = 2000, int noiseFloor = 576, int sensitivity = 43)

Parameters#

Returns#

SpeechToTextDisableTranscription(String)#

Disables the speech-to-text audio transcription inside a channel.

Declaration#

Task SpeechToTextDisableTranscription(string channelName)

Parameters#

Returns#

SpeechToTextEnableTranscription(String)#

Enables the speech-to-text audio transcription inside a channel.

Declaration#

Task SpeechToTextEnableTranscription(string channelName)

Parameters#

Returns#

StartAudioInjection(String)#

This function allows you to start audio injection. The audio file to use for audio injection should be of type WAV and MUST be single channel, 16-bit PCM, with the same sample rate as the negotiated audio codec. Injected audio is played only into the channels you're transmitting into.

Declaration#

void StartAudioInjection(string audioFilePath)

Parameters#

StopAudioInjection()#

This function allows you to stop audio injection

Declaration#

void StopAudioInjection()

TextToSpeechCancelAllMessages()#

Cancel all text-to-speech messages (ongoing and enqueued).

Declaration#

void TextToSpeechCancelAllMessages()

TextToSpeechCancelMessages(TextToSpeechMessageType)#

Cancels all text-to-speech messages of a particular TextToSpeechMessageType type (ongoing and enqueued).

Declaration#

void TextToSpeechCancelMessages(TextToSpeechMessageType messageType)

Parameters#

TextToSpeechSendMessage(String, TextToSpeechMessageType)#

Sends a text-to-speech message to the channel currently being transmitted into based on the TextToSpeechMessageType passed in. This method can also be used for local playback of text/messages exclusively.

Declaration#

void TextToSpeechSendMessage(string message, TextToSpeechMessageType messageType)

Parameters#

TextToSpeechSetVoice(String)#

Sets the current voice used when playback of a message occurs. TextToSpeechAvailableVoices contains a list of all available voice names that can be passed into this method when logged in.

Declaration#

void TextToSpeechSetVoice(string voiceName)

Parameters#

UnblockPlayerAsync(String)#

"Unblock" a player, bidirectionally unmuting audio/text between that player and the local user.

Declaration#

Task UnblockPlayerAsync(string playerId)

Parameters#

Returns#

UnmuteInputDevice()#

Unmutes the local user's input devices allowing the transmission of audio.

Declaration#

void UnmuteInputDevice()

UnmuteOutputDevice()#

Unmutes the local user's output devices allowing them to hear incoming audio.

Declaration#

void UnmuteOutputDevice()

Events#

AvailableInputDevicesChanged#

An action triggered when the input device list in refreshed/updated. An example of when this will fire is when an input device is disconnected from the primary device.

Declaration#

event Action AvailableInputDevicesChanged

Event Type#

AvailableOutputDevicesChanged#

An action triggered when the output device list in refreshed/updated. An example of when this will fire is when an output device is disconnected from the primary device.

Declaration#

event Action AvailableOutputDevicesChanged

Event Type#

ChannelJoined#

An action that will trigger when a Channel has been successfully joined by the currently logged in user. Once this event fires, the user will be in the selected text/audio state based on the ChatCapabilities of the channel, and will be able to do all channel actions. Provides the ChannelName of the channel successfully joined.

Declaration#

event Action<string> ChannelJoined

Event Type#

ChannelLeft#

An action that will trigger when a Channel has been successfully left by the currently logged in user. Once this event fires, the user will no longer be in the text/audio state for this channel, and will no longer be able to do any channel operations. Provides the ChannelName of the channel successfully left.

Declaration#

event Action<string> ChannelLeft

Event Type#

ChannelMessageDeleted#

An Action that will trigger when a channel message has been deleted in any channel the user is in. The VivoxMessage itself will contain the ChannelName of the channel it was sent in, the PlayerId of the Sender, and the MessageId that was deleted. The MessageText will be null.

Declaration#

event Action<VivoxMessage> ChannelMessageDeleted

Event Type#

ChannelMessageEdited#

An Action that will trigger when a channel message has been edited in any channel the user is in. The VivoxMessage itself will contain the ChannelName of the channel it was sent in, the PlayerId of the Sender, and the MessageId that was edited.

Declaration#

event Action<VivoxMessage> ChannelMessageEdited

Event Type#

ChannelMessageReceived#

An Action that will trigger when a channel message has been received in any channel the user is in. The VivoxMessage itself will contain ChannelName of the channel it was sent in, and the PlayerId and DisplayName of the Sender

Declaration#

event Action<VivoxMessage> ChannelMessageReceived

Event Type#

ConnectionFailedToRecover#

An Action that will fire when the network connection has been interrupted for over 30 seconds, and Vivox has halted attempts to reconnect.

Declaration#

event Action ConnectionFailedToRecover

Event Type#

ConnectionRecovered#

An action that will fire when the network connection has been successfully recovered.

Declaration#

event Action ConnectionRecovered

Event Type#

ConnectionRecovering#

An Action that will fire when the network connection for the logged-in device is interrupted. Vivox will attempt to re-establish connection for 30 seconds, firing ConnectionRecovered if the connection is recovered, or ConnectionFailedToRecover if there is a failure to reconnect.

Declaration#

event Action ConnectionRecovering

Event Type#

DirectedMessageDeleted#

An Action that will trigger when a direct message has been deleted in any channel the user is in. The VivoxMessage itself will have the PlayerId of the Player and the MessageId that was edited. The ChannelName and Message will be set to null.

Declaration#

event Action<VivoxMessage> DirectedMessageDeleted

Event Type#

DirectedMessageEdited#

An Action that will trigger when a direct message has been deleted in any channel the user is in. The VivoxMessage itself will have the PlayerId of the Player and the MessageId that was edited. The ChannelName will be set to null.

Declaration#

event Action<VivoxMessage> DirectedMessageEdited

Event Type#

DirectedMessageReceived#

An Action that will trigger when a directed message has been received by the currently logged in user. The VivoxMessage itself will have the PlayerId and DisplayName of the Player, and the ChannelName will be set to null.

Declaration#

event Action<VivoxMessage> DirectedMessageReceived

Event Type#

EffectiveInputDeviceChanged#

An action triggered when the effective input device changes. If the active input device is a virtual device such as default system device and the underlying device set in the system settings changes this event will be triggered.

Declaration#

event Action EffectiveInputDeviceChanged

Event Type#

EffectiveOutputDeviceChanged#

An action triggered when the effective output device changes. If the active output device is a virtual device such as default system device and the underlying device set in the system settings changes this event will be triggered.

Declaration#

event Action EffectiveOutputDeviceChanged

Event Type#

LoggedIn#

An action that will trigger when an Account is successfully LoggedIn to the Vivox Service.

Declaration#

event Action LoggedIn

Event Type#

LoggedOut#

An action that will trigger when an Account is successfully LoggedIn to the Vivox Service.

Declaration#

event Action LoggedOut

Event Type#

ParticipantAddedToChannel#

An Action that will trigger when a new Participant has been added to any channel the user is in. Provides a Participant object, which contains the Channel the participant is in, along with their PlayerId, DisplayName, whether speech has been detected, more specific audio energy changes and Muted status.

Declaration#

event Action<VivoxParticipant> ParticipantAddedToChannel

Event Type#

ParticipantRemovedFromChannel#

An Action that will trigger when a Participant has been removed from a channel the user is in. Provides a Participant object, which contains the Channel the participant is in, along with their PlayerId, DisplayName, whether speech has been detected, more specific audio energy changes and Muted status.

Declaration#

event Action<VivoxParticipant> ParticipantRemovedFromChannel

Event Type#

SpeechToTextMessageReceived#

An action that will trigger when a transcribed message is added. Provides the added transcribed message.

Declaration#

event Action<VivoxMessage> SpeechToTextMessageReceived

Event Type#