opentalk-roomserver-types-livekit 0.0.2

Opentalk RoomServer LiveKit Types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

// SPDX-FileCopyrightText: OpenTalk GmbH <mail@opentalk.eu>
//
// SPDX-License-Identifier: EUPL-1.2

use std::collections::BTreeSet;

use opentalk_types_signaling::ParticipantId;

use crate::{Credentials, command::UnrestrictedParticipants, error::LiveKitError};

/// The events emitted for livekit
#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[serde(tag = "message", rename_all = "snake_case")]
pub enum LiveKitEvent {
    /// The credentials for a client to use livekit
    Credentials(Credentials),

    /// The moderator enabled the microphone-restriction-state. Only participants listed in
    /// [`UnrestrictedParticipants::unrestricted_participants`] are able to unmute themselves.
    MicrophoneRestrictionsEnabled(UnrestrictedParticipants),

    /// The moderator disabled the microphone-restriction-state.
    /// Participants are allowed to unmute themselves again.
    MicrophoneRestrictionsDisabled,

    /// The moderator has force muted the participant.
    ForceMuted {
        /// The moderator who issued the force mute command.
        moderator: ParticipantId,
    },

    /// A livekit access token that cannot publish and is hidden to other participants
    PopoutStreamAccessToken {
        /// The token
        token: String,
    },

    /// LiveKit permissions have been updated.
    ///
    /// This event is the response to [`LiveKitCommand::RevokeScreenSharePermission`]
    /// and [`LiveKitCommand::GrantScreenSharePermission`] and only received by the
    /// moderator who issued the command. The participant who was the target of the
    /// command will be notified by the LiveKit server.
    ///
    /// [`LiveKitCommand::RevokeScreenSharePermission`]: crate::command::LiveKitCommand::RevokeScreenSharePermission
    /// [`LiveKitCommand::GrantScreenSharePermission`]: crate::command::LiveKitCommand::GrantScreenSharePermission
    ScreenSharePermissionsUpdated {
        /// `true` if screen share permissions where granted, `false` otherwise.
        grant: bool,
        /// The participants who received a screen share permission change.
        participants: BTreeSet<ParticipantId>,
    },

    /// The last message couldn't be processed since an unexpected error occurred.
    Error(LiveKitError),
}

impl From<LiveKitError> for LiveKitEvent {
    fn from(error: LiveKitError) -> Self {
        Self::Error(error)
    }
}