Struct matrix_sdk_base::ruma::events::call::negotiate::CallNegotiateEventContent

#[non_exhaustive]
pub struct CallNegotiateEventContent {
    pub call_id: OwnedVoipId,
    pub party_id: OwnedVoipId,
    pub version: VoipVersionId,
    pub lifetime: UInt,
    pub description: SessionDescription,
    pub sdp_stream_metadata: BTreeMap<String, StreamMetadata>,
}

Added in VoIP version 1. The content of an m.call.negotiate event.

This event is sent by either party after the call is established to renegotiate it. It can be used for media pause, hold/resume, ICE restarts and voice/video call up/downgrading.

First an event must be sent with an offer session description, which is replied to with an event with an answer session description.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

call_id: OwnedVoipId

The ID of the call this event relates to.

party_id: OwnedVoipId

The unique ID for this session for the duration of the call.

Must be the same as the one sent by the previous invite or answer from this session.

version: VoipVersionId

The version of the VoIP specification this messages adheres to.

lifetime: UInt

The time in milliseconds that the negotiation is valid for.

description: SessionDescription

The session description of the negotiation.

sdp_stream_metadata: BTreeMap<String, StreamMetadata>

Metadata describing the streams that will be sent.

This is a map of stream ID to metadata about the stream.

Implementations

impl CallNegotiateEventContent

pub fn new( call_id: OwnedVoipId, party_id: OwnedVoipId, version: VoipVersionId, lifetime: UInt, description: SessionDescription, ) -> CallNegotiateEventContent

Creates a CallNegotiateEventContent with the given call ID, party ID, lifetime and description.

pub fn version_1( call_id: OwnedVoipId, party_id: OwnedVoipId, lifetime: UInt, description: SessionDescription, ) -> CallNegotiateEventContent

Convenience method to create a version 1 CallNegotiateEventContent with all the required fields.

Trait Implementations

impl Clone for CallNegotiateEventContent

fn clone(&self) -> CallNegotiateEventContent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CallNegotiateEventContent

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CallNegotiateEventContent

fn deserialize<__D>( __deserializer: __D, ) -> Result<CallNegotiateEventContent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for CallNegotiateEventContent

type EventType = MessageLikeEventType

The Rust enum for the event kind’s known types.

fn event_type(&self) -> <CallNegotiateEventContent as EventContent>::EventType

Get the event’s type, like m.room.message.

impl From<CallNegotiateEventContent> for AnyMessageLikeEventContent

fn from(c: CallNegotiateEventContent) -> AnyMessageLikeEventContent

Converts to this type from the input type.

impl RedactContent for CallNegotiateEventContent

type Redacted = RedactedCallNegotiateEventContent

The redacted form of the event’s content.

fn redact(self, version: &RoomVersionId) -> RedactedCallNegotiateEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for CallNegotiateEventContent

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticEventContent for CallNegotiateEventContent

const TYPE: &'static str = "m.call.negotiate"

The event type.

impl MessageLikeEventContent for CallNegotiateEventContent