Enum RtcFocusInfo

#[non_exhaustive]
pub enum RtcFocusInfo {
    LiveKit(LiveKitRtcFocusInfo),
}

Available on crate feature api and (crate features client-api-c or client-api-s) only.

Information about a specific MatrixRTC focus.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

LiveKit(LiveKitRtcFocusInfo)

A LiveKit RTC focus.

Implementations

impl RtcFocusInfo

pub fn new( focus_type: &str, data: Map<String, Value>, ) -> Result<RtcFocusInfo, Error>

A constructor to create a custom RTC focus.

Prefer to use the public variants of RtcFocusInfo where possible; this constructor is meant to be used for unsupported focus types only and does not allow setting arbitrary data for supported ones.

Errors

Returns an error if the focus_type is known and serialization of data to the corresponding RtcFocusInfo variant fails.

pub fn livekit(service_url: String) -> RtcFocusInfo

Creates a new RtcFocusInfo::LiveKit.

pub fn focus_type(&self) -> &str

Returns a reference to the focus type of this RTC focus.

pub fn data(&self) -> Cow<'_, Map<String, Value>>

Returns the associated data.

The returned JSON object won’t contain the focus_type field, please use .focus_type() to access that.

Prefer to use the public variants of RtcFocusInfo where possible; this method is meant to be used for custom focus types only.

Trait Implementations

impl Clone for RtcFocusInfo

fn clone(&self) -> RtcFocusInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RtcFocusInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RtcFocusInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RtcFocusInfo

fn eq(&self, other: &RtcFocusInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RtcFocusInfo

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 Eq for RtcFocusInfo

impl StructuralPartialEq for RtcFocusInfo