livekit-datatrack 0.1.4

Data track core for LiveKit
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

// Copyright 2025 LiveKit, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::{
    api::{DataTrackInfo, DataTrackOptions, LocalDataTrack, PublishError},
    packet::Handle,
};
use bytes::Bytes;
use from_variants::FromVariants;
use std::sync::Arc;
use tokio::sync::oneshot;

/// An external event handled by [`Manager`](super::manager::Manager).
#[derive(Debug, FromVariants)]
pub enum InputEvent {
    PublishRequest(PublishRequest),
    PublishCancelled(PublishCancelled),
    QueryPublished(QueryPublished),
    UnpublishRequest(UnpublishRequest),
    SfuPublishResponse(SfuPublishResponse),
    SfuUnpublishResponse(SfuUnpublishResponse),
    /// Republish all tracks.
    ///
    /// This must be sent after a full reconnect in order for existing publications
    /// to be recognized by the SFU. Each republished track will be assigned a new SID.
    ///
    RepublishTracks,
    /// Shutdown the manager and all associated tracks.
    Shutdown,
}

/// An event produced by [`Manager`](super::manager::Manager) requiring external action.
#[derive(Debug, FromVariants)]
pub enum OutputEvent {
    SfuPublishRequest(SfuPublishRequest),
    SfuUnpublishRequest(SfuUnpublishRequest),
    /// Serialized packets are ready to be sent over the transport.
    PacketsAvailable(Vec<Bytes>),
}

// MARK: - Input events

/// Client requested to publish a track.
///
/// Send using [`ManagerInput::publish_track`] and await the result.
///
/// [`ManagerInput::publish_track`]: super::manager::ManagerInput::publish_track
///
#[derive(Debug)]
pub struct PublishRequest {
    /// Publish options.
    pub(super) options: DataTrackOptions,
    /// Async completion channel.
    pub(super) result_tx: oneshot::Sender<Result<LocalDataTrack, PublishError>>,
}

/// Client request to publish a track has been cancelled (internal).
#[derive(Debug)]
pub struct PublishCancelled {
    /// Publisher handle of the pending publication.
    pub(super) handle: Handle,
}

/// Client request to unpublish a track (internal).
#[derive(Debug)]
pub struct UnpublishRequest {
    /// Publisher handle of the track to unpublish.
    pub(super) handle: Handle,
}

/// Get information about all currently published tracks.
///
/// Send using [`ManagerInput::query_tracks`] and await the result. This is used
/// to support sync state.
///
/// [`ManagerInput::query_tracks`]: super::manager::ManagerInput::query_tracks
///
#[derive(Debug)]
pub struct QueryPublished {
    pub(super) result_tx: oneshot::Sender<Vec<Arc<DataTrackInfo>>>,
}

/// SFU responded to a request to publish a data track.
///
/// Protocol equivalent: [`livekit_protocol::PublishDataTrackResponse`].
///
#[derive(Debug)]
pub struct SfuPublishResponse {
    /// Publisher handle of the track.
    pub handle: Handle,
    /// Outcome of the publish request.
    pub result: Result<DataTrackInfo, PublishError>,
}

/// SFU notification that a track has been unpublished.
///
/// Protocol equivalent: [`livekit_protocol::UnpublishDataTrackResponse`].
///
#[derive(Debug)]
pub struct SfuUnpublishResponse {
    /// Publisher handle of the track that was unpublished.
    pub handle: Handle,
}

// MARK: - Output events

/// Request sent to the SFU to publish a track.
///
/// Protocol equivalent: [`livekit_protocol::PublishDataTrackRequest`].
///
#[derive(Debug)]
pub struct SfuPublishRequest {
    pub handle: Handle,
    pub name: String,
    pub uses_e2ee: bool,
}

/// Request sent to the SFU to unpublish a track.
///
/// Protocol equivalent: [`livekit_protocol::UnpublishDataTrackRequest`].
///
#[derive(Debug)]
pub struct SfuUnpublishRequest {
    /// Publisher handle of the track to unpublish.
    pub handle: Handle,
}