Voip Class

Attempts to establish a Voip session with the specified user. A message of type Message::MessageType::Notification_Voip_StateChange will be posted when the session is established. This function can be safely called from any thread.

Terminates a Voip session with the specified user. Note that Voip.SetMicrophoneMuted should be used to temporarily stop sending audio; stopping and restarting a Voip session after tearing it down may be an expensive operation. This function can be safely called from any thread.

This function allows you to set a callback that will be called every time audio data is captured by the microphone. The callback function must match this signature: void filterCallback(int16_t pcmData[], size_t pcmDataLength, int frequency, int numChannels); The pcmData param is used for both input and output. pcmDataLength is the size of pcmData in elements. numChannels will be 1 or 2. If numChannels is 2, then the channel data will be interleaved in pcmData. Frequency is the input data sample rate in hertz. This function can be safely called from any thread.

This function is used to enable or disable the local microphone. When muted, the microphone will not transmit any audio. Voip connections are unaffected by this state. New connections can be established or closed whether the microphone is muted or not. This can be used to implement push-to-talk, or a local mute button. The default state is unmuted. This function can be safely called from any thread.

Gets whether the microphone is currently available to the app. This can be used to show if the user's voice is able to be heard by other users. Returns a microphone availability state flag which determines whether it is available or not - Models.MicrophoneAvailabilityState.

Sets whether SystemVoip should be suppressed so that this app's Voip can use the microphone and play incoming Voip audio. Once microphone switching functionality for the user is released, this function will no longer work. You can use Voip.GetMicrophoneAvailability() to see if the user has allowed the app access to the microphone. This returns a Models.SystemVoipState object which contains statuses about whether the microphone is muted or whether passthrough is enabled.

Indicates that the current microphone availability state has been updated. Use Voip.GetMicrophoneAvailability() to extract the microphone availability state.

Sent to indicate that some part of the overall state of SystemVoip has changed. Use SystemVoipState::Status and the properties of Models.SystemVoipState to extract the state that triggered the notification. Note that the state may have changed further since the notification was generated, and that you may call the GetSystemVoip...() family of functions at any time to get the current state directly.