Struct matrix_sdk::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>,
}

Expand description

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)§

This struct is marked as 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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for CallNegotiateEventContent

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

Formats the value using the given formatter. Read more

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. Read more

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. Read more

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. Read more

impl StaticEventContent for CallNegotiateEventContent

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

The event type.

impl MessageLikeEventContent for CallNegotiateEventContent

Auto Trait Implementations§

impl RefUnwindSafe for CallNegotiateEventContent

impl Send for CallNegotiateEventContent

impl Sync for CallNegotiateEventContent

impl Unpin for CallNegotiateEventContent

impl UnwindSafe for CallNegotiateEventContent

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> EventContentFromType for T
where T: EventContent + DeserializeOwned,

fn from_parts(_event_type: &str, content: &RawValue) -> Result<T, Error>

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more

fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more

fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<>

fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

const WITNESS: W = W::MAKE

A constant of the type witness

impl<T> Identity for T
where T: ?Sized,

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> Any for T
where T: Any,

impl<T> AsyncTraitDeps for T
where T: Debug + SendOutsideWasm + SyncOutsideWasm,

impl<T> CloneAny for T
where T: Any + Clone,

impl<T> CloneAnySend for T
where T: Any + Send + Clone,

impl<T> CloneAnySendSync for T
where T: Any + Send + Sync + Clone,

impl<T> CloneAnySync for T
where T: Any + Sync + Clone,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> SendOutsideWasm for T
where T: Send,

impl<T> SyncOutsideWasm for T
where T: Sync,