StateMessage

@Serializable
@SerialName(value = "StateMessage")
data class StateMessage : BaseMessage(source)

Represents a message describing the current call state.

This data class encapsulates various parameters related to the call state, including call ID, local and remote addresses, call and media directions, and more.

Since

1.0.0

Author

Dominik Ridjic

Throws

If type is missing before calling Builder.build

Types

Link copied to clipboard
class Builder : ProguardKeep

Builder class for StateMessage.

Properties

Link copied to clipboard
@SerialName(value = "accountaor")
val addressLocal: String? = null

The local address associated with the call.

Link copied to clipboard
@SerialName(value = "peeruri")
val addressRemote: String? = null

The remote address associated with the call.

Link copied to clipboard
@SerialName(value = "peerdisplayname")
val addressRemoteDisplayName: String? = null

The display name associated with the remote address.

Link copied to clipboard
@SerialName(value = "audiodir")
val audioDirection: MediaDirection

The direction of the audio media.

Link copied to clipboard
@SerialName(value = "remoteaudiodir")
val audioRemoteDirection: MediaDirection

The remote direction of the audio media.

Link copied to clipboard
@SerialName(value = "direction")
val callDirection: CallDirection?

The direction of the call.

Link copied to clipboard
@SerialName(value = "id")
val callId: String? = null

The unique identifier for the call.

Link copied to clipboard
@SerialName(value = "timestamp")
open override val timestamp: Double

The timestamp when the message was created or received.

Link copied to clipboard
@SerialName(value = "type")
open override val type: MessageType.State

The type of the message, typically representing the call state.

Link copied to clipboard
@SerialName(value = "videodir")
val videoDirection: MediaDirection

The direction of the video media.

Link copied to clipboard
@SerialName(value = "remotevideodir")
val videoRemoteDirection: MediaDirection

The remote direction of the video media.