medea-jason 0.14.0

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

use derive_more::with_trait::From;
use wasm_bindgen::prelude::*;

use crate::{api::MediaDeviceKind, platform};

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

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

    /// Returns a kind of the represented device.
    ///
    /// This representation of [MediaDeviceInfo][1] is for input device ONLY.
    ///
    /// [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 a 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> {
        self.0.group_id()
    }
}