medea-jason 0.14.2

Client library for Medea media server.
Documentation
//! [MediaDeviceInfo][1] related objects.
//!
//! [1]: https://w3.org/TR/mediacapture-streams#device-info

use derive_more::with_trait::From;

use crate::media::MediaDeviceKind;

/// Representation of a [MediaDeviceInfo][1].
///
/// [1]: https://w3.org/TR/mediacapture-streams#device-info
#[derive(Debug, From)]
pub struct MediaDeviceInfo(web_sys::MediaDeviceInfo);

impl From<web_sys::MediaDeviceKind> for MediaDeviceKind {
    fn from(value: web_sys::MediaDeviceKind) -> Self {
        match value {
            web_sys::MediaDeviceKind::Audioinput => Self::AudioInput,
            web_sys::MediaDeviceKind::Videoinput => Self::VideoInput,
            web_sys::MediaDeviceKind::Audiooutput => Self::AudioOutput,
            _ => {
                unreachable!("unknown `MediaDeviceKind::{value:?}`")
            }
        }
    }
}

impl MediaDeviceInfo {
    /// Returns a unique identifier for the represented device.
    #[must_use]
    pub fn device_id(&self) -> String {
        self.0.device_id()
    }

    /// Returns kind of the represented device.
    ///
    /// This representation of [MediaDeviceInfo][1] ONLY for input device.
    ///
    /// [1]: https://w3.org/TR/mediacapture-streams#device-info
    #[must_use]
    pub fn kind(&self) -> MediaDeviceKind {
        self.0.kind().into()
    }

    /// Returns label describing the represented device (for example, "External
    /// USB Webcam").
    ///
    /// If the device has no associated label, then returns an empty string.
    #[must_use]
    pub fn label(&self) -> String {
        self.0.label()
    }

    /// Returns group identifier of the represented device.
    ///
    /// Two devices have the same group identifier if they belong to the same
    /// physical device. For example, the audio input and output devices
    /// representing the speaker and microphone of the same headset have the
    /// same [groupId][1].
    ///
    /// [1]: https://w3.org/TR/mediacapture-streams#dom-mediadeviceinfo-groupid
    #[must_use]
    pub fn group_id(&self) -> Option<String> {
        Some(self.0.group_id())
    }
}