Package-level declarations

Types

Link copied to clipboard

Configuration that controls whether ringing sounds should play when the device is in silent or muted mode.

Link copied to clipboard
data class RingingCallVibrationConfig(val vibratePattern: LongArray = longArrayOf(0, 1000, 500, 1000), val enabled: Boolean = false)

Configuration for the vibration pattern and enabled state for ringing calls.

Link copied to clipboard
interface RingingConfig

Configuration describing the sounds played for incoming and outgoing calls in the Stream Video SDK.

Link copied to clipboard
data class Sounds(val ringingConfig: RingingConfig, val mutedRingingConfig: MutedRingingConfig? = null)

Contains all the sounds that the SDK uses.

Functions

Link copied to clipboard

Returns a ringing call vibration config with a custom vibration pattern.

Link copied to clipboard
fun defaultMutedRingingConfig(playIncomingSoundIfMuted: Boolean = false, playOutgoingSoundIfMuted: Boolean = false): MutedRingingConfig

Creates a default MutedRingingConfig.

Link copied to clipboard

Returns a RingingConfig that uses the SDK's default bundled sounds for both incoming and outgoing calls.

Link copied to clipboard

Returns a RingingConfig that uses the device ringtone for incoming calls and the SDK default ringing tone for outgoing calls.

Link copied to clipboard

Returns a ringing call vibration config that mutes (disables) vibration.

Link copied to clipboard

Returns a RingingConfig that disables all ringing sounds.

Link copied to clipboard

Returns a default ringing call vibration config.

Link copied to clipboard
fun resRingingConfig(context: Context, @RawRes incomingCallSoundResId: Int, @RawRes outgoingCallSoundResId: Int): RingingConfig

Returns a RingingConfig that uses custom resources for incoming and outgoing call sounds.

Link copied to clipboard
fun ringingConfig(ringingConfig: RingingConfig, mutedRingingConfig: MutedRingingConfig?): Sounds

Creates a Sounds object using the provided RingingConfig and MutedRingingConfig.

Link copied to clipboard

Converts a ringing config to a Sounds object.

Link copied to clipboard
fun uriRingingConfig(incomingCallSoundUri: Uri, outgoingCallSoundUri: Uri): RingingConfig

Returns a RingingConfig that uses custom URIs for incoming and outgoing call sounds.