$voip

75 natives. Read-only natives only look things up; the rest change something. Parameter types use the language's names (Types).

clear_desired_channel_name

$voip.clear_desired_channel_name() -> bool

Clear the desired VOIP channel name.

Returns bool: True if the desired channel name was cleared.

clear_muted_users

$voip.clear_muted_users()

Clear the muted users list.

connect

read-only

$voip.connect() -> bool

Start the user connecting to the VOIP service

Returns bool: True if the connection request was issued successfully.

disable_active_channel_transcription

$voip.disable_active_channel_transcription(channel_id: string) -> bool

Disable transcription for the specified VOIP channel

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to query

Returns bool: True if request issued successfully, false otherwise.

disconnect

$voip.disconnect() -> bool

Disconnect from the VOIP service.

Returns bool: True if the disconnect request was issued successfully.

enable_active_channel_transcription

$voip.enable_active_channel_transcription(channel_id: string) -> bool

Enable transcription for the specified VOIP channel

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to query

Returns bool: True if request issued successfully, false otherwise.

get_active_capture_device_index

read-only

$voip.get_active_capture_device_index() -> int

Get the index of the active VOIP capture device.

Returns int: The index of the active VOIP capture device.

get_active_channel_count

read-only

$voip.get_active_channel_count() -> int

Get the count of how many VOIP channels are active.

Returns int: The count of active VOIP channels

get_active_channel_id

read-only

$voip.get_active_channel_id(index: int) -> string

Get the name of the specified VOIP channel.

Parameter	Type	Meaning
index	int	The index of the active channel

Returns string: The name of the VOIP channel

get_active_channel_participant_count

read-only

$voip.get_active_channel_participant_count(channel_id: string) -> int

Get the number of participants in the specified VOIP channel

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to query

Returns int: The number of participants in the channel

get_active_channel_participant_display_name

read-only

$voip.get_active_channel_participant_display_name(channel_id: string, participant_index: int) -> string

Get the display name of a participant in the specified VOIP channel

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to query
participant_index	int	Index of the channel participant.

Returns string: Display name of the participant.

get_active_channel_participant_is_current_user

read-only

$voip.get_active_channel_participant_is_current_user(channel_id: string, participant_index: int) -> bool

Get the display name of a participant in the specified VOIP channel

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to query
participant_index	int	Index of the channel participant.

Returns bool: True if the specified participant is the current user.

get_active_channel_participant_is_speaking

read-only

$voip.get_active_channel_participant_is_speaking(channel_id: string, participant_index: int) -> bool

Is the participant in the specified VOIP channel currently speaking?

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to query
participant_index	int	Index of the channel participant.

Returns bool: True if the specified participant is speaking.

get_active_channel_participant_user

read-only

$voip.get_active_channel_participant_user(channel_id: string, participant_index: int) -> User

Get the Velan user of a participant in the specified VOIP channel

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to query
participant_index	int	Index of the channel participant.

Returns User: The user handle of the participant

get_active_render_device_index

read-only

$voip.get_active_render_device_index() -> int

Get the index of the active VOIP render device.

Returns int: The index of the active VOIP render device.

get_capture_device_count

read-only

$voip.get_capture_device_count() -> int

Get the number of VOIP capture devices.

Returns int: The number of available VOIP capture devices.

get_capture_device_display_name

read-only

$voip.get_capture_device_display_name(device_index: int) -> string

Get the display name of the specified VOIP capture device.

Parameter	Type	Meaning
device_index	int	The index of the capture device to get the display name of.

Returns string: The display name of the specified VOIP capture device.

get_capture_device_identifier

read-only

$voip.get_capture_device_identifier(device_index: int) -> string

Get the device identifier of the specified VOIP capture device.

Parameter	Type	Meaning
device_index	int	The index of the capture device to get the identifier name of.

Returns string: The device identifier of the specified VOIP capture device.

get_capture_volume

read-only

$voip.get_capture_volume() -> int

Get the VOIP capture device volume.

Returns int: The capture volume in the range 0-100.

get_desired_channel_name

read-only

$voip.get_desired_channel_name() -> string

Get the desired VOIP channel name that was set using `set_desired_channel_name`.

Returns string: The desired channel name

get_received_text_message_count

read-only

$voip.get_received_text_message_count(last_id: int) -> int

Get the number of messages received since the message with the specified id.

Parameter	Type	Meaning
last_id	int	The id of the last message to read from.

Returns int: The received message count.

get_received_text_message_id

read-only

$voip.get_received_text_message_id(last_id: int, message_index: int) -> int

Get the message ID of the nth received message

Parameter	Type	Meaning
last_id	int	The id of the last message to read from.
message_index	int	Index of the message to read.

Returns int: The ID of the specified message.

get_received_text_message_text

read-only

$voip.get_received_text_message_text(last_id: int, message_index: int) -> string

Get the message text of the nth received message

Parameter	Type	Meaning
last_id	int	The id of the last message to read from.
message_index	int	Index of the message to read.

Returns string: The text of the specified message.

get_received_text_message_user

read-only

$voip.get_received_text_message_user(last_id: int, message_index: int) -> User

The Velan user id of the specified message sender

Parameter	Type	Meaning
last_id	int	The id of the last message to read from.
message_index	int	Index of the message to read.

Returns User: The Velan user of the message sender

get_received_text_message_was_sent_by_current_user

read-only

$voip.get_received_text_message_was_sent_by_current_user(last_id: int, message_index: int) -> bool

Was the sender of the specified message the currently logged in user?

Parameter	Type	Meaning
last_id	int	The id of the last message to read from.
message_index	int	Index of the message to read.

Returns bool: True if the message sender was the current user, False otherwise.

get_render_device_count

read-only

$voip.get_render_device_count() -> int

Get the number of VOIP render devices.

Returns int: The number of available VOIP render devices.

get_render_device_display_name

read-only

$voip.get_render_device_display_name(device_index: int) -> string

Get the display name of the specified VOIP render device.

Parameter	Type	Meaning
device_index	int	The index of the render device to get the display name of.

Returns string: The display name of the specified VOIP render device.

get_render_device_identifier

read-only

$voip.get_render_device_identifier(device_index: int) -> string

Get the device identifier of the specified VOIP render device.

Parameter	Type	Meaning
device_index	int	The index of the render device to get the identifier of.

Returns string: The device identifier of the specified VOIP render device.

get_render_volume

read-only

$voip.get_render_volume() -> int

Get the VOIP render device volume.

Returns int: The render volume in the range 0-100.

get_tts_voice_count

read-only

$voip.get_tts_voice_count() -> int

Get the number of available TTS voices.

Returns int: The number of available TTS voices.

get_tts_voice_name

read-only

$voip.get_tts_voice_name(voice_index: int) -> string

Get the name of the specified TTS voice.

Parameter	Type	Meaning
voice_index	int	The index of the TTS voice to query.

Returns string: The name of the specified TTS voice.

is_active_channel_audio_connected

$voip.is_active_channel_audio_connected(channel_id: string) -> bool

Is the audio stream connected for the specified VOIP channel?

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to query

Returns bool: True if audio is connected on the specified channel, false otherwise.

is_active_channel_text_connected

$voip.is_active_channel_text_connected(channel_id: string) -> bool

Is the text stream connected for the specified VOIP channel?

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to query

Returns bool: True if audio is connected on the specified channel, false otherwise.

is_active_channel_transcription_disabling

$voip.is_active_channel_transcription_disabling(channel_id: string) -> bool

Is transcription being disabled for the specified VOIP channel?

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to query

Returns bool: True if transcription is currently disabling on the specified channel, false otherwise.

is_active_channel_transcription_enabled

$voip.is_active_channel_transcription_enabled(channel_id: string) -> bool

Is transcription enabled for the specified VOIP channel?

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to query

Returns bool: True if transcription is enabled on the specified channel, false otherwise.

is_active_channel_transcription_enabling

$voip.is_active_channel_transcription_enabling(channel_id: string) -> bool

Is transcription being enabled for the specified VOIP channel?

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to query

Returns bool: True if transcription is currently enabling on the specified channel, false otherwise.

is_allowed

read-only

$voip.is_allowed(target_user: User, refresh_if_disabled: bool) -> bool

Is VOIP allowed with the specified target user? If no target user is specified, checks if VOIP is allowed with any user.

Parameter	Type	Meaning
target_user	User	The user to chat with. Can be null to query if any user can chat.
refresh_if_disabled	bool	True to force a refresh of the global chat privilege if currently disallowed. May trigger a system dialog.

Returns bool: True if the local user can chat with the target user. Note that this can change while the app is running.

is_allowed_checked

read-only

$voip.is_allowed_checked(target_user: User) -> bool

Is the VOIP allowed status for a given user finished updating?

Parameter	Type	Meaning
target_user	User	The user to chat with.

Returns bool: True if the status for VOIP is available for the given user.

is_available

read-only

$voip.is_available() -> bool

Is VOIP available?

Returns bool: True if the VOIP server is available?

is_connected

read-only

$voip.is_connected() -> bool

Is the user connected to the VOIP service?

Returns bool: True if the user is connected to the VOIP service.

is_connecting

read-only

$voip.is_connecting() -> bool

Is the user connecting to the VOIP service?

Returns bool: True if the user is connecting to the VOIP service.

is_disconnecting

read-only

$voip.is_disconnecting() -> bool

Is the user disconnecting from the VOIP service?

Returns bool: True if the user is disconnecting from the VOIP service.

is_joining_channel

read-only

$voip.is_joining_channel(channel: string) -> bool

Is the user joining the specified channel?

Parameter	Type	Meaning
channel	string	The name of the channel

Returns bool: True if the user is joining the specified channel.

is_leaving_channel

read-only

$voip.is_leaving_channel(channel: string) -> bool

Is the user leaving the specified channel?

Parameter	Type	Meaning
channel	string	The name of the channel

Returns bool: True if the user is leaving the specified channel.

is_local_user_mic_muted

read-only

$voip.is_local_user_mic_muted() -> bool

Is the local user's mic muted?

Returns bool: True if the user's mic is muted, False otherwise.

is_local_user_speaker_muted

read-only

$voip.is_local_user_speaker_muted() -> bool

Is the local user's speaker muted?

Returns bool: True if the user's speaker is muted, False otherwise.

is_logged_in

read-only

$voip.is_logged_in() -> bool

Is the user logged in to the VOIP service?

Returns bool: True if the user is logged in to the VOIP service.

is_logging_in

read-only

$voip.is_logging_in() -> bool

Is the user logging in to the VOIP service?

Returns bool: True if the user is logging in to the VOIP service.

is_logging_out

read-only

$voip.is_logging_out() -> bool

Is the user logging out of the VOIP service?

Returns bool: True if the user is logging out of the VOIP service.

is_platform_party_chat_active

read-only

$voip.is_platform_party_chat_active() -> bool

Is platform-specific party chat active?

Returns bool: True if the platform-specific party chat is active, False otherwise.

is_user_blocked

read-only

$voip.is_user_blocked(user: User) -> bool

Is the specified Velan user currently blocked?

Parameter	Type	Meaning
user	User	The user to check.

Returns bool: True if the user is currently blocked

is_user_muted

read-only

$voip.is_user_muted(user: User) -> bool

Is the specified Velan user currently muted?

Parameter	Type	Meaning
user	User	The user to check.

Returns bool: True if the user is currently muted

is_using_app_audio

read-only

$voip.is_using_app_audio() -> bool

Query if VOIP is using the app's audio to render.

Returns bool: True if VOIP is using the app's audio to render, False otherwise.

join_channel

$voip.join_channel(channel: string, media: bool, text: bool, is_echo: bool) -> bool

Join the specified VOIP channel

Parameter	Type	Meaning
channel	string	The name of the channel to join
media	bool	True if we want to connect to the channel media (voice)
text	bool	True if we want to connect to the channel's text feed
is_echo	bool	Set true to join an echo test channel.

Returns bool: True if the join request was issued successfully

leave_channel

$voip.leave_channel(channel: string) -> bool

Leave the specified VOIP channel

Parameter	Type	Meaning
channel	string	The name of the channel to leave

Returns bool: True if the leave request was issued successfully

login

read-only

$voip.login() -> bool

Start logging the user in to the VOIP service

Returns bool: True if the login request was issued successfully.

logout

$voip.logout() -> bool

Logout of the VOIP service.

Returns bool: True if the logout request was issued successfully.

mute_user

$voip.mute_user(user: User) -> bool

Mute the specified Velan user.

Parameter	Type	Meaning
user	User	The user to mute.

Returns bool: True if the request issued successfully, False otherwise.

refresh_online_block_list

$voip.refresh_online_block_list() -> bool

Refresh the Vivox blocked users list from vonline

Returns bool: True if the request was issued, False otherwise.

register_audio_system

$voip.register_audio_system(start_sound_event: Reference, stop_sound_event: Reference) -> bool

Register the audio system with Vivox

Parameter	Type	Meaning
start_sound_event	Reference	Sound event to start playing audio.
stop_sound_event	Reference	Sound event to stop playing audio.

Returns bool: True if registered successfully, False otherwise.

restart

$voip.restart()

Restart the Vivox SDK. Only call to fix exceptional issues with the SDK.

send_text_message_to_active_channel

read-only

$voip.send_text_message_to_active_channel(channel_id: string, message: string) -> bool

Send a text message to the specified VOIP channel.

Parameter	Type	Meaning
channel_id	string	The name of the VOIP channel to send to
message	string	The message to send

Returns bool: True if the request issued successfully, False otherwise.

set_capture_volume

$voip.set_capture_volume(volume: int) -> bool

Set the VOIP capture device volume.

Parameter	Type	Meaning
volume	int	The desired capture volume in the range 0-100.

Returns bool: True if the request issued successfully.

set_desired_channel_name_from_group

$voip.set_desired_channel_name_from_group() -> bool

Set the desired VOIP channel name using the current group.

Returns bool: True if the desired channel name was set.

set_desired_channel_name_from_server

$voip.set_desired_channel_name_from_server(base: string, team_id: int) -> bool

Set the desired VOIP channel name using a base string and a team ID.

Parameter	Type	Meaning
base	string	The base name of the channel.
team_id	int	The team ID to use, or -1 to ignore

Returns bool: True if the desired channel name was set.

set_local_user_mic_muted

$voip.set_local_user_mic_muted(muted: bool) -> bool

Set the muted state of the local user's mic.

Parameter	Type	Meaning
muted	bool	If true, mute the mic. If false, unmute.

Returns bool: True if the request issued successfully.

set_local_user_speaker_muted

$voip.set_local_user_speaker_muted(muted: bool) -> bool

Set the muted state of the local user's speaker.

Parameter	Type	Meaning
muted	bool	If true, mute the speaker. If false, unmute.

Returns bool: True if the request issued successfully.

set_preferred_capture_device

$voip.set_preferred_capture_device(device_id_hash: int) -> bool

Set the VOIP capture device that should be used when available.

Parameter	Type	Meaning
device_id_hash	int	The hash of the device identifier of the preferred capture device.

Returns bool: True if the request issued successfully.

set_preferred_render_device

$voip.set_preferred_render_device(device_id_hash: int) -> bool

Set the VOIP render device that should be used when available.

Parameter	Type	Meaning
device_id_hash	int	The hash of the device identifier of the preferred render device.

Returns bool: True if the request issued successfully.

set_render_volume

$voip.set_render_volume(volume: int) -> bool

Set the VOIP render device volume.

Parameter	Type	Meaning
volume	int	The desired render volume in the range 0-100.

Returns bool: True if the request issued successfully.

tts_speak

$voip.tts_speak(voice_index: int, text: string, immediate: bool, local: bool, remote: bool) -> list

Speak text using the TTS voice.

Parameter	Type	Meaning
voice_index	int	The index of the TTS voice to use.
text	string	The text to speak.
immediate	bool	If true then play immediately. If false then add to speaking queue
local	bool	If true then TTS is played locally
remote	bool	If true then send TTS to participants in connected sessions.

Returns list: A list of the following: At index 0, True if the request was successful, False otherwise. At index 1, the integer id of the utterance.

tts_stop_all_speech

$voip.tts_stop_all_speech() -> bool

Stop all TTS speech.

Returns bool: True if the request was successful, False otherwise.

tts_stop_speech

$voip.tts_stop_speech(utterance_id: int) -> bool

Stop a specific TTS utterance.

Parameter	Type	Meaning
utterance_id	int	The id of the utterance to stop (see tts_speak).

Returns bool: True if the request was successful, False otherwise.

unmute_user

$voip.unmute_user(user: User) -> bool

Unmute the specified Velan user.

Parameter	Type	Meaning
user	User	The user to unmute.

Returns bool: True if the request issued successfully, False otherwise.

unregister_audio_system

$voip.unregister_audio_system() -> bool

Unregister the audio system with Vivox

Returns bool: True if deregistered successfully, False otherwise.