Home > @twilio/voice-react-native-sdk

voice-react-native-sdk package

Provides access to Twilio Programmable Voice for React Native applications running on iOS and Android devices.

Classes

Class	Description
AudioDevice	Describes audio devices as reported by the native layer and allows the native selection of the described audio device.
Call	Provides access to information about a call, including the call parameters, and exposes functionality for a call such as disconnecting, muting, and holding.
CallInvite	Provides access to information about a call invite, including the call parameters, and exposes functionality to accept or decline a call.
IncomingCallMessage	CallMessage API is in beta.Provides access to information about a CallMessage, including the call message content, content type, message type, and voice event SID.
OutgoingCallMessage	CallMessage API is in beta.Provides access to information about a outgoingCallMessage, including the call message content, contentType, messageType, and voiceEventSid
PreflightTest	The PreflightTest for Voice React Native SDK allows you to anticipate and troubleshoot end users' connectivity and bandwidth issues before or during Twilio Voice calls.You can run a PreflightTest before a Twilio Voice call. The PreflightTest performs a test call to Twilio and provides a PreflightTest.Report object at the end. The report includes information about the end user's network connection (including jitter, packet loss, and round trip time) and connection settings.
Voice	Main entry-point of the Voice SDK. Provides access to the entire feature-set of the library.

Enumerations

Enumeration	Description
AudioCodecType	Available audio codecs.
IceTransportPolicy	Ice transport policy.

Interfaces

Interface	Description
Call	Defines strict typings for all events emitted by Call objects.
CallInvite	Defines strict typings for all events emitted by CallInvite objects.
CallMessage	The constituent values of a Call Message.
OutgoingCallMessage	Defines strict typings for all events emitted by OutgoingCallMessage objects.
PreflightTest
Voice	Defines strict typings for all events emitted by Voice objects.

Namespaces

Namespace	Description
AudioDevice	Contains interfaces and enumerations associated with audio devices.
Call	Namespace for enumerations and types used by Call objects.
CallInvite	Provides enumerations and types used by a CallInvite object.
CallKit	CallKit related types.
OutgoingCallMessage	Namespace for enumerations and types used by OutgoingCallMessage objects.
PreflightTest	Helper types for the PrefligthTest class.
RTCStats	Types related to WebRTC stats.
TwilioErrors
Voice	Provides enumerations and types used by Voice objects.

Type Aliases

Type Alias	Description
AudioCodec	The type of an audio codec.
CustomParameters	Call custom parameters. If custom parameters are present for a call, then it will have this typing.
IceServer	Ice server configuration.
OpusAudioCodec	Configuration to use the Opus audio codec.
PCMUAudioCodec	Configuration to use the PCMU audio codec.