Enum KeyMedia 

#[non_exhaustive]
#[repr(u8)]
pub enum KeyMedia {
    Play = 0,
    Pause = 1,
    PlayPause = 2,
    Reverse = 3,
    Stop = 4,
    FastForward = 5,
    Rewind = 6,
    Next = 7,
    Previous = 8,
    Record = 9,
    LowerVolume = 10,
    RaiseVolume = 11,
    MuteVolume = 12,
    Eject = 13,
    MediaSelect = 14,
    LaunchMedia = 15,
    BassBoost = 16,
    BassUp = 17,
    BassDown = 18,
    TrebleUp = 19,
    TrebleDown = 20,
    MicrophoneMute = 21,
    MicrophoneVolumeUp = 22,
    MicrophoneVolumeDown = 23,
    BrightnessUp = 24,
    BrightnessDown = 25,
    Sleep = 26,
    Wake = 27,
    Power = 28,
}

Available on crate feature event only.

🎮 Media key codes.

---

^{📍 ui/event}

^{📦 size_of::<KeyMedia>() == 1 bytes / 8 bits ⚗️Option<T>}

---

These keys are commonly found on multimedia keyboards and remote controls.

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.

Play = 0

Starts media playback.

Pause = 1

Pauses media playback.

PlayPause = 2

Toggles between playing and pausing media.

Reverse = 3

Plays media in reverse.

Stop = 4

Stops media playback.

FastForward = 5

Fast-forwards through media.

Rewind = 6

Rewinds through media.

Next = 7

Skips to the next media track.

Previous = 8

Returns to the previous media track.

Record = 9

Starts recording media.

LowerVolume = 10

Decreases the audio volume.

RaiseVolume = 11

Increases the audio volume.

MuteVolume = 12

Mutes or unmutes the audio.

Eject = 13

Ejects a removable media disk (found on some keyboards, especially Macs).

MediaSelect = 14

Opens the default media player application.

LaunchMedia = 15

Launches a media-related application.

BassBoost = 16

Toggles bass boost mode.

BassUp = 17

Increases bass levels.

BassDown = 18

Decreases bass levels.

TrebleUp = 19

Increases treble levels.

TrebleDown = 20

Decreases treble levels.

MicrophoneMute = 21

Mutes or unmutes the microphone.

MicrophoneVolumeUp = 22

Increases the microphone input volume.

MicrophoneVolumeDown = 23

Decreases the microphone input volume.

BrightnessUp = 24

Increases the screen brightness.

BrightnessDown = 25

Decreases the screen brightness.

Sleep = 26

Puts the system into sleep mode.

Wake = 27

Wakes the system from sleep mode.

Power = 28

Powers the system off or performs a power-related action.

Implementations

impl KeyMedia

pub const fn from_web_code(code: &str) -> Option<Self>

Available on crate feature web only.

Atempts to construct a KeyMedia from a JavaScript KeyboardEvent physical code.

pub const fn to_web_code(self) -> &'static str

Available on crate feature web only.

Returns a JavaScript KeyboardEvent physical code.

pub const fn from_web_key(key: &str) -> Option<Self>

Available on crate feature web only.

Atempts to construct a KeyMedia from a JavaScript KeyboardEvent semantic key.

pub const fn to_web_key(self) -> &'static str

Available on crate feature web only.

Returns a JavaScript KeyboardEvent semantic key.

Trait Implementations

impl Clone for KeyMedia

fn clone(&self) -> KeyMedia

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstInit for KeyMedia

const INIT: Self = Self::Play

Returns the compile-time “initial value” for a type.

impl Copy for KeyMedia

impl Debug for KeyMedia

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

Formats the value using the given formatter.

impl Eq for KeyMedia

impl From<KeyMedia> for Key

fn from(code: KeyMedia) -> Key

Converts to this type from the input type.

impl Hash for KeyMedia

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KeyMedia

fn eq(&self, other: &KeyMedia) -> 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 StructuralPartialEq for KeyMedia